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: Ocular anatomical location ( Experimental )

Official URL: http://hl7.org/fhir/uv/eyecare/StructureDefinition/body-structure-eye Version: 0.1.0
Draft as of 2024-12-31 Computable Name: BodyStructureEye

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.

Usage:

Formal Views of Profile Content

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

This structure is derived from BodyStructure

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure BodyStructure
... location S 0..1 CodeableConcept Body site
Binding: Ophthalmic anatomical location (preferred)
... locationQualifier S 0..* CodeableConcept Body site modifier
Binding: Ophthalmic anatomical location qualifiers (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
BodyStructure.locationpreferredOphthalmologyBodySiteEye
http://terminology.hl7.org/uv/eyecare/ValueSet/body-site-eye
from this IG
BodyStructure.locationQualifierpreferredBodyStructureQualifiers
http://terminology.hl7.org/uv/eyecare/ValueSet/qualifiers
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure 0..* BodyStructure Specific and identified anatomical structure
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
... 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
... active ?!Σ 0..1 boolean Whether this record is in active use
ele-1: All FHIR elements must have a @value or children
... locationQualifier S 0..* CodeableConcept Body site modifier
Binding: Ophthalmic anatomical location qualifiers (preferred)
ele-1: All FHIR elements must have a @value or children
... patient Σ 1..1 Reference(Patient) Who this is about
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BodyStructure.locationpreferredOphthalmologyBodySiteEye
http://terminology.hl7.org/uv/eyecare/ValueSet/body-site-eye
from this IG
BodyStructure.locationQualifierpreferredBodyStructureQualifiers
http://terminology.hl7.org/uv/eyecare/ValueSet/qualifiers
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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-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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure 0..* BodyStructure Specific and identified anatomical structure
... 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
... 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 Bodystructure identifier
... active ?!Σ 0..1 boolean Whether this record is in active use
... morphology Σ 0..1 CodeableConcept Kind of Structure
Binding: SNOMEDCTMorphologicAbnormalities (example): Codes describing anatomic morphology.

... location SΣ 0..1 CodeableConcept Body site
Binding: Ophthalmic anatomical location (preferred)
... locationQualifier S 0..* CodeableConcept Body site modifier
Binding: Ophthalmic anatomical location qualifiers (preferred)
... description Σ 0..1 string Text description
... image 0..* Attachment Attached images
... patient Σ 1..1 Reference(Patient) Who this is about

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BodyStructure.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
BodyStructure.morphologyexampleSNOMEDCTMorphologicAbnormalities
http://hl7.org/fhir/ValueSet/bodystructure-code
from the FHIR Standard
BodyStructure.locationpreferredOphthalmologyBodySiteEye
http://terminology.hl7.org/uv/eyecare/ValueSet/body-site-eye
from this IG
BodyStructure.locationQualifierpreferredBodyStructureQualifiers
http://terminology.hl7.org/uv/eyecare/ValueSet/qualifiers
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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-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()

This structure is derived from BodyStructure

Summary

Must-Support: 2 elements

Differential View

This structure is derived from BodyStructure

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure BodyStructure
... location S 0..1 CodeableConcept Body site
Binding: Ophthalmic anatomical location (preferred)
... locationQualifier S 0..* CodeableConcept Body site modifier
Binding: Ophthalmic anatomical location qualifiers (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
BodyStructure.locationpreferredOphthalmologyBodySiteEye
http://terminology.hl7.org/uv/eyecare/ValueSet/body-site-eye
from this IG
BodyStructure.locationQualifierpreferredBodyStructureQualifiers
http://terminology.hl7.org/uv/eyecare/ValueSet/qualifiers
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure 0..* BodyStructure Specific and identified anatomical structure
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
... 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
... active ?!Σ 0..1 boolean Whether this record is in active use
ele-1: All FHIR elements must have a @value or children
... locationQualifier S 0..* CodeableConcept Body site modifier
Binding: Ophthalmic anatomical location qualifiers (preferred)
ele-1: All FHIR elements must have a @value or children
... patient Σ 1..1 Reference(Patient) Who this is about
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BodyStructure.locationpreferredOphthalmologyBodySiteEye
http://terminology.hl7.org/uv/eyecare/ValueSet/body-site-eye
from this IG
BodyStructure.locationQualifierpreferredBodyStructureQualifiers
http://terminology.hl7.org/uv/eyecare/ValueSet/qualifiers
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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-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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure 0..* BodyStructure Specific and identified anatomical structure
... 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
... 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 Bodystructure identifier
... active ?!Σ 0..1 boolean Whether this record is in active use
... morphology Σ 0..1 CodeableConcept Kind of Structure
Binding: SNOMEDCTMorphologicAbnormalities (example): Codes describing anatomic morphology.

... location SΣ 0..1 CodeableConcept Body site
Binding: Ophthalmic anatomical location (preferred)
... locationQualifier S 0..* CodeableConcept Body site modifier
Binding: Ophthalmic anatomical location qualifiers (preferred)
... description Σ 0..1 string Text description
... image 0..* Attachment Attached images
... patient Σ 1..1 Reference(Patient) Who this is about

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BodyStructure.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
BodyStructure.morphologyexampleSNOMEDCTMorphologicAbnormalities
http://hl7.org/fhir/ValueSet/bodystructure-code
from the FHIR Standard
BodyStructure.locationpreferredOphthalmologyBodySiteEye
http://terminology.hl7.org/uv/eyecare/ValueSet/body-site-eye
from this IG
BodyStructure.locationQualifierpreferredBodyStructureQualifiers
http://terminology.hl7.org/uv/eyecare/ValueSet/qualifiers
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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-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()

This structure is derived from BodyStructure

Summary

Must-Support: 2 elements

 

Other representations of profile: CSV, Excel, Schematron