HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1.0 (Standard for Trial Use)

This page is part of the Occupational Data for Health (ODH) FHIR IG (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions

RelationToLandmark

 

The official URL for this extension is: 

http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-RelationToLandmark-extension

The relationship between a landmark that helps determine a body location and the body location itself. The location relative to a landmark is specified by:

  • Specifying the location and type of landmark using a body site code and optional laterality/orientation,
  • Specifying the direction from the landmark to the body location, and
  • Specifying the distance from the landmark to the body location.

The RelationToLandmark element is part of BodyLocation, a flexible structure that allows the location to be determined by a single code, or a code plus laterality and/or orientation. The body location can also be specified in relation to one or more body landmarks. SNOMED CT is used in all cases.

  • Code only: The code should include (precoordinate) laterality and/orientation to the degree necessary to completely specify the body location.
  • Code plus laterality and/or orientation: The basic code augmented by codes specifying the body side and/or anatomical orientation.
  • Relation to landmark: The location relative to a landmark is specified by:
    1. Establishing the location and type of landmark using a body site code and optional laterality/orientation, and
    2. Specifying the direction and distance from the landmark to the body location.

Note that BodyLocation is a data type (a reusable structure), not a stand-alone entity. The concept is similar to how a postal address can apply to a person, location, or organization. This contrasts with FHIR’s stand-alone BodySite (aka BodyStructure in r4) which ‘is not … intended for describing the type of anatomical location but rather a specific body site on a specific patient’ (FHIR 3.5).

This extension was published on Sat Jan 04 00:00:00 UTC 2020 as a draft by HL7 International Public Health Work Group.

Summary

Mandatory: 0 element (6 nested mandatory elements)
Fixed Value: 8 elements
Prohibited: 8 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionRelationToLandmark
... extension:landmarkType 0..1Extension
.... extension 0..0
.... url uri"landmarkType"
.... valueCodeableConcept 1..CodeableConceptBinding: Landmark Type VS (extensible)
... extension:landmarkLocation 0..1Extension
.... extension:code 0..1Extension
..... extension 0..0
..... url uri"code"
..... valueCodeableConcept 1..CodeableConcept
.... extension:laterality 0..1Extension
..... extension 0..0
..... url uri"laterality"
..... valueCodeableConcept 1..CodeableConceptBinding: Laterality VS (extensible)
.... extension:anatomicalOrientation 0..1Extension
..... extension 0..0
..... url uri"anatomicalOrientation"
..... valueCodeableConcept 1..CodeableConceptBinding: Anatomical Orientation VS (extensible)
.... url uri"landmarkLocation"
.... value[x] 0..0
... extension:landmarkToBodyLocationDirection 0..1Extension
.... extension 0..0
.... url uri"landmarkToBodyLocationDirection"
.... valueCodeableConcept 1..CodeableConceptBinding: Anatomical Direction VS (preferred)
... extension:landmarkToBodyLocationDistance 0..1Extension
.... extension 0..0
.... url uri"landmarkToBodyLocationDistance"
.... valueQuantity 1..QuantityBinding: Units Of Length VS (required)
... url uri"http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-RelationToLandmark-extension"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*ExtensionRelationToLandmark
ext-1: Must have either extensions or value[x], not both
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:landmarkType 0..1Extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"landmarkType"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Landmark Type VS (extensible)
... extension:landmarkLocation 0..1Extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:code 0..1Extension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"code"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
.... extension:laterality 0..1Extension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"laterality"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Laterality VS (extensible)
.... extension:anatomicalOrientation 0..1Extension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"anatomicalOrientation"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Anatomical Orientation VS (extensible)
.... url 1..1uri"landmarkLocation"
... extension:landmarkToBodyLocationDirection 0..1Extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"landmarkToBodyLocationDirection"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Anatomical Direction VS (preferred)
... extension:landmarkToBodyLocationDistance 0..1Extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"landmarkToBodyLocationDistance"
.... valueQuantity 1..1QuantityValue of extension
Binding: Units Of Length VS (required)
... url 1..1uri"http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-RelationToLandmark-extension"

doco Documentation for this format

Summary

Mandatory: 0 element (6 nested mandatory elements)
Fixed Value: 8 elements
Prohibited: 8 elements

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionRelationToLandmark
... extension:landmarkType 0..1Extension
.... extension 0..0
.... url uri"landmarkType"
.... valueCodeableConcept 1..CodeableConceptBinding: Landmark Type VS (extensible)
... extension:landmarkLocation 0..1Extension
.... extension:code 0..1Extension
..... extension 0..0
..... url uri"code"
..... valueCodeableConcept 1..CodeableConcept
.... extension:laterality 0..1Extension
..... extension 0..0
..... url uri"laterality"
..... valueCodeableConcept 1..CodeableConceptBinding: Laterality VS (extensible)
.... extension:anatomicalOrientation 0..1Extension
..... extension 0..0
..... url uri"anatomicalOrientation"
..... valueCodeableConcept 1..CodeableConceptBinding: Anatomical Orientation VS (extensible)
.... url uri"landmarkLocation"
.... value[x] 0..0
... extension:landmarkToBodyLocationDirection 0..1Extension
.... extension 0..0
.... url uri"landmarkToBodyLocationDirection"
.... valueCodeableConcept 1..CodeableConceptBinding: Anatomical Direction VS (preferred)
... extension:landmarkToBodyLocationDistance 0..1Extension
.... extension 0..0
.... url uri"landmarkToBodyLocationDistance"
.... valueQuantity 1..QuantityBinding: Units Of Length VS (required)
... url uri"http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-RelationToLandmark-extension"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*ExtensionRelationToLandmark
ext-1: Must have either extensions or value[x], not both
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:landmarkType 0..1Extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"landmarkType"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Landmark Type VS (extensible)
... extension:landmarkLocation 0..1Extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:code 0..1Extension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"code"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
.... extension:laterality 0..1Extension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"laterality"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Laterality VS (extensible)
.... extension:anatomicalOrientation 0..1Extension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"anatomicalOrientation"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Anatomical Orientation VS (extensible)
.... url 1..1uri"landmarkLocation"
... extension:landmarkToBodyLocationDirection 0..1Extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"landmarkToBodyLocationDirection"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Anatomical Direction VS (preferred)
... extension:landmarkToBodyLocationDistance 0..1Extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"landmarkToBodyLocationDistance"
.... valueQuantity 1..1QuantityValue of extension
Binding: Units Of Length VS (required)
... url 1..1uri"http://hl7.org/fhir/us/odh/StructureDefinition/obf-datatype-RelationToLandmark-extension"

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet
Extension.extension:landmarkType.valueCodeableConceptextensibleLandmarkTypeVS
Extension.extension:landmarkLocation.extension:laterality.valueCodeableConceptextensibleLateralityVS
Extension.extension:landmarkLocation.extension:anatomicalOrientation.valueCodeableConceptextensibleAnatomicalOrientationVS
Extension.extension:landmarkToBodyLocationDirection.valueCodeableConceptpreferredAnatomicalDirectionVS
Extension.extension:landmarkToBodyLocationDistance.valueQuantityrequiredUnitsOfLengthVS

 

Constraints

IdPathDetailsRequirements
ele-1ExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Usage

This extension is used in the following profiles: