| Common UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
"A physical entity that is an individual, a group, an item, or a part representative of a larger group, class or whole that is the target of an observation or analysis for the purpose of drawing conclusions about the group, class, or whole. This can be used to code a component of the specimen that the observation diagnosis relates to. Note that any physical entity in the universe has the potential to become a specimen." - HL7 V3. This model attempts to distinguish between that which is collected from the patient (or other entity), and that portion of such material that may have been further divided or modified in some way before testing. For example, (whole) blood is taken from the patient, but the object of the test may be only the plasma or redblood cells taken (spun down) from the blood. The specimen that undergoes testing may be the unaltered specimen that was collected, or may have undergone some sort of processing.
Attributes | ||
«CS» Code | dangerCode |
"Contains any known or suspected specimen hazards, e.g., exceptionally infectious agent or blood from a hepatitis patient." - HL7 Version 2.8, SPM-16. Possible values include (from HL7 Table 489): Biological; Corrosive; Escape Risk; Aggressive; MaterialDangerInflammable; Explosive; MaterialDangerInfectious; Biohazard; Injury Hazard; Poison; Radioactive. |
«TS» PointInTime | dateTimeReceived |
The date and time when the Specimen was received by the laboratory for processing or testing. Note that this property could potentially be derived from the collection of Specimen Handling records."Time when specimen was received for processing or testing." - HL7 FHIR, Specimen.receivedTime |
DefinedPatientEvent | definedPatientEvent |
The specific patient-related event to which a specimen collection or collections (and subsequently, any tests performed on that specimen) are related or affected by time, sequence, directive, intent, etc. Examples might include drug administration (peak and trough), beginning of fasting (lipids, FBS), glucose challenge (tolerances) or meal (postprandial), admission (pre- or post-admission studies), scheduled surgery/transfusion (compatibility testing), onset of symptoms (acute and convalescent), Last Menstrual Period (pregnancy test, Pap smear), lumbar puncture (CSF tubes 1, 2, and 3), treatment completion (test of cure, post-transfusion H&H), use/ingestion (BAT, toxicology), start of 24-hour urine pooling (creatinine clearance), etc. |
«PQ» TimeQuantity | duration |
"The span of time over which the collection of a specimen occurred." - HL7 FHIR, Specimen.collection.duration |
«CS» Code | handlingCode |
"Describes how the specimen and/or container need to be handled from the time of collection through the initiation of testing." - HL7 Version 2.8, SPM-15. Possible values include (from HL7 Table 376): Body temperature; Ambient temperature; Critical ambient temperature; Refrigerated temperature; Critical refrigerated temperature; Frozen temperature; Critical frozen temperature; Deep frozen; Ultra frozen; Liquid nitrogen; Protect from light; Protect from air; Dry; No shock; Do not shake; Upright; Metal Free. |
«II» Id | identifier |
A designation that uniquely identifies the specimen."Unique identifier for the specimen as referenced by the Placer application, the Filler application, or both." - HL7 Version 2.8, SPM-2"Contains other identifier(s) for the specimen ... in addition to those identified in [SPM-2, Specimen ID]. In may cases other applications involved in the collection, transportation or testing of the specimen will assign additional specimen identifiers." - HL7 Version 2.8, SPM-31."Id for specimen." - HL7 FHIR, Specimen.identifier |
String | note |
"A text field that allows additional information specifically about the specimen" - HL7 Version 2.8, SPM-14."To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen)." - HL7 FHIR, Specimen.note |
Specimen | parent |
This optional, derived property points to another Specimen from which this Specimen was taken or derived. Note that this property is marked as derived because the FHIM handles this relationship through an explicit Specimen Processing Event class which details the event of aliquoting or isolate extraction and which points to the parent or source specimen as well as the resulting specimens. Thus this property is meant to be used for compatibility with FHIR or for ease of processing, but can be omitted in favor of using the Specimen Processing Event mechanism."Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen." - HL7 FHIR, Specimen.parent |
SpecimenCollectionEvent | specimenCollectionEvent |
Pointer to the event during which the Specimen was collected."Details concerning the specimen collection." - HL7 FHIR, Specimen.collection |
SpecimenContainer | specimenContainer |
Identifies the object in which the specimen is contained, such as the 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."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 |
«TS» PointInTime | specimenExpirationDateTime |
"The date and time the specimen can no longer be used for the purpose implied by the order...." - HL7 Version 2.8, SPM-19. |
«CS» Code | specimenOrigin |
Domain from which the specimen comes (e.g., human, animal, environmental). Added for Public Health Reporting Initiative 10/12/12. |
SpecimenProcessingEvent | specimenProcessingEvent |
Pointer to actions performed on a specimen in order to prepare it for future testing."Details concerning processing and processing steps for the specimen." - HL7 FHIR, Specimen.processing |
«CS» Code | specimenRole |
Provides an indication of how this sample relates to other aspects of the overall workflow and/or to other specimens gathered or processed during the workflow. This property is populated from HL7 V2 user-defined Table 0369, which contains a mish-mash of concepts including "group" and "pool" which relate to aliquotting, "calibarator", "verifying calibrator", "operator testing", etc. which relate to laboratory quality assurance, etc."Indicates the role of the sample." - HL7 Version 2.8, SPM-11. Possible values include (from HL7 Table 369):Blind Sample;Calibrator, used for initial setting of calibration;Electronic QC, used with manufactured reference providing signals that simulate QC results;Specimen used for testing proficiency of the organization performing the testing (Filler);Group (where a specimen consists of multiple individual elements that are not individually identified);Pool (aliquots of individual specimens combined to form a single specimen representing all of the components.);Specimen used for testing Operator Proficiency;Patient (default if blank component value);Control specimen;Replicate (of patient sample as a control);Verifying Calibrator, used for periodic calibration checks. |
«CS» Code | specimenType |
"Describes the precise nature of the entity that will be the source material for the observation. Any physical entity that may have observations made about it may qualify as a specimen. The entry in this attribute describes the specific entity as precisely as possible, whether that is a complex organism (e.g., an ostrich) or a specific cellular mass (e.g., a specific muscle biopsy)." - HL7 Version 2.8, SPM-4. Note that HL7 identifies a Code Table (Table 487) for this property, which currently contains 271 suggested values."The kind of material that forms the specimen." - HL7 FHIR, Specimen.type. Note that FHIR also uses table 487. |
«CS» Code | specimenTypeModifier |
"Contains modifying or qualifying description(s) about the specimen type. The use of this attribute is to modify, qualify or further specify, the entity described by [SpecimenType]. This is particularly useful when the code set used in [SpecimenType] does not provide the precision required to fully describe the specimen. For example, if the specimen was precisely described as capillary venous blood but the code set employed only provided venous blood, this attribute could be employed to add the modifier capillary." - HL7 Version 2.8, SPM-5. Note that HL7 identifies a Code Table (Table 541) for this property, but does not provide any suggested values. |
«CS» Code | status |
This optional property specifies whether the Specimen is available and in sufficient condition to proceed with the requested lab test, or not."The availability of the specimen." - HL7 FHIR, Specimen.status. |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | Specimen |
Name Expression | |
Namespace | Common |
Owned Template Signature | |
Owner | Common |
Owning Template Parameter | |
Package | Common |
Qualified Name | FHIM::Common::Specimen |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public «CS» Code dangerCode
"Contains any known or suspected specimen hazards, e.g., exceptionally infectious agent or blood from a hepatitis patient." - HL7 Version 2.8, SPM-16. Possible values include (from HL7 Table 489): Biological; Corrosive; Escape Risk; Aggressive; MaterialDangerInflammable; Explosive; MaterialDangerInfectious; Biohazard; Injury Hazard; Poison; Radioactive.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Specimen |
Terminologies | [ HL7_V2 Specimen Risk Code 2.16.840.1.113883.1.11.489 ] |
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 | dangerCode |
Name Expression | |
Namespace | Specimen |
Opposite | |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::dangerCode |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «TS» PointInTime dateTimeReceived
The date and time when the Specimen was received by the laboratory for processing or testing. Note that this property could potentially be derived from the collection of Specimen Handling records."Time when specimen was received for processing or testing." - HL7 FHIR, Specimen.receivedTime
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Specimen |
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 | dateTimeReceived |
Name Expression | |
Namespace | Specimen |
Opposite | |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::dateTimeReceived |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public DefinedPatientEvent definedPatientEvent
The specific patient-related event to which a specimen collection or collections (and subsequently, any tests performed on that specimen) are related or affected by time, sequence, directive, intent, etc. Examples might include drug administration (peak and trough), beginning of fasting (lipids, FBS), glucose challenge (tolerances) or meal (postprandial), admission (pre- or post-admission studies), scheduled surgery/transfusion (compatibility testing), onset of symptoms (acute and convalescent), Last Menstrual Period (pregnancy test, Pap smear), lumbar puncture (CSF tubes 1, 2, and 3), treatment completion (test of cure, post-transfusion H&H), use/ingestion (BAT, toxicology), start of 24-hour urine pooling (creatinine clearance), etc.
Aggregation | None |
Alias | |
Association | specimen_definedPatientEvent |
Association End | |
Class | Specimen |
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 | definedPatientEvent |
Name Expression | |
Namespace | Specimen |
Opposite | |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::definedPatientEvent |
Stereotype | |
Template Parameter | |
Type | DefinedPatientEvent |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «PQ» TimeQuantity duration
"The span of time over which the collection of a specimen occurred." - HL7 FHIR, Specimen.collection.duration
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Specimen |
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 | duration |
Name Expression | |
Namespace | Specimen |
Opposite | |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::duration |
Stereotype | |
Template Parameter | |
Type | «PQ» TimeQuantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code handlingCode
"Describes how the specimen and/or container need to be handled from the time of collection through the initiation of testing." - HL7 Version 2.8, SPM-15. Possible values include (from HL7 Table 376): Body temperature; Ambient temperature; Critical ambient temperature; Refrigerated temperature; Critical refrigerated temperature; Frozen temperature; Critical frozen temperature; Deep frozen; Ultra frozen; Liquid nitrogen; Protect from light; Protect from air; Dry; No shock; Do not shake; Upright; Metal Free.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Specimen |
Terminologies | [ HL7_V2 Special Handling Code 2.16.840.1.113883.1.11.376 ] |
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 | handlingCode |
Name Expression | |
Namespace | Specimen |
Opposite | |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::handlingCode |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «II» Id identifier
A designation that uniquely identifies the specimen."Unique identifier for the specimen as referenced by the Placer application, the Filler application, or both." - HL7 Version 2.8, SPM-2"Contains other identifier(s) for the specimen ... in addition to those identified in [SPM-2, Specimen ID]. In may cases other applications involved in the collection, transportation or testing of the specimen will assign additional specimen identifiers." - HL7 Version 2.8, SPM-31."Id for specimen." - HL7 FHIR, Specimen.identifier
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Specimen |
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 | identifier |
Name Expression | |
Namespace | Specimen |
Opposite | |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::identifier |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public String note
"A text field that allows additional information specifically about the specimen" - HL7 Version 2.8, SPM-14."To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen)." - HL7 FHIR, Specimen.note
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Specimen |
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 | note |
Name Expression | |
Namespace | Specimen |
Opposite | |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::note |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Specimen parent
This optional, derived property points to another Specimen from which this Specimen was taken or derived. Note that this property is marked as derived because the FHIM handles this relationship through an explicit Specimen Processing Event class which details the event of aliquoting or isolate extraction and which points to the parent or source specimen as well as the resulting specimens. Thus this property is meant to be used for compatibility with FHIR or for ease of processing, but can be omitted in favor of using the Specimen Processing Event mechanism."Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen." - HL7 FHIR, Specimen.parent
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Specimen |
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 | * |
Name | parent |
Name Expression | |
Namespace | Specimen |
Opposite | |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::parent |
Stereotype | |
Template Parameter | |
Type | Specimen |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public SpecimenCollectionEvent specimenCollectionEvent
Pointer to the event during which the Specimen was collected."Details concerning the specimen collection." - HL7 FHIR, Specimen.collection
Aggregation | None |
Alias | |
Association | specimenCollectionEvent_specimen |
Association End | |
Class | Specimen |
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 | false |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | specimenCollectionEvent |
Name Expression | |
Namespace | Specimen |
Opposite | specimen |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::specimenCollectionEvent |
Stereotype | |
Template Parameter | |
Type | SpecimenCollectionEvent |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public SpecimenContainer specimenContainer
Identifies the object in which the specimen is contained, such as the 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."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
Aggregation | None |
Alias | |
Association | specimen_container |
Association End | |
Class | Specimen |
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 | specimenContainer |
Name Expression | |
Namespace | Specimen |
Opposite | |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::specimenContainer |
Stereotype | |
Template Parameter | |
Type | SpecimenContainer |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «TS» PointInTime specimenExpirationDateTime
"The date and time the specimen can no longer be used for the purpose implied by the order...." - HL7 Version 2.8, SPM-19.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Specimen |
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 | specimenExpirationDateTime |
Name Expression | |
Namespace | Specimen |
Opposite | |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::specimenExpirationDateTime |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code specimenOrigin
Domain from which the specimen comes (e.g., human, animal, environmental). Added for Public Health Reporting Initiative 10/12/12.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Specimen |
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 | specimenOrigin |
Name Expression | |
Namespace | Specimen |
Opposite | |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::specimenOrigin |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public SpecimenProcessingEvent specimenProcessingEvent
Pointer to actions performed on a specimen in order to prepare it for future testing."Details concerning processing and processing steps for the specimen." - HL7 FHIR, Specimen.processing
Aggregation | None |
Alias | |
Association | specimen_specimenProcessingEvent |
Association End | |
Class | Specimen |
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 | specimenProcessingEvent |
Name Expression | |
Namespace | Specimen |
Opposite | |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::specimenProcessingEvent |
Stereotype | |
Template Parameter | |
Type | SpecimenProcessingEvent |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code specimenRole
Provides an indication of how this sample relates to other aspects of the overall workflow and/or to other specimens gathered or processed during the workflow. This property is populated from HL7 V2 user-defined Table 0369, which contains a mish-mash of concepts including "group" and "pool" which relate to aliquotting, "calibarator", "verifying calibrator", "operator testing", etc. which relate to laboratory quality assurance, etc."Indicates the role of the sample." - HL7 Version 2.8, SPM-11. Possible values include (from HL7 Table 369):Blind Sample;Calibrator, used for initial setting of calibration;Electronic QC, used with manufactured reference providing signals that simulate QC results;Specimen used for testing proficiency of the organization performing the testing (Filler);Group (where a specimen consists of multiple individual elements that are not individually identified);Pool (aliquots of individual specimens combined to form a single specimen representing all of the components.);Specimen used for testing Operator Proficiency;Patient (default if blank component value);Control specimen;Replicate (of patient sample as a control);Verifying Calibrator, used for periodic calibration checks.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Specimen |
Terminologies | [ HL7_V2 Specimen Role 2.16.840.1.113883.1.11.369 ] |
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 | specimenRole |
Name Expression | |
Namespace | Specimen |
Opposite | |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::specimenRole |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code specimenType
"Describes the precise nature of the entity that will be the source material for the observation. Any physical entity that may have observations made about it may qualify as a specimen. The entry in this attribute describes the specific entity as precisely as possible, whether that is a complex organism (e.g., an ostrich) or a specific cellular mass (e.g., a specific muscle biopsy)." - HL7 Version 2.8, SPM-4. Note that HL7 identifies a Code Table (Table 487) for this property, which currently contains 271 suggested values."The kind of material that forms the specimen." - HL7 FHIR, Specimen.type. Note that FHIR also uses table 487.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Specimen |
Terminologies | [ FHIM_Defined_Content Specimen Type 2.16.840.1.113883.3.2074.1.1.38 , HL7_FHIR_R4 Specimen Type http://terminology.hl7.org/ValueSet/v2-0487 , HL7_V2 Specimen Type 2.16.840.1.113883.1.11.487 ] |
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 | specimenType |
Name Expression | |
Namespace | Specimen |
Opposite | |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::specimenType |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code specimenTypeModifier
"Contains modifying or qualifying description(s) about the specimen type. The use of this attribute is to modify, qualify or further specify, the entity described by [SpecimenType]. This is particularly useful when the code set used in [SpecimenType] does not provide the precision required to fully describe the specimen. For example, if the specimen was precisely described as capillary venous blood but the code set employed only provided venous blood, this attribute could be employed to add the modifier capillary." - HL7 Version 2.8, SPM-5. Note that HL7 identifies a Code Table (Table 541) for this property, but does not provide any suggested values.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Specimen |
Terminologies | [ HL7_V2 Specimen Type Modifier 2.16.840.1.113883.1.11.541 ] |
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 | specimenTypeModifier |
Name Expression | |
Namespace | Specimen |
Opposite | |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::specimenTypeModifier |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code status
This optional property specifies whether the Specimen is available and in sufficient condition to proceed with the requested lab test, or not."The availability of the specimen." - HL7 FHIR, Specimen.status.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Specimen |
Terminologies | [ HL7_FHIR_R4 ObservationStatus http://hl7.org/fhir/ValueSet/observation-status ] |
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 | status |
Name Expression | |
Namespace | Specimen |
Opposite | |
Owner | Specimen |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::Specimen::status |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Common UML Documentation |
Summary:AttributesProperties | Detail:Attributes |