HL7 Europe Base and Core FHIR IG
0.1.0-ballotRecon - 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 0.1.0-ballotRecon built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/base-r5/ and changes regularly. See the Directory of published versions

Resource Profile: BodyStructure (EU base)

Official URL: http://hl7.eu/fhir/base-r5/StructureDefinition/bodyStructure-eu Version: 0.1.0-ballotRecon
Standards status: Draft Maturity Level: 2 Computable Name: BodyStructureEu

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

This profile specifies how the HL7 FHIR BodyStructure resource should be used for conveying commonly used concepts in the European context.

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
... contained 0..* Resource Contained, inline Resources
... 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)
... includedStructure 1..* BackboneElement Included anatomic location(s)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... structure Σ 1..1 CodeableConcept Code that represents the included structure
Binding: SNOMEDCTBodyStructures (preferred)
.... laterality 0..1 CodeableConcept Code that represents the included structure laterality
Binding: Body Structure Laterality (preferred)
.... qualifier 0..* CodeableConcept Code that represents the included structure qualifier
Binding: Body Structure Qualifier (preferred)
... patient Σ 1..1 Reference(Patient) Who this is about

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BodyStructure.morphologypreferredSNOMEDCTMorphologicAbnormalities
http://hl7.org/fhir/ValueSet/bodystructure-code
From the FHIR Standard
BodyStructure.includedStructure.structurepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
BodyStructure.includedStructure.lateralitypreferredSiteLateralityEuVs
http://hl7.eu/fhir/base-r5/ValueSet/siteLaterality-eu
From this IG
BodyStructure.includedStructure.qualifierpreferredSiteQualifierEuVs
http://hl7.eu/fhir/base-r5/ValueSet/siteQualifier-eu
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BodyStructure 0..* BodyStructure Specific and identified anatomical structure
... text 0..1 Narrative Textual description of the body structure
... identifier 0..* Identifier Body structure identifier
... morphology 0..1 CodeableConcept Kind of Structure
Binding: SNOMEDCTMorphologicAbnormalities (preferred)
.... structure 1..1 CodeableConcept Code that represents the included structure
Binding: SNOMEDCTBodyStructures (preferred)
.... laterality 0..1 CodeableConcept Code that represents the included structure laterality
Binding: Body Structure Laterality (preferred)
.... qualifier 0..* CodeableConcept Code that represents the included structure qualifier
Binding: Body Structure Qualifier (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
BodyStructure.morphologypreferredSNOMEDCTMorphologicAbnormalities
http://hl7.org/fhir/ValueSet/bodystructure-code
From the FHIR Standard
BodyStructure.includedStructure.structurepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
BodyStructure.includedStructure.lateralitypreferredSiteLateralityEuVs
http://hl7.eu/fhir/base-r5/ValueSet/siteLaterality-eu
From this IG
BodyStructure.includedStructure.qualifierpreferredSiteQualifierEuVs
http://hl7.eu/fhir/base-r5/ValueSet/siteQualifier-eu
From this IG
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
... extension 0..* Extension Additional content defined by implementations
... 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)
... includedStructure 1..* BackboneElement Included anatomic location(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... structure Σ 1..1 CodeableConcept Code that represents the included structure
Binding: SNOMEDCTBodyStructures (preferred)
.... laterality 0..1 CodeableConcept Code that represents the included structure laterality
Binding: Body Structure Laterality (preferred)
.... bodyLandmarkOrientation 0..* BackboneElement Landmark relative location
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... landmarkDescription 0..* CodeableConcept Body ]andmark description
Binding: SNOMEDCTBodyStructures (example): Select SNOMED code system values. Values used in a podiatry setting to decsribe landmarks on the body.
..... clockFacePosition 0..* CodeableConcept Clockface orientation
Binding: BodystructureBodyLandmarkClockFacePosition (example): Select SNOMED CT codes. A set of codes that describe a things orientation based on a hourly positions of a clock face.
..... distanceFromLandmark 0..* BackboneElement Landmark relative location
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... device 0..* CodeableReference(Device) Measurement device
Binding: DeviceType (example): Codes to identify medical devices.
...... value 0..* Quantity Measured distance from body landmark
..... surfaceOrientation 0..* CodeableConcept Relative landmark surface orientation
Binding: BodystructureLocationQualifier (preferred): Select SNOMED code system values. The surface area a body location is in relation to a landmark.
.... spatialReference 0..* Reference(ImagingSelection) Cartesian reference for structure
.... qualifier 0..* CodeableConcept Code that represents the included structure qualifier
Binding: Body Structure Qualifier (preferred)
... excludedStructure 0..* See includedStructure (BodyStructure) Excluded anatomic locations(s)
... description Σ 0..1 markdown 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.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
BodyStructure.morphologypreferredSNOMEDCTMorphologicAbnormalities
http://hl7.org/fhir/ValueSet/bodystructure-code
From the FHIR Standard
BodyStructure.includedStructure.structurepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
BodyStructure.includedStructure.lateralitypreferredSiteLateralityEuVs
http://hl7.eu/fhir/base-r5/ValueSet/siteLaterality-eu
From this IG
BodyStructure.includedStructure.bodyLandmarkOrientation.landmarkDescriptionexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
BodyStructure.includedStructure.bodyLandmarkOrientation.clockFacePositionexampleBodystructureBodyLandmarkClockFacePosition
http://hl7.org/fhir/ValueSet/bodystructure-bodylandmarkorientation-clockface-position
From the FHIR Standard
BodyStructure.includedStructure.bodyLandmarkOrientation.distanceFromLandmark.deviceexampleDeviceType
http://hl7.org/fhir/ValueSet/device-type
From the FHIR Standard
BodyStructure.includedStructure.bodyLandmarkOrientation.surfaceOrientationpreferredBodystructureLocationQualifier
http://hl7.org/fhir/ValueSet/bodystructure-relative-location
From the FHIR Standard
BodyStructure.includedStructure.qualifierpreferredSiteQualifierEuVs
http://hl7.eu/fhir/base-r5/ValueSet/siteQualifier-eu
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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

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
... contained 0..* Resource Contained, inline Resources
... 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)
... includedStructure 1..* BackboneElement Included anatomic location(s)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... structure Σ 1..1 CodeableConcept Code that represents the included structure
Binding: SNOMEDCTBodyStructures (preferred)
.... laterality 0..1 CodeableConcept Code that represents the included structure laterality
Binding: Body Structure Laterality (preferred)
.... qualifier 0..* CodeableConcept Code that represents the included structure qualifier
Binding: Body Structure Qualifier (preferred)
... patient Σ 1..1 Reference(Patient) Who this is about

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
BodyStructure.morphologypreferredSNOMEDCTMorphologicAbnormalities
http://hl7.org/fhir/ValueSet/bodystructure-code
From the FHIR Standard
BodyStructure.includedStructure.structurepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
BodyStructure.includedStructure.lateralitypreferredSiteLateralityEuVs
http://hl7.eu/fhir/base-r5/ValueSet/siteLaterality-eu
From this IG
BodyStructure.includedStructure.qualifierpreferredSiteQualifierEuVs
http://hl7.eu/fhir/base-r5/ValueSet/siteQualifier-eu
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()

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
... identifier 0..* Identifier Body structure identifier
... morphology 0..1 CodeableConcept Kind of Structure
Binding: SNOMEDCTMorphologicAbnormalities (preferred)
.... structure 1..1 CodeableConcept Code that represents the included structure
Binding: SNOMEDCTBodyStructures (preferred)
.... laterality 0..1 CodeableConcept Code that represents the included structure laterality
Binding: Body Structure Laterality (preferred)
.... qualifier 0..* CodeableConcept Code that represents the included structure qualifier
Binding: Body Structure Qualifier (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
BodyStructure.morphologypreferredSNOMEDCTMorphologicAbnormalities
http://hl7.org/fhir/ValueSet/bodystructure-code
From the FHIR Standard
BodyStructure.includedStructure.structurepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
BodyStructure.includedStructure.lateralitypreferredSiteLateralityEuVs
http://hl7.eu/fhir/base-r5/ValueSet/siteLaterality-eu
From this IG
BodyStructure.includedStructure.qualifierpreferredSiteQualifierEuVs
http://hl7.eu/fhir/base-r5/ValueSet/siteQualifier-eu
From this IG

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
... extension 0..* Extension Additional content defined by implementations
... 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)
... includedStructure 1..* BackboneElement Included anatomic location(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... structure Σ 1..1 CodeableConcept Code that represents the included structure
Binding: SNOMEDCTBodyStructures (preferred)
.... laterality 0..1 CodeableConcept Code that represents the included structure laterality
Binding: Body Structure Laterality (preferred)
.... bodyLandmarkOrientation 0..* BackboneElement Landmark relative location
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... landmarkDescription 0..* CodeableConcept Body ]andmark description
Binding: SNOMEDCTBodyStructures (example): Select SNOMED code system values. Values used in a podiatry setting to decsribe landmarks on the body.
..... clockFacePosition 0..* CodeableConcept Clockface orientation
Binding: BodystructureBodyLandmarkClockFacePosition (example): Select SNOMED CT codes. A set of codes that describe a things orientation based on a hourly positions of a clock face.
..... distanceFromLandmark 0..* BackboneElement Landmark relative location
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... device 0..* CodeableReference(Device) Measurement device
Binding: DeviceType (example): Codes to identify medical devices.
...... value 0..* Quantity Measured distance from body landmark
..... surfaceOrientation 0..* CodeableConcept Relative landmark surface orientation
Binding: BodystructureLocationQualifier (preferred): Select SNOMED code system values. The surface area a body location is in relation to a landmark.
.... spatialReference 0..* Reference(ImagingSelection) Cartesian reference for structure
.... qualifier 0..* CodeableConcept Code that represents the included structure qualifier
Binding: Body Structure Qualifier (preferred)
... excludedStructure 0..* See includedStructure (BodyStructure) Excluded anatomic locations(s)
... description Σ 0..1 markdown 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.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
BodyStructure.morphologypreferredSNOMEDCTMorphologicAbnormalities
http://hl7.org/fhir/ValueSet/bodystructure-code
From the FHIR Standard
BodyStructure.includedStructure.structurepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
BodyStructure.includedStructure.lateralitypreferredSiteLateralityEuVs
http://hl7.eu/fhir/base-r5/ValueSet/siteLaterality-eu
From this IG
BodyStructure.includedStructure.bodyLandmarkOrientation.landmarkDescriptionexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
BodyStructure.includedStructure.bodyLandmarkOrientation.clockFacePositionexampleBodystructureBodyLandmarkClockFacePosition
http://hl7.org/fhir/ValueSet/bodystructure-bodylandmarkorientation-clockface-position
From the FHIR Standard
BodyStructure.includedStructure.bodyLandmarkOrientation.distanceFromLandmark.deviceexampleDeviceType
http://hl7.org/fhir/ValueSet/device-type
From the FHIR Standard
BodyStructure.includedStructure.bodyLandmarkOrientation.surfaceOrientationpreferredBodystructureLocationQualifier
http://hl7.org/fhir/ValueSet/bodystructure-relative-location
From the FHIR Standard
BodyStructure.includedStructure.qualifierpreferredSiteQualifierEuVs
http://hl7.eu/fhir/base-r5/ValueSet/siteQualifier-eu
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron