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 GroupMaturity Level: 1 Trial UseCompartments: 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.

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.

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodySite DomainResourceSpecific and identified anatomical location
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBodysite identifier
... active ?!Σ0..1booleanWhether this body site record is in active use
... code Σ0..1CodeableConceptNamed anatomical location
SNOMED CT Body Structures (Example)
... qualifier 0..*CodeableConceptModification to location code
Bodysite Location Qualifier (Example)
... description Σ0..1stringAnatomical location description
... image 0..*AttachmentAttached images
... patient Σ1..1Reference(Patient)Who this is about

doco Documentation for this format

XML Template

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

Turtle Template

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


[ 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodySite DomainResourceSpecific and identified anatomical location
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBodysite identifier
... active ?!Σ0..1booleanWhether this body site record is in active use
... code Σ0..1CodeableConceptNamed anatomical location
SNOMED CT Body Structures (Example)
... qualifier 0..*CodeableConceptModification to location code
Bodysite Location Qualifier (Example)
... description Σ0..1stringAnatomical location description
... image 0..*AttachmentAttached images
... patient Σ1..1Reference(Patient)Who this is about

doco Documentation for this format

XML Template

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

Turtle Template

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


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

PathDefinitionTypeReference
BodySite.code Codes describing anatomical locations. May include lateralityExampleSNOMED CT Body Structures
BodySite.qualifier Concepts modifying the anatomic locationExampleBodysite Location Qualifier

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

NameTypeDescriptionExpressionIn Common
codetokenNamed anatomical locationBodySite.code
identifiertokenIdentifier for this instance of the anatomical locationBodySite.identifier
patientreferencePatient to whom bodysite belongsBodySite.patient
(Patient)