Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

10.9 Resource BodyStructure - Content

Orders and Observations Work GroupMaturity Level: 1 Trial UseSecurity Category: Patient Compartments: Patient

Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

The BodyStructure resource contains details about the anatomical location of a specimen or body part, including patient information, identifiers, as well as text descriptions and images. It provides for the addition of qualifiers such as laterality and directionality to the anatomic location for those use cases where precoordination of codes is not possible. The BodyStructure resource supports recording and tracking of an anatomic location or structure on a patient outside the context of another resource. For example it can be the target of a Procedure resource or Observation resource.

The BodyStructure resource is not intended to substitute for precoordination of codes. If precoordination of codes is supported by an implementation the codeableConcept should be used. This resource is not intended for describing the type of anatomical location but rather a specific body site on a specific patient.

This resource is referenced by DeviceUsage, ImagingSelection, ImagingStudy, Observation, ServiceRequest and Specimen.

This resource does not implement any patterns.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure TUDomainResourceSpecific and identified anatomical structure
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBodystructure identifier
... active ?!Σ0..1booleanWhether this record is in active use
... morphology Σ0..1CodeableConceptKind of Structure
SNOMED CT Morphologic Abnormalities (Example)
.... structure Σ1..1CodeableConceptCode that represents the included structure
SNOMED CT Body Structures (Example)
.... laterality 0..1CodeableConceptCode that represents the included structure laterality
Bodystructure Location Qualifier (Example)
.... qualifier 0..*CodeableConceptCode that represents the included structure qualifier
Bodystructure Location Qualifier (Example)
... excludedStructure 0..*BackboneElementExcluded anatomic locations(s)
.... structure Σ1..1CodeableConceptCode that represents the excluded structure
SNOMED CT Body Structures (Example)
.... laterality 0..1CodeableConceptCode that represents the excluded structure laterality
Bodystructure Location Qualifier (Example)
.... qualifier 0..*CodeableConceptCode that represents the excluded structure qualifier
Bodystructure Location Qualifier (Example)
... description Σ0..1stringText description
... image 0..*AttachmentAttached images
... patient Σ1..1Reference(Patient)Who this is about

doco Documentation for this format

UML Diagram (Legend)

BodyStructure (DomainResource)Identifier for this instance of the anatomical structureidentifier : Identifier [0..*]Whether this body site is in active use (this element modifies the meaning of other elements)active : boolean [0..1]The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologiesmorphology : CodeableConcept [0..1] « null (Strength=Example) SNOMEDCTMorphologicAbnormalit...?? »A summary, characterization or explanation of the body structuredescription : string [0..1]Image or images used to identify a locationimage : Attachment [0..*]The person to which the body site belongspatient : Reference [1..1] « Patient »IncludedStructureCode that represents the included structurestructure : CodeableConcept [1..1] « null (Strength=Example)SNOMEDCTBodyStructures?? »Code that represents the included structure lateralitylaterality : CodeableConcept [0..1] « null (Strength=Example)BodystructureLocationQualifier?? »Code that represents the included structure qualifierqualifier : CodeableConcept [0..*] « null (Strength=Example)BodystructureLocationQualifier?? »ExcludedStructureCode that represents the excluded structurestructure : CodeableConcept [1..1] « null (Strength=Example)SNOMEDCTBodyStructures?? »Code that represents the excluded structure lateralitylaterality : CodeableConcept [0..1] « null (Strength=Example)BodystructureLocationQualifier?? »Code that represents the excluded structure qualifierqualifier : CodeableConcept [0..*] « null (Strength=Example)BodystructureLocationQualifier?? »The anatomical location(s) or region(s) of the specimen, lesion, or body structureincludedStructure[1..*]The anatomical location(s) or region(s) not occupied or represented by the specimen, lesion, or body structureexcludedStructure[0..*]

XML Template

<BodyStructure xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Bodystructure identifier --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether this record is in active use -->
 <morphology><!-- 0..1 CodeableConcept Kind of Structure --></morphology>
 <includedStructure>  <!-- 1..* Included anatomic location(s) -->
  <structure><!-- 1..1 CodeableConcept Code that represents the included structure --></structure>
  <laterality><!-- 0..1 CodeableConcept Code that represents the included structure laterality --></laterality>
  <qualifier><!-- 0..* CodeableConcept Code that represents the included structure qualifier --></qualifier>
 </includedStructure>
 <excludedStructure>  <!-- 0..* Excluded anatomic locations(s) -->
  <structure><!-- 1..1 CodeableConcept Code that represents the excluded structure --></structure>
  <laterality><!-- 0..1 CodeableConcept Code that represents the excluded structure laterality --></laterality>
  <qualifier><!-- 0..* CodeableConcept Code that represents the excluded structure qualifier --></qualifier>
 </excludedStructure>
 <description value="[string]"/><!-- 0..1 Text description -->
 <image><!-- 0..* Attachment Attached images --></image>
 <patient><!-- 1..1 Reference(Patient) Who this is about --></patient>
</BodyStructure>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:BodyStructure;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:BodyStructure.identifier [ Identifier ], ... ; # 0..* Bodystructure identifier
  fhir:BodyStructure.active [ boolean ]; # 0..1 Whether this record is in active use
  fhir:BodyStructure.morphology [ CodeableConcept ]; # 0..1 Kind of Structure
  fhir:BodyStructure.includedStructure [ # 1..* Included anatomic location(s)
    fhir:BodyStructure.includedStructure.structure [ CodeableConcept ]; # 1..1 Code that represents the included structure
    fhir:BodyStructure.includedStructure.laterality [ CodeableConcept ]; # 0..1 Code that represents the included structure laterality
    fhir:BodyStructure.includedStructure.qualifier [ CodeableConcept ], ... ; # 0..* Code that represents the included structure qualifier
  ], ...;
  fhir:BodyStructure.excludedStructure [ # 0..* Excluded anatomic locations(s)
    fhir:BodyStructure.excludedStructure.structure [ CodeableConcept ]; # 1..1 Code that represents the excluded structure
    fhir:BodyStructure.excludedStructure.laterality [ CodeableConcept ]; # 0..1 Code that represents the excluded structure laterality
    fhir:BodyStructure.excludedStructure.qualifier [ CodeableConcept ], ... ; # 0..* Code that represents the excluded structure qualifier
  ], ...;
  fhir:BodyStructure.description [ string ]; # 0..1 Text description
  fhir:BodyStructure.image [ Attachment ], ... ; # 0..* Attached images
  fhir:BodyStructure.patient [ Reference(Patient) ]; # 1..1 Who this is about
]

Changes since R3

BodyStructure
BodyStructure.includedStructure
  • Added Mandatory Element
BodyStructure.includedStructure.structure
  • Added Mandatory Element
BodyStructure.includedStructure.laterality
  • Added Element
BodyStructure.includedStructure.qualifier
  • Added Element
BodyStructure.excludedStructure
  • Added Element
BodyStructure.excludedStructure.structure
  • Added Mandatory Element
BodyStructure.excludedStructure.laterality
  • Added Element
BodyStructure.excludedStructure.qualifier
  • Added Element
BodyStructure.location
  • deleted
BodyStructure.locationQualifier
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure TUDomainResourceSpecific and identified anatomical structure
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBodystructure identifier
... active ?!Σ0..1booleanWhether this record is in active use
... morphology Σ0..1CodeableConceptKind of Structure
SNOMED CT Morphologic Abnormalities (Example)
.... structure Σ1..1CodeableConceptCode that represents the included structure
SNOMED CT Body Structures (Example)
.... laterality 0..1CodeableConceptCode that represents the included structure laterality
Bodystructure Location Qualifier (Example)
.... qualifier 0..*CodeableConceptCode that represents the included structure qualifier
Bodystructure Location Qualifier (Example)
... excludedStructure 0..*BackboneElementExcluded anatomic locations(s)
.... structure Σ1..1CodeableConceptCode that represents the excluded structure
SNOMED CT Body Structures (Example)
.... laterality 0..1CodeableConceptCode that represents the excluded structure laterality
Bodystructure Location Qualifier (Example)
.... qualifier 0..*CodeableConceptCode that represents the excluded structure qualifier
Bodystructure Location Qualifier (Example)
... description Σ0..1stringText description
... image 0..*AttachmentAttached images
... patient Σ1..1Reference(Patient)Who this is about

doco Documentation for this format

UML Diagram (Legend)

BodyStructure (DomainResource)Identifier for this instance of the anatomical structureidentifier : Identifier [0..*]Whether this body site is in active use (this element modifies the meaning of other elements)active : boolean [0..1]The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologiesmorphology : CodeableConcept [0..1] « null (Strength=Example) SNOMEDCTMorphologicAbnormalit...?? »A summary, characterization or explanation of the body structuredescription : string [0..1]Image or images used to identify a locationimage : Attachment [0..*]The person to which the body site belongspatient : Reference [1..1] « Patient »IncludedStructureCode that represents the included structurestructure : CodeableConcept [1..1] « null (Strength=Example)SNOMEDCTBodyStructures?? »Code that represents the included structure lateralitylaterality : CodeableConcept [0..1] « null (Strength=Example)BodystructureLocationQualifier?? »Code that represents the included structure qualifierqualifier : CodeableConcept [0..*] « null (Strength=Example)BodystructureLocationQualifier?? »ExcludedStructureCode that represents the excluded structurestructure : CodeableConcept [1..1] « null (Strength=Example)SNOMEDCTBodyStructures?? »Code that represents the excluded structure lateralitylaterality : CodeableConcept [0..1] « null (Strength=Example)BodystructureLocationQualifier?? »Code that represents the excluded structure qualifierqualifier : CodeableConcept [0..*] « null (Strength=Example)BodystructureLocationQualifier?? »The anatomical location(s) or region(s) of the specimen, lesion, or body structureincludedStructure[1..*]The anatomical location(s) or region(s) not occupied or represented by the specimen, lesion, or body structureexcludedStructure[0..*]

XML Template

<BodyStructure xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Bodystructure identifier --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether this record is in active use -->
 <morphology><!-- 0..1 CodeableConcept Kind of Structure --></morphology>
 <includedStructure>  <!-- 1..* Included anatomic location(s) -->
  <structure><!-- 1..1 CodeableConcept Code that represents the included structure --></structure>
  <laterality><!-- 0..1 CodeableConcept Code that represents the included structure laterality --></laterality>
  <qualifier><!-- 0..* CodeableConcept Code that represents the included structure qualifier --></qualifier>
 </includedStructure>
 <excludedStructure>  <!-- 0..* Excluded anatomic locations(s) -->
  <structure><!-- 1..1 CodeableConcept Code that represents the excluded structure --></structure>
  <laterality><!-- 0..1 CodeableConcept Code that represents the excluded structure laterality --></laterality>
  <qualifier><!-- 0..* CodeableConcept Code that represents the excluded structure qualifier --></qualifier>
 </excludedStructure>
 <description value="[string]"/><!-- 0..1 Text description -->
 <image><!-- 0..* Attachment Attached images --></image>
 <patient><!-- 1..1 Reference(Patient) Who this is about --></patient>
</BodyStructure>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:BodyStructure;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:BodyStructure.identifier [ Identifier ], ... ; # 0..* Bodystructure identifier
  fhir:BodyStructure.active [ boolean ]; # 0..1 Whether this record is in active use
  fhir:BodyStructure.morphology [ CodeableConcept ]; # 0..1 Kind of Structure
  fhir:BodyStructure.includedStructure [ # 1..* Included anatomic location(s)
    fhir:BodyStructure.includedStructure.structure [ CodeableConcept ]; # 1..1 Code that represents the included structure
    fhir:BodyStructure.includedStructure.laterality [ CodeableConcept ]; # 0..1 Code that represents the included structure laterality
    fhir:BodyStructure.includedStructure.qualifier [ CodeableConcept ], ... ; # 0..* Code that represents the included structure qualifier
  ], ...;
  fhir:BodyStructure.excludedStructure [ # 0..* Excluded anatomic locations(s)
    fhir:BodyStructure.excludedStructure.structure [ CodeableConcept ]; # 1..1 Code that represents the excluded structure
    fhir:BodyStructure.excludedStructure.laterality [ CodeableConcept ]; # 0..1 Code that represents the excluded structure laterality
    fhir:BodyStructure.excludedStructure.qualifier [ CodeableConcept ], ... ; # 0..* Code that represents the excluded structure qualifier
  ], ...;
  fhir:BodyStructure.description [ string ]; # 0..1 Text description
  fhir:BodyStructure.image [ Attachment ], ... ; # 0..* Attached images
  fhir:BodyStructure.patient [ Reference(Patient) ]; # 1..1 Who this is about
]

Changes since Release 3

BodyStructure
BodyStructure.includedStructure
  • Added Mandatory Element
BodyStructure.includedStructure.structure
  • Added Mandatory Element
BodyStructure.includedStructure.laterality
  • Added Element
BodyStructure.includedStructure.qualifier
  • Added Element
BodyStructure.excludedStructure
  • Added Element
BodyStructure.excludedStructure.structure
  • Added Mandatory Element
BodyStructure.excludedStructure.laterality
  • Added Element
BodyStructure.excludedStructure.qualifier
  • Added Element
BodyStructure.location
  • deleted
BodyStructure.locationQualifier
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a

PathDefinitionTypeReference
BodyStructure.morphology ExampleSNOMEDCTMorphologicAbnormalities
BodyStructure.includedStructure.structure ExampleSNOMEDCTBodyStructures
BodyStructure.includedStructure.laterality ExampleBodystructureLocationQualifier
BodyStructure.includedStructure.qualifier ExampleBodystructureLocationQualifier
BodyStructure.excludedStructure.structure ExampleSNOMEDCTBodyStructures
BodyStructure.excludedStructure.laterality ExampleBodystructureLocationQualifier
BodyStructure.excludedStructure.qualifier ExampleBodystructureLocationQualifier

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
identifiertokenBodystructure identifierBodyStructure.identifier
morphologytokenKind of StructureBodyStructure.morphology
patientreferenceWho this is aboutBodyStructure.patient
(Patient)
structuretokenBody site excludedStructure structureBodyStructure.excludedStructure.structure