HL7 Europe Base and Core FHIR IG
2.0.0-recon - ci-build 150

HL7 Europe Base and Core FHIR IG, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 2.0.0-recon built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/base/ and changes regularly. See the Directory of published versions

Resource Profile: BodyStructure (EU core)

Official URL: http://hl7.eu/fhir/base/StructureDefinition/bodyStructure-eu-core Version: 2.0.0-recon
Standards status: Trial-use Maturity Level: 2 Computable Name: BodyStructureEuCore

Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0).

This profile introduces essential constraints and extensions for the BodyStructure resource that apply across multiple use cases.

Body Site and Laterality

When expressing a body site with laterality, use BodyStructure.includedStructure: the body site code goes into includedStructure.structure and the laterality into includedStructure.laterality.

Qualifier

Additional positional qualifiers (e.g. "upper", "anterior", "superficial") can be expressed via includedStructure.qualifier. Multiple qualifiers may be provided within the same includedStructure entry.

Laterality only (structure unknown or not provided)

In some cases only the laterality is relevant or the specific body structure code is not known and cannot be populated. In these situations, the data-absent-reason extension can be applied to includedStructure.structure to satisfy the FHIR cardinality requirement while making clear that the value is absent, allowing includedStructure.laterality to carry the laterality information on its own.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BodyStructure 0..* BodyStructure Specific and identified anatomical structure
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Textual description of the body structure
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:includedStructure 0..* (Complex) Included anatomic location(s)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure
Constraints: ext-1
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Closed by value:url
Constraints: ext-1
...... extension:structure 1..1 Extension Extension
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "structure"
....... value[x] 0..1 CodeableConcept Code that represents the included structure
Binding: SNOMEDCTBodyStructures (preferred)
...... extension:laterality 0..1 Extension Extension
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "laterality"
....... value[x] 0..1 CodeableConcept Code that represents the included structure laterality
Binding: Body Structure Laterality (preferred)
...... extension:bodyLandmarkOrientation 0..* Extension Landmark relative location
Constraints: ext-1
....... Slices for extension Content/Rules for all slices
........ extension:landmarkDescription 0..* Extension Body ]andmark description
Constraints: ext-1
......... url 1..1 uri "landmarkDescription"
........ extension:clockFacePosition 0..* Extension Clockface orientation
Constraints: ext-1
......... url 1..1 uri "clockFacePosition"
........ extension:distanceFromLandmark 0..* Extension Landmark relative location
Constraints: ext-1
......... Slices for extension Content/Rules for all slices
.......... extension:device 0..* Extension Measurement device
Constraints: ext-1
........... Slices for extension Content/Rules for all slices
............ extension:concept 0..1 Extension Reference to a concept (by class)
Constraints: ext-1
............. url 1..1 uri "concept"
............ extension:reference 0..1 Extension Reference to a resource (by instance)
Constraints: ext-1
............. url 1..1 uri "reference"
............ extension:_datatype 0..1 (Complex) Data type name for BodyStructure.includedStructure.bodyLandmarkOrientation.distanceFromLandmark.device from FHIR R5
URL: http://hl7.org/fhir/StructureDefinition/_datatype
Constraints: ext-1
............. extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
............. url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
............. value[x] 1..1 string Value of extension
Fixed Value: CodeableReference
........... url 1..1 uri "device"
.......... extension:value 0..* Extension Measured distance from body landmark
Constraints: ext-1
........... url 1..1 uri "value"
......... url 1..1 uri "distanceFromLandmark"
........ extension:surfaceOrientation 0..* Extension Relative landmark surface orientation
Constraints: ext-1
......... url 1..1 uri "surfaceOrientation"
....... url 1..1 uri "bodyLandmarkOrientation"
...... extension:spatialReference 0..* Extension Cartesian reference for structure
Constraints: ext-1
....... url 1..1 uri "spatialReference"
...... extension:qualifier 0..* Extension Extension
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "qualifier"
....... value[x] 0..1 CodeableConcept Code that represents the included structure qualifier
Binding: Body Structure Qualifier (preferred)
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure"
... identifier Σ 0..* Identifier Body structure identifier
... active ?!Σ 0..1 boolean Whether this record is in active use
... morphology Σ 0..1 CodeableConcept Kind of Structure
Binding: SNOMEDCTMorphologicAbnormalities (preferred)
... patient Σ 1..1 Reference(Patient) Who this is about

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
BodyStructure.extension:includedStructure.​extension:structure.​value[x] Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.
BodyStructure.extension:includedStructure.​extension:laterality.​value[x] Base preferred Body Structure Laterality 📦2.0.0-recon This IG
BodyStructure.extension:includedStructure.​extension:qualifier.​value[x] Base preferred Body Structure Qualifier 📦2.0.0-recon This IG
BodyStructure.morphology Base preferred SNOMED CT Morphologic Abnormalities 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error BodyStructure If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error BodyStructure 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 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-4 error BodyStructure If 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-5 error BodyStructure If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice BodyStructure A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from BodyStructure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BodyStructure 0..* BodyStructure Specific and identified anatomical structure
... text 0..1 Narrative Textual description of the body structure
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:includedStructure 0..* (Complex) Included anatomic location(s)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure
..... Slices for extension Content/Rules for all slices
...... extension:structure 1..1 Extension Extension
....... extension 0..0 Extension
....... value[x] 0..1 CodeableConcept Code that represents the included structure
Binding: SNOMEDCTBodyStructures (preferred)
...... extension:laterality 0..1 Extension Extension
....... extension 0..0 Extension
....... value[x] 0..1 CodeableConcept Code that represents the included structure laterality
Binding: Body Structure Laterality (preferred)
...... extension:qualifier 0..* Extension Extension
....... extension 0..0 Extension
....... value[x] 0..1 CodeableConcept Code that represents the included structure qualifier
Binding: Body Structure Qualifier (preferred)
..... value[x] 0..0 Value of extension
... identifier 0..* Identifier Body structure identifier
... location 0..0 Body site
... locationQualifier 0..0 Body site modifier

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
BodyStructure.extension:includedStructure.​extension:structure.​value[x] Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.
BodyStructure.extension:includedStructure.​extension:laterality.​value[x] Base preferred Body Structure Laterality 📦2.0.0-recon This IG
BodyStructure.extension:includedStructure.​extension:qualifier.​value[x] Base preferred Body Structure Qualifier 📦2.0.0-recon This IG
BodyStructure.morphology Base preferred SNOMED CT Morphologic Abnormalities 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 Textual description of the body structure
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:includedStructure 0..* (Complex) Included anatomic location(s)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Closed by value:url
Constraints: ext-1
...... extension:structure 1..1 Extension Extension
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "structure"
....... value[x] 0..1 CodeableConcept Code that represents the included structure
Binding: SNOMEDCTBodyStructures (preferred)
...... extension:laterality 0..1 Extension Extension
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "laterality"
....... value[x] 0..1 CodeableConcept Code that represents the included structure laterality
Binding: Body Structure Laterality (preferred)
...... extension:bodyLandmarkOrientation 0..* Extension Landmark relative location
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by value:url
Constraints: ext-1
........ extension:landmarkDescription 0..* Extension Body ]andmark description
Constraints: ext-1
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
......... url 1..1 uri "landmarkDescription"
......... value[x] 0..1 CodeableConcept Body ]andmark description
Binding: R5_body_site_for_R4 (0.0.1-snapshot-2) (example): Select SNOMED code system values. Values used in a podiatry setting to decsribe landmarks on the body.
........ extension:clockFacePosition 0..* Extension Clockface orientation
Constraints: ext-1
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
......... url 1..1 uri "clockFacePosition"
......... value[x] 0..1 CodeableConcept Clockface orientation
Binding: R5_bodystructure_bod_clo_position_for_R4 (0.0.1-snapshot-2) (example): Select SNOMED CT codes. A set of codes that describe a things orientation based on a hourly positions of a clock face.
........ extension:distanceFromLandmark 0..* Extension Landmark relative location
Constraints: ext-1
......... id 0..1 string Unique id for inter-element referencing
......... Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by value:url
Constraints: ext-1
.......... extension:device 0..* Extension Measurement device
Constraints: ext-1
........... id 0..1 string Unique id for inter-element referencing
........... Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by value:url
Constraints: ext-1
............ extension:concept 0..1 Extension Reference to a concept (by class)
Constraints: ext-1
............. id 0..1 string Unique id for inter-element referencing
............. extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
............. url 1..1 uri "concept"
............. value[x] 0..1 CodeableConcept Reference to a concept (by class)
............ extension:reference 0..1 Extension Reference to a resource (by instance)
Constraints: ext-1
............. id 0..1 string Unique id for inter-element referencing
............. extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
............. url 1..1 uri "reference"
............. value[x] 0..1 Reference() Reference to a resource (by instance)
............ extension:_datatype 0..1 (Complex) Data type name for BodyStructure.includedStructure.bodyLandmarkOrientation.distanceFromLandmark.device from FHIR R5
URL: http://hl7.org/fhir/StructureDefinition/_datatype
Constraints: ext-1
............. id 0..1 id Unique id for inter-element referencing
............. extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
............. url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
............. value[x] 1..1 string Value of extension
Fixed Value: CodeableReference
........... url 1..1 uri "device"
........... value[x] 0..1 Value of extension
............ valueBase64Binary base64Binary
............ valueBoolean boolean
............ valueCanonical canonical(Any)
............ valueCode code
............ valueDate date
............ valueDateTime dateTime
............ valueDecimal decimal
............ valueId id
............ valueInstant instant
............ valueInteger integer
............ valueMarkdown markdown
............ valueOid oid
............ valuePositiveInt positiveInt
............ valueString string
............ valueTime time
............ valueUnsignedInt unsignedInt
............ valueUri uri
............ valueUrl url
............ valueUuid uuid
............ valueAddress Address
............ valueAge Age
............ valueAnnotation Annotation
............ valueAttachment Attachment
............ valueCodeableConcept CodeableConcept
............ valueCoding Coding
............ valueContactPoint ContactPoint
............ valueCount Count
............ valueDistance Distance
............ valueDuration Duration
............ valueHumanName HumanName
............ valueIdentifier Identifier
............ valueMoney Money
............ valuePeriod Period
............ valueQuantity Quantity
............ valueRange Range
............ valueRatio Ratio
............ valueReference Reference(Any)
............ valueSampledData SampledData
............ valueSignature Signature
............ valueTiming Timing
............ valueContactDetail ContactDetail
............ valueContributor Contributor
............ valueDataRequirement DataRequirement
............ valueExpression Expression
............ valueParameterDefinition ParameterDefinition
............ valueRelatedArtifact RelatedArtifact
............ valueTriggerDefinition TriggerDefinition
............ valueUsageContext UsageContext
............ valueDosage Dosage
............ valueMeta Meta
.......... extension:value 0..* Extension Measured distance from body landmark
Constraints: ext-1
........... id 0..1 string Unique id for inter-element referencing
........... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
........... url 1..1 uri "value"
........... value[x] 0..1 Quantity Measured distance from body landmark
......... url 1..1 uri "distanceFromLandmark"
......... value[x] 0..1 Value of extension
.......... valueBase64Binary base64Binary
.......... valueBoolean boolean
.......... valueCanonical canonical(Any)
.......... valueCode code
.......... valueDate date
.......... valueDateTime dateTime
.......... valueDecimal decimal
.......... valueId id
.......... valueInstant instant
.......... valueInteger integer
.......... valueMarkdown markdown
.......... valueOid oid
.......... valuePositiveInt positiveInt
.......... valueString string
.......... valueTime time
.......... valueUnsignedInt unsignedInt
.......... valueUri uri
.......... valueUrl url
.......... valueUuid uuid
.......... valueAddress Address
.......... valueAge Age
.......... valueAnnotation Annotation
.......... valueAttachment Attachment
.......... valueCodeableConcept CodeableConcept
.......... valueCoding Coding
.......... valueContactPoint ContactPoint
.......... valueCount Count
.......... valueDistance Distance
.......... valueDuration Duration
.......... valueHumanName HumanName
.......... valueIdentifier Identifier
.......... valueMoney Money
.......... valuePeriod Period
.......... valueQuantity Quantity
.......... valueRange Range
.......... valueRatio Ratio
.......... valueReference Reference(Any)
.......... valueSampledData SampledData
.......... valueSignature Signature
.......... valueTiming Timing
.......... valueContactDetail ContactDetail
.......... valueContributor Contributor
.......... valueDataRequirement DataRequirement
.......... valueExpression Expression
.......... valueParameterDefinition ParameterDefinition
.......... valueRelatedArtifact RelatedArtifact
.......... valueTriggerDefinition TriggerDefinition
.......... valueUsageContext UsageContext
.......... valueDosage Dosage
.......... valueMeta Meta
........ extension:surfaceOrientation 0..* Extension Relative landmark surface orientation
Constraints: ext-1
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
......... url 1..1 uri "surfaceOrientation"
......... value[x] 0..1 CodeableConcept Relative landmark surface orientation
Binding: R5_bodystructure_relative_location_for_R4 (0.0.1-snapshot-2) (preferred): Select SNOMED code system values. The surface area a body location is in relation to a landmark.
....... url 1..1 uri "bodyLandmarkOrientation"
....... value[x] 0..1 Value of extension
........ valueBase64Binary base64Binary
........ valueBoolean boolean
........ valueCanonical canonical(Any)
........ valueCode code
........ valueDate date
........ valueDateTime dateTime
........ valueDecimal decimal
........ valueId id
........ valueInstant instant
........ valueInteger integer
........ valueMarkdown markdown
........ valueOid oid
........ valuePositiveInt positiveInt
........ valueString string
........ valueTime time
........ valueUnsignedInt unsignedInt
........ valueUri uri
........ valueUrl url
........ valueUuid uuid
........ valueAddress Address
........ valueAge Age
........ valueAnnotation Annotation
........ valueAttachment Attachment
........ valueCodeableConcept CodeableConcept
........ valueCoding Coding
........ valueContactPoint ContactPoint
........ valueCount Count
........ valueDistance Distance
........ valueDuration Duration
........ valueHumanName HumanName
........ valueIdentifier Identifier
........ valueMoney Money
........ valuePeriod Period
........ valueQuantity Quantity
........ valueRange Range
........ valueRatio Ratio
........ valueReference Reference(Any)
........ valueSampledData SampledData
........ valueSignature Signature
........ valueTiming Timing
........ valueContactDetail ContactDetail
........ valueContributor Contributor
........ valueDataRequirement DataRequirement
........ valueExpression Expression
........ valueParameterDefinition ParameterDefinition
........ valueRelatedArtifact RelatedArtifact
........ valueTriggerDefinition TriggerDefinition
........ valueUsageContext UsageContext
........ valueDosage Dosage
........ valueMeta Meta
...... extension:spatialReference 0..* Extension Cartesian reference for structure
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "spatialReference"
....... value[x] 0..1 Reference() Cartesian reference for structure
...... extension:qualifier 0..* Extension Extension
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "qualifier"
....... value[x] 0..1 CodeableConcept Code that represents the included structure qualifier
Binding: Body Structure Qualifier (preferred)
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Body structure identifier
... active ?!Σ 0..1 boolean Whether this record is in active use
... morphology Σ 0..1 CodeableConcept Kind of Structure
Binding: SNOMEDCTMorphologicAbnormalities (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

Path Status Usage ValueSet Version Source
BodyStructure.language Base preferred Common Languages 📍4.0.1 FHIR Std.
BodyStructure.extension:includedStructure.​extension:structure.​value[x] Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.
BodyStructure.extension:includedStructure.​extension:laterality.​value[x] Base preferred Body Structure Laterality 📦2.0.0-recon This IG
BodyStructure.extension:includedStructure.​extension:bodyLandmarkOrientation.​extension:landmarkDescription.​value[x] Base example Cross-version VS for R5.SNOMEDCTBodyStructures for use in FHIR R4 📍0.0.1-snapshot-2 FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5 v0.0
BodyStructure.extension:includedStructure.​extension:bodyLandmarkOrientation.​extension:clockFacePosition.​value[x] Base example Cross-version VS for R5.BodystructureBodyLandmarkClockFacePosition for use in FHIR R4 📍0.0.1-snapshot-2 FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5 v0.0
BodyStructure.extension:includedStructure.​extension:bodyLandmarkOrientation.​extension:surfaceOrientation.​value[x] Base preferred Cross-version VS for R5.BodystructureLocationQualifier for use in FHIR R4 📍0.0.1-snapshot-2 FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5 v0.0
BodyStructure.extension:includedStructure.​extension:qualifier.​value[x] Base preferred Body Structure Qualifier 📦2.0.0-recon This IG
BodyStructure.morphology Base preferred SNOMED CT Morphologic Abnormalities 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error BodyStructure If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error BodyStructure 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 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-4 error BodyStructure If 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-5 error BodyStructure If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice BodyStructure A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from BodyStructure

Summary

Prohibited: 6 elements

Extensions

This structure refers to these extensions:

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BodyStructure 0..* BodyStructure Specific and identified anatomical structure
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Textual description of the body structure
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:includedStructure 0..* (Complex) Included anatomic location(s)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure
Constraints: ext-1
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Closed by value:url
Constraints: ext-1
...... extension:structure 1..1 Extension Extension
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "structure"
....... value[x] 0..1 CodeableConcept Code that represents the included structure
Binding: SNOMEDCTBodyStructures (preferred)
...... extension:laterality 0..1 Extension Extension
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "laterality"
....... value[x] 0..1 CodeableConcept Code that represents the included structure laterality
Binding: Body Structure Laterality (preferred)
...... extension:bodyLandmarkOrientation 0..* Extension Landmark relative location
Constraints: ext-1
....... Slices for extension Content/Rules for all slices
........ extension:landmarkDescription 0..* Extension Body ]andmark description
Constraints: ext-1
......... url 1..1 uri "landmarkDescription"
........ extension:clockFacePosition 0..* Extension Clockface orientation
Constraints: ext-1
......... url 1..1 uri "clockFacePosition"
........ extension:distanceFromLandmark 0..* Extension Landmark relative location
Constraints: ext-1
......... Slices for extension Content/Rules for all slices
.......... extension:device 0..* Extension Measurement device
Constraints: ext-1
........... Slices for extension Content/Rules for all slices
............ extension:concept 0..1 Extension Reference to a concept (by class)
Constraints: ext-1
............. url 1..1 uri "concept"
............ extension:reference 0..1 Extension Reference to a resource (by instance)
Constraints: ext-1
............. url 1..1 uri "reference"
............ extension:_datatype 0..1 (Complex) Data type name for BodyStructure.includedStructure.bodyLandmarkOrientation.distanceFromLandmark.device from FHIR R5
URL: http://hl7.org/fhir/StructureDefinition/_datatype
Constraints: ext-1
............. extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
............. url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
............. value[x] 1..1 string Value of extension
Fixed Value: CodeableReference
........... url 1..1 uri "device"
.......... extension:value 0..* Extension Measured distance from body landmark
Constraints: ext-1
........... url 1..1 uri "value"
......... url 1..1 uri "distanceFromLandmark"
........ extension:surfaceOrientation 0..* Extension Relative landmark surface orientation
Constraints: ext-1
......... url 1..1 uri "surfaceOrientation"
....... url 1..1 uri "bodyLandmarkOrientation"
...... extension:spatialReference 0..* Extension Cartesian reference for structure
Constraints: ext-1
....... url 1..1 uri "spatialReference"
...... extension:qualifier 0..* Extension Extension
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "qualifier"
....... value[x] 0..1 CodeableConcept Code that represents the included structure qualifier
Binding: Body Structure Qualifier (preferred)
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure"
... identifier Σ 0..* Identifier Body structure identifier
... active ?!Σ 0..1 boolean Whether this record is in active use
... morphology Σ 0..1 CodeableConcept Kind of Structure
Binding: SNOMEDCTMorphologicAbnormalities (preferred)
... patient Σ 1..1 Reference(Patient) Who this is about

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
BodyStructure.extension:includedStructure.​extension:structure.​value[x] Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.
BodyStructure.extension:includedStructure.​extension:laterality.​value[x] Base preferred Body Structure Laterality 📦2.0.0-recon This IG
BodyStructure.extension:includedStructure.​extension:qualifier.​value[x] Base preferred Body Structure Qualifier 📦2.0.0-recon This IG
BodyStructure.morphology Base preferred SNOMED CT Morphologic Abnormalities 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error BodyStructure If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error BodyStructure 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 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-4 error BodyStructure If 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-5 error BodyStructure If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice BodyStructure A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from BodyStructure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BodyStructure 0..* BodyStructure Specific and identified anatomical structure
... text 0..1 Narrative Textual description of the body structure
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:includedStructure 0..* (Complex) Included anatomic location(s)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure
..... Slices for extension Content/Rules for all slices
...... extension:structure 1..1 Extension Extension
....... extension 0..0 Extension
....... value[x] 0..1 CodeableConcept Code that represents the included structure
Binding: SNOMEDCTBodyStructures (preferred)
...... extension:laterality 0..1 Extension Extension
....... extension 0..0 Extension
....... value[x] 0..1 CodeableConcept Code that represents the included structure laterality
Binding: Body Structure Laterality (preferred)
...... extension:qualifier 0..* Extension Extension
....... extension 0..0 Extension
....... value[x] 0..1 CodeableConcept Code that represents the included structure qualifier
Binding: Body Structure Qualifier (preferred)
..... value[x] 0..0 Value of extension
... identifier 0..* Identifier Body structure identifier
... location 0..0 Body site
... locationQualifier 0..0 Body site modifier

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
BodyStructure.extension:includedStructure.​extension:structure.​value[x] Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.
BodyStructure.extension:includedStructure.​extension:laterality.​value[x] Base preferred Body Structure Laterality 📦2.0.0-recon This IG
BodyStructure.extension:includedStructure.​extension:qualifier.​value[x] Base preferred Body Structure Qualifier 📦2.0.0-recon This IG
BodyStructure.morphology Base preferred SNOMED CT Morphologic Abnormalities 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 Textual description of the body structure
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:includedStructure 0..* (Complex) Included anatomic location(s)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Closed by value:url
Constraints: ext-1
...... extension:structure 1..1 Extension Extension
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "structure"
....... value[x] 0..1 CodeableConcept Code that represents the included structure
Binding: SNOMEDCTBodyStructures (preferred)
...... extension:laterality 0..1 Extension Extension
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "laterality"
....... value[x] 0..1 CodeableConcept Code that represents the included structure laterality
Binding: Body Structure Laterality (preferred)
...... extension:bodyLandmarkOrientation 0..* Extension Landmark relative location
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by value:url
Constraints: ext-1
........ extension:landmarkDescription 0..* Extension Body ]andmark description
Constraints: ext-1
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
......... url 1..1 uri "landmarkDescription"
......... value[x] 0..1 CodeableConcept Body ]andmark description
Binding: R5_body_site_for_R4 (0.0.1-snapshot-2) (example): Select SNOMED code system values. Values used in a podiatry setting to decsribe landmarks on the body.
........ extension:clockFacePosition 0..* Extension Clockface orientation
Constraints: ext-1
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
......... url 1..1 uri "clockFacePosition"
......... value[x] 0..1 CodeableConcept Clockface orientation
Binding: R5_bodystructure_bod_clo_position_for_R4 (0.0.1-snapshot-2) (example): Select SNOMED CT codes. A set of codes that describe a things orientation based on a hourly positions of a clock face.
........ extension:distanceFromLandmark 0..* Extension Landmark relative location
Constraints: ext-1
......... id 0..1 string Unique id for inter-element referencing
......... Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by value:url
Constraints: ext-1
.......... extension:device 0..* Extension Measurement device
Constraints: ext-1
........... id 0..1 string Unique id for inter-element referencing
........... Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by value:url
Constraints: ext-1
............ extension:concept 0..1 Extension Reference to a concept (by class)
Constraints: ext-1
............. id 0..1 string Unique id for inter-element referencing
............. extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
............. url 1..1 uri "concept"
............. value[x] 0..1 CodeableConcept Reference to a concept (by class)
............ extension:reference 0..1 Extension Reference to a resource (by instance)
Constraints: ext-1
............. id 0..1 string Unique id for inter-element referencing
............. extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
............. url 1..1 uri "reference"
............. value[x] 0..1 Reference() Reference to a resource (by instance)
............ extension:_datatype 0..1 (Complex) Data type name for BodyStructure.includedStructure.bodyLandmarkOrientation.distanceFromLandmark.device from FHIR R5
URL: http://hl7.org/fhir/StructureDefinition/_datatype
Constraints: ext-1
............. id 0..1 id Unique id for inter-element referencing
............. extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
............. url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
............. value[x] 1..1 string Value of extension
Fixed Value: CodeableReference
........... url 1..1 uri "device"
........... value[x] 0..1 Value of extension
............ valueBase64Binary base64Binary
............ valueBoolean boolean
............ valueCanonical canonical(Any)
............ valueCode code
............ valueDate date
............ valueDateTime dateTime
............ valueDecimal decimal
............ valueId id
............ valueInstant instant
............ valueInteger integer
............ valueMarkdown markdown
............ valueOid oid
............ valuePositiveInt positiveInt
............ valueString string
............ valueTime time
............ valueUnsignedInt unsignedInt
............ valueUri uri
............ valueUrl url
............ valueUuid uuid
............ valueAddress Address
............ valueAge Age
............ valueAnnotation Annotation
............ valueAttachment Attachment
............ valueCodeableConcept CodeableConcept
............ valueCoding Coding
............ valueContactPoint ContactPoint
............ valueCount Count
............ valueDistance Distance
............ valueDuration Duration
............ valueHumanName HumanName
............ valueIdentifier Identifier
............ valueMoney Money
............ valuePeriod Period
............ valueQuantity Quantity
............ valueRange Range
............ valueRatio Ratio
............ valueReference Reference(Any)
............ valueSampledData SampledData
............ valueSignature Signature
............ valueTiming Timing
............ valueContactDetail ContactDetail
............ valueContributor Contributor
............ valueDataRequirement DataRequirement
............ valueExpression Expression
............ valueParameterDefinition ParameterDefinition
............ valueRelatedArtifact RelatedArtifact
............ valueTriggerDefinition TriggerDefinition
............ valueUsageContext UsageContext
............ valueDosage Dosage
............ valueMeta Meta
.......... extension:value 0..* Extension Measured distance from body landmark
Constraints: ext-1
........... id 0..1 string Unique id for inter-element referencing
........... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
........... url 1..1 uri "value"
........... value[x] 0..1 Quantity Measured distance from body landmark
......... url 1..1 uri "distanceFromLandmark"
......... value[x] 0..1 Value of extension
.......... valueBase64Binary base64Binary
.......... valueBoolean boolean
.......... valueCanonical canonical(Any)
.......... valueCode code
.......... valueDate date
.......... valueDateTime dateTime
.......... valueDecimal decimal
.......... valueId id
.......... valueInstant instant
.......... valueInteger integer
.......... valueMarkdown markdown
.......... valueOid oid
.......... valuePositiveInt positiveInt
.......... valueString string
.......... valueTime time
.......... valueUnsignedInt unsignedInt
.......... valueUri uri
.......... valueUrl url
.......... valueUuid uuid
.......... valueAddress Address
.......... valueAge Age
.......... valueAnnotation Annotation
.......... valueAttachment Attachment
.......... valueCodeableConcept CodeableConcept
.......... valueCoding Coding
.......... valueContactPoint ContactPoint
.......... valueCount Count
.......... valueDistance Distance
.......... valueDuration Duration
.......... valueHumanName HumanName
.......... valueIdentifier Identifier
.......... valueMoney Money
.......... valuePeriod Period
.......... valueQuantity Quantity
.......... valueRange Range
.......... valueRatio Ratio
.......... valueReference Reference(Any)
.......... valueSampledData SampledData
.......... valueSignature Signature
.......... valueTiming Timing
.......... valueContactDetail ContactDetail
.......... valueContributor Contributor
.......... valueDataRequirement DataRequirement
.......... valueExpression Expression
.......... valueParameterDefinition ParameterDefinition
.......... valueRelatedArtifact RelatedArtifact
.......... valueTriggerDefinition TriggerDefinition
.......... valueUsageContext UsageContext
.......... valueDosage Dosage
.......... valueMeta Meta
........ extension:surfaceOrientation 0..* Extension Relative landmark surface orientation
Constraints: ext-1
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
......... url 1..1 uri "surfaceOrientation"
......... value[x] 0..1 CodeableConcept Relative landmark surface orientation
Binding: R5_bodystructure_relative_location_for_R4 (0.0.1-snapshot-2) (preferred): Select SNOMED code system values. The surface area a body location is in relation to a landmark.
....... url 1..1 uri "bodyLandmarkOrientation"
....... value[x] 0..1 Value of extension
........ valueBase64Binary base64Binary
........ valueBoolean boolean
........ valueCanonical canonical(Any)
........ valueCode code
........ valueDate date
........ valueDateTime dateTime
........ valueDecimal decimal
........ valueId id
........ valueInstant instant
........ valueInteger integer
........ valueMarkdown markdown
........ valueOid oid
........ valuePositiveInt positiveInt
........ valueString string
........ valueTime time
........ valueUnsignedInt unsignedInt
........ valueUri uri
........ valueUrl url
........ valueUuid uuid
........ valueAddress Address
........ valueAge Age
........ valueAnnotation Annotation
........ valueAttachment Attachment
........ valueCodeableConcept CodeableConcept
........ valueCoding Coding
........ valueContactPoint ContactPoint
........ valueCount Count
........ valueDistance Distance
........ valueDuration Duration
........ valueHumanName HumanName
........ valueIdentifier Identifier
........ valueMoney Money
........ valuePeriod Period
........ valueQuantity Quantity
........ valueRange Range
........ valueRatio Ratio
........ valueReference Reference(Any)
........ valueSampledData SampledData
........ valueSignature Signature
........ valueTiming Timing
........ valueContactDetail ContactDetail
........ valueContributor Contributor
........ valueDataRequirement DataRequirement
........ valueExpression Expression
........ valueParameterDefinition ParameterDefinition
........ valueRelatedArtifact RelatedArtifact
........ valueTriggerDefinition TriggerDefinition
........ valueUsageContext UsageContext
........ valueDosage Dosage
........ valueMeta Meta
...... extension:spatialReference 0..* Extension Cartesian reference for structure
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "spatialReference"
....... value[x] 0..1 Reference() Cartesian reference for structure
...... extension:qualifier 0..* Extension Extension
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "qualifier"
....... value[x] 0..1 CodeableConcept Code that represents the included structure qualifier
Binding: Body Structure Qualifier (preferred)
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Body structure identifier
... active ?!Σ 0..1 boolean Whether this record is in active use
... morphology Σ 0..1 CodeableConcept Kind of Structure
Binding: SNOMEDCTMorphologicAbnormalities (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

Path Status Usage ValueSet Version Source
BodyStructure.language Base preferred Common Languages 📍4.0.1 FHIR Std.
BodyStructure.extension:includedStructure.​extension:structure.​value[x] Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.
BodyStructure.extension:includedStructure.​extension:laterality.​value[x] Base preferred Body Structure Laterality 📦2.0.0-recon This IG
BodyStructure.extension:includedStructure.​extension:bodyLandmarkOrientation.​extension:landmarkDescription.​value[x] Base example Cross-version VS for R5.SNOMEDCTBodyStructures for use in FHIR R4 📍0.0.1-snapshot-2 FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5 v0.0
BodyStructure.extension:includedStructure.​extension:bodyLandmarkOrientation.​extension:clockFacePosition.​value[x] Base example Cross-version VS for R5.BodystructureBodyLandmarkClockFacePosition for use in FHIR R4 📍0.0.1-snapshot-2 FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5 v0.0
BodyStructure.extension:includedStructure.​extension:bodyLandmarkOrientation.​extension:surfaceOrientation.​value[x] Base preferred Cross-version VS for R5.BodystructureLocationQualifier for use in FHIR R4 📍0.0.1-snapshot-2 FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5 v0.0
BodyStructure.extension:includedStructure.​extension:qualifier.​value[x] Base preferred Body Structure Qualifier 📦2.0.0-recon This IG
BodyStructure.morphology Base preferred SNOMED CT Morphologic Abnormalities 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error BodyStructure If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error BodyStructure 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 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-4 error BodyStructure If 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-5 error BodyStructure If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice BodyStructure A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from BodyStructure

Summary

Prohibited: 6 elements

Extensions

This structure refers to these extensions:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron