Lab
Class SpecimenAssessment
This class contains observations regarding the Specimen. Such observations, or assessments, of the Specimen are performed by the laboratory upon initial receipt, although periodic assessments may be performed later, especially when the Specimen is in long-term storage, or when some change in custody has occurred. The assessment also contains information concerning the handling of the Specimen, such as storage or transportation information.
| Attributes |
| String |  appropriateness |
This field is deprecated in favor of using Reject Reason (SPM-21) and Specimen Condition (SPM-24). This field is retained for backward compatibility for legacy HL7 V2 messaging."The suitability of the specimen for the particular planned use as determined by the filler." - HL7 Version 2.8, SPM-23. Possible values include (from HL7 Table 492): Preferred; Appropriate; Inappropriate; Inappropriate due to....
|
| «CS» Code | containerCondition |
"In chain of custody cases where specimens are moved from lab to lab, the status of the container that the specimen is shipped in must be recorded at each receipt. If the container is compromised in any way (seal broken, container cracked or leaking, etc) then this needs to be recorded for legal reasons." - HL7 Version 2.8, SPM-28. Note that HL7 identifies a Code Table (Table 544) for this property, which currently contains 21 suggested values.
|
| «PQ» Quantity | currentQuantity |
"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
|
| «TS» PointInTime | dateTime |
The date/time that the Specimen Assessment was performed
|
| Boolean | isSpecimenAvailable |
"Describes whether the specimen, as it exists, is currently available to use in an analysis." - HL7 Version 2.8, SPM-20.
|
| Integer | numberOfContainers |
"The number of containers for a given sample. For sample receipt verification purposes; may be different from the total number of samples that accompany the order." - HL7 Version 2.8, OBR-37 and SPM-26.
|
| «CS» Code | rejectReason |
"Describes one or more reasons the specimen is rejected for the specified observation/result/analysis." - HL7 Version 2.8, SPM-21. Possible values include (from HL7 Table 490): Expired; Quantity not sufficient; Broken container; Clotting; Missing collection date; Missing patient ID number; Missing patient name; Hemolysis; Identification problem; Labeling; Contamination; Missing phlebotomist ID; Improper storage; Name misspelling.
|
| Specimen | specimen |
Identifies the specimen associated with the assessment, and therefore to which the assessment data pertains.
|
| «CS» Code | specimenCondition |
"A mode or state of being that describes the nature of the specimen." - HL7 Version 2.8, SPM-24. Possible values include (from HL7 Table 493): Autolyzed; Clotted; Contaminated; Cool; Frozen; Hemolyzed; Live; Room temperature; Sample not received."A mode or state of being that describes the nature of the specimen." - HL7 FHIR, Specimen.condition
|
| SpecimenHandling | specimenHandling |
Points to information regarding the transportation or storage of a specimen.
|
| «CS» Code | specimenQuality |
"The degree or grade of excellence of the specimen at receipt." - HL7 Version 2.8, SPM-22. Possible values include (from HL7 Table 491): Excellent; Good; Fair; Poor.
|
| «PQ» Quantity | temperature |
"Identifies the specimen temperature in degrees Celsius" - HL7 Version 2.8, SAC-31.
|
Properties:
| Alias | |
| Classifier Behavior | |
| Is Abstract | false |
| Is Active | false |
| Is Leaf | false |
| Keywords | |
| Name | SpecimenAssessment |
| Name Expression | |
| Namespace | Lab |
| Owned Template Signature | |
| Owner | Lab |
| Owning Template Parameter | |
| Package | Lab |
| Qualified Name | FHIM::Lab::SpecimenAssessment |
| Representation | |
| Stereotype | |
| Template Parameter | |
| Visibility | Public |
appropriateness
Public String appropriateness
-
This field is deprecated in favor of using Reject Reason (SPM-21) and Specimen Condition (SPM-24). This field is retained for backward compatibility for legacy HL7 V2 messaging."The suitability of the specimen for the particular planned use as determined by the filler." - HL7 Version 2.8, SPM-23. Possible values include (from HL7 Table 492): Preferred; Appropriate; Inappropriate; Inappropriate due to....
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | SpecimenAssessment |
| 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 | appropriateness |
| Name Expression | |
| Namespace | SpecimenAssessment |
| Opposite | |
| Owner | SpecimenAssessment |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::SpecimenAssessment::appropriateness |
| Stereotype | |
| Template Parameter | |
| Type | String |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
containerCondition
Public «CS» Code containerCondition
-
"In chain of custody cases where specimens are moved from lab to lab, the status of the container that the specimen is shipped in must be recorded at each receipt. If the container is compromised in any way (seal broken, container cracked or leaking, etc) then this needs to be recorded for legal reasons." - HL7 Version 2.8, SPM-28. Note that HL7 identifies a Code Table (Table 544) for this property, which currently contains 21 suggested values.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | SpecimenAssessment |
| 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 | containerCondition |
| Name Expression | |
| Namespace | SpecimenAssessment |
| Opposite | |
| Owner | SpecimenAssessment |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::SpecimenAssessment::containerCondition |
| Stereotype | |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
currentQuantity
Public «PQ» Quantity currentQuantity
-
"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:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | SpecimenAssessment |
| 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 | currentQuantity |
| Name Expression | |
| Namespace | SpecimenAssessment |
| Opposite | |
| Owner | SpecimenAssessment |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::SpecimenAssessment::currentQuantity |
| Stereotype | |
| Template Parameter | |
| Type | «PQ» Quantity |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
dateTime
Public «TS» PointInTime dateTime
-
The date/time that the Specimen Assessment was performed
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | SpecimenAssessment |
| 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 | dateTime |
| Name Expression | |
| Namespace | SpecimenAssessment |
| Opposite | |
| Owner | SpecimenAssessment |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::SpecimenAssessment::dateTime |
| Stereotype | |
| Template Parameter | |
| Type | «TS» PointInTime |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
isSpecimenAvailable
Public Boolean isSpecimenAvailable
-
"Describes whether the specimen, as it exists, is currently available to use in an analysis." - HL7 Version 2.8, SPM-20.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | SpecimenAssessment |
| 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 | isSpecimenAvailable |
| Name Expression | |
| Namespace | SpecimenAssessment |
| Opposite | |
| Owner | SpecimenAssessment |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::SpecimenAssessment::isSpecimenAvailable |
| Stereotype | |
| Template Parameter | |
| Type | Boolean |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
numberOfContainers
Public Integer numberOfContainers
-
"The number of containers for a given sample. For sample receipt verification purposes; may be different from the total number of samples that accompany the order." - HL7 Version 2.8, OBR-37 and SPM-26.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | SpecimenAssessment |
| 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 | numberOfContainers |
| Name Expression | |
| Namespace | SpecimenAssessment |
| Opposite | |
| Owner | SpecimenAssessment |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::SpecimenAssessment::numberOfContainers |
| Stereotype | |
| Template Parameter | |
| Type | Integer |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
rejectReason
Public «CS» Code rejectReason
-
"Describes one or more reasons the specimen is rejected for the specified observation/result/analysis." - HL7 Version 2.8, SPM-21. Possible values include (from HL7 Table 490): Expired; Quantity not sufficient; Broken container; Clotting; Missing collection date; Missing patient ID number; Missing patient name; Hemolysis; Identification problem; Labeling; Contamination; Missing phlebotomist ID; Improper storage; Name misspelling.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | SpecimenAssessment |
| Terminologies | [
HL7_V2 Specimen Reject Reason (HL7) 2.16.840.1.113883.1.11.490
] |
| 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 | rejectReason |
| Name Expression | |
| Namespace | SpecimenAssessment |
| Opposite | |
| Owner | SpecimenAssessment |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::SpecimenAssessment::rejectReason |
| Stereotype | ValueSetConstraints |
| Template Parameter | |
| Type | «CS» Code |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
specimen
Public Specimen specimen
-
Identifies the specimen associated with the assessment, and therefore to which the assessment data pertains.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | specimenAssessment_Specimen |
| Association End | |
| Class | SpecimenAssessment |
| 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 | specimen |
| Name Expression | |
| Namespace | SpecimenAssessment |
| Opposite | |
| Owner | SpecimenAssessment |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::SpecimenAssessment::specimen |
| Stereotype | |
| Template Parameter | |
| Type | Specimen |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
specimenCondition
Public «CS» Code specimenCondition
-
"A mode or state of being that describes the nature of the specimen." - HL7 Version 2.8, SPM-24. Possible values include (from HL7 Table 493): Autolyzed; Clotted; Contaminated; Cool; Frozen; Hemolyzed; Live; Room temperature; Sample not received."A mode or state of being that describes the nature of the specimen." - HL7 FHIR, Specimen.condition
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | SpecimenAssessment |
| Terminologies | [
HL7_FHIR_R4 v2 Specimen Condition http://terminology.hl7.org/ValueSet/v2-0493
,
HL7_V2 Specimen Condition 2.16.840.1.113883.1.11.493
] |
| 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 | specimenCondition |
| Name Expression | |
| Namespace | SpecimenAssessment |
| Opposite | |
| Owner | SpecimenAssessment |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::SpecimenAssessment::specimenCondition |
| Stereotype | ValueSetConstraints |
| Template Parameter | |
| Type | «CS» Code |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
specimenHandling
Public SpecimenHandling specimenHandling
-
Points to information regarding the transportation or storage of a specimen.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | specimenAssessment_specimenHandling |
| Association End | |
| Class | SpecimenAssessment |
| 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 | specimenHandling |
| Name Expression | |
| Namespace | SpecimenAssessment |
| Opposite | |
| Owner | SpecimenAssessment |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::SpecimenAssessment::specimenHandling |
| Stereotype | |
| Template Parameter | |
| Type | SpecimenHandling |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
specimenQuality
Public «CS» Code specimenQuality
-
"The degree or grade of excellence of the specimen at receipt." - HL7 Version 2.8, SPM-22. Possible values include (from HL7 Table 491): Excellent; Good; Fair; Poor.
-
Constraints:
-
Properties:
-
| Aggregation | Composite |
| Alias | |
| Association | |
| Association End | |
| Class | SpecimenAssessment |
| Terminologies | [
HL7_V2 Specimen Quality (HL7) 2.16.840.1.113883.1.11.491
] |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | true |
| 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 | specimenQuality |
| Name Expression | |
| Namespace | SpecimenAssessment |
| Opposite | |
| Owner | SpecimenAssessment |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::SpecimenAssessment::specimenQuality |
| Stereotype | ValueSetConstraints |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
temperature
Public «PQ» Quantity temperature
-
"Identifies the specimen temperature in degrees Celsius" - HL7 Version 2.8, SAC-31.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | SpecimenAssessment |
| 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 | temperature |
| Name Expression | |
| Namespace | SpecimenAssessment |
| Opposite | |
| Owner | SpecimenAssessment |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Lab::SpecimenAssessment::temperature |
| Stereotype | |
| Template Parameter | |
| Type | «PQ» Quantity |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |