Specialty Eyecare CDA Implementation Guide, published by Dogwood Health Consulting. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cda-eyecare/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/cda/us/eyecare/StructureDefinition/VisualAcuityObservation | Version: 0.1.0 | |||
Draft as of 2024-02-07 | Computable Name: VisualAcuityObservation |
A constraint on ResultObservation that defines eyecare Visual Acuity measurements.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ResultObservation
Path | Conformance | ValueSet | URI |
Observation.code.code | required | VisualAcuityObservationCodeshttp://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityObservationCodes from this IG | |
Observation.methodCode.code | required | VisualAcuityMethodCodeshttp://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityMethodCodes from this IG | |
Observation.targetSiteCode.code | required | EyecareTargetSiteCodeshttp://hl7.org/cda/us/eyecare/ValueSet/EyecareTargetSiteCodes from this IG |
Path | Conformance | ValueSet / Code | URI |
Observation.classCode | required | Fixed Value: OBShttp://terminology.hl7.org/ValueSet/v3-ActClassObservation|2.0.0 | |
Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.code.code | required | VisualAcuityObservationCodeshttp://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityObservationCodes from this IG | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.statusCode.code | required | Result Status http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39 | |
Observation.value:physical-quantity.unit | preferred | UnitsOfMeasureCaseSensitive (a valid code from UCUM)http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive | |
Observation.methodCode | example | ObservationMethodhttp://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
Observation.methodCode.code | required | VisualAcuityMethodCodeshttp://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityMethodCodes from this IG | |
Observation.targetSiteCode.code | required | EyecareTargetSiteCodeshttp://hl7.org/cda/us/eyecare/ValueSet/EyecareTargetSiteCodes from this IG |
Id | Grade | Path(s) | Details | Requirements |
4537-19212 | warning | Observation.code | This code **SHOULD** be a code from the LOINC that identifies the result observation. If an appropriate LOINC code does not exist, then the local code for this result **SHALL** be sent (CONF:4537-19212). : codeSystem = '2.16.840.1.113883.6.1' | |
shall-code-or-nullflavor | error | Observation.code | SHALL contain either a @code attribute or a @nullFlavor attribute, but not both. : (code | nullFlavor).count() = 1 | |
should-author | warning | Observation | SHOULD contain author : author.exists() | |
should-interpretationCode | warning | Observation | SHOULD contain interpretationCode : interpretationCode.exists() | |
should-referenceRange | warning | Observation | SHOULD contain referenceRange : referenceRange.exists() | |
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() |
Path | Conformance | ValueSet / Code | URI |
Observation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.templateId:result-obs.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.classCode | required | Fixed Value: OBShttp://terminology.hl7.org/ValueSet/v3-ActClassObservation|2.0.0 | |
Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.code.code | required | VisualAcuityObservationCodeshttp://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityObservationCodes from this IG | |
Observation.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Observation.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Observation.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.statusCode.code | required | Result Status http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39 | |
Observation.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Observation.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages from the FHIR Standard | |
Observation.value:physical-quantity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.value:physical-quantity.unit | preferred | UnitsOfMeasureCaseSensitive (a valid code from UCUM)http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive | |
Observation.value:coded.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.interpretationCode | required | ObservationInterpretationhttp://terminology.hl7.org/ValueSet/v3-ObservationInterpretation | |
Observation.methodCode | example | ObservationMethodhttp://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
Observation.methodCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.methodCode.code | required | VisualAcuityMethodCodeshttp://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityMethodCodes from this IG | |
Observation.targetSiteCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.targetSiteCode.code | required | EyecareTargetSiteCodeshttp://hl7.org/cda/us/eyecare/ValueSet/EyecareTargetSiteCodes from this IG | |
Observation.entryRelationship.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship.typeCode | required | XActRelationshipEntryRelationshiphttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Observation.referenceRange.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeCode | required | Fixed Value: REFVhttp://terminology.hl7.org/ValueSet/v3-ActRelationshipType|2.0.0 | |
Observation.referenceRange.observationRange.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.observationRange.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.observationRange.classCode | required | ActClassObservationhttp://terminology.hl7.org/ValueSet/v3-ActClassObservation | |
Observation.referenceRange.observationRange.moodCode | required | Fixed Value: EVN.CRThttp://terminology.hl7.org/ValueSet/v3-ActMoodPredicate | |
Observation.referenceRange.observationRange.interpretationCode | required | ObservationInterpretationhttp://terminology.hl7.org/ValueSet/v3-ObservationInterpretation | |
Observation.referenceRange.observationRange.sdtcPrecondition1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.observationRange.sdtcPrecondition1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.observationRange.sdtcPrecondition1.typeCode | required | Fixed Value: PRCNhttp://terminology.hl7.org/ValueSet/v3-ActRelationshipType | |
Observation.referenceRange.observationRange.sdtcPrecondition1.conjunctionCode | required | RelationshipConjunctionhttp://terminology.hl7.org/ValueSet/v3-RelationshipConjunction|2.0.0 |
Id | Grade | Path(s) | Details | Requirements |
4537-19212 | warning | Observation.code | This code **SHOULD** be a code from the LOINC that identifies the result observation. If an appropriate LOINC code does not exist, then the local code for this result **SHALL** be sent (CONF:4537-19212). : codeSystem = '2.16.840.1.113883.6.1' | |
shall-code-or-nullflavor | error | Observation.code | SHALL contain either a @code attribute or a @nullFlavor attribute, but not both. : (code | nullFlavor).count() = 1 | |
should-author | warning | Observation, Observation.entryRelationship.observation | SHOULD contain author : author.exists() | |
should-interpretationCode | warning | Observation, Observation.entryRelationship.observation | SHOULD contain interpretationCode : interpretationCode.exists() | |
should-referenceRange | warning | Observation, Observation.entryRelationship.observation | SHOULD contain referenceRange : referenceRange.exists() | |
should-text-ref-value | warning | Observation, Observation.entryRelationship.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from ResultObservation
Differential View
This structure is derived from ResultObservation
Path | Conformance | ValueSet | URI |
Observation.code.code | required | VisualAcuityObservationCodeshttp://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityObservationCodes from this IG | |
Observation.methodCode.code | required | VisualAcuityMethodCodeshttp://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityMethodCodes from this IG | |
Observation.targetSiteCode.code | required | EyecareTargetSiteCodeshttp://hl7.org/cda/us/eyecare/ValueSet/EyecareTargetSiteCodes from this IG |
Key Elements View
Path | Conformance | ValueSet / Code | URI |
Observation.classCode | required | Fixed Value: OBShttp://terminology.hl7.org/ValueSet/v3-ActClassObservation|2.0.0 | |
Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.code.code | required | VisualAcuityObservationCodeshttp://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityObservationCodes from this IG | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.statusCode.code | required | Result Status http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39 | |
Observation.value:physical-quantity.unit | preferred | UnitsOfMeasureCaseSensitive (a valid code from UCUM)http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive | |
Observation.methodCode | example | ObservationMethodhttp://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
Observation.methodCode.code | required | VisualAcuityMethodCodeshttp://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityMethodCodes from this IG | |
Observation.targetSiteCode.code | required | EyecareTargetSiteCodeshttp://hl7.org/cda/us/eyecare/ValueSet/EyecareTargetSiteCodes from this IG |
Id | Grade | Path(s) | Details | Requirements |
4537-19212 | warning | Observation.code | This code **SHOULD** be a code from the LOINC that identifies the result observation. If an appropriate LOINC code does not exist, then the local code for this result **SHALL** be sent (CONF:4537-19212). : codeSystem = '2.16.840.1.113883.6.1' | |
shall-code-or-nullflavor | error | Observation.code | SHALL contain either a @code attribute or a @nullFlavor attribute, but not both. : (code | nullFlavor).count() = 1 | |
should-author | warning | Observation | SHOULD contain author : author.exists() | |
should-interpretationCode | warning | Observation | SHOULD contain interpretationCode : interpretationCode.exists() | |
should-referenceRange | warning | Observation | SHOULD contain referenceRange : referenceRange.exists() | |
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() |
Snapshot View
Path | Conformance | ValueSet / Code | URI |
Observation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.templateId:result-obs.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.classCode | required | Fixed Value: OBShttp://terminology.hl7.org/ValueSet/v3-ActClassObservation|2.0.0 | |
Observation.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.code.code | required | VisualAcuityObservationCodeshttp://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityObservationCodes from this IG | |
Observation.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Observation.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Observation.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.statusCode.code | required | Result Status http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39 | |
Observation.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Observation.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages from the FHIR Standard | |
Observation.value:physical-quantity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.value:physical-quantity.unit | preferred | UnitsOfMeasureCaseSensitive (a valid code from UCUM)http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive | |
Observation.value:coded.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.interpretationCode | required | ObservationInterpretationhttp://terminology.hl7.org/ValueSet/v3-ObservationInterpretation | |
Observation.methodCode | example | ObservationMethodhttp://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
Observation.methodCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.methodCode.code | required | VisualAcuityMethodCodeshttp://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityMethodCodes from this IG | |
Observation.targetSiteCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.targetSiteCode.code | required | EyecareTargetSiteCodeshttp://hl7.org/cda/us/eyecare/ValueSet/EyecareTargetSiteCodes from this IG | |
Observation.entryRelationship.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.entryRelationship.typeCode | required | XActRelationshipEntryRelationshiphttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
Observation.referenceRange.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeCode | required | Fixed Value: REFVhttp://terminology.hl7.org/ValueSet/v3-ActRelationshipType|2.0.0 | |
Observation.referenceRange.observationRange.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.observationRange.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.observationRange.classCode | required | ActClassObservationhttp://terminology.hl7.org/ValueSet/v3-ActClassObservation | |
Observation.referenceRange.observationRange.moodCode | required | Fixed Value: EVN.CRThttp://terminology.hl7.org/ValueSet/v3-ActMoodPredicate | |
Observation.referenceRange.observationRange.interpretationCode | required | ObservationInterpretationhttp://terminology.hl7.org/ValueSet/v3-ObservationInterpretation | |
Observation.referenceRange.observationRange.sdtcPrecondition1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.observationRange.sdtcPrecondition1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.observationRange.sdtcPrecondition1.typeCode | required | Fixed Value: PRCNhttp://terminology.hl7.org/ValueSet/v3-ActRelationshipType | |
Observation.referenceRange.observationRange.sdtcPrecondition1.conjunctionCode | required | RelationshipConjunctionhttp://terminology.hl7.org/ValueSet/v3-RelationshipConjunction|2.0.0 |
Id | Grade | Path(s) | Details | Requirements |
4537-19212 | warning | Observation.code | This code **SHOULD** be a code from the LOINC that identifies the result observation. If an appropriate LOINC code does not exist, then the local code for this result **SHALL** be sent (CONF:4537-19212). : codeSystem = '2.16.840.1.113883.6.1' | |
shall-code-or-nullflavor | error | Observation.code | SHALL contain either a @code attribute or a @nullFlavor attribute, but not both. : (code | nullFlavor).count() = 1 | |
should-author | warning | Observation, Observation.entryRelationship.observation | SHOULD contain author : author.exists() | |
should-interpretationCode | warning | Observation, Observation.entryRelationship.observation | SHOULD contain interpretationCode : interpretationCode.exists() | |
should-referenceRange | warning | Observation, Observation.entryRelationship.observation | SHOULD contain referenceRange : referenceRange.exists() | |
should-text-ref-value | warning | Observation, Observation.entryRelationship.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from ResultObservation