| Lab UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
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 |
"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 |
"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 |
"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 |
"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 |
"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 |
"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 |
"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 |
"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 |
"Textual description of the container." - HL7 FHIR, Specimen.container.description |
«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 |
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). |
«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 |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | SpecimenContainer |
Name Expression | |
Namespace | Lab |
Owned Template Signature | |
Owner | Lab |
Owning Template Parameter | |
Package | Lab |
Qualified Name | FHIM::Lab::SpecimenContainer |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
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]
Aggregation | None |
Alias | |
Association | specimenContainer_additive |
Association End | |
Class | SpecimenContainer |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | additive |
Name Expression | |
Namespace | SpecimenContainer |
Opposite | |
Owner | SpecimenContainer |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenContainer::additive |
Stereotype | |
Template Parameter | |
Type | SpecimenAdditive |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenContainer |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | barrierDeltaQuantity |
Name Expression | |
Namespace | SpecimenContainer |
Opposite | |
Owner | SpecimenContainer |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenContainer::barrierDeltaQuantity |
Stereotype | |
Template Parameter | |
Type | «PQ» Quantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenContainer |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | bottomDeltaQuantity |
Name Expression | |
Namespace | SpecimenContainer |
Opposite | |
Owner | SpecimenContainer |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenContainer::bottomDeltaQuantity |
Stereotype | |
Template Parameter | |
Type | «PQ» Quantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenContainer |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | capType |
Name Expression | |
Namespace | SpecimenContainer |
Opposite | |
Owner | SpecimenContainer |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenContainer::capType |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenContainer |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | containerCapacity |
Name Expression | |
Namespace | SpecimenContainer |
Opposite | |
Owner | SpecimenContainer |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenContainer::containerCapacity |
Stereotype | |
Template Parameter | |
Type | «PQ» Quantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenContainer |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | containerDiameter |
Name Expression | |
Namespace | SpecimenContainer |
Opposite | |
Owner | SpecimenContainer |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenContainer::containerDiameter |
Stereotype | |
Template Parameter | |
Type | «PQ» Quantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenContainer |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | containerHeight |
Name Expression | |
Namespace | SpecimenContainer |
Opposite | |
Owner | SpecimenContainer |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenContainer::containerHeight |
Stereotype | |
Template Parameter | |
Type | «PQ» Quantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenContainer |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | containerType |
Name Expression | |
Namespace | SpecimenContainer |
Opposite | |
Owner | SpecimenContainer |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenContainer::containerType |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String description
"Textual description of the container." - HL7 FHIR, Specimen.container.description
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenContainer |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | description |
Name Expression | |
Namespace | SpecimenContainer |
Opposite | |
Owner | SpecimenContainer |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenContainer::description |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenContainer |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | identifier |
Name Expression | |
Namespace | SpecimenContainer |
Opposite | |
Owner | SpecimenContainer |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenContainer::identifier |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenContainer |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | separatorType |
Name Expression | |
Namespace | SpecimenContainer |
Opposite | |
Owner | SpecimenContainer |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenContainer::separatorType |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenContainer |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | true |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | specimenQuantity |
Name Expression | |
Namespace | SpecimenContainer |
Opposite | |
Owner | SpecimenContainer |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenContainer::specimenQuantity |
Stereotype | |
Template Parameter | |
Type | «PQ» Quantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Lab UML Documentation |
Summary:AttributesProperties | Detail:Attributes |