HL7 Europe Laboratory Report
0.2.0-ci - ci-build 150

HL7 Europe Laboratory Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.2.0-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/laboratory/ and changes regularly. See the Directory of published versions

Resource Profile: Observation Results: laboratory

Official URL: http://hl7.eu/fhir/laboratory/StructureDefinition/Observation-resultslab-eu-lab Version: 0.2.0-ci
Standards status: Trial-use Draft as of 2025-12-01 Maturity Level: 2 Computable Name: ObservationResultsLaboratoryEu

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

This profile constrains the Observation resource to represent results produced by laboratory tests or panels/studies for the HL7 Europe project. This observation may represent the result of a simple laboratory test such as hematocrit or it may group the set of results produced by a multi-test study or panel such as a complete blood count, a dynamic function test, a urine specimen study. In the latter case, the observation carries the overall conclusion of the study and or a global interpretation by the producer of the study, in the comment element; and references the atomic results of the study as "has-member" child observations.

This profile offers two options to indicate the Certified Reference Material used for the calibration (in general when the UCUM International Units are used for the results [IU]).

  • The first to be used when the Certified Reference Material is represented by a coded concept
  • The second when the Certified Reference Material is identified with an Identifier.

Adopters are invited to give their feedback about

  1. The most proper way to refer the Certified Reference Material, that is by using an Identifier or a CodeableConcept
  2. If a CodeableReference should be used
  3. If this information should be an extension of the Observation resource, or of other elements (e.g. DeviceMetric.calibration)

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Laboratory result for a simple test or for a panel/study
Constraints: obs-6, obs-7, eu-lab-1, eu-lab-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Laboratory Test Kit
Slice: Unordered, Open by value:url
.... extension:supportingInfo 0..* Reference(Resource) Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
.... extension:triggeredBy-r5 0..* (Complex) Triggering observation(s)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
Constraints: ext-1
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Closed by value:url
Constraints: ext-1
...... extension:observation 1..1 Extension Triggering observation.
Constraints: ext-1
....... url 1..1 uri "observation"
...... extension:type 1..1 Extension The type of trigger
Constraints: ext-1
....... url 1..1 uri "type"
...... extension:reason 0..1 Extension Reason that the observation was triggered
Constraints: ext-1
....... url 1..1 uri "reason"
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy"
.... extension:certifiedRefMaterialCodeable 0..* CodeableConcept Certified Reference Material: CodeableConcept
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialCodeable
Binding: Laboratory Certified Reference Material (example)
.... extension:certifiedRefMaterialIdentifer 0..* Identifier Certified Reference Material: Identifier
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer
.... extension:labTestKit 0..* Reference(Device) Device Laboratory Test Kit
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit
.... extension:value-r5 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D]] only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]"
..... value[x] 1..1 Attachment Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for category 1..* CodeableConceptIPS(2.0.0) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:laboratory 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: laboratory
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... category:studyType 0..* CodeableConcept The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: Laboratory Study Types (required)
.... category:specialty 0..* CodeableConcept The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)
Binding: Laboratory Specialty (required)
... code Σ 1..1 CodeableConceptIPS(2.0.0) Type of observation (code / type)
Binding: Laboratory Code (preferred)
... subject Σ 1..1 Reference(Patient: Animal | Patient (EU core) | Group | Device | Location) Who and/or what the observation is about
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... effective[x] Σ 1..1 Clinically relevant time/time-period for observation
.... effective[x]All Types Content/Rules for all Types
..... Slices for extension Content/Rules for all slices
...... extension:data-absent-reason 0..1 code effective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued Σ 0..1 instant Date/Time this result was made available
... performer Σ 1..* Reference(PractitionerRole (EU core) | Practitioner (EU core) | Organization (IPS)(2.0.0) | CareTeam | Patient (EU core) | RelatedPerson) Who is responsible for the observation
.... Slices for extension Content/Rules for all slices
..... extension:performerFunction 0..1 CodeableConcept Type of performance
URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction
Binding: Performer Function Codes (extensible)
... Slices for value[x] ΣC 0..1 Actual result
Slice: Unordered, Open by type:$this
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... value[x]:valueString ΣC 0..1 string Actual result
.... value[x]:valueRange ΣC 0..1 RangeIPS Actual result
.... value[x]:valueRatio ΣC 0..1 RatioEuLab Actual result
.... value[x]:valueTime ΣC 0..1 time Actual result
.... value[x]:valueDateTime ΣC 0..1 dateTime Actual result
.... value[x]:valuePeriod ΣC 0..1 Period Actual result
.... value[x]:valueQuantity ΣC 0..1 QuantityEuLab Actual result
.... value[x]:valueCodeableConcept ΣC 0..1 CodeableConceptIPS(2.0.0) Actual result
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Set candidate
Results Presence Absence - SNOMED CT IPS Free Set candidate
Results Microorganism - SNOMED CT IPS Free Set candidate
... dataAbsentReason C 0..1 CodeableConcept Provides a reason why the expected value is missing.
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConceptIPS(2.0.0) High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... method 0..1 CodeableConceptIPS(2.0.0) How it was done
Binding: Laboratory Techniques (preferred)
... specimen 0..1 Reference(Specimen: Laboratory) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) Measuring instrument
... hasMember Σ 0..* Reference(Observation Results: laboratory) Related resource that belongs to the Observation group
... component Σ 0..* BackboneElement Laboratory result
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:value-r5 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D]] only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]"
...... value[x] 1..1 Attachment Value of extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConceptIPS(2.0.0) Type of component observation (code / type)
Binding: Results Laboratory Observation - IPS (preferred)
.... Slices for value[x] Σ 0..1 Actual component result
Slice: Unordered, Open by type:$this
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
..... value[x]:valueString Σ 0..1 string Actual component result
..... value[x]:valueRange Σ 0..1 RangeIPS Actual component result
..... value[x]:valueRatio Σ 0..1 RatioEuLab Actual component result
..... value[x]:valueTime Σ 0..1 time Actual component result
..... value[x]:valueDateTime Σ 0..1 dateTime Actual component result
..... value[x]:valuePeriod Σ 0..1 Period Actual component result
..... value[x]:valueQuantity Σ 0..1 QuantityEuLab Actual component result
..... value[x]:valueCodeableConcept Σ 0..1 CodeableConceptIPS(2.0.0) Actual component result
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Set candidate
Results Presence Absence - SNOMED CT IPS Free Set candidate
Results Microorganism - SNOMED CT IPS Free Set candidate

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:laboratory Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:studyType Base required Laboratory Study Types 📦0.2.0-ci This IG
Observation.category:specialty Base required Laboratory Specialty 📦0.2.0-ci This IG
Observation.code Base preferred Laboratory Code 📦0.2.0-ci This IG
Observation.value[x]:valueCodeableConcept Base preferred Results Coded Values Laboratory - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.method Base preferred Laboratory Techniques 📦0.2.0-ci This IG
Observation.component.​code Base preferred Results Laboratory Observation - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.component.​value[x]:valueCodeableConcept Base preferred Results Coded Values Laboratory - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation 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 Observation 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 Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation 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())
eu-lab-1 error Observation If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" (status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists()
eu-lab-2 error Observation If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists()
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Laboratory result for a simple test or for a panel/study
Constraints: eu-lab-1, eu-lab-2
... Slices for extension 0..* Extension Laboratory Test Kit
Slice: Unordered, Open by value:url
.... extension:supportingInfo 0..* Reference(Resource) Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
.... extension:triggeredBy-r5 0..* (Complex) Triggering observation(s)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
..... Slices for extension Content/Rules for all slices
...... extension:observation 1..1 Extension Triggering observation.
...... extension:type 1..1 Extension The type of trigger
.... extension:certifiedRefMaterialCodeable 0..* CodeableConcept Certified Reference Material: CodeableConcept
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialCodeable
Binding: Laboratory Certified Reference Material (example)
.... extension:certifiedRefMaterialIdentifer 0..* Identifier Certified Reference Material: Identifier
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer
.... extension:labTestKit 0..* Reference(Device) Device Laboratory Test Kit
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit
.... extension:value-r5 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D]] only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D
..... value[x] 1..1 Attachment Value of extension
... status 1..1 code Status of this observation (e.g. preliminary, final,...)
... Slices for category 1..* CodeableConceptIPS(2.0.0) Classification of type of observation
Slice: Unordered, Open by pattern:$this
.... category:laboratory 1..1 CodeableConcept Classification of type of observation
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: laboratory
.... category:studyType 0..* CodeableConcept The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: Laboratory Study Types (required)
.... category:specialty 0..* CodeableConcept The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)
Binding: Laboratory Specialty (required)
... subject 1..1 Reference(Patient: Animal | Patient (EU core) | Group | Device | Location) Who and/or what the observation is about
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... effective[x] 1..1 Clinically relevant time/time-period for observation
.... effective[x]All Types Content/Rules for all Types
..... Slices for extension Content/Rules for all slices
...... extension:data-absent-reason 0..1 code effective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued 0..1 instant Date/Time this result was made available
... performer 1..* Reference(PractitionerRole (EU core) | Practitioner (EU core) | Organization (IPS)(2.0.0) | CareTeam | Patient (EU core) | RelatedPerson) Who is responsible for the observation
.... Slices for extension Content/Rules for all slices
..... extension:performerFunction 0..* CodeableConcept Type of performance
URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction
Binding: Performer Function Codes (extensible)
... Slices for value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Actual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueString 0..1 string Actual result
.... value[x]:valueRange 0..1 RangeIPS Actual result
.... value[x]:valueRatio 0..1 RatioEuLab Actual result
.... value[x]:valueTime 0..1 time Actual result
.... value[x]:valueDateTime 0..1 dateTime Actual result
.... value[x]:valuePeriod 0..1 Period Actual result
.... value[x]:valueQuantity 0..1 QuantityEuLab Actual result
.... value[x]:valueCodeableConcept 0..1 CodeableConceptIPS(2.0.0) Actual result
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Set candidate
Results Presence Absence - SNOMED CT IPS Free Set candidate
Results Microorganism - SNOMED CT IPS Free Set candidate
... dataAbsentReason 0..1 CodeableConcept Provides a reason why the expected value is missing.
... interpretation 0..* CodeableConceptIPS(2.0.0) High, low, normal, etc.
... method 0..1 CodeableConceptIPS(2.0.0) How it was done
Binding: Laboratory Techniques (preferred)
... specimen 0..1 Reference(Specimen: Laboratory) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) Measuring instrument
... hasMember 0..* Reference(Observation Results: laboratory) Related resource that belongs to the Observation group
... component 0..* BackboneElement Laboratory result
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:value-r5 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D]] only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D
...... value[x] 1..1 Attachment Value of extension
.... code 1..1 CodeableConceptIPS(2.0.0) Type of component observation (code / type)
Binding: Results Laboratory Observation - IPS (preferred)
.... Slices for value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Actual component result
Slice: Unordered, Closed by type:$this
..... value[x]:valueString 0..1 string Actual component result
..... value[x]:valueRange 0..1 RangeIPS Actual component result
..... value[x]:valueRatio 0..1 RatioEuLab Actual component result
..... value[x]:valueTime 0..1 time Actual component result
..... value[x]:valueDateTime 0..1 dateTime Actual component result
..... value[x]:valuePeriod 0..1 Period Actual component result
..... value[x]:valueQuantity 0..1 QuantityEuLab Actual component result
..... value[x]:valueCodeableConcept 0..1 CodeableConceptIPS(2.0.0) Actual component result
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Set candidate
Results Presence Absence - SNOMED CT IPS Free Set candidate
Results Microorganism - SNOMED CT IPS Free Set candidate

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.category:studyType Base required Laboratory Study Types 📦0.2.0-ci This IG
Observation.category:specialty Base required Laboratory Specialty 📦0.2.0-ci This IG
Observation.code Base preferred Laboratory Code 📦0.2.0-ci This IG
Observation.value[x]:valueCodeableConcept Base preferred Results Coded Values Laboratory - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.method Base preferred Laboratory Techniques 📦0.2.0-ci This IG
Observation.component.​code Base preferred Results Laboratory Observation - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.component.​value[x]:valueCodeableConcept Base preferred Results Coded Values Laboratory - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1

Constraints

Id Grade Path(s) Description Expression
eu-lab-1 error Observation If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" (status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists()
eu-lab-2 error Observation If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Laboratory result for a simple test or for a panel/study
Constraints: obs-6, obs-7, eu-lab-1, eu-lab-2
... 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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 0..* Extension Laboratory Test Kit
Slice: Unordered, Open by value:url
.... extension:supportingInfo 0..* Reference(Resource) Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
.... extension:triggeredBy-r5 0..* (Complex) Triggering observation(s)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Closed by value:url
Constraints: ext-1
...... extension:observation 1..1 Extension Triggering observation.
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "observation"
....... value[x] 0..1 Reference() Triggering observation
...... extension:type 1..1 Extension The type of trigger
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "type"
....... value[x] 0..1 code reflex | repeat | re-run
Binding: R5_observation_triggeredbytype_for_R4 (0.0.1-snapshot-2) (required): The type of TriggeredBy Observation.
...... extension:reason 0..1 Extension Reason that the observation was triggered
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "reason"
....... value[x] 0..1 string Reason that the observation was triggered
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy"
..... value[x] 0..1 Value of extension
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
.... extension:certifiedRefMaterialCodeable 0..* CodeableConcept Certified Reference Material: CodeableConcept
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialCodeable
Binding: Laboratory Certified Reference Material (example)
.... extension:certifiedRefMaterialIdentifer 0..* Identifier Certified Reference Material: Identifier
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer
.... extension:labTestKit 0..* Reference(Device) Device Laboratory Test Kit
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit
.... extension:value-r5 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D]] only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]"
..... value[x] 1..1 Attachment Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!Σ 1..1 code Status of this observation (e.g. preliminary, final,...)
Binding: ObservationStatus (required): Codes providing the status of an observation.
... Slices for category 1..* CodeableConceptIPS(2.0.0) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:laboratory 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: laboratory
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... category:studyType 0..* CodeableConcept The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: Laboratory Study Types (required)
.... category:specialty 0..* CodeableConcept The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)
Binding: Laboratory Specialty (required)
... code Σ 1..1 CodeableConceptIPS(2.0.0) Type of observation (code / type)
Binding: Laboratory Code (preferred)
... subject Σ 1..1 Reference(Patient: Animal | Patient (EU core) | Group | Device | Location) Who and/or what the observation is about
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] Σ 1..1 Clinically relevant time/time-period for observation
.... effective[x]All Types Content/Rules for all Types
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:data-absent-reason 0..1 code effective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued Σ 0..1 instant Date/Time this result was made available
... performer Σ 1..* Reference(PractitionerRole (EU core) | Practitioner (EU core) | Organization (IPS)(2.0.0) | CareTeam | Patient (EU core) | RelatedPerson) Who is responsible for the observation
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:performerFunction 0..1 CodeableConcept Type of performance
URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction
Binding: Performer Function Codes (extensible)
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... Slices for value[x] ΣC 0..1 Actual result
Slice: Unordered, Open by type:$this
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... value[x]:valueString ΣC 0..1 string Actual result
.... value[x]:valueRange ΣC 0..1 RangeIPS Actual result
.... value[x]:valueRatio ΣC 0..1 RatioEuLab Actual result
.... value[x]:valueTime ΣC 0..1 time Actual result
.... value[x]:valueDateTime ΣC 0..1 dateTime Actual result
.... value[x]:valuePeriod ΣC 0..1 Period Actual result
.... value[x]:valueQuantity ΣC 0..1 QuantityEuLab Actual result
.... value[x]:valueCodeableConcept ΣC 0..1 CodeableConceptIPS(2.0.0) Actual result
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Set candidate
Results Presence Absence - SNOMED CT IPS Free Set candidate
Results Microorganism - SNOMED CT IPS Free Set candidate
... dataAbsentReason C 0..1 CodeableConcept Provides a reason why the expected value is missing.
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConceptIPS(2.0.0) High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConceptIPS(2.0.0) How it was done
Binding: Laboratory Techniques (preferred)
... specimen 0..1 Reference(Specimen: Laboratory) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) Measuring instrument
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... 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
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation Results: laboratory) Related resource that belongs to the Observation group
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
... component Σ 0..* BackboneElement Laboratory result
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:value-r5 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D]] only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]"
...... value[x] 1..1 Attachment Value of extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConceptIPS(2.0.0) Type of component observation (code / type)
Binding: Results Laboratory Observation - IPS (preferred)
.... Slices for value[x] Σ 0..1 Actual component result
Slice: Unordered, Open by type:$this
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
..... value[x]:valueString Σ 0..1 string Actual component result
..... value[x]:valueRange Σ 0..1 RangeIPS Actual component result
..... value[x]:valueRatio Σ 0..1 RatioEuLab Actual component result
..... value[x]:valueTime Σ 0..1 time Actual component result
..... value[x]:valueDateTime Σ 0..1 dateTime Actual component result
..... value[x]:valuePeriod Σ 0..1 Period Actual component result
..... value[x]:valueQuantity Σ 0..1 QuantityEuLab Actual component result
..... value[x]:valueCodeableConcept Σ 0..1 CodeableConceptIPS(2.0.0) Actual component result
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Set candidate
Results Presence Absence - SNOMED CT IPS Free Set candidate
Results Microorganism - SNOMED CT IPS Free Set candidate
.... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.extension:triggeredBy-r5.​extension:type.value[x] Base required Cross-version VS for R5.TriggeredBytype for use in FHIR R4 📍0.0.1-snapshot-2 FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5 v0.0
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:laboratory Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:studyType Base required Laboratory Study Types 📦0.2.0-ci This IG
Observation.category:specialty Base required Laboratory Specialty 📦0.2.0-ci This IG
Observation.code Base preferred Laboratory Code 📦0.2.0-ci This IG
Observation.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Observation.performer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Observation.value[x]:valueCodeableConcept Base preferred Results Coded Values Laboratory - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base preferred Laboratory Techniques 📦0.2.0-ci This IG
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base preferred Results Laboratory Observation - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.component.​value[x]:valueCodeableConcept Base preferred Results Coded Values Laboratory - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation 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 Observation 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 Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation 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())
eu-lab-1 error Observation If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" (status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists()
eu-lab-2 error Observation If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists()
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Summary

Mandatory: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.category
  • The element 1 is sliced based on the value of Observation.value[x] (Closed)
  • The element 1 is sliced based on the value of Observation.component.value[x] (Closed)

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Laboratory result for a simple test or for a panel/study
Constraints: obs-6, obs-7, eu-lab-1, eu-lab-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Laboratory Test Kit
Slice: Unordered, Open by value:url
.... extension:supportingInfo 0..* Reference(Resource) Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
.... extension:triggeredBy-r5 0..* (Complex) Triggering observation(s)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
Constraints: ext-1
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Closed by value:url
Constraints: ext-1
...... extension:observation 1..1 Extension Triggering observation.
Constraints: ext-1
....... url 1..1 uri "observation"
...... extension:type 1..1 Extension The type of trigger
Constraints: ext-1
....... url 1..1 uri "type"
...... extension:reason 0..1 Extension Reason that the observation was triggered
Constraints: ext-1
....... url 1..1 uri "reason"
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy"
.... extension:certifiedRefMaterialCodeable 0..* CodeableConcept Certified Reference Material: CodeableConcept
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialCodeable
Binding: Laboratory Certified Reference Material (example)
.... extension:certifiedRefMaterialIdentifer 0..* Identifier Certified Reference Material: Identifier
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer
.... extension:labTestKit 0..* Reference(Device) Device Laboratory Test Kit
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit
.... extension:value-r5 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D]] only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]"
..... value[x] 1..1 Attachment Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for category 1..* CodeableConceptIPS(2.0.0) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:laboratory 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: laboratory
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... category:studyType 0..* CodeableConcept The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: Laboratory Study Types (required)
.... category:specialty 0..* CodeableConcept The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)
Binding: Laboratory Specialty (required)
... code Σ 1..1 CodeableConceptIPS(2.0.0) Type of observation (code / type)
Binding: Laboratory Code (preferred)
... subject Σ 1..1 Reference(Patient: Animal | Patient (EU core) | Group | Device | Location) Who and/or what the observation is about
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... effective[x] Σ 1..1 Clinically relevant time/time-period for observation
.... effective[x]All Types Content/Rules for all Types
..... Slices for extension Content/Rules for all slices
...... extension:data-absent-reason 0..1 code effective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued Σ 0..1 instant Date/Time this result was made available
... performer Σ 1..* Reference(PractitionerRole (EU core) | Practitioner (EU core) | Organization (IPS)(2.0.0) | CareTeam | Patient (EU core) | RelatedPerson) Who is responsible for the observation
.... Slices for extension Content/Rules for all slices
..... extension:performerFunction 0..1 CodeableConcept Type of performance
URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction
Binding: Performer Function Codes (extensible)
... Slices for value[x] ΣC 0..1 Actual result
Slice: Unordered, Open by type:$this
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... value[x]:valueString ΣC 0..1 string Actual result
.... value[x]:valueRange ΣC 0..1 RangeIPS Actual result
.... value[x]:valueRatio ΣC 0..1 RatioEuLab Actual result
.... value[x]:valueTime ΣC 0..1 time Actual result
.... value[x]:valueDateTime ΣC 0..1 dateTime Actual result
.... value[x]:valuePeriod ΣC 0..1 Period Actual result
.... value[x]:valueQuantity ΣC 0..1 QuantityEuLab Actual result
.... value[x]:valueCodeableConcept ΣC 0..1 CodeableConceptIPS(2.0.0) Actual result
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Set candidate
Results Presence Absence - SNOMED CT IPS Free Set candidate
Results Microorganism - SNOMED CT IPS Free Set candidate
... dataAbsentReason C 0..1 CodeableConcept Provides a reason why the expected value is missing.
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConceptIPS(2.0.0) High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... method 0..1 CodeableConceptIPS(2.0.0) How it was done
Binding: Laboratory Techniques (preferred)
... specimen 0..1 Reference(Specimen: Laboratory) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) Measuring instrument
... hasMember Σ 0..* Reference(Observation Results: laboratory) Related resource that belongs to the Observation group
... component Σ 0..* BackboneElement Laboratory result
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:value-r5 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D]] only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]"
...... value[x] 1..1 Attachment Value of extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConceptIPS(2.0.0) Type of component observation (code / type)
Binding: Results Laboratory Observation - IPS (preferred)
.... Slices for value[x] Σ 0..1 Actual component result
Slice: Unordered, Open by type:$this
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
..... value[x]:valueString Σ 0..1 string Actual component result
..... value[x]:valueRange Σ 0..1 RangeIPS Actual component result
..... value[x]:valueRatio Σ 0..1 RatioEuLab Actual component result
..... value[x]:valueTime Σ 0..1 time Actual component result
..... value[x]:valueDateTime Σ 0..1 dateTime Actual component result
..... value[x]:valuePeriod Σ 0..1 Period Actual component result
..... value[x]:valueQuantity Σ 0..1 QuantityEuLab Actual component result
..... value[x]:valueCodeableConcept Σ 0..1 CodeableConceptIPS(2.0.0) Actual component result
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Set candidate
Results Presence Absence - SNOMED CT IPS Free Set candidate
Results Microorganism - SNOMED CT IPS Free Set candidate

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:laboratory Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:studyType Base required Laboratory Study Types 📦0.2.0-ci This IG
Observation.category:specialty Base required Laboratory Specialty 📦0.2.0-ci This IG
Observation.code Base preferred Laboratory Code 📦0.2.0-ci This IG
Observation.value[x]:valueCodeableConcept Base preferred Results Coded Values Laboratory - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.method Base preferred Laboratory Techniques 📦0.2.0-ci This IG
Observation.component.​code Base preferred Results Laboratory Observation - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.component.​value[x]:valueCodeableConcept Base preferred Results Coded Values Laboratory - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation 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 Observation 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 Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation 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())
eu-lab-1 error Observation If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" (status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists()
eu-lab-2 error Observation If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists()
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Laboratory result for a simple test or for a panel/study
Constraints: eu-lab-1, eu-lab-2
... Slices for extension 0..* Extension Laboratory Test Kit
Slice: Unordered, Open by value:url
.... extension:supportingInfo 0..* Reference(Resource) Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
.... extension:triggeredBy-r5 0..* (Complex) Triggering observation(s)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
..... Slices for extension Content/Rules for all slices
...... extension:observation 1..1 Extension Triggering observation.
...... extension:type 1..1 Extension The type of trigger
.... extension:certifiedRefMaterialCodeable 0..* CodeableConcept Certified Reference Material: CodeableConcept
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialCodeable
Binding: Laboratory Certified Reference Material (example)
.... extension:certifiedRefMaterialIdentifer 0..* Identifier Certified Reference Material: Identifier
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer
.... extension:labTestKit 0..* Reference(Device) Device Laboratory Test Kit
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit
.... extension:value-r5 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D]] only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D
..... value[x] 1..1 Attachment Value of extension
... status 1..1 code Status of this observation (e.g. preliminary, final,...)
... Slices for category 1..* CodeableConceptIPS(2.0.0) Classification of type of observation
Slice: Unordered, Open by pattern:$this
.... category:laboratory 1..1 CodeableConcept Classification of type of observation
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: laboratory
.... category:studyType 0..* CodeableConcept The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: Laboratory Study Types (required)
.... category:specialty 0..* CodeableConcept The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)
Binding: Laboratory Specialty (required)
... subject 1..1 Reference(Patient: Animal | Patient (EU core) | Group | Device | Location) Who and/or what the observation is about
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... effective[x] 1..1 Clinically relevant time/time-period for observation
.... effective[x]All Types Content/Rules for all Types
..... Slices for extension Content/Rules for all slices
...... extension:data-absent-reason 0..1 code effective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued 0..1 instant Date/Time this result was made available
... performer 1..* Reference(PractitionerRole (EU core) | Practitioner (EU core) | Organization (IPS)(2.0.0) | CareTeam | Patient (EU core) | RelatedPerson) Who is responsible for the observation
.... Slices for extension Content/Rules for all slices
..... extension:performerFunction 0..* CodeableConcept Type of performance
URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction
Binding: Performer Function Codes (extensible)
... Slices for value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Actual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueString 0..1 string Actual result
.... value[x]:valueRange 0..1 RangeIPS Actual result
.... value[x]:valueRatio 0..1 RatioEuLab Actual result
.... value[x]:valueTime 0..1 time Actual result
.... value[x]:valueDateTime 0..1 dateTime Actual result
.... value[x]:valuePeriod 0..1 Period Actual result
.... value[x]:valueQuantity 0..1 QuantityEuLab Actual result
.... value[x]:valueCodeableConcept 0..1 CodeableConceptIPS(2.0.0) Actual result
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Set candidate
Results Presence Absence - SNOMED CT IPS Free Set candidate
Results Microorganism - SNOMED CT IPS Free Set candidate
... dataAbsentReason 0..1 CodeableConcept Provides a reason why the expected value is missing.
... interpretation 0..* CodeableConceptIPS(2.0.0) High, low, normal, etc.
... method 0..1 CodeableConceptIPS(2.0.0) How it was done
Binding: Laboratory Techniques (preferred)
... specimen 0..1 Reference(Specimen: Laboratory) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) Measuring instrument
... hasMember 0..* Reference(Observation Results: laboratory) Related resource that belongs to the Observation group
... component 0..* BackboneElement Laboratory result
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:value-r5 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D]] only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D
...... value[x] 1..1 Attachment Value of extension
.... code 1..1 CodeableConceptIPS(2.0.0) Type of component observation (code / type)
Binding: Results Laboratory Observation - IPS (preferred)
.... Slices for value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Actual component result
Slice: Unordered, Closed by type:$this
..... value[x]:valueString 0..1 string Actual component result
..... value[x]:valueRange 0..1 RangeIPS Actual component result
..... value[x]:valueRatio 0..1 RatioEuLab Actual component result
..... value[x]:valueTime 0..1 time Actual component result
..... value[x]:valueDateTime 0..1 dateTime Actual component result
..... value[x]:valuePeriod 0..1 Period Actual component result
..... value[x]:valueQuantity 0..1 QuantityEuLab Actual component result
..... value[x]:valueCodeableConcept 0..1 CodeableConceptIPS(2.0.0) Actual component result
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Set candidate
Results Presence Absence - SNOMED CT IPS Free Set candidate
Results Microorganism - SNOMED CT IPS Free Set candidate

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.category:studyType Base required Laboratory Study Types 📦0.2.0-ci This IG
Observation.category:specialty Base required Laboratory Specialty 📦0.2.0-ci This IG
Observation.code Base preferred Laboratory Code 📦0.2.0-ci This IG
Observation.value[x]:valueCodeableConcept Base preferred Results Coded Values Laboratory - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.method Base preferred Laboratory Techniques 📦0.2.0-ci This IG
Observation.component.​code Base preferred Results Laboratory Observation - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.component.​value[x]:valueCodeableConcept Base preferred Results Coded Values Laboratory - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1

Constraints

Id Grade Path(s) Description Expression
eu-lab-1 error Observation If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" (status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists()
eu-lab-2 error Observation If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Laboratory result for a simple test or for a panel/study
Constraints: obs-6, obs-7, eu-lab-1, eu-lab-2
... 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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 0..* Extension Laboratory Test Kit
Slice: Unordered, Open by value:url
.... extension:supportingInfo 0..* Reference(Resource) Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
.... extension:triggeredBy-r5 0..* (Complex) Triggering observation(s)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Closed by value:url
Constraints: ext-1
...... extension:observation 1..1 Extension Triggering observation.
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "observation"
....... value[x] 0..1 Reference() Triggering observation
...... extension:type 1..1 Extension The type of trigger
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "type"
....... value[x] 0..1 code reflex | repeat | re-run
Binding: R5_observation_triggeredbytype_for_R4 (0.0.1-snapshot-2) (required): The type of TriggeredBy Observation.
...... extension:reason 0..1 Extension Reason that the observation was triggered
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "reason"
....... value[x] 0..1 string Reason that the observation was triggered
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy"
..... value[x] 0..1 Value of extension
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
.... extension:certifiedRefMaterialCodeable 0..* CodeableConcept Certified Reference Material: CodeableConcept
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialCodeable
Binding: Laboratory Certified Reference Material (example)
.... extension:certifiedRefMaterialIdentifer 0..* Identifier Certified Reference Material: Identifier
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer
.... extension:labTestKit 0..* Reference(Device) Device Laboratory Test Kit
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit
.... extension:value-r5 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D]] only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]"
..... value[x] 1..1 Attachment Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!Σ 1..1 code Status of this observation (e.g. preliminary, final,...)
Binding: ObservationStatus (required): Codes providing the status of an observation.
... Slices for category 1..* CodeableConceptIPS(2.0.0) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
.... category:laboratory 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: laboratory
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... category:studyType 0..* CodeableConcept The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: Laboratory Study Types (required)
.... category:specialty 0..* CodeableConcept The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)
Binding: Laboratory Specialty (required)
... code Σ 1..1 CodeableConceptIPS(2.0.0) Type of observation (code / type)
Binding: Laboratory Code (preferred)
... subject Σ 1..1 Reference(Patient: Animal | Patient (EU core) | Group | Device | Location) Who and/or what the observation is about
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] Σ 1..1 Clinically relevant time/time-period for observation
.... effective[x]All Types Content/Rules for all Types
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:data-absent-reason 0..1 code effective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued Σ 0..1 instant Date/Time this result was made available
... performer Σ 1..* Reference(PractitionerRole (EU core) | Practitioner (EU core) | Organization (IPS)(2.0.0) | CareTeam | Patient (EU core) | RelatedPerson) Who is responsible for the observation
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:performerFunction 0..1 CodeableConcept Type of performance
URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction
Binding: Performer Function Codes (extensible)
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... Slices for value[x] ΣC 0..1 Actual result
Slice: Unordered, Open by type:$this
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... value[x]:valueString ΣC 0..1 string Actual result
.... value[x]:valueRange ΣC 0..1 RangeIPS Actual result
.... value[x]:valueRatio ΣC 0..1 RatioEuLab Actual result
.... value[x]:valueTime ΣC 0..1 time Actual result
.... value[x]:valueDateTime ΣC 0..1 dateTime Actual result
.... value[x]:valuePeriod ΣC 0..1 Period Actual result
.... value[x]:valueQuantity ΣC 0..1 QuantityEuLab Actual result
.... value[x]:valueCodeableConcept ΣC 0..1 CodeableConceptIPS(2.0.0) Actual result
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Set candidate
Results Presence Absence - SNOMED CT IPS Free Set candidate
Results Microorganism - SNOMED CT IPS Free Set candidate
... dataAbsentReason C 0..1 CodeableConcept Provides a reason why the expected value is missing.
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConceptIPS(2.0.0) High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConceptIPS(2.0.0) How it was done
Binding: Laboratory Techniques (preferred)
... specimen 0..1 Reference(Specimen: Laboratory) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) Measuring instrument
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... 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
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation Results: laboratory) Related resource that belongs to the Observation group
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
... component Σ 0..* BackboneElement Laboratory result
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:value-r5 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D]] only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value%5Bx%5D
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]"
...... value[x] 1..1 Attachment Value of extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConceptIPS(2.0.0) Type of component observation (code / type)
Binding: Results Laboratory Observation - IPS (preferred)
.... Slices for value[x] Σ 0..1 Actual component result
Slice: Unordered, Open by type:$this
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
..... value[x]:valueString Σ 0..1 string Actual component result
..... value[x]:valueRange Σ 0..1 RangeIPS Actual component result
..... value[x]:valueRatio Σ 0..1 RatioEuLab Actual component result
..... value[x]:valueTime Σ 0..1 time Actual component result
..... value[x]:valueDateTime Σ 0..1 dateTime Actual component result
..... value[x]:valuePeriod Σ 0..1 Period Actual component result
..... value[x]:valueQuantity Σ 0..1 QuantityEuLab Actual component result
..... value[x]:valueCodeableConcept Σ 0..1 CodeableConceptIPS(2.0.0) Actual component result
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Set candidate
Results Presence Absence - SNOMED CT IPS Free Set candidate
Results Microorganism - SNOMED CT IPS Free Set candidate
.... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.extension:triggeredBy-r5.​extension:type.value[x] Base required Cross-version VS for R5.TriggeredBytype for use in FHIR R4 📍0.0.1-snapshot-2 FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5 v0.0
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:laboratory Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.category:studyType Base required Laboratory Study Types 📦0.2.0-ci This IG
Observation.category:specialty Base required Laboratory Specialty 📦0.2.0-ci This IG
Observation.code Base preferred Laboratory Code 📦0.2.0-ci This IG
Observation.subject.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Observation.performer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Observation.value[x]:valueCodeableConcept Base preferred Results Coded Values Laboratory - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base preferred Laboratory Techniques 📦0.2.0-ci This IG
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base preferred Results Laboratory Observation - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.component.​value[x]:valueCodeableConcept Base preferred Results Coded Values Laboratory - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation 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 Observation 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 Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation 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())
eu-lab-1 error Observation If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component" (status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists()
eu-lab-2 error Observation If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason" component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists()
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Summary

Mandatory: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.category
  • The element 1 is sliced based on the value of Observation.value[x] (Closed)
  • The element 1 is sliced based on the value of Observation.component.value[x] (Closed)

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron