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: Visual Acuity (VA) V3 ( Experimental )

Official URL: https://larfuma.github.io/fhir-eyecare-ig/StructureDefinition-observation-visual-acuity-version-three Version: 0.1.0
Draft as of 2024-12-31 Computable Name: ObservationVisualAcuity_version_three

An assessment of a patients ability to see - Version three

Usage:

Formal Views of Profile Content

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

This structure is derived from ObservationBase

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* ObservationBase Measurements and simple assertions
... 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: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 260246004
..... display 1..1 string Representation defined by the system
Fixed Value: Visual Acuity finding
.... coding 0..* Coding ​Additional codings
Binding: http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity (preferred)
... Slices for value[x] S 0..1 Actual result
Slice: Unordered, Open by type:$this
.... valueString string
.... valueRatio Ratio
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... value[x]:valueRatio C 0..1 Ratio Visual acuity expressed as a Snellen fraction
inv-dh-va-01: Value shall include numerator value and denominator value
.... value[x]:valueQuantity C 0..1 Quantity Visual acuity expressed as a simple quantity
inv-dh-va-02: Value shall include value and unit
..... code 0..1 code Coded form of the unit
Binding: Visual Acuity Quantity Units (preferred)
.... value[x]:valueCodeableConcept 0..1 CodeableConcept ​Visual acuity expressed as a code
Binding: https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values (preferred)
.... value[x]:valueString C 0..1 string Visual acuity expressed as a string (discouraged!)
inv-va-01: Use of valueString is discouraged; please use structured data types instead.
... note S 0..* Annotation Free text note or Comments about the VA observation
... method 0..1 CodeableConcept VA measurement Method
Binding: Visual Acuity Measurement Methods valueset (preferred)
.... coding 0..1 Coding Code defined by a terminology system
... referenceRange 0..1 BackboneElement Provides guide for interpretation
... Slices for component 0..* BackboneElement Component results
Slice: Unordered, Open by value:code, value:value
.... component:Correction-in-front-of-right-eye 0..* BackboneElement Component results
..... extension 0..1 Extension Extension
..... Slices for extension Content/Rules for all slices
...... LensDuringVATestSpecification 0..1 (Complex) Extension
URL: https://larfuma.github.io/fhir-eyecare-ig/StructureDefinition/LensDuringVATestSpecification
..... 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: 29073-4
....... display 1..1 string Representation defined by the system
Fixed Value: Right Eye position
..... value[x] 0..1 CodeableConcept Actual component result
Binding: Visual Acuity Correction Methods (preferred)
.... component:Correction-in-front-of-left-eye 0..* BackboneElement Component results
..... extension 0..1 Extension Extension
..... Slices for extension Content/Rules for all slices
...... LensDuringVATestSpecification 0..1 (Complex) Extension
URL: https://larfuma.github.io/fhir-eyecare-ig/StructureDefinition/LensDuringVATestSpecification
..... 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: 29074-2
....... display 1..1 string Representation defined by the system
Fixed Value: Left eye Position
..... value[x] 0..1 CodeableConcept Actual component result
Binding: Visual Acuity Correction Methods (preferred)
.... component:Test-Distance 0..1 BackboneElement Distance of Visual acuity Test
..... 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: 252124009
....... display 1..1 string Representation defined by the system
Fixed Value: Test distance
..... Slices for value[x] 0..1 Actual component result
Slice: Unordered, Open by type:$this
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... value[x]:valueCodeableConcept 0..1 CodeableConcept Measurement Distance as Coded Concept
Binding: Visual Acuity Test Distance (preferred)
.... component:Optotype-used 0..1 BackboneElement Optotype used
..... 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: 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: Optotype
....... display 1..1 string Representation defined by the system
Fixed Value: Optotype
..... value[x] 0..1 CodeableConcept Actual component result
Binding: Optotype ValueSet (preferred)
.... component:SpecialVATestingParameters 0..* 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: 370115009
....... display 1..1 string Representation defined by the system
Fixed Value: Special Concept
..... value[x] 0..1 CodeableConcept ​Actual component result
Binding: https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.code.codingpreferred​http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity
http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity
Observation.value[x]:valueQuantity.codepreferredVisualAcuityQuantityUnits
https://larfuma.github.io/fhir-eyecare-ig/ValueSet/visual-acuity-quantity-units
from this IG
Observation.value[x]:valueCodeableConceptpreferred​https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values
Observation.bodySiterequiredValueSet-right-left-both-eyes
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-right-left-both-eyes.html
from this IG
Observation.methodpreferredOphthalmologyVisualAcuityMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-observation-visual-acuity-methods
from this IG
Observation.component:Correction-in-front-of-right-eye.value[x]preferredVisualAcuityCorrectionMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-correction-methods-with-sl
from this IG
Observation.component:Correction-in-front-of-left-eye.value[x]preferredVisualAcuityCorrectionMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-correction-methods-with-sl
from this IG
Observation.component:Test-Distance.value[x]:valueCodeableConceptpreferredVisualAcuityTestDistance
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-test-distance
from this IG
Observation.component:Optotype-used.value[x]preferredOptotypes
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-optotypes
from this IG
Observation.component:SpecialVATestingParameters.value[x]preferred​https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-va-01errorObservation.value[x]:valueRatioValue shall include numerator value and denominator value
: numerator.value.exists() and denominator.value.exists()
inv-dh-va-02errorObservation.value[x]:valueQuantityValue shall include value and unit
: value.exists() and unit.exists()
inv-va-01warningObservation.value[x]:valueStringUse of valueString is discouraged; please use structured data types instead.
: true
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* ObservationBase 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
... 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 ?!SΣ 1..1 code final | amended
Binding: Observation Status (required): Reduced status set


ele-1: All FHIR elements must have a @value or children
.... category:ophthalCategory 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


ele-1: All FHIR elements must have a @value or children
..... coding Σ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
...... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: exam
... code SΣ 1..1 CodeableConcept Type of 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: 260246004
..... display 1..1 string Representation defined by the system
Fixed Value: Visual Acuity finding
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
.... coding Σ 0..* Coding ​Additional codings
Binding: http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity (preferred)
ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(Patient) Who and/or what the observation is about
ele-1: All FHIR elements must have a @value or children
... Slices for value[x] SΣC 0..1 Actual result
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
.... valueString string
.... valueRatio Ratio
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... value[x]:valueRatio ΣC 0..1 Ratio Visual acuity expressed as a Snellen fraction
ele-1: All FHIR elements must have a @value or children
inv-dh-va-01: Value shall include numerator value and denominator value
.... value[x]:valueQuantity ΣC 0..1 Quantity Visual acuity expressed as a simple quantity
ele-1: All FHIR elements must have a @value or children
inv-dh-va-02: Value shall include value and unit
..... 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
..... code Σ 0..1 code Coded form of the unit
Binding: Visual Acuity Quantity Units (preferred)
ele-1: All FHIR elements must have a @value or children
.... value[x]:valueCodeableConcept ΣC 0..1 CodeableConcept ​Visual acuity expressed as a code
Binding: https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values (preferred)
ele-1: All FHIR elements must have a @value or children
.... value[x]:valueString ΣC 0..1 string Visual acuity expressed as a string (discouraged!)
ele-1: All FHIR elements must have a @value or children
inv-va-01: Use of valueString is discouraged; please use structured data types instead.
... note S 0..* Annotation Free text note or Comments about the VA observation
ele-1: All FHIR elements must have a @value or children
... bodySite S 1..1 CodeableConcept Observed body part
Binding: ValueSet-right-left-both-eyes (required)
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... bodySiteEye S 0..* (Complex) Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/bodySite"
...... value[x] S 1..1 Reference(BodyStructure | Ocular anatomical location) Value of extension
ele-1: All FHIR elements must have a @value or children
... method 0..1 CodeableConcept VA measurement Method
Binding: Visual Acuity Measurement Methods valueset (preferred)
ele-1: All FHIR elements must have a @value or children
.... coding Σ 0..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
... referenceRange C 0..1 BackboneElement Provides guide for interpretation
ele-1: All FHIR elements must have a @value or children
obs-3: Must have at least a low or a high or text
.... 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
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code, value:value
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:Correction-in-front-of-right-eye Σ 0..* BackboneElement Component results
ele-1: All FHIR elements must have a @value or children
..... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... LensDuringVATestSpecification 0..1 (Complex) Extension
URL: https://larfuma.github.io/fhir-eyecare-ig/StructureDefinition/LensDuringVATestSpecification
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... 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: 29073-4
....... display 1..1 string Representation defined by the system
Fixed Value: Right Eye position
....... 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 CodeableConcept Actual component result
Binding: Visual Acuity Correction Methods (preferred)
ele-1: All FHIR elements must have a @value or children
.... component:Correction-in-front-of-left-eye Σ 0..* BackboneElement Component results
ele-1: All FHIR elements must have a @value or children
..... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... LensDuringVATestSpecification 0..1 (Complex) Extension
URL: https://larfuma.github.io/fhir-eyecare-ig/StructureDefinition/LensDuringVATestSpecification
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... 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: 29074-2
....... display 1..1 string Representation defined by the system
Fixed Value: Left eye Position
....... 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 CodeableConcept Actual component result
Binding: Visual Acuity Correction Methods (preferred)
ele-1: All FHIR elements must have a @value or children
.... component:Test-Distance Σ 0..1 BackboneElement Distance of Visual acuity Test
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: 252124009
....... display 1..1 string Representation defined by the system
Fixed Value: Test distance
....... 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 value[x] Σ 0..1 Actual component result
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... value[x]:valueCodeableConcept Σ 0..1 CodeableConcept Measurement Distance as Coded Concept
Binding: Visual Acuity Test Distance (preferred)
ele-1: All FHIR elements must have a @value or children
.... component:Optotype-used Σ 0..1 BackboneElement Optotype used
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: 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: Optotype
....... display 1..1 string Representation defined by the system
Fixed Value: Optotype
....... 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 CodeableConcept Actual component result
Binding: Optotype ValueSet (preferred)
ele-1: All FHIR elements must have a @value or children
.... component:SpecialVATestingParameters Σ 0..* 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: 370115009
....... display 1..1 string Representation defined by the system
Fixed Value: Special Concept
....... 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 CodeableConcept ​Actual component result
Binding: https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html (preferred)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

Constraints

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://terminology.hl7.org/uv/eyecare/ValueSet/observation-final-status
from this IG
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:ophthalCategorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleFixed Value: SNOMED-CT Code 260246004("Visual Acuity finding")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.code.codingpreferred​http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity
http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity
Observation.value[x]:valueQuantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.value[x]:valueQuantity.codepreferredVisualAcuityQuantityUnits
https://larfuma.github.io/fhir-eyecare-ig/ValueSet/visual-acuity-quantity-units
from this IG
Observation.value[x]:valueCodeableConceptpreferred​https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values
Observation.bodySiterequiredValueSet-right-left-both-eyes
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-right-left-both-eyes.html
from this IG
Observation.methodpreferredOphthalmologyVisualAcuityMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-observation-visual-acuity-methods
from this IG
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Correction-in-front-of-right-eye.codeexampleFixed Value: LOINC Code 29073-4("Right Eye position")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Correction-in-front-of-right-eye.value[x]preferredVisualAcuityCorrectionMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-correction-methods-with-sl
from this IG
Observation.component:Correction-in-front-of-left-eye.codeexampleFixed Value: LOINC Code 29074-2("Left eye Position")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Correction-in-front-of-left-eye.value[x]preferredVisualAcuityCorrectionMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-correction-methods-with-sl
from this IG
Observation.component:Test-Distance.codeexampleFixed Value: SNOMED-CT Code 252124009("Test distance")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Test-Distance.value[x]:valueCodeableConceptpreferredVisualAcuityTestDistance
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-test-distance
from this IG
Observation.component:Optotype-used.codeexampleFixed Value: Optotype("Optotype")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Optotype-used.value[x]preferredOptotypes
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-optotypes
from this IG
Observation.component:SpecialVATestingParameters.codeexampleFixed Value: SNOMED-CT Code 370115009("Special Concept")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:SpecialVATestingParameters.value[x]preferred​https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html
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-dh-va-01errorObservation.value[x]:valueRatioValue shall include numerator value and denominator value
: numerator.value.exists() and denominator.value.exists()
inv-dh-va-02errorObservation.value[x]:valueQuantityValue shall include value and unit
: value.exists() and unit.exists()
inv-va-01warningObservation.value[x]:valueStringUse of valueString is discouraged; please use structured data types instead.
: true
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* ObservationBase Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... 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 ?!SΣ 1..1 code final | amended
Binding: Observation Status (required): Reduced status set

... Slices for category S 1..* CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:ophthalCategory 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: exam
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... code SΣ 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: 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: 260246004
..... display 1..1 string Representation defined by the system
Fixed Value: Visual Acuity finding
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding ​Additional codings
Binding: http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity (preferred)
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Patient) 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
... Slices for value[x] SΣC 0..1 Actual result
Slice: Unordered, Closed by type:$this
.... valueString string
.... valueRatio Ratio
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... value[x]:valueRatio ΣC 0..1 Ratio Visual acuity expressed as a Snellen fraction
inv-dh-va-01: Value shall include numerator value and denominator value
.... value[x]:valueQuantity ΣC 0..1 Quantity Visual acuity expressed as a simple quantity
inv-dh-va-02: Value shall include value and unit
..... 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
..... system ΣC 0..1 uri System that defines coded unit form
..... code Σ 0..1 code Coded form of the unit
Binding: Visual Acuity Quantity Units (preferred)
.... value[x]:valueCodeableConcept ΣC 0..1 CodeableConcept ​Visual acuity expressed as a code
Binding: https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values (preferred)
.... value[x]:valueString ΣC 0..1 string Visual acuity expressed as a string (discouraged!)
inv-va-01: Use of valueString is discouraged; please use structured data types instead.
... 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 S 0..* Annotation Free text note or Comments about the VA observation
... bodySite S 1..1 CodeableConcept Observed body part
Binding: ValueSet-right-left-both-eyes (required)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
..... bodySiteEye S 0..* (Complex) Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/bodySite"
...... value[x] S 1..1 Reference(BodyStructure | Ocular anatomical location) Value of extension
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... method 0..1 CodeableConcept VA measurement Method
Binding: Visual Acuity Measurement Methods valueset (preferred)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..1 BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity Low Range, if relevant
.... high C 0..1 SimpleQuantity High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

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


.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code, value:value
.... 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:Correction-in-front-of-right-eye Σ 0..* BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
...... LensDuringVATestSpecification 0..1 (Complex) Extension
URL: https://larfuma.github.io/fhir-eyecare-ig/StructureDefinition/LensDuringVATestSpecification
..... 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: 29073-4
....... display 1..1 string Representation defined by the system
Fixed Value: Right Eye position
....... 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 CodeableConcept Actual component result
Binding: Visual Acuity Correction Methods (preferred)
..... 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:Correction-in-front-of-left-eye Σ 0..* BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
...... LensDuringVATestSpecification 0..1 (Complex) Extension
URL: https://larfuma.github.io/fhir-eyecare-ig/StructureDefinition/LensDuringVATestSpecification
..... 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: 29074-2
....... display 1..1 string Representation defined by the system
Fixed Value: Left eye Position
....... 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 CodeableConcept Actual component result
Binding: Visual Acuity Correction Methods (preferred)
..... 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:Test-Distance Σ 0..1 BackboneElement Distance of Visual acuity Test
..... 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: 252124009
....... display 1..1 string Representation defined by the system
Fixed Value: Test distance
....... 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 value[x] Σ 0..1 Actual component result
Slice: Unordered, Open by type:$this
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... value[x]:valueCodeableConcept Σ 0..1 CodeableConcept Measurement Distance as Coded Concept
Binding: Visual Acuity Test Distance (preferred)
..... 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:Optotype-used Σ 0..1 BackboneElement Optotype used
..... 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: 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: Optotype
....... display 1..1 string Representation defined by the system
Fixed Value: Optotype
....... 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 CodeableConcept Actual component result
Binding: Optotype ValueSet (preferred)
..... 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:SpecialVATestingParameters Σ 0..* 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: 370115009
....... display 1..1 string Representation defined by the system
Fixed Value: Special Concept
....... 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 CodeableConcept ​Actual component result
Binding: https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html (preferred)
..... 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

Constraints

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
http://terminology.hl7.org/uv/eyecare/ValueSet/observation-final-status
from this IG
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:ophthalCategorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleFixed Value: SNOMED-CT Code 260246004("Visual Acuity finding")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.code.codingpreferred​http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity
http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity
Observation.value[x]:valueQuantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.value[x]:valueQuantity.codepreferredVisualAcuityQuantityUnits
https://larfuma.github.io/fhir-eyecare-ig/ValueSet/visual-acuity-quantity-units
from this IG
Observation.value[x]:valueCodeableConceptpreferred​https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values
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.bodySiterequiredValueSet-right-left-both-eyes
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-right-left-both-eyes.html
from this IG
Observation.methodpreferredOphthalmologyVisualAcuityMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-observation-visual-acuity-methods
from this IG
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:Correction-in-front-of-right-eye.codeexampleFixed Value: LOINC Code 29073-4("Right Eye position")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Correction-in-front-of-right-eye.value[x]preferredVisualAcuityCorrectionMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-correction-methods-with-sl
from this IG
Observation.component:Correction-in-front-of-right-eye.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:Correction-in-front-of-right-eye.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:Correction-in-front-of-left-eye.codeexampleFixed Value: LOINC Code 29074-2("Left eye Position")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Correction-in-front-of-left-eye.value[x]preferredVisualAcuityCorrectionMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-correction-methods-with-sl
from this IG
Observation.component:Correction-in-front-of-left-eye.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:Correction-in-front-of-left-eye.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:Test-Distance.codeexampleFixed Value: SNOMED-CT Code 252124009("Test distance")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Test-Distance.value[x]:valueCodeableConceptpreferredVisualAcuityTestDistance
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-test-distance
from this IG
Observation.component:Test-Distance.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:Test-Distance.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:Optotype-used.codeexampleFixed Value: Optotype("Optotype")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Optotype-used.value[x]preferredOptotypes
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-optotypes
from this IG
Observation.component:Optotype-used.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:Optotype-used.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:SpecialVATestingParameters.codeexampleFixed Value: SNOMED-CT Code 370115009("Special Concept")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:SpecialVATestingParameters.value[x]preferred​https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html
Observation.component:SpecialVATestingParameters.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:SpecialVATestingParameters.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
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-dh-va-01errorObservation.value[x]:valueRatioValue shall include numerator value and denominator value
: numerator.value.exists() and denominator.value.exists()
inv-dh-va-02errorObservation.value[x]:valueQuantityValue shall include value and unit
: value.exists() and unit.exists()
inv-va-01warningObservation.value[x]:valueStringUse of valueString is discouraged; please use structured data types instead.
: true
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 ObservationBase

Summary

Mandatory: 1 element
Must-Support: 2 elements
Fixed: 6 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.value[x]
  • The element 2 is sliced based on the values of Observation.component
  • The element 1 is sliced based on the value of Observation.component.value[x]

Differential View

This structure is derived from ObservationBase

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* ObservationBase Measurements and simple assertions
... 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: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 260246004
..... display 1..1 string Representation defined by the system
Fixed Value: Visual Acuity finding
.... coding 0..* Coding ​Additional codings
Binding: http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity (preferred)
... Slices for value[x] S 0..1 Actual result
Slice: Unordered, Open by type:$this
.... valueString string
.... valueRatio Ratio
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... value[x]:valueRatio C 0..1 Ratio Visual acuity expressed as a Snellen fraction
inv-dh-va-01: Value shall include numerator value and denominator value
.... value[x]:valueQuantity C 0..1 Quantity Visual acuity expressed as a simple quantity
inv-dh-va-02: Value shall include value and unit
..... code 0..1 code Coded form of the unit
Binding: Visual Acuity Quantity Units (preferred)
.... value[x]:valueCodeableConcept 0..1 CodeableConcept ​Visual acuity expressed as a code
Binding: https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values (preferred)
.... value[x]:valueString C 0..1 string Visual acuity expressed as a string (discouraged!)
inv-va-01: Use of valueString is discouraged; please use structured data types instead.
... note S 0..* Annotation Free text note or Comments about the VA observation
... method 0..1 CodeableConcept VA measurement Method
Binding: Visual Acuity Measurement Methods valueset (preferred)
.... coding 0..1 Coding Code defined by a terminology system
... referenceRange 0..1 BackboneElement Provides guide for interpretation
... Slices for component 0..* BackboneElement Component results
Slice: Unordered, Open by value:code, value:value
.... component:Correction-in-front-of-right-eye 0..* BackboneElement Component results
..... extension 0..1 Extension Extension
..... Slices for extension Content/Rules for all slices
...... LensDuringVATestSpecification 0..1 (Complex) Extension
URL: https://larfuma.github.io/fhir-eyecare-ig/StructureDefinition/LensDuringVATestSpecification
..... 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: 29073-4
....... display 1..1 string Representation defined by the system
Fixed Value: Right Eye position
..... value[x] 0..1 CodeableConcept Actual component result
Binding: Visual Acuity Correction Methods (preferred)
.... component:Correction-in-front-of-left-eye 0..* BackboneElement Component results
..... extension 0..1 Extension Extension
..... Slices for extension Content/Rules for all slices
...... LensDuringVATestSpecification 0..1 (Complex) Extension
URL: https://larfuma.github.io/fhir-eyecare-ig/StructureDefinition/LensDuringVATestSpecification
..... 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: 29074-2
....... display 1..1 string Representation defined by the system
Fixed Value: Left eye Position
..... value[x] 0..1 CodeableConcept Actual component result
Binding: Visual Acuity Correction Methods (preferred)
.... component:Test-Distance 0..1 BackboneElement Distance of Visual acuity Test
..... 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: 252124009
....... display 1..1 string Representation defined by the system
Fixed Value: Test distance
..... Slices for value[x] 0..1 Actual component result
Slice: Unordered, Open by type:$this
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... value[x]:valueCodeableConcept 0..1 CodeableConcept Measurement Distance as Coded Concept
Binding: Visual Acuity Test Distance (preferred)
.... component:Optotype-used 0..1 BackboneElement Optotype used
..... 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: 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: Optotype
....... display 1..1 string Representation defined by the system
Fixed Value: Optotype
..... value[x] 0..1 CodeableConcept Actual component result
Binding: Optotype ValueSet (preferred)
.... component:SpecialVATestingParameters 0..* 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: 370115009
....... display 1..1 string Representation defined by the system
Fixed Value: Special Concept
..... value[x] 0..1 CodeableConcept ​Actual component result
Binding: https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.code.codingpreferred​http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity
http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity
Observation.value[x]:valueQuantity.codepreferredVisualAcuityQuantityUnits
https://larfuma.github.io/fhir-eyecare-ig/ValueSet/visual-acuity-quantity-units
from this IG
Observation.value[x]:valueCodeableConceptpreferred​https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values
Observation.bodySiterequiredValueSet-right-left-both-eyes
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-right-left-both-eyes.html
from this IG
Observation.methodpreferredOphthalmologyVisualAcuityMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-observation-visual-acuity-methods
from this IG
Observation.component:Correction-in-front-of-right-eye.value[x]preferredVisualAcuityCorrectionMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-correction-methods-with-sl
from this IG
Observation.component:Correction-in-front-of-left-eye.value[x]preferredVisualAcuityCorrectionMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-correction-methods-with-sl
from this IG
Observation.component:Test-Distance.value[x]:valueCodeableConceptpreferredVisualAcuityTestDistance
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-test-distance
from this IG
Observation.component:Optotype-used.value[x]preferredOptotypes
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-optotypes
from this IG
Observation.component:SpecialVATestingParameters.value[x]preferred​https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-va-01errorObservation.value[x]:valueRatioValue shall include numerator value and denominator value
: numerator.value.exists() and denominator.value.exists()
inv-dh-va-02errorObservation.value[x]:valueQuantityValue shall include value and unit
: value.exists() and unit.exists()
inv-va-01warningObservation.value[x]:valueStringUse of valueString is discouraged; please use structured data types instead.
: true

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* ObservationBase 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
... 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 ?!SΣ 1..1 code final | amended
Binding: Observation Status (required): Reduced status set


ele-1: All FHIR elements must have a @value or children
.... category:ophthalCategory 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


ele-1: All FHIR elements must have a @value or children
..... coding Σ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
...... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: exam
... code SΣ 1..1 CodeableConcept Type of 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: 260246004
..... display 1..1 string Representation defined by the system
Fixed Value: Visual Acuity finding
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
.... coding Σ 0..* Coding ​Additional codings
Binding: http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity (preferred)
ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(Patient) Who and/or what the observation is about
ele-1: All FHIR elements must have a @value or children
... Slices for value[x] SΣC 0..1 Actual result
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
.... valueString string
.... valueRatio Ratio
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... value[x]:valueRatio ΣC 0..1 Ratio Visual acuity expressed as a Snellen fraction
ele-1: All FHIR elements must have a @value or children
inv-dh-va-01: Value shall include numerator value and denominator value
.... value[x]:valueQuantity ΣC 0..1 Quantity Visual acuity expressed as a simple quantity
ele-1: All FHIR elements must have a @value or children
inv-dh-va-02: Value shall include value and unit
..... 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
..... code Σ 0..1 code Coded form of the unit
Binding: Visual Acuity Quantity Units (preferred)
ele-1: All FHIR elements must have a @value or children
.... value[x]:valueCodeableConcept ΣC 0..1 CodeableConcept ​Visual acuity expressed as a code
Binding: https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values (preferred)
ele-1: All FHIR elements must have a @value or children
.... value[x]:valueString ΣC 0..1 string Visual acuity expressed as a string (discouraged!)
ele-1: All FHIR elements must have a @value or children
inv-va-01: Use of valueString is discouraged; please use structured data types instead.
... note S 0..* Annotation Free text note or Comments about the VA observation
ele-1: All FHIR elements must have a @value or children
... bodySite S 1..1 CodeableConcept Observed body part
Binding: ValueSet-right-left-both-eyes (required)
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... bodySiteEye S 0..* (Complex) Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/bodySite"
...... value[x] S 1..1 Reference(BodyStructure | Ocular anatomical location) Value of extension
ele-1: All FHIR elements must have a @value or children
... method 0..1 CodeableConcept VA measurement Method
Binding: Visual Acuity Measurement Methods valueset (preferred)
ele-1: All FHIR elements must have a @value or children
.... coding Σ 0..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
... referenceRange C 0..1 BackboneElement Provides guide for interpretation
ele-1: All FHIR elements must have a @value or children
obs-3: Must have at least a low or a high or text
.... 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
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code, value:value
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:Correction-in-front-of-right-eye Σ 0..* BackboneElement Component results
ele-1: All FHIR elements must have a @value or children
..... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... LensDuringVATestSpecification 0..1 (Complex) Extension
URL: https://larfuma.github.io/fhir-eyecare-ig/StructureDefinition/LensDuringVATestSpecification
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... 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: 29073-4
....... display 1..1 string Representation defined by the system
Fixed Value: Right Eye position
....... 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 CodeableConcept Actual component result
Binding: Visual Acuity Correction Methods (preferred)
ele-1: All FHIR elements must have a @value or children
.... component:Correction-in-front-of-left-eye Σ 0..* BackboneElement Component results
ele-1: All FHIR elements must have a @value or children
..... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... LensDuringVATestSpecification 0..1 (Complex) Extension
URL: https://larfuma.github.io/fhir-eyecare-ig/StructureDefinition/LensDuringVATestSpecification
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... 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: 29074-2
....... display 1..1 string Representation defined by the system
Fixed Value: Left eye Position
....... 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 CodeableConcept Actual component result
Binding: Visual Acuity Correction Methods (preferred)
ele-1: All FHIR elements must have a @value or children
.... component:Test-Distance Σ 0..1 BackboneElement Distance of Visual acuity Test
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: 252124009
....... display 1..1 string Representation defined by the system
Fixed Value: Test distance
....... 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 value[x] Σ 0..1 Actual component result
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... value[x]:valueCodeableConcept Σ 0..1 CodeableConcept Measurement Distance as Coded Concept
Binding: Visual Acuity Test Distance (preferred)
ele-1: All FHIR elements must have a @value or children
.... component:Optotype-used Σ 0..1 BackboneElement Optotype used
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: 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: Optotype
....... display 1..1 string Representation defined by the system
Fixed Value: Optotype
....... 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 CodeableConcept Actual component result
Binding: Optotype ValueSet (preferred)
ele-1: All FHIR elements must have a @value or children
.... component:SpecialVATestingParameters Σ 0..* 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: 370115009
....... display 1..1 string Representation defined by the system
Fixed Value: Special Concept
....... 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 CodeableConcept ​Actual component result
Binding: https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html (preferred)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

Constraints

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://terminology.hl7.org/uv/eyecare/ValueSet/observation-final-status
from this IG
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:ophthalCategorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleFixed Value: SNOMED-CT Code 260246004("Visual Acuity finding")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.code.codingpreferred​http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity
http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity
Observation.value[x]:valueQuantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.value[x]:valueQuantity.codepreferredVisualAcuityQuantityUnits
https://larfuma.github.io/fhir-eyecare-ig/ValueSet/visual-acuity-quantity-units
from this IG
Observation.value[x]:valueCodeableConceptpreferred​https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values
Observation.bodySiterequiredValueSet-right-left-both-eyes
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-right-left-both-eyes.html
from this IG
Observation.methodpreferredOphthalmologyVisualAcuityMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-observation-visual-acuity-methods
from this IG
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Correction-in-front-of-right-eye.codeexampleFixed Value: LOINC Code 29073-4("Right Eye position")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Correction-in-front-of-right-eye.value[x]preferredVisualAcuityCorrectionMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-correction-methods-with-sl
from this IG
Observation.component:Correction-in-front-of-left-eye.codeexampleFixed Value: LOINC Code 29074-2("Left eye Position")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Correction-in-front-of-left-eye.value[x]preferredVisualAcuityCorrectionMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-correction-methods-with-sl
from this IG
Observation.component:Test-Distance.codeexampleFixed Value: SNOMED-CT Code 252124009("Test distance")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Test-Distance.value[x]:valueCodeableConceptpreferredVisualAcuityTestDistance
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-test-distance
from this IG
Observation.component:Optotype-used.codeexampleFixed Value: Optotype("Optotype")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Optotype-used.value[x]preferredOptotypes
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-optotypes
from this IG
Observation.component:SpecialVATestingParameters.codeexampleFixed Value: SNOMED-CT Code 370115009("Special Concept")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:SpecialVATestingParameters.value[x]preferred​https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html
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-dh-va-01errorObservation.value[x]:valueRatioValue shall include numerator value and denominator value
: numerator.value.exists() and denominator.value.exists()
inv-dh-va-02errorObservation.value[x]:valueQuantityValue shall include value and unit
: value.exists() and unit.exists()
inv-va-01warningObservation.value[x]:valueStringUse of valueString is discouraged; please use structured data types instead.
: true
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* ObservationBase Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... 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 ?!SΣ 1..1 code final | amended
Binding: Observation Status (required): Reduced status set

... Slices for category S 1..* CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:ophthalCategory 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: exam
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... code SΣ 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: 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: 260246004
..... display 1..1 string Representation defined by the system
Fixed Value: Visual Acuity finding
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding ​Additional codings
Binding: http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity (preferred)
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Patient) 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
... Slices for value[x] SΣC 0..1 Actual result
Slice: Unordered, Closed by type:$this
.... valueString string
.... valueRatio Ratio
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... value[x]:valueRatio ΣC 0..1 Ratio Visual acuity expressed as a Snellen fraction
inv-dh-va-01: Value shall include numerator value and denominator value
.... value[x]:valueQuantity ΣC 0..1 Quantity Visual acuity expressed as a simple quantity
inv-dh-va-02: Value shall include value and unit
..... 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
..... system ΣC 0..1 uri System that defines coded unit form
..... code Σ 0..1 code Coded form of the unit
Binding: Visual Acuity Quantity Units (preferred)
.... value[x]:valueCodeableConcept ΣC 0..1 CodeableConcept ​Visual acuity expressed as a code
Binding: https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values (preferred)
.... value[x]:valueString ΣC 0..1 string Visual acuity expressed as a string (discouraged!)
inv-va-01: Use of valueString is discouraged; please use structured data types instead.
... 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 S 0..* Annotation Free text note or Comments about the VA observation
... bodySite S 1..1 CodeableConcept Observed body part
Binding: ValueSet-right-left-both-eyes (required)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
..... bodySiteEye S 0..* (Complex) Target anatomic location or structure
URL: http://hl7.org/fhir/StructureDefinition/bodySite
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/bodySite"
...... value[x] S 1..1 Reference(BodyStructure | Ocular anatomical location) Value of extension
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... method 0..1 CodeableConcept VA measurement Method
Binding: Visual Acuity Measurement Methods valueset (preferred)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..1 BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity Low Range, if relevant
.... high C 0..1 SimpleQuantity High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

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


.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code, value:value
.... 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:Correction-in-front-of-right-eye Σ 0..* BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
...... LensDuringVATestSpecification 0..1 (Complex) Extension
URL: https://larfuma.github.io/fhir-eyecare-ig/StructureDefinition/LensDuringVATestSpecification
..... 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: 29073-4
....... display 1..1 string Representation defined by the system
Fixed Value: Right Eye position
....... 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 CodeableConcept Actual component result
Binding: Visual Acuity Correction Methods (preferred)
..... 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:Correction-in-front-of-left-eye Σ 0..* BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
...... LensDuringVATestSpecification 0..1 (Complex) Extension
URL: https://larfuma.github.io/fhir-eyecare-ig/StructureDefinition/LensDuringVATestSpecification
..... 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: 29074-2
....... display 1..1 string Representation defined by the system
Fixed Value: Left eye Position
....... 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 CodeableConcept Actual component result
Binding: Visual Acuity Correction Methods (preferred)
..... 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:Test-Distance Σ 0..1 BackboneElement Distance of Visual acuity Test
..... 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: 252124009
....... display 1..1 string Representation defined by the system
Fixed Value: Test distance
....... 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 value[x] Σ 0..1 Actual component result
Slice: Unordered, Open by type:$this
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... value[x]:valueCodeableConcept Σ 0..1 CodeableConcept Measurement Distance as Coded Concept
Binding: Visual Acuity Test Distance (preferred)
..... 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:Optotype-used Σ 0..1 BackboneElement Optotype used
..... 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: 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: Optotype
....... display 1..1 string Representation defined by the system
Fixed Value: Optotype
....... 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 CodeableConcept Actual component result
Binding: Optotype ValueSet (preferred)
..... 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:SpecialVATestingParameters Σ 0..* 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: 370115009
....... display 1..1 string Representation defined by the system
Fixed Value: Special Concept
....... 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 CodeableConcept ​Actual component result
Binding: https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html (preferred)
..... 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

Constraints

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
http://terminology.hl7.org/uv/eyecare/ValueSet/observation-final-status
from this IG
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:ophthalCategorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleFixed Value: SNOMED-CT Code 260246004("Visual Acuity finding")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.code.codingpreferred​http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity
http://terminology.hl7.org/uv/eyecare/ValueSet-observation-visual-acuity
Observation.value[x]:valueQuantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
Observation.value[x]:valueQuantity.codepreferredVisualAcuityQuantityUnits
https://larfuma.github.io/fhir-eyecare-ig/ValueSet/visual-acuity-quantity-units
from this IG
Observation.value[x]:valueCodeableConceptpreferred​https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-categorical-values
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.bodySiterequiredValueSet-right-left-both-eyes
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-right-left-both-eyes.html
from this IG
Observation.methodpreferredOphthalmologyVisualAcuityMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-observation-visual-acuity-methods
from this IG
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:Correction-in-front-of-right-eye.codeexampleFixed Value: LOINC Code 29073-4("Right Eye position")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Correction-in-front-of-right-eye.value[x]preferredVisualAcuityCorrectionMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-correction-methods-with-sl
from this IG
Observation.component:Correction-in-front-of-right-eye.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:Correction-in-front-of-right-eye.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:Correction-in-front-of-left-eye.codeexampleFixed Value: LOINC Code 29074-2("Left eye Position")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Correction-in-front-of-left-eye.value[x]preferredVisualAcuityCorrectionMethods
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-correction-methods-with-sl
from this IG
Observation.component:Correction-in-front-of-left-eye.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:Correction-in-front-of-left-eye.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:Test-Distance.codeexampleFixed Value: SNOMED-CT Code 252124009("Test distance")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Test-Distance.value[x]:valueCodeableConceptpreferredVisualAcuityTestDistance
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-visual-acuity-test-distance
from this IG
Observation.component:Test-Distance.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:Test-Distance.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:Optotype-used.codeexampleFixed Value: Optotype("Optotype")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:Optotype-used.value[x]preferredOptotypes
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-optotypes
from this IG
Observation.component:Optotype-used.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:Optotype-used.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component:SpecialVATestingParameters.codeexampleFixed Value: SNOMED-CT Code 370115009("Special Concept")
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component:SpecialVATestingParameters.value[x]preferred​https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html
https://larfuma.github.io/fhir-eyecare-ig/ValueSet-special-va-testing-parameters.html
Observation.component:SpecialVATestingParameters.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component:SpecialVATestingParameters.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
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-dh-va-01errorObservation.value[x]:valueRatioValue shall include numerator value and denominator value
: numerator.value.exists() and denominator.value.exists()
inv-dh-va-02errorObservation.value[x]:valueQuantityValue shall include value and unit
: value.exists() and unit.exists()
inv-va-01warningObservation.value[x]:valueStringUse of valueString is discouraged; please use structured data types instead.
: true
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 ObservationBase

Summary

Mandatory: 1 element
Must-Support: 2 elements
Fixed: 6 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.value[x]
  • The element 2 is sliced based on the values of Observation.component
  • The element 1 is sliced based on the value of Observation.component.value[x]

 

Other representations of profile: CSV, Excel, Schematron