Lab
Class SpecimenContainer

Container: "an object used for or capable of holding, esp for transport or storage, such as a carton, box, etc." - Dictionary.com. This class describes the object in which the specimen is contained, such as its capacity, etc. Some containers are manufactured such that they contain a pre-defined substance that may act to preserve, maintain or enhance the particular nature or component of the specimen. For example, a "blue top tube" typically contains an anticoagulant such as citrate. It is therefore important to know what kind of container the sample is in, as the condition of the sample may be affected.

"An Entity that holds other Entities." - HL7 Version 3.
"The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here." - HL7 FHIR, Specimen.container

Attributes
SpecimenAdditive additive additive

"Identifies any additives introduced to the specimen before or at the time of collection. These additives may be introduced in order to preserve, maintain or enhance the particular nature or component of the specimen." - HL7 Version 2.8, SPM-6. Note that HL7 identifies a Code Table (Table 371) for this property, which currently contains 57 suggested values.
"Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA." - HL7 FHIR, Specimen.container.additive[x]

«PQ» Quantity barrierDeltaQuantity barrierDeltaQuantity

"Identifies the distance from the Point of Reference to the separator material (barrier) within the container in units specified below. This distance may be provided by the LAS to the instrument and/or specimen processing/handling device to facilitate the insertion of a sampling probe into the specimen without touching the separator." - HL7 Version 2.8, SAC-18.
"The distance from the point of reference to the separator material (barrier) within a container." - HL7 Version 3 (Container.barrierDeltaQuantity).

«PQ» Quantity bottomDeltaQuantity bottomDeltaQuantity

"Identifies the distance from the Point of Reference to the separator material (barrier) within the container in units specified below. This distance may be provided by the LAS to the instrument and/or specimen processing/handling device to facilitate the insertion of a sampling probe into the specimen without touching the separator." - HL7 Version 2.8, SAC-18.
"The distance from the point of reference to the separator material (barrier) within a container." - HL7 Version 3 (Container.barrierDeltaQuantity).

String capType capType

"Indicates the type of cap that is to be used with this container for decapping, piercing or other mechanisms." - HL7 Version 2.8, SAC-26. Note that HL7 identifies a Code Table (Table 381) for this property, but does not provide any suggested values.
"The type of cap (closure) associated with the container that is the entity being described." - HL7 Version 3 (Container.capTypeCode).

«PQ» Quantity containerCapacity containerCapacity

"Indicates the capacity of the container in the units specified [in SAC-24]." - HL7 Version 2.8, SAC-21.
"The unit identifier that is being used to describe the volume of the container...." - HL7 Version 2.8, SAC-24.
"The functional capacity of the container." - HL7 Version 3 (Container.capacityQuantity).
"The capacity (volume or other measure) the container may contain." - HL7 FHIR, Specimen.container.capacity

«PQ» Quantity containerDiameter containerDiameter

"Identifies the outside diameter of the container in units specified [in SAC-24]." - HL7 Version 2.8, SAC-17.
"The unit identifier that is being used to describe the volume of the container...." - HL7 Version 2.8, SAC-24.
"The outside diameter of the container." - HL7 Version 3 (Container.diameterQuantity).

«PQ» Quantity containerHeight containerHeight

"Identifies the height of the container in units specified [in SAC-24]." - HL7 Version 2.8, SAC-16.
"The unit identifier that is being used to describe the volume of the container...." - HL7 Version 2.8, SAC-24.
"The height of the container." - HL7 Version 3 (Container.heightQuantity).

String containerType containerType

"The container in or on which a specimen is transported." - HL7 Version 2.8, SPM-27. Note that although this property is a flavor of Code in HL7 Version 2, HL7 does not link this property to a Code Table nor do they provide any suggested values.
"The type of container associated with the specimen (e.g. slide, aliquot, etc.)." - HL7 FHIR, Specimen.container.type

String description description

"Textual description of the container." - HL7 FHIR, Specimen.container.description

«II» Id identifier identifier

"The container's unique identifier assigned by the corresponding equipment...." - HL7 Version 2.8, SAC-3.
"Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances." - HL7 FHIR, Specimen.container.identifier

String separatorType separatorType

"Identifies the type of the separator that is being used (e.g., gel separator in the container…)" - HL7 Version 2.8, SAC-25. Note that HL7 identifies a Code Table (Table 380) for this property, but does not provide any suggested values.
"A material added to a container to facilitate and create a physical separation of specimen components of differing density. The composition or nature of the separator material may have an effect on the analysis. Knowledge of the material aids interpretation of results." - HL7 Version 3 (Container.separatorTypeCode).

«PQ» Quantity specimenQuantity specimenQuantity

The amount of specimen in the container. Note that this property could potentially be derived through a Specimen Assessment, and therefore is marked as a derived property.
"The amount of specimen that currently exists or is available for use in further testing." - HL7 Version 2.8, SPM-25.
"The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type." - HL7 FHIR, Specimen.container.specimenQuantity


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameSpecimenContainer
Name Expression
NamespaceLab
Owned Template Signature
OwnerLab
Owning Template Parameter
PackageLab
Qualified NameFHIM::Lab::SpecimenContainer
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 additive
Public SpecimenAdditive additive

"Identifies any additives introduced to the specimen before or at the time of collection. These additives may be introduced in order to preserve, maintain or enhance the particular nature or component of the specimen." - HL7 Version 2.8, SPM-6. Note that HL7 identifies a Code Table (Table 371) for this property, which currently contains 57 suggested values.
"Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA." - HL7 FHIR, Specimen.container.additive[x]

Constraints:
Properties:

AggregationNone
Alias
AssociationspecimenContainer_additive
Association End
ClassSpecimenContainer
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameadditive
Name Expression
NamespaceSpecimenContainer
Opposite
OwnerSpecimenContainer
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::SpecimenContainer::additive
Stereotype
Template Parameter
TypeSpecimenAdditive
Upper*
Upper Value(*)
VisibilityPublic


 barrierDeltaQuantity
Public «PQ» Quantity barrierDeltaQuantity

"Identifies the distance from the Point of Reference to the separator material (barrier) within the container in units specified below. This distance may be provided by the LAS to the instrument and/or specimen processing/handling device to facilitate the insertion of a sampling probe into the specimen without touching the separator." - HL7 Version 2.8, SAC-18.
"The distance from the point of reference to the separator material (barrier) within a container." - HL7 Version 3 (Container.barrierDeltaQuantity).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSpecimenContainer
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamebarrierDeltaQuantity
Name Expression
NamespaceSpecimenContainer
Opposite
OwnerSpecimenContainer
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::SpecimenContainer::barrierDeltaQuantity
Stereotype
Template Parameter
Type«PQ» Quantity
Upper1
Upper Value(1)
VisibilityPublic


 bottomDeltaQuantity
Public «PQ» Quantity bottomDeltaQuantity

"Identifies the distance from the Point of Reference to the separator material (barrier) within the container in units specified below. This distance may be provided by the LAS to the instrument and/or specimen processing/handling device to facilitate the insertion of a sampling probe into the specimen without touching the separator." - HL7 Version 2.8, SAC-18.
"The distance from the point of reference to the separator material (barrier) within a container." - HL7 Version 3 (Container.barrierDeltaQuantity).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSpecimenContainer
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamebottomDeltaQuantity
Name Expression
NamespaceSpecimenContainer
Opposite
OwnerSpecimenContainer
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::SpecimenContainer::bottomDeltaQuantity
Stereotype
Template Parameter
Type«PQ» Quantity
Upper1
Upper Value(1)
VisibilityPublic


 capType
Public String capType

"Indicates the type of cap that is to be used with this container for decapping, piercing or other mechanisms." - HL7 Version 2.8, SAC-26. Note that HL7 identifies a Code Table (Table 381) for this property, but does not provide any suggested values.
"The type of cap (closure) associated with the container that is the entity being described." - HL7 Version 3 (Container.capTypeCode).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSpecimenContainer
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamecapType
Name Expression
NamespaceSpecimenContainer
Opposite
OwnerSpecimenContainer
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::SpecimenContainer::capType
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 containerCapacity
Public «PQ» Quantity containerCapacity

"Indicates the capacity of the container in the units specified [in SAC-24]." - HL7 Version 2.8, SAC-21.
"The unit identifier that is being used to describe the volume of the container...." - HL7 Version 2.8, SAC-24.
"The functional capacity of the container." - HL7 Version 3 (Container.capacityQuantity).
"The capacity (volume or other measure) the container may contain." - HL7 FHIR, Specimen.container.capacity

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSpecimenContainer
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamecontainerCapacity
Name Expression
NamespaceSpecimenContainer
Opposite
OwnerSpecimenContainer
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::SpecimenContainer::containerCapacity
Stereotype
Template Parameter
Type«PQ» Quantity
Upper1
Upper Value(1)
VisibilityPublic


 containerDiameter
Public «PQ» Quantity containerDiameter

"Identifies the outside diameter of the container in units specified [in SAC-24]." - HL7 Version 2.8, SAC-17.
"The unit identifier that is being used to describe the volume of the container...." - HL7 Version 2.8, SAC-24.
"The outside diameter of the container." - HL7 Version 3 (Container.diameterQuantity).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSpecimenContainer
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamecontainerDiameter
Name Expression
NamespaceSpecimenContainer
Opposite
OwnerSpecimenContainer
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::SpecimenContainer::containerDiameter
Stereotype
Template Parameter
Type«PQ» Quantity
Upper1
Upper Value(1)
VisibilityPublic


 containerHeight
Public «PQ» Quantity containerHeight

"Identifies the height of the container in units specified [in SAC-24]." - HL7 Version 2.8, SAC-16.
"The unit identifier that is being used to describe the volume of the container...." - HL7 Version 2.8, SAC-24.
"The height of the container." - HL7 Version 3 (Container.heightQuantity).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSpecimenContainer
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamecontainerHeight
Name Expression
NamespaceSpecimenContainer
Opposite
OwnerSpecimenContainer
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::SpecimenContainer::containerHeight
Stereotype
Template Parameter
Type«PQ» Quantity
Upper1
Upper Value(1)
VisibilityPublic


 containerType
Public String containerType

"The container in or on which a specimen is transported." - HL7 Version 2.8, SPM-27. Note that although this property is a flavor of Code in HL7 Version 2, HL7 does not link this property to a Code Table nor do they provide any suggested values.
"The type of container associated with the specimen (e.g. slide, aliquot, etc.)." - HL7 FHIR, Specimen.container.type

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSpecimenContainer
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamecontainerType
Name Expression
NamespaceSpecimenContainer
Opposite
OwnerSpecimenContainer
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::SpecimenContainer::containerType
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 description
Public String description

"Textual description of the container." - HL7 FHIR, Specimen.container.description

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSpecimenContainer
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namedescription
Name Expression
NamespaceSpecimenContainer
Opposite
OwnerSpecimenContainer
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::SpecimenContainer::description
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 identifier
Public «II» Id identifier

"The container's unique identifier assigned by the corresponding equipment...." - HL7 Version 2.8, SAC-3.
"Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances." - HL7 FHIR, Specimen.container.identifier

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSpecimenContainer
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Nameidentifier
Name Expression
NamespaceSpecimenContainer
Opposite
OwnerSpecimenContainer
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::SpecimenContainer::identifier
Stereotype
Template Parameter
Type«II» Id
Upper1
Upper Value(1)
VisibilityPublic


 separatorType
Public String separatorType

"Identifies the type of the separator that is being used (e.g., gel separator in the container…)" - HL7 Version 2.8, SAC-25. Note that HL7 identifies a Code Table (Table 380) for this property, but does not provide any suggested values.
"A material added to a container to facilitate and create a physical separation of specimen components of differing density. The composition or nature of the separator material may have an effect on the analysis. Knowledge of the material aids interpretation of results." - HL7 Version 3 (Container.separatorTypeCode).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSpecimenContainer
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameseparatorType
Name Expression
NamespaceSpecimenContainer
Opposite
OwnerSpecimenContainer
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::SpecimenContainer::separatorType
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 specimenQuantity
Public «PQ» Quantity specimenQuantity

The amount of specimen in the container. Note that this property could potentially be derived through a Specimen Assessment, and therefore is marked as a derived property.
"The amount of specimen that currently exists or is available for use in further testing." - HL7 Version 2.8, SPM-25.
"The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type." - HL7 FHIR, Specimen.container.specimenQuantity

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassSpecimenContainer
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamespecimenQuantity
Name Expression
NamespaceSpecimenContainer
Opposite
OwnerSpecimenContainer
Owning Association
Owning Template Parameter
Qualified NameFHIM::Lab::SpecimenContainer::specimenQuantity
Stereotype
Template Parameter
Type«PQ» Quantity
Upper1
Upper Value(1)
VisibilityPublic