This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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
Detailed Descriptions for the elements in the Location resource.
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. |
Control | 1..1 |
Location.identifier | |
Definition | Unique code or number identifying the location to its users. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | Organization label locations in registries, need to keep track of those. |
Summary | true |
Location.status | |
Definition | active | suspended | inactive. |
Control | 0..1 |
Binding | LocationStatus: Indicates whether the location is still in use. (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Location.name | |
Definition | Name of the location as used by humans. Does not need to be unique. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | If the name of an location changes, consider putting the old name in the alias column so that it can still be located through searches. |
Location.alias | |
Definition | A list of alternate names that the location is known as, or was known as in the past. |
Control | 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 | |
Definition | Description of the Location, which helps in finding or referencing the place. |
Control | 0..1 |
Type | string |
Requirements | Humans need additional information to verify a correct location has been identified. |
Summary | true |
Location.mode | |
Definition | Indicates whether a resource instance represents a specific location or a class of locations. |
Control | 0..1 |
Binding | LocationMode: Indicates whether a resource instance represents a specific location or a class of locations. (Required) |
Type | code |
Is Modifier | true |
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 |
Location.type | |
Definition | Indicates the type of function performed at the location. |
Control | 0..1 |
Binding | ServiceDeliveryLocationRoleType: Indicates the type of function performed at the location. (Extensible) |
Type | CodeableConcept |
Summary | true |
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. |
Control | 0..* |
Type | ContactPoint |
Location.address | |
Definition | Physical location. |
Control | 0..1 |
Type | Address |
Requirements | If locations can be visited, we need to keep track of their address. |
Comments | This was kept as 0..1 as there is no use property on the address, so wouldn't be able to identify different address types. |
Location.physicalType | |
Definition | Physical form of the location, e.g. building, room, vehicle, road. |
Control | 0..1 |
Binding | LocationType: Physical form of the location (Example) |
Type | CodeableConcept |
Requirements | For purposes of showing relevant locations in queries, we need to categorize locations. |
Summary | true |
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). |
Control | 0..1 |
Requirements | For mobile applications and automated route-finding knowing the exact location of the Location is required. |
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). |
Control | 1..1 |
Type | decimal |
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). |
Control | 1..1 |
Type | decimal |
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). |
Control | 0..1 |
Type | decimal |
Location.managingOrganization | |
Definition | The organization responsible for the provisioning and upkeep of the location. |
Control | 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 | |
Definition | Another Location which this Location is physically part of. |
Control | 0..1 |
Type | Reference(Location) |
Requirements | For purposes of location, display and identification, knowing which locations are located within other locations is important. |
Location.endpoint | |
Definition | Technical endpoints providing access to services operated for the location. |
Control | 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. |