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 Observation Definition (R4)

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

Copyright/Legal: CC0-1.0

R4 adaptation of the Order Catalog ObservationDefinition for CH Lab Order IG.

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
.. ObservationDefinition 0..* ObservationDefinition Definition of an observation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: CH Lab LOINC ValueSet (required)
... multipleResultsAllowed S 0..1 boolean Multiple results allowed
Example General: true
... method S 0..1 CodeableConcept Method used to produce the observation
Binding: ObservationMethods (extensible)
... preferredReportName S 0..1 string Preferred report name
... quantitativeDetails S 0..1 BackboneElement Characteristics of quantitative results
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... customaryUnit S 0..1 CodeableConcept Customary unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.
.... unit S 0..1 CodeableConcept SI unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.
.... conversionFactor S 0..1 decimal SI to Customary unit conversion factor
.... decimalPrecision S 0..1 integer Decimal precision of observation quantitative results
... qualifiedInterval S 0..* BackboneElement Qualified range for continuous and ordinal observation results
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ObservationDefinition.​code Base required CH Lab LOINC ValueSet 📦3.0.0-ci-build This IG
ObservationDefinition.​permittedDataType Base required ObservationDataType 📍4.0.1 FHIR Std.
ObservationDefinition.​method Base extensible Observation Methods 📦4.0.1 FHIR Std.
ObservationDefinition.​quantitativeDetails.​customaryUnit Base extensible UCUM Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​quantitativeDetails.​unit Base extensible UCUM Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ObservationDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ObservationDefinition 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 ObservationDefinition 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 ObservationDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ObservationDefinition 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 ObservationDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ObservationDefinition 0..* ObservationDefinition Definition of an observation
... code S 1..1 CodeableConcept Type of observation (code / type)
Binding: CH Lab LOINC ValueSet (required)
... permittedDataType S 1..* code Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required)
... multipleResultsAllowed S 0..1 boolean Multiple results allowed
... preferredReportName S 0..1 string Preferred report name
... quantitativeDetails S 0..1 BackboneElement Characteristics of quantitative results
.... customaryUnit S 0..1 CodeableConcept Customary unit for quantitative results
.... unit S 0..1 CodeableConcept SI unit for quantitative results
.... conversionFactor S 0..1 decimal SI to Customary unit conversion factor
.... decimalPrecision S 0..1 integer Decimal precision of observation quantitative results
... qualifiedInterval S 0..* BackboneElement Qualified range for continuous and ordinal observation results

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ObservationDefinition.​code Base required CH Lab LOINC ValueSet 📦3.0.0-ci-build This IG
ObservationDefinition.​permittedDataType Base required ObservationDataType 📍4.0.1 FHIR Std.
ObservationDefinition.​method Base extensible Observation Methods 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ObservationDefinition 0..* ObservationDefinition Definition of an observation
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... category Σ 0..* CodeableConcept Category of observation
Binding: ObservationCategoryCodes (example): Codes for high level observation categories.
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: CH Lab LOINC ValueSet (required)
... identifier Σ 0..* Identifier Business identifier for this ObservationDefinition instance
... permittedDataType S 1..* code Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required)

Example General: CodeableConcept
... multipleResultsAllowed S 0..1 boolean Multiple results allowed
Example General: true
... method S 0..1 CodeableConcept Method used to produce the observation
Binding: ObservationMethods (extensible)
... preferredReportName S 0..1 string Preferred report name
... quantitativeDetails S 0..1 BackboneElement Characteristics of quantitative results
.... 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
.... customaryUnit S 0..1 CodeableConcept Customary unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.
.... unit S 0..1 CodeableConcept SI unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.
.... conversionFactor S 0..1 decimal SI to Customary unit conversion factor
.... decimalPrecision S 0..1 integer Decimal precision of observation quantitative results
... qualifiedInterval S 0..* BackboneElement Qualified range for continuous and ordinal observation results
.... 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
.... category 0..1 code reference | critical | absolute
Binding: ObservationRangeCategory (required): Codes identifying the category of observation range.
Example General: critical
.... range 0..1 Range The interval itself, for continuous or ordinal observations
.... context 0..1 CodeableConcept Range context qualifier
Binding: ObservationReferenceRangeMeaningCodes (extensible): Code identifying the health context of a range.
.... appliesTo 0..* CodeableConcept Targetted population of the range
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Example General: female
.... age 0..1 Range Applicable age range, if relevant
.... gestationalAge 0..1 Range Applicable gestational age range, if relevant
.... condition 0..1 string Condition associated with the reference range
... validCodedValueSet 0..1 Reference(ValueSet) Value set of valid coded values for the observations conforming to this ObservationDefinition
... normalCodedValueSet 0..1 Reference(ValueSet) Value set of normal coded values for the observations conforming to this ObservationDefinition
... abnormalCodedValueSet 0..1 Reference(ValueSet) Value set of abnormal coded values for the observations conforming to this ObservationDefinition
... criticalCodedValueSet 0..1 Reference(ValueSet) Value set of critical coded values for the observations conforming to this ObservationDefinition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ObservationDefinition.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ObservationDefinition.​category Base example Observation Category Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​code Base required CH Lab LOINC ValueSet 📦3.0.0-ci-build This IG
ObservationDefinition.​permittedDataType Base required ObservationDataType 📍4.0.1 FHIR Std.
ObservationDefinition.​method Base extensible Observation Methods 📦4.0.1 FHIR Std.
ObservationDefinition.​quantitativeDetails.​customaryUnit Base extensible UCUM Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​quantitativeDetails.​unit Base extensible UCUM Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.category Base required ObservationRangeCategory 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.context Base extensible Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ObservationDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ObservationDefinition 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 ObservationDefinition 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 ObservationDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ObservationDefinition 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 ObservationDefinition

Summary

Mandatory: 1 element
Must-Support: 11 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ObservationDefinition 0..* ObservationDefinition Definition of an observation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: CH Lab LOINC ValueSet (required)
... multipleResultsAllowed S 0..1 boolean Multiple results allowed
Example General: true
... method S 0..1 CodeableConcept Method used to produce the observation
Binding: ObservationMethods (extensible)
... preferredReportName S 0..1 string Preferred report name
... quantitativeDetails S 0..1 BackboneElement Characteristics of quantitative results
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... customaryUnit S 0..1 CodeableConcept Customary unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.
.... unit S 0..1 CodeableConcept SI unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.
.... conversionFactor S 0..1 decimal SI to Customary unit conversion factor
.... decimalPrecision S 0..1 integer Decimal precision of observation quantitative results
... qualifiedInterval S 0..* BackboneElement Qualified range for continuous and ordinal observation results
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ObservationDefinition.​code Base required CH Lab LOINC ValueSet 📦3.0.0-ci-build This IG
ObservationDefinition.​permittedDataType Base required ObservationDataType 📍4.0.1 FHIR Std.
ObservationDefinition.​method Base extensible Observation Methods 📦4.0.1 FHIR Std.
ObservationDefinition.​quantitativeDetails.​customaryUnit Base extensible UCUM Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​quantitativeDetails.​unit Base extensible UCUM Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ObservationDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ObservationDefinition 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 ObservationDefinition 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 ObservationDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ObservationDefinition 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 ObservationDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ObservationDefinition 0..* ObservationDefinition Definition of an observation
... code S 1..1 CodeableConcept Type of observation (code / type)
Binding: CH Lab LOINC ValueSet (required)
... permittedDataType S 1..* code Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required)
... multipleResultsAllowed S 0..1 boolean Multiple results allowed
... preferredReportName S 0..1 string Preferred report name
... quantitativeDetails S 0..1 BackboneElement Characteristics of quantitative results
.... customaryUnit S 0..1 CodeableConcept Customary unit for quantitative results
.... unit S 0..1 CodeableConcept SI unit for quantitative results
.... conversionFactor S 0..1 decimal SI to Customary unit conversion factor
.... decimalPrecision S 0..1 integer Decimal precision of observation quantitative results
... qualifiedInterval S 0..* BackboneElement Qualified range for continuous and ordinal observation results

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ObservationDefinition.​code Base required CH Lab LOINC ValueSet 📦3.0.0-ci-build This IG
ObservationDefinition.​permittedDataType Base required ObservationDataType 📍4.0.1 FHIR Std.
ObservationDefinition.​method Base extensible Observation Methods 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ObservationDefinition 0..* ObservationDefinition Definition of an observation
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... category Σ 0..* CodeableConcept Category of observation
Binding: ObservationCategoryCodes (example): Codes for high level observation categories.
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: CH Lab LOINC ValueSet (required)
... identifier Σ 0..* Identifier Business identifier for this ObservationDefinition instance
... permittedDataType S 1..* code Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required)

Example General: CodeableConcept
... multipleResultsAllowed S 0..1 boolean Multiple results allowed
Example General: true
... method S 0..1 CodeableConcept Method used to produce the observation
Binding: ObservationMethods (extensible)
... preferredReportName S 0..1 string Preferred report name
... quantitativeDetails S 0..1 BackboneElement Characteristics of quantitative results
.... 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
.... customaryUnit S 0..1 CodeableConcept Customary unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.
.... unit S 0..1 CodeableConcept SI unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.
.... conversionFactor S 0..1 decimal SI to Customary unit conversion factor
.... decimalPrecision S 0..1 integer Decimal precision of observation quantitative results
... qualifiedInterval S 0..* BackboneElement Qualified range for continuous and ordinal observation results
.... 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
.... category 0..1 code reference | critical | absolute
Binding: ObservationRangeCategory (required): Codes identifying the category of observation range.
Example General: critical
.... range 0..1 Range The interval itself, for continuous or ordinal observations
.... context 0..1 CodeableConcept Range context qualifier
Binding: ObservationReferenceRangeMeaningCodes (extensible): Code identifying the health context of a range.
.... appliesTo 0..* CodeableConcept Targetted population of the range
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Example General: female
.... age 0..1 Range Applicable age range, if relevant
.... gestationalAge 0..1 Range Applicable gestational age range, if relevant
.... condition 0..1 string Condition associated with the reference range
... validCodedValueSet 0..1 Reference(ValueSet) Value set of valid coded values for the observations conforming to this ObservationDefinition
... normalCodedValueSet 0..1 Reference(ValueSet) Value set of normal coded values for the observations conforming to this ObservationDefinition
... abnormalCodedValueSet 0..1 Reference(ValueSet) Value set of abnormal coded values for the observations conforming to this ObservationDefinition
... criticalCodedValueSet 0..1 Reference(ValueSet) Value set of critical coded values for the observations conforming to this ObservationDefinition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ObservationDefinition.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ObservationDefinition.​category Base example Observation Category Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​code Base required CH Lab LOINC ValueSet 📦3.0.0-ci-build This IG
ObservationDefinition.​permittedDataType Base required ObservationDataType 📍4.0.1 FHIR Std.
ObservationDefinition.​method Base extensible Observation Methods 📦4.0.1 FHIR Std.
ObservationDefinition.​quantitativeDetails.​customaryUnit Base extensible UCUM Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​quantitativeDetails.​unit Base extensible UCUM Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.category Base required ObservationRangeCategory 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.context Base extensible Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ObservationDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ObservationDefinition 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 ObservationDefinition 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 ObservationDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ObservationDefinition 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 ObservationDefinition

Summary

Mandatory: 1 element
Must-Support: 11 elements

 

Other representations of profile: CSV, Excel, Schematron