CH ELM (R4), published by Federal Office of Public Health FOPH. This guide is not an authorized publication; it is the continuous build for version 1.16.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ahdis/ch-elm/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-specimen | Version: 1.16.0 | ||||
| Active as of 2026-10-22 | Computable Name: ChElmSpecimen | ||||
Copyright/Legal: CC0-1.0 |
|||||
This CH ELM base profile constrains the Specimen resource for the purpose of laboratory test reports.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | ChLabSpecimen | CH Lab Specimen: Laboratory This profile also imposes the profile Specimen: Laboratory | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |
![]() ![]() |
0..1 | CodeableConcept | The mechanism to declare the collection material is described under 'Guidance - Laboratory Result' Binding: Specimen Types (preferred) | |
![]() ![]() ![]() |
0..1 | ChElmCoding | Code defined by a terminology system Binding: CH ELM Results Complete Spec (required) | |
![]() ![]() |
1..1 | Reference(CH ELM Patient) | 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 | |
![]() ![]() |
0..1 | BackboneElement | Collection details | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/bodySite" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Body structure: Laboratory) | Value of extension | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
0..1 | Collection time Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Collection time Constraints: ch-elm-dateTime |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | preferred | Specimen Types | 📦0.1.1 | HL7 Europe Laboratory Report v0.1 |
| Specimen.type.coding | Base | required | CH ELM Results Complete Spec | 📦1.16.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ch-elm-dateTime | error | Specimen.collection.collected[x]:collectedDateTime | At least the format YYYY-MM-DD is required. |
$this.toString().length() >= 10
|
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | 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 | Specimen | 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 | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Specimen | 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 ChLabSpecimen
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | ChLabSpecimen | CH Lab Specimen: Laboratory This profile also imposes the profile Specimen: Laboratory | |
![]() ![]() |
0..1 | CodeableConcept | The mechanism to declare the collection material is described under 'Guidance - Laboratory Result' | |
![]() ![]() ![]() |
0..1 | ChElmCoding | Code defined by a terminology system Binding: CH ELM Results Complete Spec (required) | |
![]() ![]() |
1..1 | Reference(CH ELM Patient) | 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 | |
![]() ![]() |
0..1 | BackboneElement | Collection details | |
![]() ![]() ![]() |
0..1 | dateTime, Period | Collection time Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |
![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Collection time Constraints: ch-elm-dateTime |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.type.coding | Base | required | CH ELM Results Complete Spec | 📦1.16.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ch-elm-dateTime | error | Specimen.collection.collected[x]:collectedDateTime | At least the format YYYY-MM-DD is required. |
$this.toString().length() >= 10
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ChLabSpecimen | CH Lab Specimen: Laboratory This profile also imposes the profile Specimen: Laboratory | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | External Identifier | |||||
![]() ![]() |
0..1 | Identifier | Identifier assigned by the lab | |||||
![]() ![]() |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |||||
![]() ![]() |
0..1 | CodeableConcept | The mechanism to declare the collection material is described under 'Guidance - Laboratory Result' Binding: Specimen Types (preferred) | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | ChElmCoding | Code defined by a terminology system Binding: CH ELM Results Complete Spec (required) | |||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
1..1 | Reference(CH ELM Patient) | 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 | |||||
![]() ![]() |
0..1 | dateTime | The time when specimen was received for processing | |||||
![]() ![]() |
0..* | Reference(CH LAB-Report Specimen) | Specimen from which this specimen originated | |||||
![]() ![]() |
0..* | Reference(ServiceRequest) | Why the specimen was collected. | |||||
![]() ![]() |
0..1 | BackboneElement | Collection details | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/bodySite" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Body structure: Laboratory) | Value of extension | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | |||||
![]() ![]() ![]() |
0..1 | Collection time Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Collection time Constraints: ch-elm-dateTime | ||||
![]() ![]() ![]() |
0..1 | Duration | How long it took to collect specimen | |||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.0.1) | The quantity of specimen collected Constraints: sqty-1 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (preferred) | |||||
![]() ![]() ![]() |
0..1 | Whether or how long patient abstained from food and/or drink Binding: Hl7VSRelevantClincialInformation (3.0.0) (extensible): Codes describing the fasting status of the patient. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() |
0..* | BackboneElement | Processing and processing step details | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | string | Textual description of procedure | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||
![]() ![]() ![]() |
0..* | Reference(Substance | CH LAB-Report Additive Substance) | Material used in the processing step | |||||
![]() ![]() ![]() |
0..1 | Date and time of specimen processing | ||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Cross-version Profile for R5.Device for use in FHIR R4(0.1.0) | Device) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..* | Identifier | Id for the container | |||||
![]() ![]() ![]() |
0..1 | string | Textual description of the container | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: Specimen Container (preferred) | |||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.0.1) | Container volume or size Constraints: sqty-1 | ||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.0.1) | Quantity of specimen within container Constraints: sqty-1 | ||||
![]() ![]() |
0..* | CodeableConcept | State of the specimen Binding: Hl7VSSpecimenCondition (3.0.0) (extensible): Codes describing the state of the specimen. | |||||
![]() ![]() |
0..* | Annotation | Comments | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | preferred | Specimen Types | 📦0.1.1 | HL7 Europe Laboratory Report v0.1 |
| Specimen.type.coding | Base | required | CH ELM Results Complete Spec | 📦1.16.0 | This IG |
| Specimen.collection.method | Base | example | FHIR Specimen Collection Method | 📍4.0.1 | FHIR Std. |
| Specimen.collection.bodySite | Base | preferred | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std. |
| Specimen.collection.fastingStatus[x] | Base | extensible | hl7VS-relevantClincialInformation | 📍3.0.0 | THO v7.4 |
| Specimen.processing.procedure | Base | example | Specimen processing procedure | 📍4.0.1 | FHIR Std. |
| Specimen.container.type | Base | preferred | Specimen Container | 📦0.1.1 | HL7 Europe Laboratory Report v0.1 |
| Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📍3.0.0 | THO v7.4 |
| Id | Grade | Path(s) | Description | Expression |
| ch-elm-dateTime | error | Specimen.collection.collected[x]:collectedDateTime | At least the format YYYY-MM-DD is required. |
$this.toString().length() >= 10
|
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | 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 | Specimen | 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 | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Specimen | 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()
|
| sqty-1 | error | Specimen.collection.quantity, Specimen.container.capacity, Specimen.container.specimenQuantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from ChLabSpecimen
Summary
Mandatory: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | ChLabSpecimen | CH Lab Specimen: Laboratory This profile also imposes the profile Specimen: Laboratory | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |
![]() ![]() |
0..1 | CodeableConcept | The mechanism to declare the collection material is described under 'Guidance - Laboratory Result' Binding: Specimen Types (preferred) | |
![]() ![]() ![]() |
0..1 | ChElmCoding | Code defined by a terminology system Binding: CH ELM Results Complete Spec (required) | |
![]() ![]() |
1..1 | Reference(CH ELM Patient) | 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 | |
![]() ![]() |
0..1 | BackboneElement | Collection details | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/bodySite" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Body structure: Laboratory) | Value of extension | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
0..1 | Collection time Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Collection time Constraints: ch-elm-dateTime |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | preferred | Specimen Types | 📦0.1.1 | HL7 Europe Laboratory Report v0.1 |
| Specimen.type.coding | Base | required | CH ELM Results Complete Spec | 📦1.16.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ch-elm-dateTime | error | Specimen.collection.collected[x]:collectedDateTime | At least the format YYYY-MM-DD is required. |
$this.toString().length() >= 10
|
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | 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 | Specimen | 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 | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Specimen | 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 ChLabSpecimen
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | ChLabSpecimen | CH Lab Specimen: Laboratory This profile also imposes the profile Specimen: Laboratory | |
![]() ![]() |
0..1 | CodeableConcept | The mechanism to declare the collection material is described under 'Guidance - Laboratory Result' | |
![]() ![]() ![]() |
0..1 | ChElmCoding | Code defined by a terminology system Binding: CH ELM Results Complete Spec (required) | |
![]() ![]() |
1..1 | Reference(CH ELM Patient) | 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 | |
![]() ![]() |
0..1 | BackboneElement | Collection details | |
![]() ![]() ![]() |
0..1 | dateTime, Period | Collection time Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |
![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Collection time Constraints: ch-elm-dateTime |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.type.coding | Base | required | CH ELM Results Complete Spec | 📦1.16.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ch-elm-dateTime | error | Specimen.collection.collected[x]:collectedDateTime | At least the format YYYY-MM-DD is required. |
$this.toString().length() >= 10
|
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ChLabSpecimen | CH Lab Specimen: Laboratory This profile also imposes the profile Specimen: Laboratory | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | External Identifier | |||||
![]() ![]() |
0..1 | Identifier | Identifier assigned by the lab | |||||
![]() ![]() |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |||||
![]() ![]() |
0..1 | CodeableConcept | The mechanism to declare the collection material is described under 'Guidance - Laboratory Result' Binding: Specimen Types (preferred) | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | ChElmCoding | Code defined by a terminology system Binding: CH ELM Results Complete Spec (required) | |||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
1..1 | Reference(CH ELM Patient) | 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 | |||||
![]() ![]() |
0..1 | dateTime | The time when specimen was received for processing | |||||
![]() ![]() |
0..* | Reference(CH LAB-Report Specimen) | Specimen from which this specimen originated | |||||
![]() ![]() |
0..* | Reference(ServiceRequest) | Why the specimen was collected. | |||||
![]() ![]() |
0..1 | BackboneElement | Collection details | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/bodySite" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Body structure: Laboratory) | Value of extension | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | |||||
![]() ![]() ![]() |
0..1 | Collection time Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Collection time Constraints: ch-elm-dateTime | ||||
![]() ![]() ![]() |
0..1 | Duration | How long it took to collect specimen | |||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.0.1) | The quantity of specimen collected Constraints: sqty-1 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (preferred) | |||||
![]() ![]() ![]() |
0..1 | Whether or how long patient abstained from food and/or drink Binding: Hl7VSRelevantClincialInformation (3.0.0) (extensible): Codes describing the fasting status of the patient. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() |
0..* | BackboneElement | Processing and processing step details | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | string | Textual description of procedure | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||
![]() ![]() ![]() |
0..* | Reference(Substance | CH LAB-Report Additive Substance) | Material used in the processing step | |||||
![]() ![]() ![]() |
0..1 | Date and time of specimen processing | ||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Cross-version Profile for R5.Device for use in FHIR R4(0.1.0) | Device) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..* | Identifier | Id for the container | |||||
![]() ![]() ![]() |
0..1 | string | Textual description of the container | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: Specimen Container (preferred) | |||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.0.1) | Container volume or size Constraints: sqty-1 | ||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.0.1) | Quantity of specimen within container Constraints: sqty-1 | ||||
![]() ![]() |
0..* | CodeableConcept | State of the specimen Binding: Hl7VSSpecimenCondition (3.0.0) (extensible): Codes describing the state of the specimen. | |||||
![]() ![]() |
0..* | Annotation | Comments | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | preferred | Specimen Types | 📦0.1.1 | HL7 Europe Laboratory Report v0.1 |
| Specimen.type.coding | Base | required | CH ELM Results Complete Spec | 📦1.16.0 | This IG |
| Specimen.collection.method | Base | example | FHIR Specimen Collection Method | 📍4.0.1 | FHIR Std. |
| Specimen.collection.bodySite | Base | preferred | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std. |
| Specimen.collection.fastingStatus[x] | Base | extensible | hl7VS-relevantClincialInformation | 📍3.0.0 | THO v7.4 |
| Specimen.processing.procedure | Base | example | Specimen processing procedure | 📍4.0.1 | FHIR Std. |
| Specimen.container.type | Base | preferred | Specimen Container | 📦0.1.1 | HL7 Europe Laboratory Report v0.1 |
| Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📍3.0.0 | THO v7.4 |
| Id | Grade | Path(s) | Description | Expression |
| ch-elm-dateTime | error | Specimen.collection.collected[x]:collectedDateTime | At least the format YYYY-MM-DD is required. |
$this.toString().length() >= 10
|
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | 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 | Specimen | 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 | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Specimen | 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()
|
| sqty-1 | error | Specimen.collection.quantity, Specimen.container.capacity, Specimen.container.specimenQuantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from ChLabSpecimen
Summary
Mandatory: 1 element
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron