| Lab UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
The actual gathering of portions or quantities of material for use in testing, examination, or study based upon the request (order).
Attributes | ||
«PQ» Quantity | collectionAmount |
"Specifies the volume or mass of the collected specimen." - HL7 Version 2.8, SPM-12."The volume of a specimen." - HL7 Version 2.8, OBR-9."The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample." - HL7 FHIR, Specimen.collection.quantity |
«CS» Code | collectionMethod |
"Describes the procedure or process by which the specimen was collected." - HL7 Version 2.8, SPM-7. Note that HL7 identifies a Code Table (Table 488) for this property, which currently contains 42 suggested values."A coded value specifying the technique that is used to perform the procedure." - HL7 FHIR, Specimen.collection.method |
«CS» Code | collectionSite |
"This field differs from [SpecimenCollectionEvent.sourceSite] in those cases where the source site must be approached via a particular site (e.g., anatomic location). For example, in the case where a liver biopsy is obtained via a percutaneous needle, the collection site would be the point of entry of the needle. For venous blood collected from the left radial vein, the collection site could be Antecubital Fossa." - HL7 Version 2.8, SPM-10. Note that HL7 identifies a Code Table (Table 543) for this property, but does not provide any suggested values. |
fastingStatusCode |
"Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection." - HL7 FHIR, Specimen.collection.fastingStatus[x] |
|
«PQ» TimeQuantity | fastingStatusDuration |
"Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection." - HL7 FHIR, Specimen.collection.fastingStatus[x] |
«CS» Code | sourceSite |
"Specifies the source from which the specimen was obtained. For example, in the case where a liver biopsy is obtained via a percutaneous needle, the source would be Liver. Any nationally recognized coding system might be used for this field including SNOMED; alternatively HL7 Table 0163 may be used." - HL7 Version 2.8, SPM-8."Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens." - HL7 FHIR, Specimen.collection.bodySite |
«CS» Code | sourceSiteModifier |
"Contains modifying or qualifying description(s) about the specimen source site. The use of this attribute is to modify, qualify or further specify, the entity described by [SpecimenCollectionEvent.sourceSite]. This is particularly useful when the code set used in [Specimen Source Site] does not provide the precision required to fully describe the site from which the specimen originated. For example, if the specimen source site was precisely described as Left Radial Vein but the code set employed only provided Radial Vein, this attribute could be employed to add the modifier Left." - HL7 Version 2.8, SPM-9. Note that HL7 identifies a Code Table (Table 542) for this property, but does not provide any suggested values. |
Specimen | specimen |
A collection of samples or specimens collected and potentially processed for eventual testing. |
Attributes inherited from FHIM::Common::ActionPerformed | ||
basedOn, bodySite, complication, complicationDetail, duration, enactsPlan, focalDevice, followUp, fulfillsOrder, fulfillsPromise, nonCompletionTimeframe, outcome, partOf, performancePeriod, performer, procedureModifier, report, researchStudy, status, statusReason, timesPerformed, topicCode, usedCode, usedReference, wasCompleted |
Attributes inherited from FHIM::Common::ActionStatement | ||
category, currentStatus, description, indication, inputFinding, instantiatesCanonical, instantiatesUri, insurance, intent, justification, location, method, outputFinding, precondition, reasonCode, reasonNarrative, reasonReference, relevantHistory, scope, supportingInformation, usingDevice, wasReported |
Attributes inherited from FHIM::Common::ClinicalStatement | ||
clinicalDataSource, contentVersion, contextCode, encounter, note, recordStatus, relatedClinicalInformation, sourceRecordType, sourceSystem, subjectGroup, subjectOfInformation, subjectOfRecord, temporalContext, topicCode, cosigned, recorded, signed, verified |
Attributes inherited from FHIM::Common::InformationEntry | ||
identifier |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | SpecimenCollectionEvent |
Name Expression | |
Namespace | Lab |
Owned Template Signature | |
Owner | Lab |
Owning Template Parameter | |
Package | Lab |
Qualified Name | FHIM::Lab::SpecimenCollectionEvent |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public «PQ» Quantity collectionAmount
"Specifies the volume or mass of the collected specimen." - HL7 Version 2.8, SPM-12."The volume of a specimen." - HL7 Version 2.8, OBR-9."The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample." - HL7 FHIR, Specimen.collection.quantity
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenCollectionEvent |
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 | collectionAmount |
Name Expression | |
Namespace | SpecimenCollectionEvent |
Opposite | |
Owner | SpecimenCollectionEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenCollectionEvent::collectionAmount |
Stereotype | |
Template Parameter | |
Type | «PQ» Quantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code collectionMethod
"Describes the procedure or process by which the specimen was collected." - HL7 Version 2.8, SPM-7. Note that HL7 identifies a Code Table (Table 488) for this property, which currently contains 42 suggested values."A coded value specifying the technique that is used to perform the procedure." - HL7 FHIR, Specimen.collection.method
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenCollectionEvent |
Terminologies | [ HL7_FHIR_R4 FHIR Specimen Collection Method http://hl7.org/fhir/ValueSet/specimen-collection-method , HL7_V2 Specimen Collection Method (HL7) 2.16.840.1.113883.1.11.488 ] |
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 | collectionMethod |
Name Expression | |
Namespace | SpecimenCollectionEvent |
Opposite | |
Owner | SpecimenCollectionEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenCollectionEvent::collectionMethod |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code collectionSite
"This field differs from [SpecimenCollectionEvent.sourceSite] in those cases where the source site must be approached via a particular site (e.g., anatomic location). For example, in the case where a liver biopsy is obtained via a percutaneous needle, the collection site would be the point of entry of the needle. For venous blood collected from the left radial vein, the collection site could be Antecubital Fossa." - HL7 Version 2.8, SPM-10. Note that HL7 identifies a Code Table (Table 543) for this property, but does not provide any suggested values.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenCollectionEvent |
Terminologies | [ HL7_FHIR_R4 SNOMED CT Body Structures http://hl7.org/fhir/ValueSet/body-site ] |
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 | collectionSite |
Name Expression | |
Namespace | SpecimenCollectionEvent |
Opposite | |
Owner | SpecimenCollectionEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenCollectionEvent::collectionSite |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public fastingStatusCode
"Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection." - HL7 FHIR, Specimen.collection.fastingStatus[x]
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenCollectionEvent |
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 | fastingStatusCode |
Name Expression | |
Namespace | SpecimenCollectionEvent |
Opposite | |
Owner | SpecimenCollectionEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenCollectionEvent::fastingStatusCode |
Stereotype | |
Template Parameter | |
Type | |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «PQ» TimeQuantity fastingStatusDuration
"Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection." - HL7 FHIR, Specimen.collection.fastingStatus[x]
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenCollectionEvent |
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 | fastingStatusDuration |
Name Expression | |
Namespace | SpecimenCollectionEvent |
Opposite | |
Owner | SpecimenCollectionEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenCollectionEvent::fastingStatusDuration |
Stereotype | |
Template Parameter | |
Type | «PQ» TimeQuantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code sourceSite
"Specifies the source from which the specimen was obtained. For example, in the case where a liver biopsy is obtained via a percutaneous needle, the source would be Liver. Any nationally recognized coding system might be used for this field including SNOMED; alternatively HL7 Table 0163 may be used." - HL7 Version 2.8, SPM-8."Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens." - HL7 FHIR, Specimen.collection.bodySite
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenCollectionEvent |
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 | sourceSite |
Name Expression | |
Namespace | SpecimenCollectionEvent |
Opposite | |
Owner | SpecimenCollectionEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenCollectionEvent::sourceSite |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code sourceSiteModifier
"Contains modifying or qualifying description(s) about the specimen source site. The use of this attribute is to modify, qualify or further specify, the entity described by [SpecimenCollectionEvent.sourceSite]. This is particularly useful when the code set used in [Specimen Source Site] does not provide the precision required to fully describe the site from which the specimen originated. For example, if the specimen source site was precisely described as Left Radial Vein but the code set employed only provided Radial Vein, this attribute could be employed to add the modifier Left." - HL7 Version 2.8, SPM-9. Note that HL7 identifies a Code Table (Table 542) for this property, but does not provide any suggested values.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | SpecimenCollectionEvent |
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 | sourceSiteModifier |
Name Expression | |
Namespace | SpecimenCollectionEvent |
Opposite | |
Owner | SpecimenCollectionEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenCollectionEvent::sourceSiteModifier |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public Specimen specimen
A collection of samples or specimens collected and potentially processed for eventual testing.
Aggregation | None |
Alias | |
Association | specimenCollectionEvent_specimen |
Association End | |
Class | SpecimenCollectionEvent |
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 | 1 |
Lower Value | (1) |
Multiplicity | 1..* |
Name | specimen |
Name Expression | |
Namespace | SpecimenCollectionEvent |
Opposite | specimenCollectionEvent |
Owner | SpecimenCollectionEvent |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Lab::SpecimenCollectionEvent::specimen |
Stereotype | |
Template Parameter | |
Type | Specimen |
Upper | * |
Upper Value | (*) |
Visibility | Public |
| Lab UML Documentation |
Summary:AttributesProperties | Detail:Attributes |