Current Build
Patient Administration Work GroupMaturity Level: 3 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the Location resource.

Location
Element IdLocation
Definition

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

Cardinality0..*
TypeDomainResource
Location.identifier
Element IdLocation.identifier
Definition

Unique code or number identifying the location to its users.

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

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

Summarytrue
Location.status
Element IdLocation.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.

Cardinality0..1
Terminology BindingLocationStatus (Required)
Typecode
Is Modifiertrue (Reason: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid)
Summarytrue
Location.operationalStatus
Element IdLocation.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.

Cardinality0..1
Terminology Bindingv2 BED STATUS (Preferred)
TypeCoding
Summarytrue
Location.name
Element IdLocation.name
Definition

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

Cardinality0..1
Typestring
Summarytrue
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 IdLocation.alias
Definition

A list of alternate names that the location is known as, or was known as, in the past.

Cardinality0..*
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
Element IdLocation.description
Definition

Description of the Location, which helps in finding or referencing the place.

Cardinality0..1
Typestring
Requirements

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

Summarytrue
Location.mode
Element IdLocation.mode
Definition

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

Cardinality0..1
Terminology BindingLocationMode (Required)
Typecode
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
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 IdLocation.type
Definition

Indicates the type of function performed at the location.

Cardinality0..*
Terminology BindingV3 Value SetServiceDeliveryLocationRoleType (Extensible)
TypeCodeableConcept
Summarytrue
Location.telecom
Element IdLocation.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.

Cardinality0..*
TypeContactPoint
Location.address
Element IdLocation.address
Definition

Physical location.

Cardinality0..1
TypeAddress
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 IdLocation.physicalType
Definition

Physical form of the location, e.g. building, room, vehicle, road.

Cardinality0..1
Terminology BindingLocation type (Example)
TypeCodeableConcept
Requirements

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

Summarytrue
Location.position
Element IdLocation.position
Definition

The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

Cardinality0..1
Requirements

For mobile applications and automated route-finding knowing the exact location of the Location is required.

Location.position.longitude
Element IdLocation.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).

Cardinality1..1
Typedecimal
Location.position.latitude
Element IdLocation.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).

Cardinality1..1
Typedecimal
Location.position.altitude
Element IdLocation.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).

Cardinality0..1
Typedecimal
Location.managingOrganization
Element IdLocation.managingOrganization
Definition

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

Cardinality0..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
Element IdLocation.partOf
Definition

Another Location of which this Location is physically a part of.

Cardinality0..1
TypeReference(Location)
HierarchyThis 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 IdLocation.hoursOfOperation
Definition

What days/times during a week is this location usually open.

Cardinality0..*
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 IdLocation.hoursOfOperation.daysOfWeek
Definition

Indicates which days of the week are available between the start and end Times.

Cardinality0..*
Terminology BindingDaysOfWeek (Required)
Typecode
Location.hoursOfOperation.allDay
Element IdLocation.hoursOfOperation.allDay
Definition

The Location is open all day.

Cardinality0..1
Typeboolean
Location.hoursOfOperation.openingTime
Element IdLocation.hoursOfOperation.openingTime
Definition

Time that the Location opens.

Cardinality0..1
Typetime
Location.hoursOfOperation.closingTime
Element IdLocation.hoursOfOperation.closingTime
Definition

Time that the Location closes.

Cardinality0..1
Typetime
Location.availabilityExceptions
Element IdLocation.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.

Cardinality0..1
Typestring
Location.endpoint
Element IdLocation.endpoint
Definition

Technical endpoints providing access to services operated for the location.

Cardinality0..*
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.