This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). 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
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.
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.
No resources refer to this resource directly.
This resource does not implement any patterns.
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) |
location | Σ | 0..1 | CodeableConcept | Body site SNOMED CT Body Structures (Example) |
locationQualifier | 0..* | CodeableConcept | Body site modifier 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 |
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> <location><!-- 0..1 CodeableConcept Body site --></location> <locationQualifier><!-- 0..* CodeableConcept Body site modifier --></locationQualifier> <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 "location" : { CodeableConcept }, // Body site "locationQualifier" : [{ CodeableConcept }], // Body site modifier "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.location [ CodeableConcept ]; # 0..1 Body site fhir:BodyStructure.locationQualifier [ CodeableConcept ], ... ; # 0..* Body site modifier 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 |
|
See the Full Difference for further information
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) |
location | Σ | 0..1 | CodeableConcept | Body site SNOMED CT Body Structures (Example) |
locationQualifier | 0..* | CodeableConcept | Body site modifier 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 |
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> <location><!-- 0..1 CodeableConcept Body site --></location> <locationQualifier><!-- 0..* CodeableConcept Body site modifier --></locationQualifier> <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 "location" : { CodeableConcept }, // Body site "locationQualifier" : [{ CodeableConcept }], // Body site modifier "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.location [ CodeableConcept ]; # 0..1 Body site fhir:BodyStructure.locationQualifier [ CodeableConcept ], ... ; # 0..* Body site modifier 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 |
|
See the Full Difference for further information
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
Path | Definition | Type | Reference |
---|---|---|---|
BodyStructure.morphology | Codes describing anatomic morphology. | Example | SNOMEDCTMorphologicAbnormalities |
BodyStructure.location | Codes describing anatomical locations. May include laterality. | Example | SNOMEDCTBodyStructures |
BodyStructure.locationQualifier | Concepts modifying the anatomic location. | Example | BodystructureLocationQualifier |
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) |