Eyes back on FHIR? An experimental continuation of the Eyes on FHIR working group's HL7 FHIR® IG
0.1.0 - experimental Unknown region code '276'

Eyes back on FHIR? An experimental continuation of the Eyes on FHIR working group's HL7 FHIR® IG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile:

Official URL: https://larfuma.github.io/fhir-eyecare-ig/StructureDefinition/pupil-comparison Version: 0.1.0
Draft as of 2024-12-31 Computable Name: PupilComparison

Usage:

Formal Views of Profile Content

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

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
inv-1: Right eye observation must have bodySite code indicating right eye.
inv-2: Left eye observation must have bodySite code indicating left eye.
inv-3: All components in the PupilComparison observation must match components in both hasMember observations.
... code 1..1 CodeableConcept Type of observation (code / type)
Fixed Value: As shown
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://larfuma.github.io/fhir-eyecare-ig/CodeSystem/custom-codes-to-be-submitted-to-SNOMED-or-LOINC
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: comparison-of-pupil-diameter-between-eyes
..... display 1..1 string Representation defined by the system
Fixed Value: Comparison of Pupil diameters
... bodySite 0..1 CodeableConcept Observed body part
Fixed Value: As shown
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 362508001
..... display 1..1 string Representation defined by the system
Fixed Value: Both eyes, entire (body structure)
... Slices for hasMember 2..2 Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
Slice: Unordered, Closed by value:resolve().bodySite.coding.code
.... hasMember:rightEye 1..1 Reference(PupilDiameter) Related resource that belongs to the Observation group
.... hasMember:leftEye 1..1 Reference(PupilDiameter) Related resource that belongs to the Observation group
.... component:RoomBrightness 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Fixed Value: As shown
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP429645-7
....... display 1..1 string Representation defined by the system
Fixed Value: Room brightness level during testing
..... value[x] 0..1 Quantity Actual component result
...... unit 0..1 string Unit representation
Fixed Value: lux
...... system 0..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code 0..1 code Coded form of the unit
Fixed Value: lx
.... component:PupilLuminance 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Fixed Value: As shown
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 27073006
....... display 1..1 string Representation defined by the system
Fixed Value: Luminance
..... value[x] 0..1 Quantity Actual component result
...... unit 0..1 string Unit representation
Fixed Value: cd/m2
...... system 0..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code 0..1 code Coded form of the unit
Fixed Value: cd/m2
.... component:PharmacologicalTestDurationSinceAdministration 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Fixed Value: As shown
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 82757-5
....... display 1..1 string Representation defined by the system
Fixed Value: Time since administration of medication
..... value[x] 0..1 Quantity Actual component result
...... unit 0..1 string Unit representation
Fixed Value: minutes
...... system 0..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code 0..1 code Coded form of the unit
Fixed Value: min
.... component:PharmacologicalTestActiveSubstanceInEyedrops 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Fixed Value: As shown
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 410942007
....... display 1..1 string Representation defined by the system
Fixed Value: Drug or medicament (substance)
..... value[x] 0..1 Actual component result
Binding: Pupil Testing Active Substances (preferred): Valueset of active substances typically used in pharmacological pupil testing

...... valueCodeableConcept CodeableConcept
...... valueString string

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.component:PharmacologicalTestActiveSubstanceInEyedrops.value[x]preferredPupiTestingActiveSubstances
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-pupi-testing-active-substances
from this IG

Constraints

IdGradePath(s)DetailsRequirements
inv-1errorObservationRight eye observation must have bodySite code indicating right eye.
: hasMember.where(sliceName='rightEye').resolve().bodySite.coding.exists(system='http://snomed.info/sct' and code='51285007')
inv-2errorObservationLeft eye observation must have bodySite code indicating left eye.
: hasMember.where(sliceName='leftEye').resolve().bodySite.coding.exists(system='http://snomed.info/sct' and code='12853009')
inv-3errorObservationAll components in the PupilComparison observation must match components in both hasMember observations.
: component.forAll(c | hasMember.resolve().component.where(code = c.code).all(inner | c.value = inner.value))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
inv-1: Right eye observation must have bodySite code indicating right eye.
inv-2: Left eye observation must have bodySite code indicating left eye.
inv-3: All components in the PupilComparison observation must match components in both hasMember observations.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.


ele-1: All FHIR elements must have a @value or children
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://larfuma.github.io/fhir-eyecare-ig/CodeSystem/custom-codes-to-be-submitted-to-SNOMED-or-LOINC
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: comparison-of-pupil-diameter-between-eyes
..... display 1..1 string Representation defined by the system
Fixed Value: Comparison of Pupil diameters
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


ele-1: All FHIR elements must have a @value or children
Fixed Value: As shown
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 362508001
..... display 1..1 string Representation defined by the system
Fixed Value: Both eyes, entire (body structure)
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... Slices for hasMember Σ 2..2 Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
Slice: Unordered, Closed by value:resolve().bodySite.coding.code
ele-1: All FHIR elements must have a @value or children
.... hasMember:rightEye Σ 1..1 Reference(PupilDiameter) Related resource that belongs to the Observation group
ele-1: All FHIR elements must have a @value or children
.... hasMember:leftEye Σ 1..1 Reference(PupilDiameter) Related resource that belongs to the Observation group
ele-1: All FHIR elements must have a @value or children
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
ele-1: All FHIR elements must have a @value or children
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


ele-1: All FHIR elements must have a @value or children
.... component:RoomBrightness Σ 0..1 BackboneElement Component results
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


ele-1: All FHIR elements must have a @value or children
Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP429645-7
....... display 1..1 string Representation defined by the system
Fixed Value: Room brightness level during testing
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... value[x] Σ 0..1 Quantity Actual component result
ele-1: All FHIR elements must have a @value or children
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.


ele-1: All FHIR elements must have a @value or children
...... unit Σ 0..1 string Unit representation
ele-1: All FHIR elements must have a @value or children
Fixed Value: lux
...... system ΣC 0..1 uri System that defines coded unit form
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://unitsofmeasure.org
...... code Σ 0..1 code Coded form of the unit
ele-1: All FHIR elements must have a @value or children
Fixed Value: lx
.... component:PupilLuminance Σ 0..1 BackboneElement Component results
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


ele-1: All FHIR elements must have a @value or children
Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 27073006
....... display 1..1 string Representation defined by the system
Fixed Value: Luminance
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... value[x] Σ 0..1 Quantity Actual component result
ele-1: All FHIR elements must have a @value or children
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.


ele-1: All FHIR elements must have a @value or children
...... unit Σ 0..1 string Unit representation
ele-1: All FHIR elements must have a @value or children
Fixed Value: cd/m2
...... system ΣC 0..1 uri System that defines coded unit form
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://unitsofmeasure.org
...... code Σ 0..1 code Coded form of the unit
ele-1: All FHIR elements must have a @value or children
Fixed Value: cd/m2
.... component:PharmacologicalTestDurationSinceAdministration Σ 0..1 BackboneElement Component results
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


ele-1: All FHIR elements must have a @value or children
Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 82757-5
....... display 1..1 string Representation defined by the system
Fixed Value: Time since administration of medication
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... value[x] Σ 0..1 Quantity Actual component result
ele-1: All FHIR elements must have a @value or children
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.


ele-1: All FHIR elements must have a @value or children
...... unit Σ 0..1 string Unit representation
ele-1: All FHIR elements must have a @value or children
Fixed Value: minutes
...... system ΣC 0..1 uri System that defines coded unit form
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://unitsofmeasure.org
...... code Σ 0..1 code Coded form of the unit
ele-1: All FHIR elements must have a @value or children
Fixed Value: min
.... component:PharmacologicalTestActiveSubstanceInEyedrops Σ 0..1 BackboneElement Component results
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


ele-1: All FHIR elements must have a @value or children
Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 410942007
....... display 1..1 string Representation defined by the system
Fixed Value: Drug or medicament (substance)
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... value[x] Σ 0..1 Actual component result
Binding: Pupil Testing Active Substances (preferred): Valueset of active substances typically used in pharmacological pupil testing


ele-1: All FHIR elements must have a @value or children
...... valueCodeableConcept CodeableConcept
...... valueString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.codeexampleFixed Value: comparison-of-pupil-diameter-between-eyes("Comparison of Pupil diameters")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.bodySiteexampleFixed Value: SNOMED-CT Code 362508001("Both eyes, entire (body structure)")
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:RoomBrightness.codeexampleFixed Value: LOINC Code LP429645-7("Room brightness level during testing")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:RoomBrightness.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:PupilLuminance.codeexampleFixed Value: SNOMED-CT Code 27073006("Luminance")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:PupilLuminance.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:PharmacologicalTestDurationSinceAdministration.codeexampleFixed Value: LOINC Code 82757-5("Time since administration of medication")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:PharmacologicalTestDurationSinceAdministration.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:PharmacologicalTestActiveSubstanceInEyedrops.codeexampleFixed Value: SNOMED-CT Code 410942007("Drug or medicament (substance)")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:PharmacologicalTestActiveSubstanceInEyedrops.value[x]preferredPupiTestingActiveSubstances
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-pupi-testing-active-substances
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorObservationRight eye observation must have bodySite code indicating right eye.
: hasMember.where(sliceName='rightEye').resolve().bodySite.coding.exists(system='http://snomed.info/sct' and code='51285007')
inv-2errorObservationLeft eye observation must have bodySite code indicating left eye.
: hasMember.where(sliceName='leftEye').resolve().bodySite.coding.exists(system='http://snomed.info/sct' and code='12853009')
inv-3errorObservationAll components in the PupilComparison observation must match components in both hasMember observations.
: component.forAll(c | hasMember.resolve().component.where(code = c.code).all(inner | c.value = inner.value))
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
inv-1: Right eye observation must have bodySite code indicating right eye.
inv-2: Left eye observation must have bodySite code indicating left eye.
inv-3: All components in the PupilComparison observation must match components in both hasMember observations.
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... 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.

... 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: LOINCCodes (example): Codes identifying names of simple observations.


Fixed Value: As shown
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://larfuma.github.io/fhir-eyecare-ig/CodeSystem/custom-codes-to-be-submitted-to-SNOMED-or-LOINC
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: comparison-of-pupil-diameter-between-eyes
..... display 1..1 string Representation defined by the system
Fixed Value: Comparison of Pupil diameters
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... subject Σ 0..1 Reference(Patient | Group | Device | Location) Who and/or what the observation is about
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] Σ 0..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 Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
... value[x] ΣC 0..1 Actual result
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


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


Fixed Value: As shown
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 362508001
..... display 1..1 string Representation defined by the system
Fixed Value: Both eyes, entire (body structure)
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity Low Range, if relevant
.... high C 0..1 SimpleQuantity High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... Slices for hasMember Σ 2..2 Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
Slice: Unordered, Closed by value:resolve().bodySite.coding.code
.... hasMember:rightEye Σ 1..1 Reference(PupilDiameter) Related resource that belongs to the Observation group
.... hasMember:leftEye Σ 1..1 Reference(PupilDiameter) 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 Σ 0..* BackboneElement Component results
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: LOINCCodes (example): Codes identifying names of simple observations.

..... value[x] Σ 0..1 Actual component result
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:RoomBrightness Σ 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: LOINCCodes (example): Codes identifying names of simple observations.


Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP429645-7
....... display 1..1 string Representation defined by the system
Fixed Value: Room brightness level during testing
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... value[x] Σ 0..1 Quantity Actual component result
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ 0..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit Σ 0..1 string Unit representation
Fixed Value: lux
...... system ΣC 0..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code Σ 0..1 code Coded form of the unit
Fixed Value: lx
..... 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:PupilLuminance Σ 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: LOINCCodes (example): Codes identifying names of simple observations.


Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 27073006
....... display 1..1 string Representation defined by the system
Fixed Value: Luminance
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... value[x] Σ 0..1 Quantity Actual component result
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ 0..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit Σ 0..1 string Unit representation
Fixed Value: cd/m2
...... system ΣC 0..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code Σ 0..1 code Coded form of the unit
Fixed Value: cd/m2
..... 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:PharmacologicalTestDurationSinceAdministration Σ 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: LOINCCodes (example): Codes identifying names of simple observations.


Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 82757-5
....... display 1..1 string Representation defined by the system
Fixed Value: Time since administration of medication
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... value[x] Σ 0..1 Quantity Actual component result
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ 0..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit Σ 0..1 string Unit representation
Fixed Value: minutes
...... system ΣC 0..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code Σ 0..1 code Coded form of the unit
Fixed Value: min
..... 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:PharmacologicalTestActiveSubstanceInEyedrops Σ 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: LOINCCodes (example): Codes identifying names of simple observations.


Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 410942007
....... display 1..1 string Representation defined by the system
Fixed Value: Drug or medicament (substance)
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... value[x] Σ 0..1 Actual component result
Binding: Pupil Testing Active Substances (preferred): Valueset of active substances typically used in pharmacological pupil testing

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleFixed Value: comparison-of-pupil-diameter-between-eyes("Comparison of Pupil diameters")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleFixed Value: SNOMED-CT Code 362508001("Both eyes, entire (body structure)")
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:RoomBrightness.codeexampleFixed Value: LOINC Code LP429645-7("Room brightness level during testing")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:RoomBrightness.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:RoomBrightness.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:RoomBrightness.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:PupilLuminance.codeexampleFixed Value: SNOMED-CT Code 27073006("Luminance")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:PupilLuminance.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:PupilLuminance.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:PupilLuminance.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:PharmacologicalTestDurationSinceAdministration.codeexampleFixed Value: LOINC Code 82757-5("Time since administration of medication")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:PharmacologicalTestDurationSinceAdministration.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:PharmacologicalTestDurationSinceAdministration.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:PharmacologicalTestDurationSinceAdministration.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:PharmacologicalTestActiveSubstanceInEyedrops.codeexampleFixed Value: SNOMED-CT Code 410942007("Drug or medicament (substance)")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:PharmacologicalTestActiveSubstanceInEyedrops.value[x]preferredPupiTestingActiveSubstances
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-pupi-testing-active-substances
from this IG
Observation.component:PharmacologicalTestActiveSubstanceInEyedrops.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:PharmacologicalTestActiveSubstanceInEyedrops.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorObservationRight eye observation must have bodySite code indicating right eye.
: hasMember.where(sliceName='rightEye').resolve().bodySite.coding.exists(system='http://snomed.info/sct' and code='51285007')
inv-2errorObservationLeft eye observation must have bodySite code indicating left eye.
: hasMember.where(sliceName='leftEye').resolve().bodySite.coding.exists(system='http://snomed.info/sct' and code='12853009')
inv-3errorObservationAll components in the PupilComparison observation must match components in both hasMember observations.
: component.forAll(c | hasMember.resolve().component.where(code = c.code).all(inner | c.value = inner.value))
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from Observation

Summary

Mandatory: 2 elements
Fixed: 15 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.hasMember (Closed)
  • The element 1 is sliced based on the value of Observation.component

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
inv-1: Right eye observation must have bodySite code indicating right eye.
inv-2: Left eye observation must have bodySite code indicating left eye.
inv-3: All components in the PupilComparison observation must match components in both hasMember observations.
... code 1..1 CodeableConcept Type of observation (code / type)
Fixed Value: As shown
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://larfuma.github.io/fhir-eyecare-ig/CodeSystem/custom-codes-to-be-submitted-to-SNOMED-or-LOINC
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: comparison-of-pupil-diameter-between-eyes
..... display 1..1 string Representation defined by the system
Fixed Value: Comparison of Pupil diameters
... bodySite 0..1 CodeableConcept Observed body part
Fixed Value: As shown
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 362508001
..... display 1..1 string Representation defined by the system
Fixed Value: Both eyes, entire (body structure)
... Slices for hasMember 2..2 Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
Slice: Unordered, Closed by value:resolve().bodySite.coding.code
.... hasMember:rightEye 1..1 Reference(PupilDiameter) Related resource that belongs to the Observation group
.... hasMember:leftEye 1..1 Reference(PupilDiameter) Related resource that belongs to the Observation group
.... component:RoomBrightness 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Fixed Value: As shown
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP429645-7
....... display 1..1 string Representation defined by the system
Fixed Value: Room brightness level during testing
..... value[x] 0..1 Quantity Actual component result
...... unit 0..1 string Unit representation
Fixed Value: lux
...... system 0..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code 0..1 code Coded form of the unit
Fixed Value: lx
.... component:PupilLuminance 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Fixed Value: As shown
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 27073006
....... display 1..1 string Representation defined by the system
Fixed Value: Luminance
..... value[x] 0..1 Quantity Actual component result
...... unit 0..1 string Unit representation
Fixed Value: cd/m2
...... system 0..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code 0..1 code Coded form of the unit
Fixed Value: cd/m2
.... component:PharmacologicalTestDurationSinceAdministration 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Fixed Value: As shown
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 82757-5
....... display 1..1 string Representation defined by the system
Fixed Value: Time since administration of medication
..... value[x] 0..1 Quantity Actual component result
...... unit 0..1 string Unit representation
Fixed Value: minutes
...... system 0..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code 0..1 code Coded form of the unit
Fixed Value: min
.... component:PharmacologicalTestActiveSubstanceInEyedrops 0..1 BackboneElement Component results
..... code 1..1 CodeableConcept Type of component observation (code / type)
Fixed Value: As shown
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 410942007
....... display 1..1 string Representation defined by the system
Fixed Value: Drug or medicament (substance)
..... value[x] 0..1 Actual component result
Binding: Pupil Testing Active Substances (preferred): Valueset of active substances typically used in pharmacological pupil testing

...... valueCodeableConcept CodeableConcept
...... valueString string

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.component:PharmacologicalTestActiveSubstanceInEyedrops.value[x]preferredPupiTestingActiveSubstances
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-pupi-testing-active-substances
from this IG

Constraints

IdGradePath(s)DetailsRequirements
inv-1errorObservationRight eye observation must have bodySite code indicating right eye.
: hasMember.where(sliceName='rightEye').resolve().bodySite.coding.exists(system='http://snomed.info/sct' and code='51285007')
inv-2errorObservationLeft eye observation must have bodySite code indicating left eye.
: hasMember.where(sliceName='leftEye').resolve().bodySite.coding.exists(system='http://snomed.info/sct' and code='12853009')
inv-3errorObservationAll components in the PupilComparison observation must match components in both hasMember observations.
: component.forAll(c | hasMember.resolve().component.where(code = c.code).all(inner | c.value = inner.value))

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
inv-1: Right eye observation must have bodySite code indicating right eye.
inv-2: Left eye observation must have bodySite code indicating left eye.
inv-3: All components in the PupilComparison observation must match components in both hasMember observations.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.


ele-1: All FHIR elements must have a @value or children
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://larfuma.github.io/fhir-eyecare-ig/CodeSystem/custom-codes-to-be-submitted-to-SNOMED-or-LOINC
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: comparison-of-pupil-diameter-between-eyes
..... display 1..1 string Representation defined by the system
Fixed Value: Comparison of Pupil diameters
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


ele-1: All FHIR elements must have a @value or children
Fixed Value: As shown
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 362508001
..... display 1..1 string Representation defined by the system
Fixed Value: Both eyes, entire (body structure)
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... Slices for hasMember Σ 2..2 Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
Slice: Unordered, Closed by value:resolve().bodySite.coding.code
ele-1: All FHIR elements must have a @value or children
.... hasMember:rightEye Σ 1..1 Reference(PupilDiameter) Related resource that belongs to the Observation group
ele-1: All FHIR elements must have a @value or children
.... hasMember:leftEye Σ 1..1 Reference(PupilDiameter) Related resource that belongs to the Observation group
ele-1: All FHIR elements must have a @value or children
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
ele-1: All FHIR elements must have a @value or children
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


ele-1: All FHIR elements must have a @value or children
.... component:RoomBrightness Σ 0..1 BackboneElement Component results
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


ele-1: All FHIR elements must have a @value or children
Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP429645-7
....... display 1..1 string Representation defined by the system
Fixed Value: Room brightness level during testing
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... value[x] Σ 0..1 Quantity Actual component result
ele-1: All FHIR elements must have a @value or children
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.


ele-1: All FHIR elements must have a @value or children
...... unit Σ 0..1 string Unit representation
ele-1: All FHIR elements must have a @value or children
Fixed Value: lux
...... system ΣC 0..1 uri System that defines coded unit form
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://unitsofmeasure.org
...... code Σ 0..1 code Coded form of the unit
ele-1: All FHIR elements must have a @value or children
Fixed Value: lx
.... component:PupilLuminance Σ 0..1 BackboneElement Component results
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


ele-1: All FHIR elements must have a @value or children
Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 27073006
....... display 1..1 string Representation defined by the system
Fixed Value: Luminance
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... value[x] Σ 0..1 Quantity Actual component result
ele-1: All FHIR elements must have a @value or children
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.


ele-1: All FHIR elements must have a @value or children
...... unit Σ 0..1 string Unit representation
ele-1: All FHIR elements must have a @value or children
Fixed Value: cd/m2
...... system ΣC 0..1 uri System that defines coded unit form
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://unitsofmeasure.org
...... code Σ 0..1 code Coded form of the unit
ele-1: All FHIR elements must have a @value or children
Fixed Value: cd/m2
.... component:PharmacologicalTestDurationSinceAdministration Σ 0..1 BackboneElement Component results
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


ele-1: All FHIR elements must have a @value or children
Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 82757-5
....... display 1..1 string Representation defined by the system
Fixed Value: Time since administration of medication
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... value[x] Σ 0..1 Quantity Actual component result
ele-1: All FHIR elements must have a @value or children
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.


ele-1: All FHIR elements must have a @value or children
...... unit Σ 0..1 string Unit representation
ele-1: All FHIR elements must have a @value or children
Fixed Value: minutes
...... system ΣC 0..1 uri System that defines coded unit form
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://unitsofmeasure.org
...... code Σ 0..1 code Coded form of the unit
ele-1: All FHIR elements must have a @value or children
Fixed Value: min
.... component:PharmacologicalTestActiveSubstanceInEyedrops Σ 0..1 BackboneElement Component results
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


ele-1: All FHIR elements must have a @value or children
Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 410942007
....... display 1..1 string Representation defined by the system
Fixed Value: Drug or medicament (substance)
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... value[x] Σ 0..1 Actual component result
Binding: Pupil Testing Active Substances (preferred): Valueset of active substances typically used in pharmacological pupil testing


ele-1: All FHIR elements must have a @value or children
...... valueCodeableConcept CodeableConcept
...... valueString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.codeexampleFixed Value: comparison-of-pupil-diameter-between-eyes("Comparison of Pupil diameters")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.bodySiteexampleFixed Value: SNOMED-CT Code 362508001("Both eyes, entire (body structure)")
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:RoomBrightness.codeexampleFixed Value: LOINC Code LP429645-7("Room brightness level during testing")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:RoomBrightness.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:PupilLuminance.codeexampleFixed Value: SNOMED-CT Code 27073006("Luminance")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:PupilLuminance.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:PharmacologicalTestDurationSinceAdministration.codeexampleFixed Value: LOINC Code 82757-5("Time since administration of medication")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:PharmacologicalTestDurationSinceAdministration.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:PharmacologicalTestActiveSubstanceInEyedrops.codeexampleFixed Value: SNOMED-CT Code 410942007("Drug or medicament (substance)")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:PharmacologicalTestActiveSubstanceInEyedrops.value[x]preferredPupiTestingActiveSubstances
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-pupi-testing-active-substances
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorObservationRight eye observation must have bodySite code indicating right eye.
: hasMember.where(sliceName='rightEye').resolve().bodySite.coding.exists(system='http://snomed.info/sct' and code='51285007')
inv-2errorObservationLeft eye observation must have bodySite code indicating left eye.
: hasMember.where(sliceName='leftEye').resolve().bodySite.coding.exists(system='http://snomed.info/sct' and code='12853009')
inv-3errorObservationAll components in the PupilComparison observation must match components in both hasMember observations.
: component.forAll(c | hasMember.resolve().component.where(code = c.code).all(inner | c.value = inner.value))
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
inv-1: Right eye observation must have bodySite code indicating right eye.
inv-2: Left eye observation must have bodySite code indicating left eye.
inv-3: All components in the PupilComparison observation must match components in both hasMember observations.
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... 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.

... 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: LOINCCodes (example): Codes identifying names of simple observations.


Fixed Value: As shown
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://larfuma.github.io/fhir-eyecare-ig/CodeSystem/custom-codes-to-be-submitted-to-SNOMED-or-LOINC
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: comparison-of-pupil-diameter-between-eyes
..... display 1..1 string Representation defined by the system
Fixed Value: Comparison of Pupil diameters
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... subject Σ 0..1 Reference(Patient | Group | Device | Location) Who and/or what the observation is about
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] Σ 0..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 Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
... value[x] ΣC 0..1 Actual result
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


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


Fixed Value: As shown
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 362508001
..... display 1..1 string Representation defined by the system
Fixed Value: Both eyes, entire (body structure)
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity Low Range, if relevant
.... high C 0..1 SimpleQuantity High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... Slices for hasMember Σ 2..2 Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
Slice: Unordered, Closed by value:resolve().bodySite.coding.code
.... hasMember:rightEye Σ 1..1 Reference(PupilDiameter) Related resource that belongs to the Observation group
.... hasMember:leftEye Σ 1..1 Reference(PupilDiameter) 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 Σ 0..* BackboneElement Component results
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: LOINCCodes (example): Codes identifying names of simple observations.

..... value[x] Σ 0..1 Actual component result
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:RoomBrightness Σ 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: LOINCCodes (example): Codes identifying names of simple observations.


Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP429645-7
....... display 1..1 string Representation defined by the system
Fixed Value: Room brightness level during testing
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... value[x] Σ 0..1 Quantity Actual component result
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ 0..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit Σ 0..1 string Unit representation
Fixed Value: lux
...... system ΣC 0..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code Σ 0..1 code Coded form of the unit
Fixed Value: lx
..... 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:PupilLuminance Σ 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: LOINCCodes (example): Codes identifying names of simple observations.


Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 27073006
....... display 1..1 string Representation defined by the system
Fixed Value: Luminance
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... value[x] Σ 0..1 Quantity Actual component result
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ 0..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit Σ 0..1 string Unit representation
Fixed Value: cd/m2
...... system ΣC 0..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code Σ 0..1 code Coded form of the unit
Fixed Value: cd/m2
..... 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:PharmacologicalTestDurationSinceAdministration Σ 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: LOINCCodes (example): Codes identifying names of simple observations.


Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 82757-5
....... display 1..1 string Representation defined by the system
Fixed Value: Time since administration of medication
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... value[x] Σ 0..1 Quantity Actual component result
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ 0..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit Σ 0..1 string Unit representation
Fixed Value: minutes
...... system ΣC 0..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code Σ 0..1 code Coded form of the unit
Fixed Value: min
..... 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:PharmacologicalTestActiveSubstanceInEyedrops Σ 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: LOINCCodes (example): Codes identifying names of simple observations.


Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..0 string Unique id for inter-element referencing
....... extension 0..0 Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version 0..0 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 410942007
....... display 1..1 string Representation defined by the system
Fixed Value: Drug or medicament (substance)
....... userSelected 0..0 boolean If this coding was chosen directly by the user
...... text 0..0 string Plain text representation of the concept
..... value[x] Σ 0..1 Actual component result
Binding: Pupil Testing Active Substances (preferred): Valueset of active substances typically used in pharmacological pupil testing

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleFixed Value: comparison-of-pupil-diameter-between-eyes("Comparison of Pupil diameters")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleFixed Value: SNOMED-CT Code 362508001("Both eyes, entire (body structure)")
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:RoomBrightness.codeexampleFixed Value: LOINC Code LP429645-7("Room brightness level during testing")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:RoomBrightness.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:RoomBrightness.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:RoomBrightness.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:PupilLuminance.codeexampleFixed Value: SNOMED-CT Code 27073006("Luminance")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:PupilLuminance.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:PupilLuminance.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:PupilLuminance.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:PharmacologicalTestDurationSinceAdministration.codeexampleFixed Value: LOINC Code 82757-5("Time since administration of medication")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:PharmacologicalTestDurationSinceAdministration.value[x].comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.component:PharmacologicalTestDurationSinceAdministration.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:PharmacologicalTestDurationSinceAdministration.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:PharmacologicalTestActiveSubstanceInEyedrops.codeexampleFixed Value: SNOMED-CT Code 410942007("Drug or medicament (substance)")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:PharmacologicalTestActiveSubstanceInEyedrops.value[x]preferredPupiTestingActiveSubstances
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-pupi-testing-active-substances
from this IG
Observation.component:PharmacologicalTestActiveSubstanceInEyedrops.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:PharmacologicalTestActiveSubstanceInEyedrops.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorObservationRight eye observation must have bodySite code indicating right eye.
: hasMember.where(sliceName='rightEye').resolve().bodySite.coding.exists(system='http://snomed.info/sct' and code='51285007')
inv-2errorObservationLeft eye observation must have bodySite code indicating left eye.
: hasMember.where(sliceName='leftEye').resolve().bodySite.coding.exists(system='http://snomed.info/sct' and code='12853009')
inv-3errorObservationAll components in the PupilComparison observation must match components in both hasMember observations.
: component.forAll(c | hasMember.resolve().component.where(code = c.code).all(inner | c.value = inner.value))
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from Observation

Summary

Mandatory: 2 elements
Fixed: 15 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.hasMember (Closed)
  • The element 1 is sliced based on the value of Observation.component

 

Other representations of profile: CSV, Excel, Schematron