HL7 FHIR® Implementation Guide: Ophthalmology Retinal, Release 1
0.1.0 - STU 1 Ballot

HL7 FHIR® Implementation Guide: Ophthalmology Retinal, Release 1, published by HL7 International - Patient Care WG. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7/fhir-eyecare-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Ocular anatomical location

Defining URL:http://hl7.org/fhir/uv/eyecare/StructureDefinition/body-structure-eye
Version:0.1.0
Name:BodyStructureEye
Title:Ocular anatomical location
Status:Draft as of 2022-06-24 01:58:09+0000
Definition:

The description of an ophthalmic anatomical site that is located within the following structures: the eyeball or the periocular or orbital regions (as opposed to non-ocular anatomical locations). This profile is used by combining the unique valueset (hyperlink) for relevant ophthalmic specific BodyStructure.locationQualifier (Body Site modifier) in combination with the base Observation BodyStructure.location (Body Site; descendants from SNOMED 371398005 (Eye Region Structure), each with a preferred binding in order to refine the accuracy of the location decription of occular structures. This unique qualifying element is important because these locations are routinely described either diffently and/or more granularly than other body parts. Of note - non occular (or surrounding) anatomical location references of Observations (eg - arm) do not need to use this modified specialty profile.

Publisher:HL7 International - Patient Care WG
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/uv/eyecare/StructureDefinition/body-structure-eye

Formal Views of Profile Content

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

This structure is derived from BodyStructure

Summary

Must-Support: 2 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure 0..*BodyStructureSpecific and identified anatomical structure
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBodystructure identifier
... active ?!Σ0..1booleanWhether this record is in active use
... morphology Σ0..1CodeableConceptKind of Structure
Binding: SNOMEDCTMorphologicAbnormalities (example): Codes describing anatomic morphology.

... location SΣ0..1CodeableConceptBody site
Binding: Ophthalmic anatomical location (preferred)
... locationQualifier S0..*CodeableConceptBody site modifier
Binding: Ophthalmic anatomical location qualifiers (preferred)
... description Σ0..1stringText description
... image 0..*AttachmentAttached images
... patient Σ1..1Reference(Patient)Who this is about

doco Documentation for this format

This structure is derived from BodyStructure

Summary

Must-Support: 2 elements

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure 0..*BodyStructureSpecific and identified anatomical structure
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBodystructure identifier
... active ?!Σ0..1booleanWhether this record is in active use
... morphology Σ0..1CodeableConceptKind of Structure
Binding: SNOMEDCTMorphologicAbnormalities (example): Codes describing anatomic morphology.

... location SΣ0..1CodeableConceptBody site
Binding: Ophthalmic anatomical location (preferred)
... locationQualifier S0..*CodeableConceptBody site modifier
Binding: Ophthalmic anatomical location qualifiers (preferred)
... description Σ0..1stringText description
... image 0..*AttachmentAttached images
... patient Σ1..1Reference(Patient)Who this is about

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
BodyStructure.languagepreferredCommonLanguages
Max Binding: AllLanguages
BodyStructure.morphologyexampleSNOMEDCTMorphologicAbnormalities
BodyStructure.locationpreferredOphthalmologyBodySiteEye
BodyStructure.locationQualifierpreferredBodyStructureQualifiers

Constraints

IdGradePathDetailsRequirements
dom-2errorBodyStructureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBodyStructureIf 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-4errorBodyStructureIf 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-5errorBodyStructureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeBodyStructureA resource should have narrative for robust management
: text.`div`.exists()
ele-1errorBodyStructure.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBodyStructure.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBodyStructure.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBodyStructure.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBodyStructure.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBodyStructure.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBodyStructure.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBodyStructure.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBodyStructure.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBodyStructure.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBodyStructure.morphologyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBodyStructure.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBodyStructure.locationQualifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBodyStructure.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBodyStructure.imageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBodyStructure.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())