FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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: R3 R2

10.7 Resource BodySite - Content

Orders and Observations

Work Group

Maturity Level: 1

Trial Use

Compartments: Patient

Record details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

10.7.1 Scope and Usage

The BodySite resource contains details about the anatomical location of a specimen or body part, including patient information, identifiers, as well as text descriptons 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 BodySite 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.7.2 Boundaries and Relationships

The BodySite 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.

Structure

Name	Flags	Card.	Type	Description & Constraints
BodySite			DomainResource	Specific and identified anatomical location Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier	Σ	0..*	Identifier	Bodysite identifier
active	?!Σ	0..1	boolean	Whether this body site record is in active use
code	Σ	0..1	CodeableConcept	Named anatomical location SNOMED CT Body Structures (Example)
qualifier		0..*	CodeableConcept	Modification to location code Bodysite Location Qualifier (Example)
description	Σ	0..1	string	Anatomical location description
image		0..*	Attachment	Attached images
patient	Σ	1..1	Reference(Patient)	Who this is about
Documentation for this format

UML Diagram (Legend)

XML Template

<BodySite xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Bodysite identifier --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether this body site record is in active use -->
 <code><!-- 0..1 CodeableConcept Named anatomical location --></code>
 <qualifier><!-- 0..* CodeableConcept Modification to location code --></qualifier>
 <description value="[string]"/><!-- 0..1 Anatomical location description -->
 <image><!-- 0..* Attachment Attached images --></image>
 <patient><!-- 1..1 Reference(Patient) Who this is about --></patient>
</BodySite>

JSON Template

{
  "resourceType" : "BodySite",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Bodysite identifier
  "active" : <boolean>, // Whether this body site record is in active use
  "code" : { CodeableConcept }, // Named anatomical location
  "qualifier" : [{ CodeableConcept }], // Modification to location code
  "description" : "<string>", // Anatomical location description
  "image" : [{ Attachment }], // Attached images
  "patient" : { Reference(Patient) } // R!  Who this is about
}

Turtle Template

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


[ a fhir:BodySite;
  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:BodySite.identifier [ Identifier ], ... ; # 0..* Bodysite identifier
  fhir:BodySite.active [ boolean ]; # 0..1 Whether this body site record is in active use
  fhir:BodySite.code [ CodeableConcept ]; # 0..1 Named anatomical location
  fhir:BodySite.qualifier [ CodeableConcept ], ... ; # 0..* Modification to location code
  fhir:BodySite.description [ string ]; # 0..1 Anatomical location description
  fhir:BodySite.image [ Attachment ], ... ; # 0..* Attached images
  fhir:BodySite.patient [ Reference(Patient) ]; # 1..1 Who this is about
]

Changes since DSTU2

BodySite

BodySite.active

Added Element

BodySite.qualifier

Renamed from modifier to qualifier

See the Full Difference for further information

This analysis is available as XML or JSON.

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

Structure

Name	Flags	Card.	Type	Description & Constraints
BodySite			DomainResource	Specific and identified anatomical location Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier	Σ	0..*	Identifier	Bodysite identifier
active	?!Σ	0..1	boolean	Whether this body site record is in active use
code	Σ	0..1	CodeableConcept	Named anatomical location SNOMED CT Body Structures (Example)
qualifier		0..*	CodeableConcept	Modification to location code Bodysite Location Qualifier (Example)
description	Σ	0..1	string	Anatomical location description
image		0..*	Attachment	Attached images
patient	Σ	1..1	Reference(Patient)	Who this is about
Documentation for this format

UML Diagram (Legend)

XML Template

<BodySite xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Bodysite identifier --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether this body site record is in active use -->
 <code><!-- 0..1 CodeableConcept Named anatomical location --></code>
 <qualifier><!-- 0..* CodeableConcept Modification to location code --></qualifier>
 <description value="[string]"/><!-- 0..1 Anatomical location description -->
 <image><!-- 0..* Attachment Attached images --></image>
 <patient><!-- 1..1 Reference(Patient) Who this is about --></patient>
</BodySite>

JSON Template

{
  "resourceType" : "BodySite",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Bodysite identifier
  "active" : <boolean>, // Whether this body site record is in active use
  "code" : { CodeableConcept }, // Named anatomical location
  "qualifier" : [{ CodeableConcept }], // Modification to location code
  "description" : "<string>", // Anatomical location description
  "image" : [{ Attachment }], // Attached images
  "patient" : { Reference(Patient) } // R!  Who this is about
}

Turtle Template

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


[ a fhir:BodySite;
  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:BodySite.identifier [ Identifier ], ... ; # 0..* Bodysite identifier
  fhir:BodySite.active [ boolean ]; # 0..1 Whether this body site record is in active use
  fhir:BodySite.code [ CodeableConcept ]; # 0..1 Named anatomical location
  fhir:BodySite.qualifier [ CodeableConcept ], ... ; # 0..* Modification to location code
  fhir:BodySite.description [ string ]; # 0..1 Anatomical location description
  fhir:BodySite.image [ Attachment ], ... ; # 0..* Attached images
  fhir:BodySite.patient [ Reference(Patient) ]; # 1..1 Who this is about
]

Changes since DSTU2

BodySite

BodySite.active

Added Element

BodySite.qualifier

Renamed from modifier to qualifier

See the Full Difference for further information

This analysis is available as XML or JSON.

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

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)

10.7.3.1 Terminology Bindings

Path	Definition	Type	Reference
BodySite.code	Codes describing anatomical locations. May include laterality	Example	SNOMED CT Body Structures
BodySite.qualifier	Concepts modifying the anatomic location	Example	Bodysite Location Qualifier

Path

Definition

Type

Reference

BodySite.code

Codes describing anatomical locations. May include laterality

Example

SNOMED CT Body Structures

BodySite.qualifier

Concepts modifying the anatomic location

Example

Bodysite Location Qualifier

10.7.4 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
code	token	Named anatomical location	BodySite.code
identifier	token	Identifier for this instance of the anatomical location	BodySite.identifier
patient	reference	Patient to whom bodysite belongs	BodySite.patient (Patient)