HL7 Europe Laboratory Report
0.1.0 - trial-use 150

This page is part of the HL7 Europe Laboratory Report (v0.1.0: STU 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: Specimen: Laboratory

Official URL: http://hl7.eu/fhir/laboratory/StructureDefinition/Specimen-eu-lab Version: 0.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: SpecimenEu

Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

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..*SpecimenLaboratory Specimen
... type 0..1CodeableConceptKind of material that forms the specimen
Binding: Specimen Types (preferred)
... subject 0..1Reference(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..*ExtensionExtension
Slice: Unordered, Open by value:url
.... bodySite 0..1Reference(BodyStructure)Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
..... value[x] 1..1Reference(Body structure: Laboratory)Value of extension
.... bodySite 0..1CodeableConceptAnatomical 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..*ExtensionExtension
Slice: Unordered, Open by value:url
.... device 0..1Reference(Device)Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device
.... type 0..1CodeableConceptKind of container directly associated with specimen
Binding: Specimen Container (preferred)
.... additive[x] 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Specimen.typepreferredLabSpecimenTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-specimenType-eu-lab
from this IG
Specimen.collection.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Specimen.container.typepreferredLabSpecimenContainerEu
http://hl7.eu/fhir/laboratory/ValueSet/lab-specimenContainer-eu-lab
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenLaboratory Specimen
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... subject Σ0..1Reference(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.typepreferredLabSpecimenTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-specimenType-eu-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..*SpecimenLaboratory Specimen
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Identifier
... accessionIdentifier Σ0..1IdentifierIdentifier assigned by the lab
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type Σ0..1CodeableConceptKind of material that forms the specimen
Binding: Specimen Types (preferred)
... subject Σ0..1Reference(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..1dateTimeThe 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..1BackboneElementCollection details
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... bodySite 0..1Reference(BodyStructure)Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/bodySite"
..... value[x] 1..1Reference(Body structure: Laboratory)Value of extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... collector Σ0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
.... collected[x] Σ0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... duration Σ0..1DurationHow long it took to collect specimen
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.

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

..... fastingStatusCodeableConceptCodeableConcept
..... fastingStatusDurationDuration
... processing 0..*BackboneElementProcessing and processing step details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 0..1stringTextual description of procedure
.... procedure 0..1CodeableConceptIndicates 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..1Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... device 0..1Reference(Device)Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierId for the container
.... description 0..1stringTextual description of the container
.... type 0..1CodeableConceptKind of container directly associated with specimen
Binding: Specimen Container (preferred)
.... capacity 0..1SimpleQuantityContainer volume or size
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
... condition Σ0..*CodeableConceptState of the specimen
Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.


... note 0..*AnnotationComments

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.typepreferredLabSpecimenTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-specimenType-eu-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.typepreferredLabSpecimenContainerEu
http://hl7.eu/fhir/laboratory/ValueSet/lab-specimenContainer-eu-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..*SpecimenLaboratory Specimen
... type 0..1CodeableConceptKind of material that forms the specimen
Binding: Specimen Types (preferred)
... subject 0..1Reference(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..*ExtensionExtension
Slice: Unordered, Open by value:url
.... bodySite 0..1Reference(BodyStructure)Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
..... value[x] 1..1Reference(Body structure: Laboratory)Value of extension
.... bodySite 0..1CodeableConceptAnatomical 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..*ExtensionExtension
Slice: Unordered, Open by value:url
.... device 0..1Reference(Device)Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device
.... type 0..1CodeableConceptKind of container directly associated with specimen
Binding: Specimen Container (preferred)
.... additive[x] 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Specimen.typepreferredLabSpecimenTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-specimenType-eu-lab
from this IG
Specimen.collection.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Specimen.container.typepreferredLabSpecimenContainerEu
http://hl7.eu/fhir/laboratory/ValueSet/lab-specimenContainer-eu-lab
from this IG

Key Elements View

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

... subject Σ0..1Reference(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.typepreferredLabSpecimenTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-specimenType-eu-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..*SpecimenLaboratory Specimen
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Identifier
... accessionIdentifier Σ0..1IdentifierIdentifier assigned by the lab
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type Σ0..1CodeableConceptKind of material that forms the specimen
Binding: Specimen Types (preferred)
... subject Σ0..1Reference(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..1dateTimeThe 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..1BackboneElementCollection details
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... bodySite 0..1Reference(BodyStructure)Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/bodySite"
..... value[x] 1..1Reference(Body structure: Laboratory)Value of extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... collector Σ0..1Reference(Practitioner | PractitionerRole)Who collected the specimen
.... collected[x] Σ0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... duration Σ0..1DurationHow long it took to collect specimen
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.

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

..... fastingStatusCodeableConceptCodeableConcept
..... fastingStatusDurationDuration
... processing 0..*BackboneElementProcessing and processing step details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 0..1stringTextual description of procedure
.... procedure 0..1CodeableConceptIndicates 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..1Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... device 0..1Reference(Device)Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierId for the container
.... description 0..1stringTextual description of the container
.... type 0..1CodeableConceptKind of container directly associated with specimen
Binding: Specimen Container (preferred)
.... capacity 0..1SimpleQuantityContainer volume or size
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
... condition Σ0..*CodeableConceptState of the specimen
Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.


... note 0..*AnnotationComments

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.typepreferredLabSpecimenTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-specimenType-eu-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.typepreferredLabSpecimenContainerEu
http://hl7.eu/fhir/laboratory/ValueSet/lab-specimenContainer-eu-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