2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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 R3 R2

5.13 Resource Location - Content

This resource maintained by the Patient Administration Work Group

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.

5.13.1 Scope and Usage

A Location includes both incidental locations (a place which is used for healthcare without prior designation or authorization) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages.

Examples of Locations are:

  • Building, ward, corridor or room
  • Freezer, incubator
  • Vehicle or lift
  • Home, shed, or a garage
  • Road, parking place, a park

This resource is referenced by Appointment, CarePlan, Composition, Contract, Device, DiagnosticOrder, DiagnosticReport, Encounter, HealthcareService, Immunization, InstitutionalClaim, List, MedicationDispense, Observation, OralHealthClaim, Organization, PharmacyClaim, Practitioner, ProfessionalClaim, Provenance, Supply and VisionClaim

5.13.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location DomainResourceDetails and position information for a physical place
... identifier 0..*IdentifierUnique code or number identifying the location to its users
... name 0..1stringName of the location as used by humans
... description 0..1stringDescription of the Location, which helps in finding or referencing the place
... type 0..1CodeableConceptIndicates the type of function performed at the location
LocationType (Incomplete)
... telecom 0..*ContactPointContact details of the location
... address 0..1AddressPhysical location
... physicalType 0..1CodeableConceptPhysical form of the location
PhysicalType (Example)
... position 0..1ElementThe absolute geographic location
.... longitude 1..1decimalLongitude as expressed in KML
.... latitude 1..1decimalLatitude as expressed in KML
.... altitude 0..1decimalAltitude as expressed in KML
... managingOrganization 0..1OrganizationThe organization that is responsible for the provisioning and upkeep of the location
... status M0..1codeactive | suspended | inactive
LocationStatus (Required)
... partOf 0..1LocationAnother Location which this Location is physically part of
... mode M0..1codeinstance | kind
LocationMode (Required)

UML Diagram

Location (DomainResource)Unique code or number identifying the location to its usersidentifier : Identifier 0..*Name of the location as used by humans. Does not need to be uniquename : string 0..1Description of the Location, which helps in finding or referencing the placedescription : string 0..1Indicates the type of function performed at the locationtype : CodeableConcept 0..1 « Indicates the type of function performed at the locationLocationType+ »The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sitestelecom : ContactPoint 0..*Physical locationaddress : Address 0..1Physical form of the location, e.g. building, room, vehicle, roadphysicalType : CodeableConcept 0..1 « (Physical form of the locationPhysicalType) »The organization that is responsible for the provisioning and upkeep of the locationmanagingOrganization : Reference(Organization) 0..1active | suspended | inactive (this element modifies the meaning of other elements)status : code 0..1 « Indicates whether the location is still in useLocationStatus »Another Location which this Location is physically part ofpartOf : Reference(Location) 0..1Indicates whether a resource instance represents a specific location or a class of locations (this element modifies the meaning of other elements)mode : code 0..1 « Indicates whether a resource instance represents a specific location or a class of locationsLocationMode »PositionLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below)longitude : decimal 1..1Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below)latitude : decimal 1..1Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below)altitude : decimal 0..1The absolute geographic location of the Location, expressed in a KML compatible manner (see notes below for KML)position0..1

XML Template

<Location xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier 
     Unique code or number identifying the location to its users --></identifier>
 <name value="[string]"/><!-- 0..1 Name of the location as used by humans -->
 <description value="[string]"/><!-- 0..1 Description of the Location, which helps in finding or referencing the place -->
 <type><!-- 0..1 CodeableConcept Indicates the type of function performed at the location --></type>
 <telecom><!-- 0..* ContactPoint Contact details of the location --></telecom>
 <address><!-- 0..1 Address Physical location --></address>
 <physicalType><!-- 0..1 CodeableConcept Physical form of the location --></physicalType>
 <position>  <!-- 0..1 The absolute geographic location -->
  <longitude value="[decimal]"/><!-- 1..1 Longitude as expressed in KML -->
  <latitude value="[decimal]"/><!-- 1..1 Latitude as expressed in KML -->
  <altitude value="[decimal]"/><!-- 0..1 Altitude as expressed in KML -->
 </position>
 <managingOrganization><!-- 0..1 Reference(Organization) 
     The organization that is responsible for the provisioning and upkeep of the location --></managingOrganization>
 <status value="[code]"/><!-- 0..1 active | suspended | inactive -->
 <partOf><!-- 0..1 Reference(Location) 
     Another Location which this Location is physically part of --></partOf>
 <mode value="[code]"/><!-- 0..1 instance | kind -->
</Location>

JSON Template

{doco
  "resourceType" : "Location",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // 
     Unique code or number identifying the location to its users
  "name" : "<string>", // Name of the location as used by humans
  "description" : "<string>", // Description of the Location, which helps in finding or referencing the place
  "type" : { CodeableConcept }, // Indicates the type of function performed at the location
  "telecom" : [{ ContactPoint }], // Contact details of the location
  "address" : { Address }, // Physical location
  "physicalType" : { CodeableConcept }, // Physical form of the location
  "position" : { // The absolute geographic location
    "longitude" : <decimal>, // R! Longitude as expressed in KML
    "latitude" : <decimal>, // R! Latitude as expressed in KML
    "altitude" : <decimal> // Altitude as expressed in KML
  },
  "managingOrganization" : { Reference(Organization) }, // 
     The organization that is responsible for the provisioning and upkeep of the location
  "status" : "<code>", // active | suspended | inactive
  "partOf" : { Reference(Location) }, // 
     Another Location which this Location is physically part of
  "mode" : "<code>" // instance | kind
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location DomainResourceDetails and position information for a physical place
... identifier 0..*IdentifierUnique code or number identifying the location to its users
... name 0..1stringName of the location as used by humans
... description 0..1stringDescription of the Location, which helps in finding or referencing the place
... type 0..1CodeableConceptIndicates the type of function performed at the location
LocationType (Incomplete)
... telecom 0..*ContactPointContact details of the location
... address 0..1AddressPhysical location
... physicalType 0..1CodeableConceptPhysical form of the location
PhysicalType (Example)
... position 0..1ElementThe absolute geographic location
.... longitude 1..1decimalLongitude as expressed in KML
.... latitude 1..1decimalLatitude as expressed in KML
.... altitude 0..1decimalAltitude as expressed in KML
... managingOrganization 0..1OrganizationThe organization that is responsible for the provisioning and upkeep of the location
... status M0..1codeactive | suspended | inactive
LocationStatus (Required)
... partOf 0..1LocationAnother Location which this Location is physically part of
... mode M0..1codeinstance | kind
LocationMode (Required)

UML Diagram

Location (DomainResource)Unique code or number identifying the location to its usersidentifier : Identifier 0..*Name of the location as used by humans. Does not need to be uniquename : string 0..1Description of the Location, which helps in finding or referencing the placedescription : string 0..1Indicates the type of function performed at the locationtype : CodeableConcept 0..1 « Indicates the type of function performed at the locationLocationType+ »The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sitestelecom : ContactPoint 0..*Physical locationaddress : Address 0..1Physical form of the location, e.g. building, room, vehicle, roadphysicalType : CodeableConcept 0..1 « (Physical form of the locationPhysicalType) »The organization that is responsible for the provisioning and upkeep of the locationmanagingOrganization : Reference(Organization) 0..1active | suspended | inactive (this element modifies the meaning of other elements)status : code 0..1 « Indicates whether the location is still in useLocationStatus »Another Location which this Location is physically part ofpartOf : Reference(Location) 0..1Indicates whether a resource instance represents a specific location or a class of locations (this element modifies the meaning of other elements)mode : code 0..1 « Indicates whether a resource instance represents a specific location or a class of locationsLocationMode »PositionLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below)longitude : decimal 1..1Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below)latitude : decimal 1..1Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below)altitude : decimal 0..1The absolute geographic location of the Location, expressed in a KML compatible manner (see notes below for KML)position0..1

XML Template

<Location xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier 
     Unique code or number identifying the location to its users --></identifier>
 <name value="[string]"/><!-- 0..1 Name of the location as used by humans -->
 <description value="[string]"/><!-- 0..1 Description of the Location, which helps in finding or referencing the place -->
 <type><!-- 0..1 CodeableConcept Indicates the type of function performed at the location --></type>
 <telecom><!-- 0..* ContactPoint Contact details of the location --></telecom>
 <address><!-- 0..1 Address Physical location --></address>
 <physicalType><!-- 0..1 CodeableConcept Physical form of the location --></physicalType>
 <position>  <!-- 0..1 The absolute geographic location -->
  <longitude value="[decimal]"/><!-- 1..1 Longitude as expressed in KML -->
  <latitude value="[decimal]"/><!-- 1..1 Latitude as expressed in KML -->
  <altitude value="[decimal]"/><!-- 0..1 Altitude as expressed in KML -->
 </position>
 <managingOrganization><!-- 0..1 Reference(Organization) 
     The organization that is responsible for the provisioning and upkeep of the location --></managingOrganization>
 <status value="[code]"/><!-- 0..1 active | suspended | inactive -->
 <partOf><!-- 0..1 Reference(Location) 
     Another Location which this Location is physically part of --></partOf>
 <mode value="[code]"/><!-- 0..1 instance | kind -->
</Location>

JSON Template

{doco
  "resourceType" : "Location",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // 
     Unique code or number identifying the location to its users
  "name" : "<string>", // Name of the location as used by humans
  "description" : "<string>", // Description of the Location, which helps in finding or referencing the place
  "type" : { CodeableConcept }, // Indicates the type of function performed at the location
  "telecom" : [{ ContactPoint }], // Contact details of the location
  "address" : { Address }, // Physical location
  "physicalType" : { CodeableConcept }, // Physical form of the location
  "position" : { // The absolute geographic location
    "longitude" : <decimal>, // R! Longitude as expressed in KML
    "latitude" : <decimal>, // R! Latitude as expressed in KML
    "altitude" : <decimal> // Altitude as expressed in KML
  },
  "managingOrganization" : { Reference(Organization) }, // 
     The organization that is responsible for the provisioning and upkeep of the location
  "status" : "<code>", // active | suspended | inactive
  "partOf" : { Reference(Location) }, // 
     Another Location which this Location is physically part of
  "mode" : "<code>" // instance | kind
}

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

5.13.2.1 Terminology Bindings

PathDefinitionTypeReference
Location.type Indicates the type of function performed at the locationIncompletehttp://hl7.org/fhir/v3/vs/ServiceDeliveryLocationRoleType
Location.physicalType Physical form of the locationExamplehttp://hl7.org/fhir/vs/location-physical-type
Location.status Indicates whether the location is still in useFixedhttp://hl7.org/fhir/location-status
Location.mode Indicates whether a resource instance represents a specific location or a class of locationsFixedhttp://hl7.org/fhir/location-mode

5.13.3 Notes

  • Multiple Organizations or Practitioners may provide services at a Location. These references are not kept in Location, but can be found in the models for Organization and Practitioner instead.
  • Locations may range from whole buildings to cabinets; it is possible to relate smaller Locations to their containing bigger Location using the Location.partOf element.
  • Location.position is expressed using the same syntax, datum and reference system as used in Google Earth's KML files, see Google/OGS's KML.

5.13.3.1 Location Mode

The Location.mode element can be used to indicate whether a Location resource represents a specific (potentially identifiable) Location ('instance'), or a class of Locations ('kind'). Especially Resources capturing orders, resource scheduling, plans and definitions may refer to Locations in 'kind' mode. For these domains, it is often not necessary to refer to a specific Location, but rather to a class of Locations. An example of this is found in planning, where we need to allocate an "isolation room" for a patient, or need to dispatch "an ambulance" at a certain time. In these cases it is not important exactly which isolation room or ambulance is allocated, and it is sufficient to just indicate a 'kind' of Location.

Note that 'kind' should not be used to represent Locations where an actual instance of a Location was involved, but identifying information is missing. E.g. when a patient arrived 'by ambulance', but it is not known by which ambulance, this should be represented using a Location in 'instance' mode with a missing identifier, not a Location of 'kind' ambulance.

Some of Location's data elements are only relevant when mode is 'instance' and should not be used when mode is 'kind':

  • Location.identifier
  • Location.telecom
  • Location.address
  • Location.position
  • Location.status
  • Location.managingOrganization

5.13.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.

NameTypeDescriptionPaths
addressstringA (part of the) address of the locationLocation.address
identifiertokenUnique code or number identifying the location to its usersLocation.identifier
namestringA (portion of the) name of the locationLocation.name
neartokenThe coordinates expressed as [lat],[long] (using KML, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency)
near-distancetokenA distance quantity to limit the near search to locations within a specific distance
organizationreferenceSearches for locations that are managed by the provided organizationLocation.managingOrganization
(Organization)
partofreferenceThe location of which this location is a partLocation.partOf
(Location)
statustokenSearches for locations with a specific kind of statusLocation.status
typetokenA code for the type of locationLocation.type