Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). 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.10 Resource BodyStructure - Content

Orders and Observations icon

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.10.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.

When needed, it allows the the representation of complex body structures and/or locations using the included and excluded elements. Also, it provides for the addition of qualifiers such as laterality and directionality to the anatomic location for those use cases where pre-coordination 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 or Observation resource.

10.10.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.10.3 References to this Resource

Structure

Name	Flags	Card.	Type	Description & Constraints
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)
laterality		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 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
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<BodyStructure xmlns="http://hl7.org/fhir"> 
 <!-- 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>

JSON Template

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

Turtle Template

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


[ 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 R4

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

Name	Flags	Card.	Type	Description & Constraints
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)
laterality		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 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
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<BodyStructure xmlns="http://hl7.org/fhir"> 
 <!-- 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>

JSON Template

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

Turtle Template

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


[ 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 4

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.

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

10.10.4.1 Terminology Bindings

Path	Definition	Type	Reference
BodyStructure.morphology	This value set includes all codes from SNOMED CT where concept is-a 442083009 (Anatomical or acquired body site (body structure)).	Example	SNOMEDCTMorphologicAbnormalities
BodyStructure.includedStructure.structure	This value set includes all codes from SNOMED CT where concept is-a 442083009 (Anatomical or acquired body site (body structure)).	Example	SNOMEDCTBodyStructures
BodyStructure.includedStructure.laterality	SNOMED-CT concepts modifying the anatomic location	Example	BodystructureLocationQualifier
BodyStructure.includedStructure.qualifier	SNOMED-CT concepts modifying the anatomic location	Example	BodystructureLocationQualifier
BodyStructure.excludedStructure.structure	This value set includes all codes from SNOMED CT where concept is-a 442083009 (Anatomical or acquired body site (body structure)).	Example	SNOMEDCTBodyStructures
BodyStructure.excludedStructure.laterality	SNOMED-CT concepts modifying the anatomic location	Example	BodystructureLocationQualifier
BodyStructure.excludedStructure.qualifier	SNOMED-CT concepts modifying the anatomic location	Example	BodystructureLocationQualifier

Path

Definition

Type

Reference

BodyStructure.morphology

This value set includes all codes from SNOMED CT icon where concept is-a 442083009 (Anatomical or acquired body site (body structure)).

Example

SNOMEDCTMorphologicAbnormalities

BodyStructure.includedStructure.structure

This value set includes all codes from SNOMED CT icon where concept is-a 442083009 (Anatomical or acquired body site (body structure)).

Example

SNOMEDCTBodyStructures

BodyStructure.includedStructure.laterality

SNOMED-CT concepts modifying the anatomic location

Example

BodystructureLocationQualifier

BodyStructure.includedStructure.qualifier

SNOMED-CT concepts modifying the anatomic location

Example

BodystructureLocationQualifier

BodyStructure.excludedStructure.structure

This value set includes all codes from SNOMED CT icon where concept is-a 442083009 (Anatomical or acquired body site (body structure)).

Example

SNOMEDCTBodyStructures

BodyStructure.excludedStructure.laterality

SNOMED-CT concepts modifying the anatomic location

Example

BodystructureLocationQualifier

BodyStructure.excludedStructure.qualifier

SNOMED-CT concepts modifying the anatomic location

Example

BodystructureLocationQualifier

10.10.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
excluded_structure	token	Body site excludedStructure structure	BodyStructure.excludedStructure.structure
identifier	token	Bodystructure identifier	BodyStructure.identifier
included_structure	token	Body site includedStructure structure	BodyStructure.includedStructure.structure
morphology	token	Kind of Structure	BodyStructure.morphology
patient	reference	Who this is about	BodyStructure.patient (Patient)