Standard Health Record FHIR Implementation Guide

SHR BodySite Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySite

A location or structure in the body, including tissues, regions, cavities, and spaces, for example, right elbow, or left ventricle of the heart.

This profile builds on BodySite.

This profile was published on Tue Feb 27 00:00:00 EST 2018 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Summary

Mandatory: 0 element (1 nested mandatory element)

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element BodySite.qualifier is sliced based on the value of value:coding.code

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.entity.BodySite maps to BodySite:
  CodeableConcept maps to code
  Laterality maps to qualifier (slice on = coding.code)
  Directionality maps to qualifier
  PortionTotality maps to qualifier
  Details maps to description	

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodySite SHR BodySite Profile
... code 1..1Binding: SHR BodySiteVS ValueSet (required)
... qualifier Slice: Unordered, Open by value:coding.code
... qualifier 0..1Laterality
Binding: SHR LateralityVS ValueSet (required)
... qualifier 0..1Directionality
Binding: SHR DirectionalityVS ValueSet (required)
... qualifier 0..1PortionTotality
Binding: SHR PortionTotalityVS ValueSet (required)
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-ClockDirection-extension 0..1(Complex)SHR ClockDirection Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-ClockDirection-extension
... shr-core-Distance-extension 0..1Reference(SHR Distance Profile)SHR Distance Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Distance-extension
... shr-entity-BodySiteMarker-extension 0..1stringSHR BodySiteMarker Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySiteMarker-extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. BodySite I0..*SHR BodySite Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-ClockDirection-extension 0..1(Complex)SHR ClockDirection Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-ClockDirection-extension
... shr-core-Distance-extension 0..1Reference(SHR Distance Profile)SHR Distance Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Distance-extension
... shr-entity-BodySiteMarker-extension 0..1stringSHR BodySiteMarker Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySiteMarker-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBodysite identifier
... active ?!Σ0..1booleanWhether this body site record is in active use
... code Σ1..1CodeableConceptNamed anatomical location
Binding: SHR BodySiteVS ValueSet (required)
... qualifier CodeableConceptModification to location code
Slice: Unordered, Open by value:coding.code
Binding: Bodysite Location Qualifier (example)
... qualifier 0..1CodeableConceptLaterality
Binding: SHR LateralityVS ValueSet (required)
... qualifier 0..1CodeableConceptDirectionality
Binding: SHR DirectionalityVS ValueSet (required)
... qualifier 0..1CodeableConceptPortionTotality
Binding: SHR PortionTotalityVS ValueSet (required)
... description Σ0..1stringAnatomical location description
... image 0..*AttachmentAttached images
... patient Σ1..1Reference(Patient)Who this is about

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element BodySite.qualifier is sliced based on the value of value:coding.code

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.entity.BodySite maps to BodySite:
  CodeableConcept maps to code
  Laterality maps to qualifier (slice on = coding.code)
  Directionality maps to qualifier
  PortionTotality maps to qualifier
  Details maps to description	

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodySite SHR BodySite Profile
... code 1..1Binding: SHR BodySiteVS ValueSet (required)
... qualifier Slice: Unordered, Open by value:coding.code
... qualifier 0..1Laterality
Binding: SHR LateralityVS ValueSet (required)
... qualifier 0..1Directionality
Binding: SHR DirectionalityVS ValueSet (required)
... qualifier 0..1PortionTotality
Binding: SHR PortionTotalityVS ValueSet (required)
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-ClockDirection-extension 0..1(Complex)SHR ClockDirection Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-ClockDirection-extension
... shr-core-Distance-extension 0..1Reference(SHR Distance Profile)SHR Distance Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Distance-extension
... shr-entity-BodySiteMarker-extension 0..1stringSHR BodySiteMarker Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySiteMarker-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodySite I0..*SHR BodySite Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-ClockDirection-extension 0..1(Complex)SHR ClockDirection Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-ClockDirection-extension
... shr-core-Distance-extension 0..1Reference(SHR Distance Profile)SHR Distance Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Distance-extension
... shr-entity-BodySiteMarker-extension 0..1stringSHR BodySiteMarker Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySiteMarker-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBodysite identifier
... active ?!Σ0..1booleanWhether this body site record is in active use
... code Σ1..1CodeableConceptNamed anatomical location
Binding: SHR BodySiteVS ValueSet (required)
... qualifier CodeableConceptModification to location code
Slice: Unordered, Open by value:coding.code
Binding: Bodysite Location Qualifier (example)
... qualifier 0..1CodeableConceptLaterality
Binding: SHR LateralityVS ValueSet (required)
... qualifier 0..1CodeableConceptDirectionality
Binding: SHR DirectionalityVS ValueSet (required)
... qualifier 0..1CodeableConceptPortionTotality
Binding: SHR PortionTotalityVS ValueSet (required)
... description Σ0..1stringAnatomical location description
... image 0..*AttachmentAttached images
... patient Σ1..1Reference(Patient)Who this is about

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
BodySite.languageCommon LanguagesextensibleCommon Languages
BodySite.codeSHR BodySiteVS ValueSetrequiredSHR BodySiteVS ValueSet
BodySite.qualifierSHR PortionTotalityVS ValueSetrequiredSHR PortionTotalityVS ValueSet
BodySite.qualifierSHR PortionTotalityVS ValueSetrequiredSHR PortionTotalityVS ValueSet
BodySite.qualifierSHR PortionTotalityVS ValueSetrequiredSHR PortionTotalityVS ValueSet
BodySite.qualifierSHR PortionTotalityVS ValueSetrequiredSHR PortionTotalityVS ValueSet

 

Constraints

IdPathDetailsRequirements
dom-2BodySiteIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1BodySiteIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4BodySiteIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3BodySiteIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()