This page is part of the FHIR Specification (v1.8.0: STU 3 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

• Content
• Examples
• Detailed Descriptions
• Mappings
• Profiles & Extensions

8.12 Resource Location - Content

Patient Administration Work Group

Maturity Level: 1

Compartments: Not linked to any defined compartments

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

This resource is referenced by Account, ActivityDefinition, Appointment, AppointmentResponse, AuditEvent, CarePlan, Claim, Contract, Device, DeviceUseRequest, DiagnosticReport, DiagnosticRequest, EligibilityRequest, Encounter, ExplanationOfBenefit, Flag, HealthcareService, Immunization, List, MedicationDispense, Observation, Practitioner, PractitionerRole, Procedure, Provenance, ResearchStudy, Schedule and SupplyDelivery

8.12.3 Resource Content

 

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

8.12.3.1 Terminology Bindings

Path	Definition	Type	Reference
Location.status	Indicates whether the location is still in use.	Required	LocationStatus
Location.mode	Indicates whether a resource instance represents a specific location or a class of locations.	Required	LocationMode
Location.type	Indicates the type of function performed at the location.	Extensible	ServiceDeliveryLocationRoleType
Location.physicalType	Physical form of the location	Example	LocationType

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

8.12.4.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':
(however this information could still be included if was relevant, such as when it is a generic item, but not globally generic, e.g. a Burgers MU ambulance)

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

8.12.5 Example Location Hierarchy

An example location hierarchy should help give some guidance as to one example of how a location hierarchy could look within a fictitious Hospital.
(The nesting here would be the "part-of" structure of the location)

Hospital A Building C (instance)
    East Wing (instance)
        Level 1 (instance)
            Reception (instance)
            Nurses Station EM-ns1 (instance)
                Medication Cupboard A (instance)
            Room 1 (instance)
                Room 1a (instance) - space in room separatable via a curtain
                    Bed 1a (instance) - always in this room
                Room 1b (instance)
                    Trolley 43 (instance) - moves about
                Room 1d (instance)
                    Trolley 19 (instance) - moves about
                Room 2 (instance)
                    ...
            Theatre EM-TA (instance)
            Coridor (generic)
        Level 2 (instance)
            Reception (instance)
                ...
            Nurses Station EM-ns1 (instance)
                Medication Cupboard A (instance)
            Coridor (generic)
Mobile Services (kind)
    Ambulance (kind)
        Ambulance AMB1 (instance)
        Ambulance AMB2 (instance)
	

Note: Wards/departments are not part of this structure - these would form part of the Organizational Hierarchy.

8.12.5.1 Positional Searching

Searching for locations often require that a facility is within a specified distance of a particular point. For example, to locate healthcare facilities within 2kms of a clients home, or the current geo-coded position of a practitioner travelling between patients (read from a mobile phone or device).

 GET [base]/Location?near=-83.694810:42.256500&near-distance=11.20||km...

Note: The near search parameters are not able to be used with multiples thus the multiple seperator , should not be used with near or near-distance.

The distance between the location and the provided point is often used as one of the determining factors for selection of the location. So this value is included in the results.
However the value cannot be inside the Location resource as it is different depending on the point of reference in the search. So the distance between is included in the search section of the bundle entry.

<entry> 
    <resource>
        <Location>
            <!-- location details -->
        </Location>
    </resource>
    <search>
        <extension url="http://hl7.org/fhir/StructureDefinition/location-distance">
            <valueDistance >
                <!-- The distance that this location resource is from the provided point in the query --<
                </value value="10.5"/>
                </unit value="km"/>
            </valueDistance>
        </extension>
    </search>
</entry> 

8.12.6 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	Paths	In Common
address	string	A (part of the) address of the location	Location.address
address-city	string	A city specified in an address	Location.address.city
address-country	string	A country specified in an address	Location.address.country
address-postalcode	string	A postal code specified in an address	Location.address.postalCode
address-state	string	A state specified in an address	Location.address.state
address-use	token	A use code specified in an address	Location.address.use
endpoint	reference	Technical endpoints providing access to services operated for the location	Location.endpoint (Endpoint)
identifier	token	Unique code or number identifying the location to its users	Location.identifier
name	string	A (portion of the) name of the location or alias	Location.name, Location.alias
near	token	The coordinates expressed as [latitude]:[longitude] (using the WGS84 datum, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency). Requires the near-distance parameter to be provided also	Location.position
near-distance	quantity	A distance quantity to limit the near search to locations within a specific distance Requires the near parameter to be included also	Location.position
organization	reference	Searches for locations that are managed by the provided organization	Location.managingOrganization (Organization)
partof	reference	The location of which this location is a part	Location.partOf (Location)
status	token	Searches for locations with a specific kind of status	Location.status
type	token	A code for the type of location	Location.type