STU3 Candidate

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

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.

Control1..1
Location.identifier
Definition

Unique code or number identifying the location to its users.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Organization label locations in registries, need to keep track of those.

Summarytrue
Location.status
Definition

active | suspended | inactive.

Control0..1
Terminology BindingLocationStatus (Required)
Typecode
Is Modifiertrue
Summarytrue
Location.name
Definition

Name of the location as used by humans. Does not need to be unique.

Control0..1
Typestring
Summarytrue
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.

Control0..*
Typestring
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.

Control0..1
Typestring
Requirements

Humans need additional information to verify a correct location has been identified.

Summarytrue
Location.mode
Definition

Indicates whether a resource instance represents a specific location or a class of locations.

Control0..1
Terminology BindingLocationMode (Required)
Typecode
Is Modifiertrue
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.

Summarytrue
Location.type
Definition

Indicates the type of function performed at the location.

Control0..1
Terminology BindingServiceDeliveryLocationRoleType (Extensible)
TypeCodeableConcept
Summarytrue
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.

Control0..*
TypeContactPoint
Location.address
Definition

Physical location.

Control0..1
TypeAddress
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.

Control0..1
Terminology BindingLocationType (Example)
TypeCodeableConcept
Requirements

For purposes of showing relevant locations in queries, we need to categorize locations.

Summarytrue
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).

Control0..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).

Control1..1
Typedecimal
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).

Control1..1
Typedecimal
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).

Control0..1
Typedecimal
Location.managingOrganization
Definition

The organization responsible for the provisioning and upkeep of the location.

Control0..1
TypeReference(Organization)
Requirements

Need to know who manages the location.

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

Control0..1
TypeReference(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.

Control0..*
TypeReference(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.