Clinical Core
1.4.0 - STU1 Belgium flag

Clinical Core, published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 1.4.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/core-clinical/ and changes regularly. See the Directory of published versions

Resource Profile: BeScoreResult

Official URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-scoreresult Version: 1.4.0
Active as of 2021-01-10 Maturity Level: 1 Computable Name: BeScoreResult
Other Identifiers: OID:2.16.840.1.113883.4.642.40.200.5.42.18

To support the standard exchange of scores such as pain assessment scores, or risk score, etc

Usages:

  • This Profile is not used by any profiles in this Specification

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: doco
Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for extension.extension:recordedDate This element must be supported. 1..1 dateTime RecordedDate
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorded-date
Observation.Slices for extension.extension:recorder This element must be supported. 1..1 (Complex) Recorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
Observation.Slices for extension.extension:recorder.extension 0..0 Extension
Slice: Unordered, Open by value:url
Observation.Slices for extension.extension:recorder.url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder"
Observation.Slices for extension.extension:recorder.Slices for value[x] 0..1 Reference(BePractitioner | BePractitionerRole | BeOrganization) The responsability for a recording can only be taken by a natural person. The use of BeOrganisation is therefore discouraged. Use the organisation in BePractionerRole instead.
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for extension.extension:recorder.Slices for value[x] Content/Rules for all slices
Observation.Slices for extension.extension:recorder.Slices for value[x].value[x]:valueReference 0..1 Reference(BePatient | BePractitioner | BeOrganization | BePractitionerRole) Value of extension
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.identifier This element must be supported. This element is included in summaries. 1..* Identifier Business Identifier for observation
Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.category This element must be supported. 0..* CodeableConcept The high-level group or category of the score - e.g. 'Risk score' or 'Pain score'
Binding: Score Category ValueSet (required)
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept The code of the score that is being calculated.
Binding: Score ValueSet (required)
Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(BePatient | Group) The patient that this score refers to
Observation.Slices for effective[x] This element is included in summaries. 1..1 Period Clinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for effective[x].effective[x]:effectivePeriod This element must be supported. This element is included in summaries. 1..1 Period The time period that the score refers to.
Observation.issued This element must be supported. This element is included in summaries. 0..1 instant Date/Time this version was made available
Observation.performer This element must be supported. This element is included in summaries. 0..* Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization) The care provider that took the assessment
Observation.value[x] This element must be supported. This element is included in summaries. C 0..1 The actual score value.
Observation.value[x].valueQuantity Quantity
Observation.value[x].valueCodeableConcept CodeableConcept
Observation.value[x].valueString string
Observation.value[x].valueBoolean boolean
Observation.value[x].valueInteger integer
Observation.value[x].valueRange Range
Observation.value[x].valueRatio Ratio
Observation.value[x].valueSampledData SampledData
Observation.value[x].valueTime time
Observation.value[x].valueDateTime dateTime
Observation.value[x].valuePeriod Period
Observation.interpretation This element must be supported. 0..* CodeableConcept The interpretation of the result from the value. For example if value is 12, the interpretation can be 'elevated'
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.note This element must be supported. 0..* Annotation Free text remark
Observation.bodySite This element must be supported. 0..1 CodeableConcept The body site to which the score applies, when applicable
Binding: Body Site ValueSet (required)
Observation.bodySite.Slices for extension Content/Rules for all slices
Observation.bodySite.Slices for extension.extension:laterality This element must be supported. 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality ValueSet (required)
Observation.bodySite.Slices for extension.extension:topography This element must be supported. 0..1 CodeableConcept BeExtBodyTopography
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-body-topography
Binding: Body Topography ValueSet (preferred)
Observation.method This element must be supported. 0..1 CodeableConcept How the observation was obtained
Binding: ObservationMethods (example): Methods for simple observations.
Observation.referenceRange This element must be supported. C 0..1 BackboneElement The different ranges of the value
Constraints: obs-3
Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.hasMember This element must be supported. This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Groups the observations that make up this assessment scale
Observation.derivedFrom This element must be supported. This element is included in summaries. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) The source values for the assessment - for example a QuestionnaireResponse
Observation.component This element must be supported. This element is included in summaries. 0..* BackboneElement A sub-score or component of the assessment scale
Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.component.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Identifies the sub-score or component of the assessment scale
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Observation.component.value[x] This element must be supported. This element is included in summaries. 0..1 The value or score of this component
Observation.component.value[x].valueQuantity Quantity
Observation.component.value[x].valueCodeableConcept CodeableConcept
Observation.component.value[x].valueString string
Observation.component.value[x].valueBoolean boolean
Observation.component.value[x].valueInteger integer
Observation.component.value[x].valueRange Range
Observation.component.value[x].valueRatio Ratio
Observation.component.value[x].valueSampledData SampledData
Observation.component.value[x].valueTime time
Observation.component.value[x].valueDateTime dateTime
Observation.component.value[x].valuePeriod Period
Observation.component.interpretation This element must be supported. 0..* CodeableConcept The clinical interpretation of the sub-score
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.

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 required Score Category ValueSet 📦1.4.0 This IG
Observation.code Base required Score ValueSet 📦1.4.0 This IG
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base required Body Site ValueSet 📦1.4.0 This IG
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍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())
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()

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation 0..* Observation Measurements and simple assertions
Observation.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for extension.extension:recordedDate This element must be supported. 1..1 dateTime RecordedDate
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorded-date
Observation.Slices for extension.extension:recorder This element must be supported. 1..1 (Complex) Recorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
Observation.Slices for extension.extension:recorder.value[x] 0..1 Reference(BePractitioner | BePractitionerRole | BeOrganization) The responsability for a recording can only be taken by a natural person. The use of BeOrganisation is therefore discouraged. Use the organisation in BePractionerRole instead.
Observation.identifier This element must be supported. 1..* Identifier Business Identifier for observation
Observation.status This element must be supported. 1..1 code registered | preliminary | final | amended +
Observation.code This element must be supported. 1..1 CodeableConcept The code of the score that is being calculated.
Binding: Score ValueSet (required)
Observation.subject This element must be supported. 1..1 Reference(BePatient | Group) The patient that this score refers to
Observation.Slices for effective[x] 1..1 Period Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for effective[x].effective[x]:effectivePeriod This element must be supported. 1..1 Period The time period that the score refers to.
Observation.issued This element must be supported. 0..1 instant Date/Time this version was made available
Observation.performer This element must be supported. 0..* Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization) The care provider that took the assessment
Observation.value[x] This element must be supported. 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period The actual score value.
Observation.interpretation This element must be supported. 0..* CodeableConcept The interpretation of the result from the value. For example if value is 12, the interpretation can be 'elevated'
Observation.note This element must be supported. 0..* Annotation Free text remark
Observation.bodySite This element must be supported. 0..1 CodeableConcept The body site to which the score applies, when applicable
Binding: Body Site ValueSet (required)
Observation.bodySite.Slices for extension Content/Rules for all slices
Observation.bodySite.Slices for extension.extension:laterality This element must be supported. 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality ValueSet (required)
Observation.bodySite.Slices for extension.extension:topography This element must be supported. 0..1 CodeableConcept BeExtBodyTopography
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-body-topography
Binding: Body Topography ValueSet (preferred)
Observation.method This element must be supported. 0..1 CodeableConcept How the observation was obtained
Observation.referenceRange This element must be supported. 0..1 BackboneElement The different ranges of the value
Observation.hasMember This element must be supported. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Groups the observations that make up this assessment scale
Observation.derivedFrom This element must be supported. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) The source values for the assessment - for example a QuestionnaireResponse
Observation.component This element must be supported. 0..* BackboneElement A sub-score or component of the assessment scale
Observation.component.code This element must be supported. 1..1 CodeableConcept Identifies the sub-score or component of the assessment scale
Observation.component.value[x] This element must be supported. 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period The value or score of this component
Observation.component.interpretation This element must be supported. 0..* CodeableConcept The clinical interpretation of the sub-score

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.category Base required Score Category ValueSet 📦1.4.0 This IG
Observation.code Base required Score ValueSet 📦1.4.0 This IG
Observation.bodySite Base required Body Site ValueSet 📦1.4.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7
Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Observation.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
Observation.contained 0..* Resource Contained, inline Resources
Observation.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for extension.extension:recordedDate This element must be supported. 1..1 dateTime RecordedDate
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorded-date
Observation.Slices for extension.extension:recorder This element must be supported. 1..1 (Complex) Recorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
Observation.Slices for extension.extension:recorder.id 0..1 string Unique id for inter-element referencing
Observation.Slices for extension.extension:recorder.extension 0..0 Extension
Slice: Unordered, Open by value:url
Observation.Slices for extension.extension:recorder.url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder"
Observation.Slices for extension.extension:recorder.Slices for value[x] 0..1 Reference(BePractitioner | BePractitionerRole | BeOrganization) The responsability for a recording can only be taken by a natural person. The use of BeOrganisation is therefore discouraged. Use the organisation in BePractionerRole instead.
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for extension.extension:recorder.Slices for value[x] Content/Rules for all slices
Observation.Slices for extension.extension:recorder.Slices for value[x].value[x]:valueReference 0..1 Reference(BePatient | BePractitioner | BeOrganization | BePractitionerRole) Value of extension
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.identifier This element must be supported. This element is included in summaries. 1..* Identifier Business Identifier for observation
Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.category This element must be supported. 0..* CodeableConcept The high-level group or category of the score - e.g. 'Risk score' or 'Pain score'
Binding: Score Category ValueSet (required)
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept The code of the score that is being calculated.
Binding: Score ValueSet (required)
Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(BePatient | Group) The patient that this score refers to
Observation.focus This element is included in summaries. 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made
Observation.Slices for effective[x] This element is included in summaries. 1..1 Period Clinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for effective[x].effective[x]:effectivePeriod This element must be supported. This element is included in summaries. 1..1 Period The time period that the score refers to.
Observation.issued This element must be supported. This element is included in summaries. 0..1 instant Date/Time this version was made available
Observation.performer This element must be supported. This element is included in summaries. 0..* Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization) The care provider that took the assessment
Observation.value[x] This element must be supported. This element is included in summaries. C 0..1 The actual score value.
Observation.value[x].valueQuantity Quantity
Observation.value[x].valueCodeableConcept CodeableConcept
Observation.value[x].valueString string
Observation.value[x].valueBoolean boolean
Observation.value[x].valueInteger integer
Observation.value[x].valueRange Range
Observation.value[x].valueRatio Ratio
Observation.value[x].valueSampledData SampledData
Observation.value[x].valueTime time
Observation.value[x].valueDateTime dateTime
Observation.value[x].valuePeriod Period
Observation.dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.interpretation This element must be supported. 0..* CodeableConcept The interpretation of the result from the value. For example if value is 12, the interpretation can be 'elevated'
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.note This element must be supported. 0..* Annotation Free text remark
Observation.bodySite This element must be supported. 0..1 CodeableConcept The body site to which the score applies, when applicable
Binding: Body Site ValueSet (required)
Observation.bodySite.id 0..1 string Unique id for inter-element referencing
Observation.bodySite.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.bodySite.Slices for extension.extension:laterality This element must be supported. 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality ValueSet (required)
Observation.bodySite.Slices for extension.extension:topography This element must be supported. 0..1 CodeableConcept BeExtBodyTopography
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-body-topography
Binding: Body Topography ValueSet (preferred)
Observation.bodySite.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Observation.bodySite.text This element is included in summaries. 0..1 string Plain text representation of the concept
Observation.method This element must be supported. 0..1 CodeableConcept How the observation was obtained
Binding: ObservationMethods (example): Methods for simple observations.
Observation.specimen 0..1 Reference(Specimen) Specimen used for this observation
Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
Observation.referenceRange This element must be supported. C 0..1 BackboneElement The different ranges of the value
Constraints: obs-3
Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.referenceRange.low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
Constraints: sqty-1
Observation.referenceRange.high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
Constraints: sqty-1
Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
Observation.referenceRange.text 0..1 string Text based reference range in an observation
Observation.hasMember This element must be supported. This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Groups the observations that make up this assessment scale
Observation.derivedFrom This element must be supported. This element is included in summaries. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) The source values for the assessment - for example a QuestionnaireResponse
Observation.component This element must be supported. This element is included in summaries. 0..* BackboneElement A sub-score or component of the assessment scale
Observation.component.id 0..1 string Unique id for inter-element referencing
Observation.component.extension 0..* Extension Additional content defined by implementations
Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.component.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Identifies the sub-score or component of the assessment scale
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Observation.component.value[x] This element must be supported. This element is included in summaries. 0..1 The value or score of this component
Observation.component.value[x].valueQuantity Quantity
Observation.component.value[x].valueCodeableConcept CodeableConcept
Observation.component.value[x].valueString string
Observation.component.value[x].valueBoolean boolean
Observation.component.value[x].valueInteger integer
Observation.component.value[x].valueRange Range
Observation.component.value[x].valueRatio Ratio
Observation.component.value[x].valueSampledData SampledData
Observation.component.value[x].valueTime time
Observation.component.value[x].valueDateTime dateTime
Observation.component.value[x].valuePeriod Period
Observation.component.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.component.interpretation This element must be supported. 0..* CodeableConcept The clinical interpretation of the sub-score
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.component.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.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base required Score Category ValueSet 📦1.4.0 This IG
Observation.code Base required Score ValueSet 📦1.4.0 This IG
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 required Body Site ValueSet 📦1.4.0 This IG
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
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 example LOINC Codes 📍4.0.1 FHIR Std.
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())
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()
sqty-1 error Observation.referenceRange.low, Observation.referenceRange.high The comparator is not used on a SimpleQuantity comparator.empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for extension.extension:recordedDate This element must be supported. 1..1 dateTime RecordedDate
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorded-date
Observation.Slices for extension.extension:recorder This element must be supported. 1..1 (Complex) Recorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
Observation.Slices for extension.extension:recorder.extension 0..0 Extension
Slice: Unordered, Open by value:url
Observation.Slices for extension.extension:recorder.url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder"
Observation.Slices for extension.extension:recorder.Slices for value[x] 0..1 Reference(BePractitioner | BePractitionerRole | BeOrganization) The responsability for a recording can only be taken by a natural person. The use of BeOrganisation is therefore discouraged. Use the organisation in BePractionerRole instead.
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for extension.extension:recorder.Slices for value[x] Content/Rules for all slices
Observation.Slices for extension.extension:recorder.Slices for value[x].value[x]:valueReference 0..1 Reference(BePatient | BePractitioner | BeOrganization | BePractitionerRole) Value of extension
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.identifier This element must be supported. This element is included in summaries. 1..* Identifier Business Identifier for observation
Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.category This element must be supported. 0..* CodeableConcept The high-level group or category of the score - e.g. 'Risk score' or 'Pain score'
Binding: Score Category ValueSet (required)
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept The code of the score that is being calculated.
Binding: Score ValueSet (required)
Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(BePatient | Group) The patient that this score refers to
Observation.Slices for effective[x] This element is included in summaries. 1..1 Period Clinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for effective[x].effective[x]:effectivePeriod This element must be supported. This element is included in summaries. 1..1 Period The time period that the score refers to.
Observation.issued This element must be supported. This element is included in summaries. 0..1 instant Date/Time this version was made available
Observation.performer This element must be supported. This element is included in summaries. 0..* Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization) The care provider that took the assessment
Observation.value[x] This element must be supported. This element is included in summaries. C 0..1 The actual score value.
Observation.value[x].valueQuantity Quantity
Observation.value[x].valueCodeableConcept CodeableConcept
Observation.value[x].valueString string
Observation.value[x].valueBoolean boolean
Observation.value[x].valueInteger integer
Observation.value[x].valueRange Range
Observation.value[x].valueRatio Ratio
Observation.value[x].valueSampledData SampledData
Observation.value[x].valueTime time
Observation.value[x].valueDateTime dateTime
Observation.value[x].valuePeriod Period
Observation.interpretation This element must be supported. 0..* CodeableConcept The interpretation of the result from the value. For example if value is 12, the interpretation can be 'elevated'
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.note This element must be supported. 0..* Annotation Free text remark
Observation.bodySite This element must be supported. 0..1 CodeableConcept The body site to which the score applies, when applicable
Binding: Body Site ValueSet (required)
Observation.bodySite.Slices for extension Content/Rules for all slices
Observation.bodySite.Slices for extension.extension:laterality This element must be supported. 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality ValueSet (required)
Observation.bodySite.Slices for extension.extension:topography This element must be supported. 0..1 CodeableConcept BeExtBodyTopography
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-body-topography
Binding: Body Topography ValueSet (preferred)
Observation.method This element must be supported. 0..1 CodeableConcept How the observation was obtained
Binding: ObservationMethods (example): Methods for simple observations.
Observation.referenceRange This element must be supported. C 0..1 BackboneElement The different ranges of the value
Constraints: obs-3
Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.hasMember This element must be supported. This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Groups the observations that make up this assessment scale
Observation.derivedFrom This element must be supported. This element is included in summaries. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) The source values for the assessment - for example a QuestionnaireResponse
Observation.component This element must be supported. This element is included in summaries. 0..* BackboneElement A sub-score or component of the assessment scale
Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.component.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Identifies the sub-score or component of the assessment scale
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Observation.component.value[x] This element must be supported. This element is included in summaries. 0..1 The value or score of this component
Observation.component.value[x].valueQuantity Quantity
Observation.component.value[x].valueCodeableConcept CodeableConcept
Observation.component.value[x].valueString string
Observation.component.value[x].valueBoolean boolean
Observation.component.value[x].valueInteger integer
Observation.component.value[x].valueRange Range
Observation.component.value[x].valueRatio Ratio
Observation.component.value[x].valueSampledData SampledData
Observation.component.value[x].valueTime time
Observation.component.value[x].valueDateTime dateTime
Observation.component.value[x].valuePeriod Period
Observation.component.interpretation This element must be supported. 0..* CodeableConcept The clinical interpretation of the sub-score
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.

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 required Score Category ValueSet 📦1.4.0 This IG
Observation.code Base required Score ValueSet 📦1.4.0 This IG
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base required Body Site ValueSet 📦1.4.0 This IG
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍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())
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()

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation 0..* Observation Measurements and simple assertions
Observation.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for extension.extension:recordedDate This element must be supported. 1..1 dateTime RecordedDate
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorded-date
Observation.Slices for extension.extension:recorder This element must be supported. 1..1 (Complex) Recorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
Observation.Slices for extension.extension:recorder.value[x] 0..1 Reference(BePractitioner | BePractitionerRole | BeOrganization) The responsability for a recording can only be taken by a natural person. The use of BeOrganisation is therefore discouraged. Use the organisation in BePractionerRole instead.
Observation.identifier This element must be supported. 1..* Identifier Business Identifier for observation
Observation.status This element must be supported. 1..1 code registered | preliminary | final | amended +
Observation.category This element must be supported. 0..* CodeableConcept The high-level group or category of the score - e.g. 'Risk score' or 'Pain score'
Binding: Score Category ValueSet (required)
Observation.code This element must be supported. 1..1 CodeableConcept The code of the score that is being calculated.
Binding: Score ValueSet (required)
Observation.subject This element must be supported. 1..1 Reference(BePatient | Group) The patient that this score refers to
Observation.Slices for effective[x] 1..1 Period Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for effective[x].effective[x]:effectivePeriod This element must be supported. 1..1 Period The time period that the score refers to.
Observation.issued This element must be supported. 0..1 instant Date/Time this version was made available
Observation.performer This element must be supported. 0..* Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization) The care provider that took the assessment
Observation.value[x] This element must be supported. 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period The actual score value.
Observation.interpretation This element must be supported. 0..* CodeableConcept The interpretation of the result from the value. For example if value is 12, the interpretation can be 'elevated'
Observation.note This element must be supported. 0..* Annotation Free text remark
Observation.bodySite This element must be supported. 0..1 CodeableConcept The body site to which the score applies, when applicable
Binding: Body Site ValueSet (required)
Observation.bodySite.Slices for extension Content/Rules for all slices
Observation.bodySite.Slices for extension.extension:laterality This element must be supported. 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality ValueSet (required)
Observation.bodySite.Slices for extension.extension:topography This element must be supported. 0..1 CodeableConcept BeExtBodyTopography
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-body-topography
Binding: Body Topography ValueSet (preferred)
Observation.method This element must be supported. 0..1 CodeableConcept How the observation was obtained
Observation.referenceRange This element must be supported. 0..1 BackboneElement The different ranges of the value
Observation.hasMember This element must be supported. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Groups the observations that make up this assessment scale
Observation.derivedFrom This element must be supported. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) The source values for the assessment - for example a QuestionnaireResponse
Observation.component This element must be supported. 0..* BackboneElement A sub-score or component of the assessment scale
Observation.component.code This element must be supported. 1..1 CodeableConcept Identifies the sub-score or component of the assessment scale
Observation.component.value[x] This element must be supported. 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period The value or score of this component
Observation.component.interpretation This element must be supported. 0..* CodeableConcept The clinical interpretation of the sub-score

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.category Base required Score Category ValueSet 📦1.4.0 This IG
Observation.code Base required Score ValueSet 📦1.4.0 This IG
Observation.bodySite Base required Body Site ValueSet 📦1.4.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7
Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Observation.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
Observation.contained 0..* Resource Contained, inline Resources
Observation.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for extension.extension:recordedDate This element must be supported. 1..1 dateTime RecordedDate
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorded-date
Observation.Slices for extension.extension:recorder This element must be supported. 1..1 (Complex) Recorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
Observation.Slices for extension.extension:recorder.id 0..1 string Unique id for inter-element referencing
Observation.Slices for extension.extension:recorder.extension 0..0 Extension
Slice: Unordered, Open by value:url
Observation.Slices for extension.extension:recorder.url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder"
Observation.Slices for extension.extension:recorder.Slices for value[x] 0..1 Reference(BePractitioner | BePractitionerRole | BeOrganization) The responsability for a recording can only be taken by a natural person. The use of BeOrganisation is therefore discouraged. Use the organisation in BePractionerRole instead.
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for extension.extension:recorder.Slices for value[x] Content/Rules for all slices
Observation.Slices for extension.extension:recorder.Slices for value[x].value[x]:valueReference 0..1 Reference(BePatient | BePractitioner | BeOrganization | BePractitionerRole) Value of extension
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.identifier This element must be supported. This element is included in summaries. 1..* Identifier Business Identifier for observation
Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.category This element must be supported. 0..* CodeableConcept The high-level group or category of the score - e.g. 'Risk score' or 'Pain score'
Binding: Score Category ValueSet (required)
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept The code of the score that is being calculated.
Binding: Score ValueSet (required)
Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(BePatient | Group) The patient that this score refers to
Observation.focus This element is included in summaries. 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made
Observation.Slices for effective[x] This element is included in summaries. 1..1 Period Clinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for effective[x].effective[x]:effectivePeriod This element must be supported. This element is included in summaries. 1..1 Period The time period that the score refers to.
Observation.issued This element must be supported. This element is included in summaries. 0..1 instant Date/Time this version was made available
Observation.performer This element must be supported. This element is included in summaries. 0..* Reference(BePatient | BePractitioner | BePractitionerRole | BeOrganization) The care provider that took the assessment
Observation.value[x] This element must be supported. This element is included in summaries. C 0..1 The actual score value.
Observation.value[x].valueQuantity Quantity
Observation.value[x].valueCodeableConcept CodeableConcept
Observation.value[x].valueString string
Observation.value[x].valueBoolean boolean
Observation.value[x].valueInteger integer
Observation.value[x].valueRange Range
Observation.value[x].valueRatio Ratio
Observation.value[x].valueSampledData SampledData
Observation.value[x].valueTime time
Observation.value[x].valueDateTime dateTime
Observation.value[x].valuePeriod Period
Observation.dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.interpretation This element must be supported. 0..* CodeableConcept The interpretation of the result from the value. For example if value is 12, the interpretation can be 'elevated'
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.note This element must be supported. 0..* Annotation Free text remark
Observation.bodySite This element must be supported. 0..1 CodeableConcept The body site to which the score applies, when applicable
Binding: Body Site ValueSet (required)
Observation.bodySite.id 0..1 string Unique id for inter-element referencing
Observation.bodySite.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Observation.bodySite.Slices for extension.extension:laterality This element must be supported. 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality ValueSet (required)
Observation.bodySite.Slices for extension.extension:topography This element must be supported. 0..1 CodeableConcept BeExtBodyTopography
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-body-topography
Binding: Body Topography ValueSet (preferred)
Observation.bodySite.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Observation.bodySite.text This element is included in summaries. 0..1 string Plain text representation of the concept
Observation.method This element must be supported. 0..1 CodeableConcept How the observation was obtained
Binding: ObservationMethods (example): Methods for simple observations.
Observation.specimen 0..1 Reference(Specimen) Specimen used for this observation
Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
Observation.referenceRange This element must be supported. C 0..1 BackboneElement The different ranges of the value
Constraints: obs-3
Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.referenceRange.low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
Constraints: sqty-1
Observation.referenceRange.high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
Constraints: sqty-1
Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
Observation.referenceRange.text 0..1 string Text based reference range in an observation
Observation.hasMember This element must be supported. This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Groups the observations that make up this assessment scale
Observation.derivedFrom This element must be supported. This element is included in summaries. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) The source values for the assessment - for example a QuestionnaireResponse
Observation.component This element must be supported. This element is included in summaries. 0..* BackboneElement A sub-score or component of the assessment scale
Observation.component.id 0..1 string Unique id for inter-element referencing
Observation.component.extension 0..* Extension Additional content defined by implementations
Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.component.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Identifies the sub-score or component of the assessment scale
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Observation.component.value[x] This element must be supported. This element is included in summaries. 0..1 The value or score of this component
Observation.component.value[x].valueQuantity Quantity
Observation.component.value[x].valueCodeableConcept CodeableConcept
Observation.component.value[x].valueString string
Observation.component.value[x].valueBoolean boolean
Observation.component.value[x].valueInteger integer
Observation.component.value[x].valueRange Range
Observation.component.value[x].valueRatio Ratio
Observation.component.value[x].valueSampledData SampledData
Observation.component.value[x].valueTime time
Observation.component.value[x].valueDateTime dateTime
Observation.component.value[x].valuePeriod Period
Observation.component.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.component.interpretation This element must be supported. 0..* CodeableConcept The clinical interpretation of the sub-score
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.component.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.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base required Score Category ValueSet 📦1.4.0 This IG
Observation.code Base required Score ValueSet 📦1.4.0 This IG
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 required Body Site ValueSet 📦1.4.0 This IG
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
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 example LOINC Codes 📍4.0.1 FHIR Std.
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())
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()
sqty-1 error Observation.referenceRange.low, Observation.referenceRange.high The comparator is not used on a SimpleQuantity comparator.empty()

 

Other representations of profile: CSV, Excel, Schematron