UK Core Observation - Interweave Implementation Guide v0.1.0

Interweave Implementation Guide
0.1.0 - ci-build United Kingdom flag

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.

Resource Profile: UK Core Observation

Official URL: https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation Version: 2.5.0
Active as of 2023-12-12 Computable Name: UKCoreObservation

Copyright/Legal: Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.

This profile defines the UK constraints and extensions on the International FHIR resource Observation.

This profile allows exchange of information of Measurements and simple assertions made about an individual, device or other subject.

Note: this profile SHALL NOT be used where a more specific UK Core profile exists.

Usage:

Formal Views of Profile Content

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

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* Observation Measurements and simple assertions
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... triggeredByR5 0..* (Complex) Triggering observation(s). This is a R5 backport.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
..... Slices for extension Content/Rules for all slices
...... extension:observation 1..1 Extension Extension
....... value[x] 1..1 Reference(Observation) Triggering observation.
...... extension:type 1..1 Extension Extension
....... value[x] 1..1 code The type of trigger. Reflex | Repeat | Re-run
...... extension:reason 0..1 Extension Extension
....... value[x] 1..1 string Reason that the observation was triggered.
.... bodyStructureR5 0..1 Reference(BodyStructure) Observed body structure. This is a R5 backport.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure
... status S 1..1 code The status of the result value.
... category S 0..* CodeableConcept A code that classifies the general type of observation being made.
... subject S 0..1 Reference(Patient | Group | Device | Location) Who and / or what the observation is about.
... effective[x] S 0..1 dateTime, Period, Timing, instant A clinically relevant time / time-period for observation.
... performer S 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation.
... value[x] S 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period The actual observed result.
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality.

... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (preferred): Methods for simple observations.

... component S 0..* BackboneElement Component / sub results.
.... code 1..1 CodeableConcept Type of component observation (code / type)
Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.codepreferredUKCoreObservationType
https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType
from this IG
Observation.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodpreferredObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.component.codepreferredUKCoreObservationType
https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... triggeredByR5 0..* (Complex) Triggering observation(s). This is a R5 backport.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:observation 1..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "observation"
....... value[x] 1..1 Reference(Observation) Triggering observation.
...... extension:type 1..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "type"
....... value[x] 1..1 code ​The type of trigger. Reflex | Repeat | Re-run
Binding: observation-triggeredbytype (required)
...... extension:reason 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "reason"
....... value[x] 1..1 string Reason that the observation was triggered.
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy"
.... bodyStructureR5 0..1 Reference(BodyStructure) Observed body structure. This is a R5 backport.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... category S 0..* CodeableConcept A code that classifies the general type of observation being made.
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


... code SΣ 1..1 CodeableConcept The type of observation (code / type).
Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation

... subject SΣ 0..1 Reference(Patient | Group | Device | Location) Who and / or what the observation is about.
... effective[x] SΣ 0..1 A clinically relevant time / time-period for observation.
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation.
... value[x] SΣC 0..1 The actual observed result.
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality.

... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (preferred): Methods for simple observations.

... component SΣ 0..* BackboneElement Component / sub results.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.extension:triggeredByR5.extension:type.value[x]requiredhttp://hl7.org/fhir/ValueSet/observation-triggeredbytype
http://hl7.org/fhir/ValueSet/observation-triggeredbytype
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codepreferredUKCoreObservationType
https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType
from this IG
Observation.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodpreferredObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.component.codepreferredUKCoreObservationType
https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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 & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... triggeredByR5 0..* (Complex) Triggering observation(s). This is a R5 backport.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:observation 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "observation"
....... value[x] 1..1 Reference(Observation) Triggering observation.
...... extension:type 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "type"
....... value[x] 1..1 code ​The type of trigger. Reflex | Repeat | Re-run
Binding: observation-triggeredbytype (required)
...... extension:reason 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "reason"
....... value[x] 1..1 string Reason that the observation was triggered.
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy"
.... bodyStructureR5 0..1 Reference(BodyStructure) Observed body structure. This is a R5 backport.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure
... 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 ?!SΣ 1..1 code The status of the result value.
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category S 0..* CodeableConcept A code that classifies the general type of observation being made.
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


... code SΣ 1..1 CodeableConcept The type of observation (code / type).
Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation

... subject SΣ 0..1 Reference(Patient | Group | Device | Location) Who and / or what the observation is about.
... 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] SΣ 0..1 A clinically relevant time / time-period for observation.
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Σ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation.
... value[x] SΣC 0..1 The actual observed result.
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... dataAbsentReason C 0..1 CodeableConcept Why the 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.


... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality.

... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (preferred): Methods for simple observations.

... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... 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 Low Range, if relevant
.... high C 0..1 SimpleQuantity 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 | QuestionnaireResponse | MolecularSequence) 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 SΣ 0..* BackboneElement Component / sub 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
.... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation

.... value[x] Σ 0..1 Actual component result
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
.... 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

PathConformanceValueSetURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.extension:triggeredByR5.extension:type.value[x]requiredhttp://hl7.org/fhir/ValueSet/observation-triggeredbytype
http://hl7.org/fhir/ValueSet/observation-triggeredbytype
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codepreferredUKCoreObservationType
https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType
from this IG
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodpreferredObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codepreferredUKCoreObservationType
https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType
from this IG
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()

This structure is derived from Observation

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* Observation Measurements and simple assertions
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... triggeredByR5 0..* (Complex) Triggering observation(s). This is a R5 backport.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
..... Slices for extension Content/Rules for all slices
...... extension:observation 1..1 Extension Extension
....... value[x] 1..1 Reference(Observation) Triggering observation.
...... extension:type 1..1 Extension Extension
....... value[x] 1..1 code The type of trigger. Reflex | Repeat | Re-run
...... extension:reason 0..1 Extension Extension
....... value[x] 1..1 string Reason that the observation was triggered.
.... bodyStructureR5 0..1 Reference(BodyStructure) Observed body structure. This is a R5 backport.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure
... status S 1..1 code The status of the result value.
... category S 0..* CodeableConcept A code that classifies the general type of observation being made.
... subject S 0..1 Reference(Patient | Group | Device | Location) Who and / or what the observation is about.
... effective[x] S 0..1 dateTime, Period, Timing, instant A clinically relevant time / time-period for observation.
... performer S 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation.
... value[x] S 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period The actual observed result.
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality.

... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (preferred): Methods for simple observations.

... component S 0..* BackboneElement Component / sub results.
.... code 1..1 CodeableConcept Type of component observation (code / type)
Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.codepreferredUKCoreObservationType
https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType
from this IG
Observation.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodpreferredObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.component.codepreferredUKCoreObservationType
https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... triggeredByR5 0..* (Complex) Triggering observation(s). This is a R5 backport.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:observation 1..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "observation"
....... value[x] 1..1 Reference(Observation) Triggering observation.
...... extension:type 1..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "type"
....... value[x] 1..1 code ​The type of trigger. Reflex | Repeat | Re-run
Binding: observation-triggeredbytype (required)
...... extension:reason 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "reason"
....... value[x] 1..1 string Reason that the observation was triggered.
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy"
.... bodyStructureR5 0..1 Reference(BodyStructure) Observed body structure. This is a R5 backport.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... category S 0..* CodeableConcept A code that classifies the general type of observation being made.
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


... code SΣ 1..1 CodeableConcept The type of observation (code / type).
Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation

... subject SΣ 0..1 Reference(Patient | Group | Device | Location) Who and / or what the observation is about.
... effective[x] SΣ 0..1 A clinically relevant time / time-period for observation.
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation.
... value[x] SΣC 0..1 The actual observed result.
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality.

... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (preferred): Methods for simple observations.

... component SΣ 0..* BackboneElement Component / sub results.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.extension:triggeredByR5.extension:type.value[x]requiredhttp://hl7.org/fhir/ValueSet/observation-triggeredbytype
http://hl7.org/fhir/ValueSet/observation-triggeredbytype
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codepreferredUKCoreObservationType
https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType
from this IG
Observation.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodpreferredObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.component.codepreferredUKCoreObservationType
https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... triggeredByR5 0..* (Complex) Triggering observation(s). This is a R5 backport.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:observation 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "observation"
....... value[x] 1..1 Reference(Observation) Triggering observation.
...... extension:type 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "type"
....... value[x] 1..1 code ​The type of trigger. Reflex | Repeat | Re-run
Binding: observation-triggeredbytype (required)
...... extension:reason 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "reason"
....... value[x] 1..1 string Reason that the observation was triggered.
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy"
.... bodyStructureR5 0..1 Reference(BodyStructure) Observed body structure. This is a R5 backport.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure
... 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 ?!SΣ 1..1 code The status of the result value.
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category S 0..* CodeableConcept A code that classifies the general type of observation being made.
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


... code SΣ 1..1 CodeableConcept The type of observation (code / type).
Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation

... subject SΣ 0..1 Reference(Patient | Group | Device | Location) Who and / or what the observation is about.
... 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] SΣ 0..1 A clinically relevant time / time-period for observation.
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Σ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation.
... value[x] SΣC 0..1 The actual observed result.
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... dataAbsentReason C 0..1 CodeableConcept Why the 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.


... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality.

... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (preferred): Methods for simple observations.

... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... 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 Low Range, if relevant
.... high C 0..1 SimpleQuantity 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 | QuestionnaireResponse | MolecularSequence) 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 SΣ 0..* BackboneElement Component / sub 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
.... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: UK Core Observation Type (preferred): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation

.... value[x] Σ 0..1 Actual component result
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
.... 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

PathConformanceValueSetURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.extension:triggeredByR5.extension:type.value[x]requiredhttp://hl7.org/fhir/ValueSet/observation-triggeredbytype
http://hl7.org/fhir/ValueSet/observation-triggeredbytype
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codepreferredUKCoreObservationType
https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType
from this IG
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodpreferredObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codepreferredUKCoreObservationType
https://fhir.hl7.org.uk/ValueSet/UKCore-ObservationType
from this IG
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()

This structure is derived from Observation

 

Other representations of profile: CSV, Excel, Schematron