Standard Health Record FHIR Implementation Guide

SHR Facility Profile

 

The official URL for this profile is:

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

Services and space and equipment provided for a particular purpose; a building or place that provides a particular service or is used for a particular industry. Could be a clinical site, community site, or a mobile facility.

This profile builds on US Core Location Profile.

This profile was published on Wed Dec 20 00:00:00 EST 2017 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 (2 nested mandatory elements)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.entity.Facility maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-location:
  FacilityName maps to name
  Location.Address maps to address
  Location.Geoposition.Latitude maps to position.latitude
  Location.Geoposition.Longitude maps to position.longitude
  Location.Geoposition.Altitude maps to position.altitude
  ContactPoint maps to telecom
  ManagingOrganization maps to managingOrganization
  Type maps to type

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location I0..*SHR Facility 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-MobileFacility-extension 0..1booleanSHR MobileFacility Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-MobileFacility-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!SΣ0..1codeactive | suspended | inactive
Binding: LocationStatus (required)
... operationalStatus Σ0..1CodingThe Operational status of the location (typically only for a bed/room)
Binding: v2 Bed Status (preferred)
... name SΣ1..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode ?!Σ0..1codeinstance | kind
Binding: LocationMode (required)
... type Σ1..1CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (required)
... telecom S0..1SHR ContactPoint ProfileContact details of the location
... address S0..1SHR Address ProfilePhysical location
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General': 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode SΣ0..1stringUS Zip Codes
Example General': 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example)
... position I0..1BackboneElementThe absolute geographic location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ1..1Reference(SHR Organization Profile)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically part of
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Summary

Mandatory: 0 element (2 nested mandatory elements)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.entity.Facility maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-location:
  FacilityName maps to name
  Location.Address maps to address
  Location.Geoposition.Latitude maps to position.latitude
  Location.Geoposition.Longitude maps to position.longitude
  Location.Geoposition.Altitude maps to position.altitude
  ContactPoint maps to telecom
  ManagingOrganization maps to managingOrganization
  Type maps to type

Differential View

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location I0..*SHR Facility 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-MobileFacility-extension 0..1booleanSHR MobileFacility Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-MobileFacility-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!SΣ0..1codeactive | suspended | inactive
Binding: LocationStatus (required)
... operationalStatus Σ0..1CodingThe Operational status of the location (typically only for a bed/room)
Binding: v2 Bed Status (preferred)
... name SΣ1..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode ?!Σ0..1codeinstance | kind
Binding: LocationMode (required)
... type Σ1..1CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (required)
... telecom S0..1SHR ContactPoint ProfileContact details of the location
... address S0..1SHR Address ProfilePhysical location
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General': 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode SΣ0..1stringUS Zip Codes
Example General': 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example)
... position I0..1BackboneElementThe absolute geographic location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ1..1Reference(SHR Organization Profile)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically part of
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

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

 

Terminology Bindings

PathNameConformanceValueSet
Location.languageCommon LanguagesextensibleCommon Languages
Location.statusLocationStatusrequiredLocationStatus
Location.operationalStatusv2 Bed Statuspreferredv2 Bed Status
Location.modeLocationModerequiredLocationMode
Location.typeServiceDeliveryLocationRoleTyperequiredServiceDeliveryLocationRoleType
Location.address.useAddressUserequiredAddressUse
Location.address.typeAddressTyperequiredAddressType
Location.address.stateUSPS Two Letter Alphabetic CodesextensibleUSPS Two Letter Alphabetic Codes
Location.physicalTypeLocationTypeexampleLocationType

 

Constraints

IdPathDetailsRequirements
dom-2LocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1LocationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4LocationIf 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-3LocationIf 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()
ele-1Location.positionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())