This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). 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 |
Detailed Descriptions for the elements in the Location resource.
Location | |
Element Id | Location |
Definition | Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. |
Cardinality | 0..* |
Type | DomainResource |
Location.identifier | |
Element Id | Location.identifier |
Definition | Unique code or number identifying the location to its users. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Requirements | Organization label locations in registries, need to keep track of those. |
Summary | true |
Location.status | |
Element Id | Location.status |
Definition | The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location. |
Cardinality | 0..1 |
Terminology Binding | LocationStatus (Required) |
Type | code |
Is Modifier | true (Reason: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid) |
Summary | true |
Location.operationalStatus | |
Element Id | Location.operationalStatus |
Definition | The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance. |
Cardinality | 0..1 |
Terminology Binding | v2 BED STATUS (Preferred) |
Type | Coding |
Summary | true |
Location.name | |
Element Id | Location.name |
Definition | Name of the location as used by humans. Does not need to be unique. |
Cardinality | 0..1 |
Type | string |
Summary | true |
Comments | If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches. |
Location.alias | |
Element Id | Location.alias |
Definition | A list of alternate names that the location is known as, or was known as, in the past. |
Cardinality | 0..* |
Type | string |
Requirements | Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the location was known by can be very useful. |
Comments | There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location. |
Location.description | |
Element Id | Location.description |
Definition | Description of the Location, which helps in finding or referencing the place. |
Cardinality | 0..1 |
Type | string |
Requirements | Humans need additional information to verify a correct location has been identified. |
Summary | true |
Location.mode | |
Element Id | Location.mode |
Definition | Indicates whether a resource instance represents a specific location or a class of locations. |
Cardinality | 0..1 |
Terminology Binding | LocationMode (Required) |
Type | code |
Requirements | When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location. |
Summary | true |
Comments | This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood. |
Location.type | |
Element Id | Location.type |
Definition | Indicates the type of function performed at the location. |
Cardinality | 0..* |
Terminology Binding | V3 Value SetServiceDeliveryLocationRoleType (Extensible) |
Type | CodeableConcept |
Summary | true |
Location.telecom | |
Element Id | Location.telecom |
Definition | The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. |
Cardinality | 0..* |
Type | ContactPoint |
Location.address | |
Element Id | Location.address |
Definition | Physical location. |
Cardinality | 0..1 |
Type | Address |
Requirements | If locations can be visited, we need to keep track of their address. |
Comments | Additional addresses should be recorded using another instance of the Location resource, or via the Organization. |
Location.physicalType | |
Element Id | Location.physicalType |
Definition | Physical form of the location, e.g. building, room, vehicle, road. |
Cardinality | 0..1 |
Terminology Binding | Location type (Example) |
Type | CodeableConcept |
Requirements | For purposes of showing relevant locations in queries, we need to categorize locations. |
Summary | true |
Location.position | |
Element Id | Location.position |
Definition | The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). |
Cardinality | 0..1 |
Requirements | For mobile applications and automated route-finding knowing the exact location of the Location is required. |
Location.position.longitude | |
Element Id | Location.position.longitude |
Definition | Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). |
Cardinality | 1..1 |
Type | decimal |
Location.position.latitude | |
Element Id | Location.position.latitude |
Definition | Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). |
Cardinality | 1..1 |
Type | decimal |
Location.position.altitude | |
Element Id | Location.position.altitude |
Definition | Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). |
Cardinality | 0..1 |
Type | decimal |
Location.managingOrganization | |
Element Id | Location.managingOrganization |
Definition | The organization responsible for the provisioning and upkeep of the location. |
Cardinality | 0..1 |
Type | Reference(Organization) |
Requirements | Need to know who manages the location. |
Summary | true |
Comments | This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource. |
Location.partOf | |
Element Id | Location.partOf |
Definition | Another Location of which this Location is physically a part of. |
Cardinality | 0..1 |
Type | Reference(Location) |
Hierarchy | This reference is part of a strict Hierarchy |
Requirements | For purposes of location, display and identification, knowing which locations are located within other locations is important. |
Location.hoursOfOperation | |
Element Id | Location.hoursOfOperation |
Definition | What days/times during a week is this location usually open. |
Cardinality | 0..* |
Comments | This type of information is commonly found published in directories and on websites informing customers when the facility is available. Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours. |
Location.hoursOfOperation.daysOfWeek | |
Element Id | Location.hoursOfOperation.daysOfWeek |
Definition | Indicates which days of the week are available between the start and end Times. |
Cardinality | 0..* |
Terminology Binding | DaysOfWeek (Required) |
Type | code |
Location.hoursOfOperation.allDay | |
Element Id | Location.hoursOfOperation.allDay |
Definition | The Location is open all day. |
Cardinality | 0..1 |
Type | boolean |
Location.hoursOfOperation.openingTime | |
Element Id | Location.hoursOfOperation.openingTime |
Definition | Time that the Location opens. |
Cardinality | 0..1 |
Type | time |
Location.hoursOfOperation.closingTime | |
Element Id | Location.hoursOfOperation.closingTime |
Definition | Time that the Location closes. |
Cardinality | 0..1 |
Type | time |
Location.availabilityExceptions | |
Element Id | Location.availabilityExceptions |
Definition | A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times. |
Cardinality | 0..1 |
Type | string |
Location.endpoint | |
Element Id | Location.endpoint |
Definition | Technical endpoints providing access to services operated for the location. |
Cardinality | 0..* |
Type | Reference(Endpoint) |
Requirements | Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose. |