OneAquaHealth Project
0.1.0-ci-build - ci-build 150

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

Resource Profile: Observation: OAH indicators with Components

Official URL: http://hl7.eu/fhir/ig/oah/StructureDefinition/observation-with-component-oah Version: 0.1.0-ci-build
Draft as of 2025-11-20 Computable Name: ObservationWithCompOah

Profile for OneAquaHealth project macrophytes observations.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* ObservationIndicatorsOah Measurements and simple assertions
Constraints: obs-6, obs-7
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Required Pattern: final
... subject Σ 1..1 Reference(Location: OAH Indicators) Who and/or what the observation is about
... effective[x] Σ 1..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer Σ 1..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
... Slices for component Σ 1..* BackboneElement Slice per type of measure
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: OAH Indicators (preferred)
..... value[x] Σ 1..1 OAH Indicator component value
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
.... component:macrophytes Σ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: OAH Macrophytes Indicator Codes (required)
..... value[x] Σ 1..1 CodeableConcept OAH Indicator component value
Binding: OAH Macrophytes Indicator Values (required)
.... component:nonNativeMacrophytes Σ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: OAH Macrophytes Indicator Codes (Non-Native) (required)
..... value[x] Σ 1..1 string OAH Indicator component value
.... component:riparianVegetation Σ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: OAH Riparian Vegetation Indicator Codes (required)
..... value[x] Σ 1..1 CodeableConcept OAH Indicator component value
Binding: OAH Riparian Vegetation Indicator Values (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.code Base extensible OAH Observation Type with Components 📦0.1.0-ci-build This IG
Observation.component.​code Base preferred OAH Indicators 📦0.1.0-ci-build This IG
Observation.component:macrophytes.​code Base required OAH Macrophytes Indicator Codes 📦0.1.0-ci-build This IG
Observation.component:macrophytes.​value[x] Base required OAH Macrophytes Indicator Values 📦0.1.0-ci-build This IG
Observation.component:nonNativeMacrophytes.​code Base required OAH Macrophytes Indicator Codes (Non-Native) 📦0.1.0-ci-build This IG
Observation.component:riparianVegetation.​code Base required OAH Riparian Vegetation Indicator Codes 📦0.1.0-ci-build This IG
Observation.component:riparianVegetation.​value[x] Base required OAH Riparian Vegetation Indicator Values 📦0.1.0-ci-build This IG

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-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 ObservationIndicatorsOah

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* ObservationIndicatorsOah Measurements and simple assertions
... code 1..1 CodeableConcept Type of observation (code / type)
Binding: OAH Observation Type with Components (extensible)
... value[x] 0..0 OAH Indicator value
... Slices for component 1..* BackboneElement Slice per type of measure
Slice: Unordered, Open by value:code
.... component:macrophytes 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Binding: OAH Macrophytes Indicator Codes (required)
..... value[x] 1..1 CodeableConcept OAH Indicator component value
Binding: OAH Macrophytes Indicator Values (required)
.... component:nonNativeMacrophytes 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Binding: OAH Macrophytes Indicator Codes (Non-Native) (required)
..... value[x] 1..1 string OAH Indicator component value
.... component:riparianVegetation 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Binding: OAH Riparian Vegetation Indicator Codes (required)
..... value[x] 1..1 CodeableConcept OAH Indicator component value
Binding: OAH Riparian Vegetation Indicator Values (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.code Base extensible OAH Observation Type with Components 📦0.1.0-ci-build This IG
Observation.component:macrophytes.​code Base required OAH Macrophytes Indicator Codes 📦0.1.0-ci-build This IG
Observation.component:macrophytes.​value[x] Base required OAH Macrophytes Indicator Values 📦0.1.0-ci-build This IG
Observation.component:nonNativeMacrophytes.​code Base required OAH Macrophytes Indicator Codes (Non-Native) 📦0.1.0-ci-build This IG
Observation.component:riparianVegetation.​code Base required OAH Riparian Vegetation Indicator Codes 📦0.1.0-ci-build This IG
Observation.component:riparianVegetation.​value[x] Base required OAH Riparian Vegetation Indicator Values 📦0.1.0-ci-build This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* ObservationIndicatorsOah Measurements and simple assertions
Constraints: obs-6, obs-7
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Required Pattern: final
... category 0..* CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
... code Σ 1..1 CodeableConcept Type of observation (code / type)
Binding: OAH Observation Type with Components (extensible)
... subject Σ 1..1 Reference(Location: OAH Indicators) 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] Σ 1..1 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 Σ 1..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
... 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 (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen: OAH Indicators) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation | 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
... Slices for component Σ 1..* BackboneElement Slice per type of measure
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... 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: OAH Indicators (preferred)
..... value[x] Σ 1..1 OAH Indicator component value
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
..... 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
.... component:macrophytes Σ 0..1 BackboneElement Component 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: OAH Macrophytes Indicator Codes (required)
..... value[x] Σ 1..1 CodeableConcept OAH Indicator component value
Binding: OAH Macrophytes Indicator Values (required)
..... 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
.... component:nonNativeMacrophytes Σ 0..1 BackboneElement Component 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: OAH Macrophytes Indicator Codes (Non-Native) (required)
..... value[x] Σ 1..1 string OAH Indicator component value
..... 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
.... component:riparianVegetation Σ 0..1 BackboneElement Component 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: OAH Riparian Vegetation Indicator Codes (required)
..... value[x] Σ 1..1 CodeableConcept OAH Indicator component value
Binding: OAH Riparian Vegetation Indicator Values (required)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base extensible OAH Observation Type with Components 📦0.1.0-ci-build 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 example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
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 preferred OAH Indicators 📦0.1.0-ci-build This IG
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:macrophytes.​code Base required OAH Macrophytes Indicator Codes 📦0.1.0-ci-build This IG
Observation.component:macrophytes.​value[x] Base required OAH Macrophytes Indicator Values 📦0.1.0-ci-build This IG
Observation.component:macrophytes.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:macrophytes.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:nonNativeMacrophytes.​code Base required OAH Macrophytes Indicator Codes (Non-Native) 📦0.1.0-ci-build This IG
Observation.component:nonNativeMacrophytes.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:nonNativeMacrophytes.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:riparianVegetation.​code Base required OAH Riparian Vegetation Indicator Codes 📦0.1.0-ci-build This IG
Observation.component:riparianVegetation.​value[x] Base required OAH Riparian Vegetation Indicator Values 📦0.1.0-ci-build This IG
Observation.component:riparianVegetation.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:riparianVegetation.​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 ObservationIndicatorsOah

Summary

Mandatory: 1 element
Prohibited: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.component

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* ObservationIndicatorsOah Measurements and simple assertions
Constraints: obs-6, obs-7
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Required Pattern: final
... subject Σ 1..1 Reference(Location: OAH Indicators) Who and/or what the observation is about
... effective[x] Σ 1..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer Σ 1..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
... Slices for component Σ 1..* BackboneElement Slice per type of measure
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: OAH Indicators (preferred)
..... value[x] Σ 1..1 OAH Indicator component value
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
.... component:macrophytes Σ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: OAH Macrophytes Indicator Codes (required)
..... value[x] Σ 1..1 CodeableConcept OAH Indicator component value
Binding: OAH Macrophytes Indicator Values (required)
.... component:nonNativeMacrophytes Σ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: OAH Macrophytes Indicator Codes (Non-Native) (required)
..... value[x] Σ 1..1 string OAH Indicator component value
.... component:riparianVegetation Σ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: OAH Riparian Vegetation Indicator Codes (required)
..... value[x] Σ 1..1 CodeableConcept OAH Indicator component value
Binding: OAH Riparian Vegetation Indicator Values (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.code Base extensible OAH Observation Type with Components 📦0.1.0-ci-build This IG
Observation.component.​code Base preferred OAH Indicators 📦0.1.0-ci-build This IG
Observation.component:macrophytes.​code Base required OAH Macrophytes Indicator Codes 📦0.1.0-ci-build This IG
Observation.component:macrophytes.​value[x] Base required OAH Macrophytes Indicator Values 📦0.1.0-ci-build This IG
Observation.component:nonNativeMacrophytes.​code Base required OAH Macrophytes Indicator Codes (Non-Native) 📦0.1.0-ci-build This IG
Observation.component:riparianVegetation.​code Base required OAH Riparian Vegetation Indicator Codes 📦0.1.0-ci-build This IG
Observation.component:riparianVegetation.​value[x] Base required OAH Riparian Vegetation Indicator Values 📦0.1.0-ci-build This IG

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-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 ObservationIndicatorsOah

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* ObservationIndicatorsOah Measurements and simple assertions
... code 1..1 CodeableConcept Type of observation (code / type)
Binding: OAH Observation Type with Components (extensible)
... value[x] 0..0 OAH Indicator value
... Slices for component 1..* BackboneElement Slice per type of measure
Slice: Unordered, Open by value:code
.... component:macrophytes 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Binding: OAH Macrophytes Indicator Codes (required)
..... value[x] 1..1 CodeableConcept OAH Indicator component value
Binding: OAH Macrophytes Indicator Values (required)
.... component:nonNativeMacrophytes 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Binding: OAH Macrophytes Indicator Codes (Non-Native) (required)
..... value[x] 1..1 string OAH Indicator component value
.... component:riparianVegetation 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Binding: OAH Riparian Vegetation Indicator Codes (required)
..... value[x] 1..1 CodeableConcept OAH Indicator component value
Binding: OAH Riparian Vegetation Indicator Values (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.code Base extensible OAH Observation Type with Components 📦0.1.0-ci-build This IG
Observation.component:macrophytes.​code Base required OAH Macrophytes Indicator Codes 📦0.1.0-ci-build This IG
Observation.component:macrophytes.​value[x] Base required OAH Macrophytes Indicator Values 📦0.1.0-ci-build This IG
Observation.component:nonNativeMacrophytes.​code Base required OAH Macrophytes Indicator Codes (Non-Native) 📦0.1.0-ci-build This IG
Observation.component:riparianVegetation.​code Base required OAH Riparian Vegetation Indicator Codes 📦0.1.0-ci-build This IG
Observation.component:riparianVegetation.​value[x] Base required OAH Riparian Vegetation Indicator Values 📦0.1.0-ci-build This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* ObservationIndicatorsOah Measurements and simple assertions
Constraints: obs-6, obs-7
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
Required Pattern: final
... category 0..* CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
... code Σ 1..1 CodeableConcept Type of observation (code / type)
Binding: OAH Observation Type with Components (extensible)
... subject Σ 1..1 Reference(Location: OAH Indicators) 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] Σ 1..1 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 Σ 1..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
... 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 (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen: OAH Indicators) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation | 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
... Slices for component Σ 1..* BackboneElement Slice per type of measure
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... 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: OAH Indicators (preferred)
..... value[x] Σ 1..1 OAH Indicator component value
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
..... 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
.... component:macrophytes Σ 0..1 BackboneElement Component 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: OAH Macrophytes Indicator Codes (required)
..... value[x] Σ 1..1 CodeableConcept OAH Indicator component value
Binding: OAH Macrophytes Indicator Values (required)
..... 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
.... component:nonNativeMacrophytes Σ 0..1 BackboneElement Component 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: OAH Macrophytes Indicator Codes (Non-Native) (required)
..... value[x] Σ 1..1 string OAH Indicator component value
..... 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
.... component:riparianVegetation Σ 0..1 BackboneElement Component 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: OAH Riparian Vegetation Indicator Codes (required)
..... value[x] Σ 1..1 CodeableConcept OAH Indicator component value
Binding: OAH Riparian Vegetation Indicator Values (required)
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base extensible OAH Observation Type with Components 📦0.1.0-ci-build 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 example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
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 preferred OAH Indicators 📦0.1.0-ci-build This IG
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:macrophytes.​code Base required OAH Macrophytes Indicator Codes 📦0.1.0-ci-build This IG
Observation.component:macrophytes.​value[x] Base required OAH Macrophytes Indicator Values 📦0.1.0-ci-build This IG
Observation.component:macrophytes.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:macrophytes.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:nonNativeMacrophytes.​code Base required OAH Macrophytes Indicator Codes (Non-Native) 📦0.1.0-ci-build This IG
Observation.component:nonNativeMacrophytes.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:nonNativeMacrophytes.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:riparianVegetation.​code Base required OAH Riparian Vegetation Indicator Codes 📦0.1.0-ci-build This IG
Observation.component:riparianVegetation.​value[x] Base required OAH Riparian Vegetation Indicator Values 📦0.1.0-ci-build This IG
Observation.component:riparianVegetation.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:riparianVegetation.​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 ObservationIndicatorsOah

Summary

Mandatory: 1 element
Prohibited: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.component

 

Other representations of profile: CSV, Excel, Schematron