HL7 Laboratory Report
1.0.0-ballot - STU 1 Ballot International flag

This page is part of the HL7 Laboratory Report (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: Specimen: Laboratory

Official URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/Specimen-uv-lab Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: SpecimenUvLab

This profile defines how to represent Specimens in HL7 FHIR for the purpose of this guide.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..* Specimen Laboratory Specimen
... type 0..1 CodeableConcept Kind of material that forms the specimen
Binding: Specimen Types (preferred)
... subject 0..1 Reference(Patient: Person | Patient: Animal | Group | Device | Substance | Location) Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... parent 0..* Reference(Specimen: Laboratory) Specimen from which this specimen originated
... collection
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... bodySite 0..1 (Complex) Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
...... value[x] 1..1 Reference(Body structure: Laboratory) Value of extension
.... bodySite 0..1 CodeableConcept Anatomical collection site
Binding: SNOMEDCTBodyStructures (preferred)
... processing
.... additive 0..* Reference(Substance | Substance: Specimen Additive Substance) Material used in the processing step
... container
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... device 0..1 Reference(Device) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device
.... type 0..1 CodeableConcept Kind of container directly associated with specimen
Binding: Specimen Container (preferred)
.... additive[x] 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Specimen.typepreferredLabSpecimenTypesVs
http://hl7.org/fhir/uv/lab-report/ValueSet/specimenType-uv-lab
from this IG
Specimen.collection.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Specimen.container.typepreferredLabSpecimenContainerVs
http://hl7.org/fhir/uv/lab-report/ValueSet/specimenContainer-uv-lab
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..* Specimen Laboratory Specimen
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... subject Σ 0..1 Reference(Patient: Person | Patient: Animal | Group | Device | Substance | Location) Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... parent 0..* Reference(Specimen: Laboratory) Specimen from which this specimen originated
... request 0..* Reference(ServiceRequest) Why the specimen was collected.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Specimen.statusrequiredSpecimenStatus
http://hl7.org/fhir/ValueSet/specimen-status|4.0.1
from the FHIR Standard
Specimen.typepreferredLabSpecimenTypesVs
http://hl7.org/fhir/uv/lab-report/ValueSet/specimenType-uv-lab
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorSpecimenIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorSpecimenIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..* Specimen Laboratory Specimen
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Identifier
... accessionIdentifier Σ 0..1 Identifier Identifier assigned by the lab
... status ?!Σ 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type Σ 0..1 CodeableConcept Kind of material that forms the specimen
Binding: Specimen Types (preferred)
... subject Σ 0..1 Reference(Patient: Person | Patient: Animal | Group | Device | Substance | Location) Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime Σ 0..1 dateTime The time when specimen was received for processing
... parent 0..* Reference(Specimen: Laboratory) Specimen from which this specimen originated
... request 0..* Reference(ServiceRequest) Why the specimen was collected.
... collection 0..1 BackboneElement Collection details
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... bodySite 0..1 (Complex) Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/bodySite"
...... value[x] 1..1 Reference(Body structure: Laboratory) Value of extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... collector Σ 0..1 Reference(Practitioner | PractitionerRole) Who collected the specimen
.... collected[x] Σ 0..1 Collection time
..... collectedDateTime dateTime
..... collectedPeriod Period
.... duration Σ 0..1 Duration How long it took to collect specimen
.... quantity 0..1 SimpleQuantity The quantity of specimen collected
.... method 0..1 CodeableConcept Technique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.

.... bodySite 0..1 CodeableConcept Anatomical collection site
Binding: SNOMEDCTBodyStructures (preferred)
.... fastingStatus[x] Σ 0..1 Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.

..... fastingStatusCodeableConcept CodeableConcept
..... fastingStatusDuration Duration
... processing 0..* BackboneElement Processing and processing step details
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 0..1 string Textual description of procedure
.... procedure 0..1 CodeableConcept Indicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen.

.... additive 0..* Reference(Substance | Substance: Specimen Additive Substance) Material used in the processing step
.... time[x] 0..1 Date and time of specimen processing
..... timeDateTime dateTime
..... timePeriod Period
... container 0..* BackboneElement Direct container of specimen (tube/slide, etc.)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... device 0..1 Reference(Device) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 0..* Identifier Id for the container
.... description 0..1 string Textual description of the container
.... type 0..1 CodeableConcept Kind of container directly associated with specimen
Binding: Specimen Container (preferred)
.... capacity 0..1 SimpleQuantity Container volume or size
.... specimenQuantity 0..1 SimpleQuantity Quantity of specimen within container
... condition Σ 0..* CodeableConcept State of the specimen
Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.


... note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Specimen.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Specimen.statusrequiredSpecimenStatus
http://hl7.org/fhir/ValueSet/specimen-status|4.0.1
from the FHIR Standard
Specimen.typepreferredLabSpecimenTypesVs
http://hl7.org/fhir/uv/lab-report/ValueSet/specimenType-uv-lab
from this IG
Specimen.collection.methodexampleFHIRSpecimenCollectionMethod
http://hl7.org/fhir/ValueSet/specimen-collection-method
from the FHIR Standard
Specimen.collection.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
http://terminology.hl7.org/ValueSet/v2-0916
Specimen.processing.procedureexampleSpecimenProcessingProcedure
http://hl7.org/fhir/ValueSet/specimen-processing-procedure
from the FHIR Standard
Specimen.container.typepreferredLabSpecimenContainerVs
http://hl7.org/fhir/uv/lab-report/ValueSet/specimenContainer-uv-lab
from this IG
Specimen.conditionextensibleHl7VSSpecimenCondition
http://terminology.hl7.org/ValueSet/v2-0493

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorSpecimenIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorSpecimenIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..* Specimen Laboratory Specimen
... type 0..1 CodeableConcept Kind of material that forms the specimen
Binding: Specimen Types (preferred)
... subject 0..1 Reference(Patient: Person | Patient: Animal | Group | Device | Substance | Location) Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... parent 0..* Reference(Specimen: Laboratory) Specimen from which this specimen originated
... collection
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... bodySite 0..1 (Complex) Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
...... value[x] 1..1 Reference(Body structure: Laboratory) Value of extension
.... bodySite 0..1 CodeableConcept Anatomical collection site
Binding: SNOMEDCTBodyStructures (preferred)
... processing
.... additive 0..* Reference(Substance | Substance: Specimen Additive Substance) Material used in the processing step
... container
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... device 0..1 Reference(Device) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device
.... type 0..1 CodeableConcept Kind of container directly associated with specimen
Binding: Specimen Container (preferred)
.... additive[x] 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Specimen.typepreferredLabSpecimenTypesVs
http://hl7.org/fhir/uv/lab-report/ValueSet/specimenType-uv-lab
from this IG
Specimen.collection.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Specimen.container.typepreferredLabSpecimenContainerVs
http://hl7.org/fhir/uv/lab-report/ValueSet/specimenContainer-uv-lab
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..* Specimen Laboratory Specimen
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... subject Σ 0..1 Reference(Patient: Person | Patient: Animal | Group | Device | Substance | Location) Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... parent 0..* Reference(Specimen: Laboratory) Specimen from which this specimen originated
... request 0..* Reference(ServiceRequest) Why the specimen was collected.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Specimen.statusrequiredSpecimenStatus
http://hl7.org/fhir/ValueSet/specimen-status|4.0.1
from the FHIR Standard
Specimen.typepreferredLabSpecimenTypesVs
http://hl7.org/fhir/uv/lab-report/ValueSet/specimenType-uv-lab
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorSpecimenIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorSpecimenIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..* Specimen Laboratory Specimen
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Identifier
... accessionIdentifier Σ 0..1 Identifier Identifier assigned by the lab
... status ?!Σ 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type Σ 0..1 CodeableConcept Kind of material that forms the specimen
Binding: Specimen Types (preferred)
... subject Σ 0..1 Reference(Patient: Person | Patient: Animal | Group | Device | Substance | Location) Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime Σ 0..1 dateTime The time when specimen was received for processing
... parent 0..* Reference(Specimen: Laboratory) Specimen from which this specimen originated
... request 0..* Reference(ServiceRequest) Why the specimen was collected.
... collection 0..1 BackboneElement Collection details
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... bodySite 0..1 (Complex) Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/bodySite"
...... value[x] 1..1 Reference(Body structure: Laboratory) Value of extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... collector Σ 0..1 Reference(Practitioner | PractitionerRole) Who collected the specimen
.... collected[x] Σ 0..1 Collection time
..... collectedDateTime dateTime
..... collectedPeriod Period
.... duration Σ 0..1 Duration How long it took to collect specimen
.... quantity 0..1 SimpleQuantity The quantity of specimen collected
.... method 0..1 CodeableConcept Technique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.

.... bodySite 0..1 CodeableConcept Anatomical collection site
Binding: SNOMEDCTBodyStructures (preferred)
.... fastingStatus[x] Σ 0..1 Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.

..... fastingStatusCodeableConcept CodeableConcept
..... fastingStatusDuration Duration
... processing 0..* BackboneElement Processing and processing step details
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 0..1 string Textual description of procedure
.... procedure 0..1 CodeableConcept Indicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen.

.... additive 0..* Reference(Substance | Substance: Specimen Additive Substance) Material used in the processing step
.... time[x] 0..1 Date and time of specimen processing
..... timeDateTime dateTime
..... timePeriod Period
... container 0..* BackboneElement Direct container of specimen (tube/slide, etc.)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... device 0..1 Reference(Device) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 0..* Identifier Id for the container
.... description 0..1 string Textual description of the container
.... type 0..1 CodeableConcept Kind of container directly associated with specimen
Binding: Specimen Container (preferred)
.... capacity 0..1 SimpleQuantity Container volume or size
.... specimenQuantity 0..1 SimpleQuantity Quantity of specimen within container
... condition Σ 0..* CodeableConcept State of the specimen
Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.


... note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Specimen.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Specimen.statusrequiredSpecimenStatus
http://hl7.org/fhir/ValueSet/specimen-status|4.0.1
from the FHIR Standard
Specimen.typepreferredLabSpecimenTypesVs
http://hl7.org/fhir/uv/lab-report/ValueSet/specimenType-uv-lab
from this IG
Specimen.collection.methodexampleFHIRSpecimenCollectionMethod
http://hl7.org/fhir/ValueSet/specimen-collection-method
from the FHIR Standard
Specimen.collection.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
http://terminology.hl7.org/ValueSet/v2-0916
Specimen.processing.procedureexampleSpecimenProcessingProcedure
http://hl7.org/fhir/ValueSet/specimen-processing-procedure
from the FHIR Standard
Specimen.container.typepreferredLabSpecimenContainerVs
http://hl7.org/fhir/uv/lab-report/ValueSet/specimenContainer-uv-lab
from this IG
Specimen.conditionextensibleHl7VSSpecimenCondition
http://terminology.hl7.org/ValueSet/v2-0493

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorSpecimenIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorSpecimenIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron