Release 5 Draft Ballot
AdministrationThis page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). 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
| Patient Administration Work Group | Maturity Level: 3 | Trial Use | Security Category: Business | 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.
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:
These locations are not intended to cover locations on a patient where something occurred (i.e. a patient's broken leg), but can happily cover the location where the patient broke the leg (the playground)
Locations and Organizations are very closely related resources and can often be mixed/matched/confused.
The Location is intended to describe the more physical structures managed/operated by an organization, whereas the Organization is intended to
represent the more conceptual hierarchies, such as a ward.
A Location is valid without an address in cases where it could be purely described by
a geo-coded location in remote areas, or when recorded by a device. Locations with a mode = "kind" would
also likely not have an address, as they are just a type of location, but could also have an address where
they can be found at the address.
Another use of location could be for describing a Jurisdiction. This jurisdiction may be considered a classified boundary which could be a combination of a physical boundary, and some other discriminator(s):
This resource is referenced by UsageContext, Account, ActivityDefinition, AdverseEvent, Appointment, AppointmentResponse, AuditEvent, CatalogEntry, Claim, ClaimResponse, Communication, Contract, CoverageEligibilityRequest, Device, DeviceRequest, DiagnosticReport, DocumentReference, Encounter, ExplanationOfBenefit, Flag, HealthcareService, ImagingStudy, Immunization, InsurancePlan, InventoryReport, List, itself, MeasureReport, MedicationDispense, NutritionIntake, Observation, OrganizationAffiliation, PlanDefinition, PractitionerRole, Procedure, Provenance, RegulatedAuthorization, RequestGroup, ResearchStudy, Schedule, ServiceRequest, Specimen, SupplyDelivery, SupplyRequest and Task.
This resource implements the ParticipantContactable pattern.
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Location | TU | DomainResource | Details and position information for a physical place Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
  identifier | Σ | 0..* | Identifier | Unique code or number identifying the location to its users |
 status | ?!Σ | 0..1 | code | active | suspended | inactive LocationStatus (Required) |
| operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) hl7VS-bedStatus (Preferred) |
| name | Σ | 0..1 | string | Name of the location as used by humans |
| alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |
| description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
| mode | Σ | 0..1 | code | instance | kind LocationMode (Required) |
| type | Σ | 0..* | CodeableConcept | Type of function performed ServiceDeliveryLocationRoleType (Extensible) |
| telecom | 0..* | ContactPoint | Contact details of the location | |
| address | 0..1 | Address | Physical location | |
| physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location LocationType (Example) |
  position | 0..1 | BackboneElement | The absolute geographic location | |
 longitude | 1..1 | decimal | Longitude with WGS84 datum | |
| latitude | 1..1 | decimal | Latitude with WGS84 datum | |
 altitude | 0..1 | decimal | Altitude with WGS84 datum | |
 managingOrganization | Σ | 0..1 | Reference(Organization) | Organization responsible for provisioning and upkeep |
| partOf | 0..1 | Reference(Location) | Another Location this one is physically a part of | |
| hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun DaysOfWeek (Required) | |
| allDay | 0..1 | boolean | The Location is open all day | |
| openingTime | 0..1 | time | Time that the Location opens | |
| closingTime | 0..1 | time | Time that the Location closes | |
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |
| Documentation for this format | ||||
UML Diagram (Legend)
XML Template
<Location xmlns="http://hl7.org/fhir"><!-- 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> <status value="[code]"/><!-- 0..1 active | suspended | inactive --> <operationalStatus><!-- 0..1 Coding The operational status of the location (typically only for a bed/room)
JSON Template
{
"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
"status" : "<code>", // active | suspended | inactive
"operationalStatus" : { Coding }, // The operational status of the location (typically only for a bed/room)
"name" : "<string>", // Name of the location as used by humans
"alias" : ["<string>"], // A list of alternate names that the location is known as, or was known as, in the past
"description" : "<string>", // Additional details about the location that could be displayed as further information to identify the location beyond its name
"mode" : "<code>", // instance | kind
"type" : [{ CodeableConcept }], // Type of function performed
"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 with WGS84 datum
"latitude" : <decimal>, // R! Latitude with WGS84 datum
"altitude" : <decimal> // Altitude with WGS84 datum
},
"managingOrganization" : { Reference(Organization) }, // Organization responsible for provisioning and upkeep
"partOf" : { Reference(Location) }, // Another Location this one is physically a part of
"hoursOfOperation" : [{ // What days/times during a week is this location usually open
"daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun
"allDay" : <boolean>, // The Location is open all day
"openingTime" : "<time>", // Time that the Location opens
"closingTime" : "<time>" // Time that the Location closes
}],
"availabilityExceptions" : "<string>", // Description of availability exceptions
"endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to services operated for the location
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since R3
| Location | |
| Location.status |
|
| Location.mode |
|
| Location.hoursOfOperation.daysOfWeek |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 6 tests that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors).)
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | TU | DomainResource | Details and position information for a physical place Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
| identifier | Σ | 0..* | Identifier | Unique code or number identifying the location to its users |
| status | ?!Σ | 0..1 | code | active | suspended | inactive LocationStatus (Required) |
| operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) hl7VS-bedStatus (Preferred) |
| name | Σ | 0..1 | string | Name of the location as used by humans |
| alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |
| description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
| mode | Σ | 0..1 | code | instance | kind LocationMode (Required) |
| type | Σ | 0..* | CodeableConcept | Type of function performed ServiceDeliveryLocationRoleType (Extensible) |
| telecom | 0..* | ContactPoint | Contact details of the location | |
| address | 0..1 | Address | Physical location | |
| physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location LocationType (Example) |
| position | 0..1 | BackboneElement | The absolute geographic location | |
| longitude | 1..1 | decimal | Longitude with WGS84 datum | |
| latitude | 1..1 | decimal | Latitude with WGS84 datum | |
| altitude | 0..1 | decimal | Altitude with WGS84 datum | |
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization responsible for provisioning and upkeep |
| partOf | 0..1 | Reference(Location) | Another Location this one is physically a part of | |
| hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun DaysOfWeek (Required) | |
| allDay | 0..1 | boolean | The Location is open all day | |
| openingTime | 0..1 | time | Time that the Location opens | |
| closingTime | 0..1 | time | Time that the Location closes | |
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |
| Documentation for this format | ||||
XML Template
<Location xmlns="http://hl7.org/fhir">
JSON Template
{
"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
"status" : "<code>", // active | suspended | inactive
"operationalStatus" : { Coding }, // The operational status of the location (typically only for a bed/room)
"name" : "<string>", // Name of the location as used by humans
"alias" : ["<string>"], // A list of alternate names that the location is known as, or was known as, in the past
"description" : "<string>", // Additional details about the location that could be displayed as further information to identify the location beyond its name
"mode" : "<code>", // instance | kind
"type" : [{ CodeableConcept }], // Type of function performed
"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 with WGS84 datum
"latitude" : <decimal>, // R! Latitude with WGS84 datum
"altitude" : <decimal> // Altitude with WGS84 datum
},
"managingOrganization" : { Reference(Organization) }, // Organization responsible for provisioning and upkeep
"partOf" : { Reference(Location) }, // Another Location this one is physically a part of
"hoursOfOperation" : [{ // What days/times during a week is this location usually open
"daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun
"allDay" : <boolean>, // The Location is open all day
"openingTime" : "<time>", // Time that the Location opens
"closingTime" : "<time>" // Time that the Location closes
}],
"availabilityExceptions" : "<string>", // Description of availability exceptions
"endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to services operated for the location
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since Release 3
| Location | |
| Location.status |
|
| Location.mode |
|
| Location.hoursOfOperation.daysOfWeek |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 6 tests that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors).)
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a
| Path | Definition | Type | Reference |
|---|---|---|---|
| Location.status | Required | LocationStatus | |
| Location.operationalStatus | Preferred | Hl7VSBedStatus | |
| Location.mode | Required | LocationMode | |
| Location.type | Extensible | ServiceDeliveryLocationRoleType | |
| Location.physicalType | Example | LocationType | |
| Location.hoursOfOperation.daysOfWeek | Required | DaysOfWeek |
.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 to identify exactly which isolation room or ambulance is allocated, 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 by identifying missing information. 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 Medical Centre ambulance)
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.
Searching for locations often require that a facility is within a specified distance of a specified point. For example, to locate healthcare facilities within 11.2 kms of a client's 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|11.20|km...
The distance and distance unit parameter components are optional, if the units are missing, kms are to be assumed. If the distance parameter component is missing, then the server may choose its own interpretation of what near enough is to be included in the search results.
Note: The STU3 version of this functionality did not support the multiple
separator , or chaining. The update to this format now supports both of these use cases.
(And the near-distance was deprecated as a result of this change too)
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. Where multiple near positions are included, the distance to the closest
point provided may be included.
<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>
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 | Expression | In Common |
| address | string | A (part of the) address of the location | Location.address | |
| address-city N | string | A city specified in an address | Location.address.city | |
| address-country N | string | A country specified in an address | Location.address.country | |
| address-postalcode N | string | A postal code specified in an address | Location.address.postalCode | |
| address-state N | string | A state specified in an address | Location.address.state | |
| address-use N | 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 | An identifier for the location | Location.identifier | |
| name | string | A portion of the location's name or alias | Location.name | Location.alias | |
| near | special | Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant) Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency. Requires the near-distance parameter to be provided also | Location.position | |
| operational-status | token | Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping) | Location.operationalStatus | |
| organization | reference | Searches for locations that are managed by the provided organization | Location.managingOrganization (Organization) | |
| partof | reference | A location of which this location is a part | Location.partOf (Location) | |
| status N | token | Searches for locations with a specific kind of status | Location.status | |
| type | token | A code for the type of location | Location.type |
FHIR ®© HL7.org 2011+. FHIR R5 Draft Ballot hl7.fhir.core#4.6.0 generated on Thu, Apr 15, 2021 12:29+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change