CH LAB-Order (R4)
3.0.0-ci-build - ci-build Switzerland flag

CH LAB-Order (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-lab-order/ and changes regularly. See the Directory of published versions

Resource Profile: CH LAB Specimen Definition (R4)

Official URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-specimendefinition-r4 Version: 3.0.0-ci-build
Active as of 2025-10-19 Computable Name: ChLab_SpecimenDefinitionR4

Copyright/Legal: CC0-1.0

R4-compatible specimen definition aligned with R5 and HL7 Order Catalog model.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SpecimenDefinition 0..* SpecimenDefinition Kind of specimen
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:status 1..1 code Publication status of the SpecimenDefinition
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-specimen-status
Binding: PublicationStatus (required)
.... extension:testingDestination 0..1 CodeableConcept Testing destination for the SpecimenDefinition
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-specimen-definition-testing-destination
Binding: CH LAB Testing Destination (preferred)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SpecimenDefinition.typeCollected Base extensible CH LAB-Order Specimen Type (SNOMED CT) 📦3.0.0-ci-build This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error SpecimenDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error SpecimenDefinition If 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-4 error SpecimenDefinition If 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-5 error SpecimenDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice SpecimenDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from SpecimenDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SpecimenDefinition 0..* SpecimenDefinition Kind of specimen
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:status 1..1 code Publication status of the SpecimenDefinition
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-specimen-status
Binding: PublicationStatus (required)
.... extension:testingDestination 0..1 CodeableConcept Testing destination for the SpecimenDefinition
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-specimen-definition-testing-destination
Binding: CH LAB Testing Destination (preferred)
... typeCollected 0..1 CodeableConcept The type of specimen to be collected
Binding: CH LAB-Order Specimen Type (SNOMED CT) (extensible)
... typeTested
.... type 1..1 CodeableConcept Type of intended specimen
Binding: CH LAB-Order Specimen Type (SNOMED CT) (extensible)
.... container
..... description 0..1 string Container description (plain text)
.... requirement 0..1 string Requirements or additional information about the specimen

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
SpecimenDefinition.typeCollected Base extensible CH LAB-Order Specimen Type (SNOMED CT) 📦3.0.0-ci-build This IG
SpecimenDefinition.typeTested.​type Base extensible CH LAB-Order Specimen Type (SNOMED CT) 📦3.0.0-ci-build This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SpecimenDefinition 0..* SpecimenDefinition Kind of 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:status 1..1 code Publication status of the SpecimenDefinition
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-specimen-status
Binding: PublicationStatus (required)
.... extension:testingDestination 0..1 CodeableConcept Testing destination for the SpecimenDefinition
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-specimen-definition-testing-destination
Binding: CH LAB Testing Destination (preferred)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Business identifier of a kind of specimen
... typeCollected Σ 0..1 CodeableConcept The type of specimen to be collected
Binding: CH LAB-Order Specimen Type (SNOMED CT) (extensible)
... patientPreparation Σ 0..* CodeableConcept Patient preparation for collection
Binding: PreparePatient (example): Checks on the patient prior specimen collection.
... timeAspect Σ 0..1 string Time aspect for collection
Example General: 24 hour, 20' post charge
... collection Σ 0..* CodeableConcept Specimen collection procedure
Binding: SpecimenCollection (example): The action to collect a type of specimen.
... typeTested 0..* BackboneElement Specimen in container intended for testing by lab
.... 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
.... isDerived 0..1 boolean Primary or secondary specimen
Example General: false
.... type 1..1 CodeableConcept Type of intended specimen
Binding: CH LAB-Order Specimen Type (SNOMED CT) (extensible)
.... preference 1..1 code preferred | alternate
Binding: SpecimenContainedPreference (required): Degree of preference of a type of conditioned specimen.
Example General: preferred, alternate
.... container 0..1 BackboneElement The specimen's container
..... 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
..... material 0..1 CodeableConcept Container material
Binding: ContainerMaterials (example): Types of material for specimen containers.
..... type 0..1 CodeableConcept Kind of container associated with the kind of specimen
Binding: SpecimenContainerType (example): Type of specimen container.
..... cap 0..1 CodeableConcept Color of container cap
Binding: ContainerCap (example): Color of the container cap.
..... description 0..1 string Container description (plain text)
Example General: Blue top tube with citrate
..... capacity 0..1 SimpleQuantity(4.0.1) Container capacity
..... minimumVolume[x] 0..1 Minimum volume
...... minimumVolumeQuantity Quantity(SimpleQuantity)
...... minimumVolumeString string
..... additive 0..* BackboneElement Additive associated with container
...... 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
...... additive[x] 1..1 Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.
....... additiveCodeableConcept CodeableConcept
....... additiveReference Reference(Substance)
..... preparation 0..1 string Specimen container preparation
.... requirement 0..1 string Requirements or additional information about the specimen
.... retentionTime 0..1 Duration Specimen retention time
.... rejectionCriterion 0..* CodeableConcept Rejection criterion
Binding: RejectionCriterion (example): Criterion for rejection of the specimen by laboratory.
.... handling 0..* BackboneElement Specimen handling before testing
..... 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
..... temperatureQualifier 0..1 CodeableConcept Temperature qualifier
Binding: HandlingConditionSet (example): Set of handling instructions prior testing of the specimen.
..... temperatureRange 0..1 Range Temperature range
..... maxDuration 0..1 Duration Maximum preservation time
..... instruction 0..1 string Preservation instruction
Example General: freeze within 4 hours

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SpecimenDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
SpecimenDefinition.typeCollected Base extensible CH LAB-Order Specimen Type (SNOMED CT) 📦3.0.0-ci-build This IG
SpecimenDefinition.patientPreparation Base example Patient preparation prior specimen collection 📍4.0.1 FHIR Std.
SpecimenDefinition.collection Base example Specimen collection methods 📍4.0.1 FHIR Std.
SpecimenDefinition.typeTested.​type Base extensible CH LAB-Order Specimen Type (SNOMED CT) 📦3.0.0-ci-build This IG
SpecimenDefinition.typeTested.​preference Base required SpecimenContainedPreference 📍4.0.1 FHIR Std.
SpecimenDefinition.typeTested.​container.material Base example Types of material for specimen containers 📍4.0.1 FHIR Std.
SpecimenDefinition.typeTested.​container.type Base example Specimen Container Type 📍4.0.1 FHIR Std.
SpecimenDefinition.typeTested.​container.cap Base example ContainerCap 📍4.0.1 FHIR Std.
SpecimenDefinition.typeTested.​container.additive.additive[x] Base example hl7VS-additivePreservative 📦2.0.0 THO v6.5
SpecimenDefinition.typeTested.​rejectionCriterion Base example RejectionCriterion 📍4.0.1 FHIR Std.
SpecimenDefinition.typeTested.​handling.temperatureQualifier Base example HandlingConditionSet 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error SpecimenDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error SpecimenDefinition If 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-4 error SpecimenDefinition If 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-5 error SpecimenDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice SpecimenDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from SpecimenDefinition

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SpecimenDefinition 0..* SpecimenDefinition Kind of specimen
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:status 1..1 code Publication status of the SpecimenDefinition
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-specimen-status
Binding: PublicationStatus (required)
.... extension:testingDestination 0..1 CodeableConcept Testing destination for the SpecimenDefinition
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-specimen-definition-testing-destination
Binding: CH LAB Testing Destination (preferred)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SpecimenDefinition.typeCollected Base extensible CH LAB-Order Specimen Type (SNOMED CT) 📦3.0.0-ci-build This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error SpecimenDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error SpecimenDefinition If 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-4 error SpecimenDefinition If 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-5 error SpecimenDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice SpecimenDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from SpecimenDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SpecimenDefinition 0..* SpecimenDefinition Kind of specimen
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:status 1..1 code Publication status of the SpecimenDefinition
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-specimen-status
Binding: PublicationStatus (required)
.... extension:testingDestination 0..1 CodeableConcept Testing destination for the SpecimenDefinition
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-specimen-definition-testing-destination
Binding: CH LAB Testing Destination (preferred)
... typeCollected 0..1 CodeableConcept The type of specimen to be collected
Binding: CH LAB-Order Specimen Type (SNOMED CT) (extensible)
... typeTested
.... type 1..1 CodeableConcept Type of intended specimen
Binding: CH LAB-Order Specimen Type (SNOMED CT) (extensible)
.... container
..... description 0..1 string Container description (plain text)
.... requirement 0..1 string Requirements or additional information about the specimen

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
SpecimenDefinition.typeCollected Base extensible CH LAB-Order Specimen Type (SNOMED CT) 📦3.0.0-ci-build This IG
SpecimenDefinition.typeTested.​type Base extensible CH LAB-Order Specimen Type (SNOMED CT) 📦3.0.0-ci-build This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SpecimenDefinition 0..* SpecimenDefinition Kind of 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:status 1..1 code Publication status of the SpecimenDefinition
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-specimen-status
Binding: PublicationStatus (required)
.... extension:testingDestination 0..1 CodeableConcept Testing destination for the SpecimenDefinition
URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-specimen-definition-testing-destination
Binding: CH LAB Testing Destination (preferred)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Business identifier of a kind of specimen
... typeCollected Σ 0..1 CodeableConcept The type of specimen to be collected
Binding: CH LAB-Order Specimen Type (SNOMED CT) (extensible)
... patientPreparation Σ 0..* CodeableConcept Patient preparation for collection
Binding: PreparePatient (example): Checks on the patient prior specimen collection.
... timeAspect Σ 0..1 string Time aspect for collection
Example General: 24 hour, 20' post charge
... collection Σ 0..* CodeableConcept Specimen collection procedure
Binding: SpecimenCollection (example): The action to collect a type of specimen.
... typeTested 0..* BackboneElement Specimen in container intended for testing by lab
.... 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
.... isDerived 0..1 boolean Primary or secondary specimen
Example General: false
.... type 1..1 CodeableConcept Type of intended specimen
Binding: CH LAB-Order Specimen Type (SNOMED CT) (extensible)
.... preference 1..1 code preferred | alternate
Binding: SpecimenContainedPreference (required): Degree of preference of a type of conditioned specimen.
Example General: preferred, alternate
.... container 0..1 BackboneElement The specimen's container
..... 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
..... material 0..1 CodeableConcept Container material
Binding: ContainerMaterials (example): Types of material for specimen containers.
..... type 0..1 CodeableConcept Kind of container associated with the kind of specimen
Binding: SpecimenContainerType (example): Type of specimen container.
..... cap 0..1 CodeableConcept Color of container cap
Binding: ContainerCap (example): Color of the container cap.
..... description 0..1 string Container description (plain text)
Example General: Blue top tube with citrate
..... capacity 0..1 SimpleQuantity(4.0.1) Container capacity
..... minimumVolume[x] 0..1 Minimum volume
...... minimumVolumeQuantity Quantity(SimpleQuantity)
...... minimumVolumeString string
..... additive 0..* BackboneElement Additive associated with container
...... 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
...... additive[x] 1..1 Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.
....... additiveCodeableConcept CodeableConcept
....... additiveReference Reference(Substance)
..... preparation 0..1 string Specimen container preparation
.... requirement 0..1 string Requirements or additional information about the specimen
.... retentionTime 0..1 Duration Specimen retention time
.... rejectionCriterion 0..* CodeableConcept Rejection criterion
Binding: RejectionCriterion (example): Criterion for rejection of the specimen by laboratory.
.... handling 0..* BackboneElement Specimen handling before testing
..... 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
..... temperatureQualifier 0..1 CodeableConcept Temperature qualifier
Binding: HandlingConditionSet (example): Set of handling instructions prior testing of the specimen.
..... temperatureRange 0..1 Range Temperature range
..... maxDuration 0..1 Duration Maximum preservation time
..... instruction 0..1 string Preservation instruction
Example General: freeze within 4 hours

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SpecimenDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
SpecimenDefinition.typeCollected Base extensible CH LAB-Order Specimen Type (SNOMED CT) 📦3.0.0-ci-build This IG
SpecimenDefinition.patientPreparation Base example Patient preparation prior specimen collection 📍4.0.1 FHIR Std.
SpecimenDefinition.collection Base example Specimen collection methods 📍4.0.1 FHIR Std.
SpecimenDefinition.typeTested.​type Base extensible CH LAB-Order Specimen Type (SNOMED CT) 📦3.0.0-ci-build This IG
SpecimenDefinition.typeTested.​preference Base required SpecimenContainedPreference 📍4.0.1 FHIR Std.
SpecimenDefinition.typeTested.​container.material Base example Types of material for specimen containers 📍4.0.1 FHIR Std.
SpecimenDefinition.typeTested.​container.type Base example Specimen Container Type 📍4.0.1 FHIR Std.
SpecimenDefinition.typeTested.​container.cap Base example ContainerCap 📍4.0.1 FHIR Std.
SpecimenDefinition.typeTested.​container.additive.additive[x] Base example hl7VS-additivePreservative 📦2.0.0 THO v6.5
SpecimenDefinition.typeTested.​rejectionCriterion Base example RejectionCriterion 📍4.0.1 FHIR Std.
SpecimenDefinition.typeTested.​handling.temperatureQualifier Base example HandlingConditionSet 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error SpecimenDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error SpecimenDefinition If 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-4 error SpecimenDefinition If 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-5 error SpecimenDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice SpecimenDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from SpecimenDefinition

 

Other representations of profile: CSV, Excel, Schematron