Release 4 5 Snapshot #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v5.0.0-snapshot1: R5 Snapshot #1). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

10.9 Resource BodyStructure - Content

Orders and Observations Work Group Maturity Level : 1   Trial Use Security 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.

10.9.1 Scope and Usage

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.

10.9.2 Boundaries and Relationships

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.

10.9.3 References

This resource is referenced by DeviceUsage and Specimen .

This resource does not implement any patterns.

10.9.3 10.9.4 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . BodyStructure TU DomainResource Specific and identified anatomical structure
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier Bodystructure identifier
. . . active ?! Σ 0..1 boolean Whether this record is in active use
. . . morphology Σ 0..1 CodeableConcept Kind of Structure
SNOMED CT Morphologic Abnormalities ( Example )
. . . includedStructure 1..* BackboneElement Included anatomic location(s)
.... structure Σ 1..1 CodeableConcept Code that represents the included structure
SNOMED CT Body Structures ( Example )
.. . . locationQualifier laterality 0..* 0..1 CodeableConcept Code that represents the included structure laterality
Bodystructure Location Qualifier ( Example )
.... qualifier 0..* CodeableConcept Code that represents the included structure qualifier
Bodystructure Location Qualifier ( Example )
... excludedStructure 0..* BackboneElement Excluded anatomic locations(s)
.... structure Σ 1..1 CodeableConcept Code that represents the excluded structure
SNOMED CT Body site modifier Structures ( Example )
.... laterality 0..1 CodeableConcept Code that represents the excluded structure laterality
Bodystructure Location Qualifier ( Example )
.... qualifier 0..* CodeableConcept Code that represents the excluded structure qualifier
Bodystructure Location Qualifier ( Example )
. . . 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

UML Diagram ( Legend )

BodyStructure ( DomainResource ) Identifier for this instance of the anatomical structure identifier : 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 morphologies morphology : CodeableConcept [0..1] « Codes describing anatomic morphology. null (Strength=Example) SNOMEDCTMorphologicAbnormalit... ?? » The anatomical location or region of the specimen, lesion, or body structure location : CodeableConcept [0..1] « Codes describing anatomical locations. May include laterality. null (Strength=Example) SNOMEDCTBodyStructures ?? » Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane locationQualifier : CodeableConcept [0..*] « Concepts modifying the anatomic location. (Strength=Example) BodystructureLocationQualifier ?? » A summary, characterization or explanation of the body structure description : string [0..1] Image or images used to identify a location image : Attachment [0..*] The person to which the body site belongs patient : Reference [1..1] « Patient » IncludedStructure Code that represents the included structure structure : CodeableConcept [1..1] « null (Strength=Example) SNOMEDCTBodyStructures ?? » Code that represents the included structure laterality laterality : CodeableConcept [0..1] « null (Strength=Example) BodystructureLocationQualifier ?? » Code that represents the included structure qualifier qualifier : CodeableConcept [0..*] « null (Strength=Example) BodystructureLocationQualifier ?? » ExcludedStructure Code that represents the excluded structure structure : CodeableConcept [1..1] « null (Strength=Example) SNOMEDCTBodyStructures ?? » Code that represents the excluded structure laterality laterality : CodeableConcept [0..1] « null (Strength=Example) BodystructureLocationQualifier ?? » Code that represents the excluded structure qualifier qualifier : CodeableConcept [0..*] « null (Strength=Example) BodystructureLocationQualifier ?? » The anatomical location(s) or region(s) of the specimen, lesion, or body structure includedStructure [1..*] The anatomical location(s) or region(s) not occupied or represented by the specimen, lesion, or body structure excludedStructure [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>
 <location><!-- 0..1 CodeableConcept Body site --></location>
 <</locationQualifier>

 <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.location [ CodeableConcept ]; # 0..1 Body site
  fhir:

  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.locationQualifier
  • deleted

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)

Structure

Name Flags Card. Type Description & Constraints doco
. . BodyStructure TU DomainResource Specific and identified anatomical structure
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier Bodystructure identifier
. . . active ?! Σ 0..1 boolean Whether this record is in active use
. . . morphology Σ 0..1 CodeableConcept Kind of Structure
SNOMED CT Morphologic Abnormalities ( Example )
. . . includedStructure 1..* BackboneElement Included anatomic location(s)
.... structure Σ 1..1 CodeableConcept Code that represents the included structure
SNOMED CT Body Structures ( Example )
.. . . locationQualifier laterality 0..* 0..1 CodeableConcept Code that represents the included structure laterality
Bodystructure Location Qualifier ( Example )
.... qualifier 0..* CodeableConcept Code that represents the included structure qualifier
Bodystructure Location Qualifier ( Example )
... excludedStructure 0..* BackboneElement Excluded anatomic locations(s)
.... structure Σ 1..1 CodeableConcept Code that represents the excluded structure
SNOMED CT Body site modifier Structures ( Example )
.... laterality 0..1 CodeableConcept Code that represents the excluded structure laterality
Bodystructure Location Qualifier ( Example )
.... qualifier 0..* CodeableConcept Code that represents the excluded structure qualifier
Bodystructure Location Qualifier ( Example )
. . . 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

UML Diagram ( Legend )

BodyStructure ( DomainResource ) Identifier for this instance of the anatomical structure identifier : 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 morphologies morphology : CodeableConcept [0..1] « Codes describing anatomic morphology. null (Strength=Example) SNOMEDCTMorphologicAbnormalit... ?? » The anatomical location or region of the specimen, lesion, or body structure location : CodeableConcept [0..1] « Codes describing anatomical locations. May include laterality. null (Strength=Example) SNOMEDCTBodyStructures ?? » Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane locationQualifier : CodeableConcept [0..*] « Concepts modifying the anatomic location. (Strength=Example) BodystructureLocationQualifier ?? » A summary, characterization or explanation of the body structure description : string [0..1] Image or images used to identify a location image : Attachment [0..*] The person to which the body site belongs patient : Reference [1..1] « Patient » IncludedStructure Code that represents the included structure structure : CodeableConcept [1..1] « null (Strength=Example) SNOMEDCTBodyStructures ?? » Code that represents the included structure laterality laterality : CodeableConcept [0..1] « null (Strength=Example) BodystructureLocationQualifier ?? » Code that represents the included structure qualifier qualifier : CodeableConcept [0..*] « null (Strength=Example) BodystructureLocationQualifier ?? » ExcludedStructure Code that represents the excluded structure structure : CodeableConcept [1..1] « null (Strength=Example) SNOMEDCTBodyStructures ?? » Code that represents the excluded structure laterality laterality : CodeableConcept [0..1] « null (Strength=Example) BodystructureLocationQualifier ?? » Code that represents the excluded structure qualifier qualifier : CodeableConcept [0..*] « null (Strength=Example) BodystructureLocationQualifier ?? » The anatomical location(s) or region(s) of the specimen, lesion, or body structure includedStructure [1..*] The anatomical location(s) or region(s) not occupied or represented by the specimen, lesion, or body structure excludedStructure [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>
 <location><!-- 0..1 CodeableConcept Body site --></location>
 <</locationQualifier>

 <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.location [ CodeableConcept ]; # 0..1 Body site
  fhir:

  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.locationQualifier
  • deleted

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)

 

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

10.9.3.1 10.9.4.1 Terminology Bindings

Path Definition Type Reference
BodyStructure.morphology Codes describing anatomic morphology. Example SNOMEDCTMorphologicAbnormalities
BodyStructure.location Codes describing anatomical locations. May include laterality. Example SNOMEDCTBodyStructures
BodyStructure.includedStructure.structure Example SNOMEDCTBodyStructures
BodyStructure.locationQualifier BodyStructure.includedStructure.laterality Concepts modifying the anatomic location. Example BodystructureLocationQualifier
BodyStructure.includedStructure.qualifier Example BodystructureLocationQualifier
BodyStructure.excludedStructure.structure Example SNOMEDCTBodyStructures
BodyStructure.excludedStructure.laterality Example BodystructureLocationQualifier
BodyStructure.excludedStructure.qualifier Example BodystructureLocationQualifier

10.9.4 10.9.5 Search Parameters

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

Name Type Description Expression In Common
identifier token Bodystructure identifier BodyStructure.identifier
location token Body site BodyStructure.location
morphology token Kind of Structure BodyStructure.morphology
patient reference Who this is about BodyStructure.patient
( Patient )