Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.Specimen extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Sample for analysis.

Property Inventory


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = Specimen;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = Specimen;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property accessionIdentifier as HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "accessionIdentifier", XMLPROJECTION = "ELEMENT");

Identifier assigned by the lab.

Property methods: accessionIdentifierGet(), accessionIdentifierGetSwizzled(), accessionIdentifierIsValid(), accessionIdentifierNewObject(), accessionIdentifierSet()
property collection as HS.FHIR.DTL.vR4.Model.Element.Specimen.collection (XMLNAME = "collection", XMLPROJECTION = "ELEMENT");

Collection details.

Property methods: collectionGet(), collectionGetSwizzled(), collectionIsValid(), collectionNewObject(), collectionSet()
property condition as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "condition", XMLPROJECTION = "ELEMENT");

State of the specimen.

v2-0493 is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in v2-0493, you may formally EXTEND v2-0493 to add codes to it.

Property methods: conditionBuildValueArray(), conditionCollectionToDisplay(), conditionCollectionToOdbc(), conditionDisplayToCollection(), conditionGet(), conditionGetObject(), conditionGetObjectId(), conditionGetSwizzled(), conditionIsValid(), conditionOdbcToCollection(), conditionSet(), conditionSetObject(), conditionSetObjectId()
property container as list of HS.FHIR.DTL.vR4.Model.Element.Specimen.container (XMLNAME = "container", XMLPROJECTION = "ELEMENT");

Direct container of specimen (tube/slide, etc.)

Property methods: containerBuildValueArray(), containerCollectionToDisplay(), containerCollectionToOdbc(), containerDisplayToCollection(), containerGet(), containerGetObject(), containerGetObjectId(), containerGetSwizzled(), containerIsValid(), containerOdbcToCollection(), containerSet(), containerSetObject(), containerSetObjectId()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

External Identifier.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property note as list of HS.FHIR.DTL.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");


Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property parent as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "parent", XMLPROJECTION = "ELEMENT");

Specimen from which this specimen originated.


Property methods: parentBuildValueArray(), parentCollectionToDisplay(), parentCollectionToOdbc(), parentDisplayToCollection(), parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentOdbcToCollection(), parentSet(), parentSetObject(), parentSetObjectId()
property processing as list of HS.FHIR.DTL.vR4.Model.Element.Specimen.processing (XMLNAME = "processing", XMLPROJECTION = "ELEMENT");

Processing and processing step details.

Property methods: processingBuildValueArray(), processingCollectionToDisplay(), processingCollectionToOdbc(), processingDisplayToCollection(), processingGet(), processingGetObject(), processingGetObjectId(), processingGetSwizzled(), processingIsValid(), processingOdbcToCollection(), processingSet(), processingSetObject(), processingSetObjectId()
property receivedTime as %String (MAXLEN = 1000000, XMLNAME = "receivedTime", XMLPROJECTION = "ATTRIBUTE");

The time when specimen was received for processing.

Property methods: receivedTimeDisplayToLogical(), receivedTimeGet(), receivedTimeIsValid(), receivedTimeLogicalToDisplay(), receivedTimeLogicalToOdbc(), receivedTimeNormalize(), receivedTimeSet()
property request as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "request", XMLPROJECTION = "ELEMENT");

Why the specimen was collected.


Property methods: requestBuildValueArray(), requestCollectionToDisplay(), requestCollectionToOdbc(), requestDisplayToCollection(), requestGet(), requestGetObject(), requestGetObjectId(), requestGetSwizzled(), requestIsValid(), requestOdbcToCollection(), requestSet(), requestSetObject(), requestSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");

available | unavailable | unsatisfactory | entered-in-error

specimen-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend specimen-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");

Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.

Patient | Group | Device | Substance | Location

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property type as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");

Kind of material that forms the specimen.

any FHIR4 code may be used; v2-0487 shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab