Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Patient Administration icon Work GroupMaturity Level: 5 Trial UseSecurity Category: Business Compartments: No defined compartments

Detailed Descriptions for the elements in the Location resource.

Location
Element IdLocation
Definition

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

Short DisplayDetails and position information for a place
Cardinality0..*
TypeDomainResource
Summaryfalse
Location.identifier
Element IdLocation.identifier
Definition

Unique code or number identifying the location to its users.

Short DisplayUnique 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.

Short Displayactive | suspended | inactive
Cardinality0..1
Terminology BindingLocation Status (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.

Short DisplayThe operational status of the location (typically only for a bed/room)
Cardinality0..1
Terminology Bindinghl7VS-bedStatus icon (Preferred)
TypeCoding
Summarytrue
Location.name
Element IdLocation.name
Definition

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

Short DisplayName of the location as used by humans
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.

Short DisplayA 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.

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

Short DisplayAdditional details about the location that could be displayed as further information to identify the location beyond its name
Cardinality0..1
Typemarkdown
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.

Short Displayinstance | kind
Cardinality0..1
Terminology BindingLocation Mode (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.

Short DisplayType of function performed
Cardinality0..*
Terminology BindingServiceDeliveryLocationRoleType icon (Extensible)
TypeCodeableConcept
Summarytrue
Location.contact
Element IdLocation.contact
Definition

The contact details of communication devices available at the location. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.

Short DisplayOfficial contact details for the location
Cardinality0..*
TypeExtendedContactDetail
Requirements

Need to keep track of both simple contact details and also assigned contacts within larger organizations.

Summaryfalse
Comments

The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the Healthcare itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc.

If this is empty (or the type of interest is empty), refer to the organization's contacts.

Location.address
Element IdLocation.address
Definition

Physical location.

Short DisplayPhysical location
Cardinality0..1
TypeAddress
Requirements

If locations can be visited, we need to keep track of their address.

Summaryfalse
Comments

Additional addresses should be recorded using another instance of the Location resource, or via the Organization.

Location.form
Element IdLocation.form
Definition

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

Short DisplayPhysical form of the location
Cardinality0..1
Terminology BindingLocation Form (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).

Short DisplayThe absolute geographic location
Cardinality0..1
Requirements

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

Summaryfalse
Comments

To define a boundary shape for this location use the standard extension [http://hl7.org/fhir/StructureDefinition/location-boundary-geojson](http://hl7.org/fhir/extensions/StructureDefinition-location-boundary-geojson.html), and search using the contains special search parameter.

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 on Location main page).

Short DisplayLongitude with WGS84 datum
Cardinality1..1
Typedecimal
Summaryfalse
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 on Location main page).

Short DisplayLatitude with WGS84 datum
Cardinality1..1
Typedecimal
Summaryfalse
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 on Location main page).

Short DisplayAltitude with WGS84 datum
Cardinality0..1
Typedecimal
Summaryfalse
Location.managingOrganization
Element IdLocation.managingOrganization
Definition

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

Short DisplayOrganization responsible for provisioning and upkeep
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.

Short DisplayAnother Location this one 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.

Summaryfalse
Location.characteristic
Element IdLocation.characteristic
Definition

Collection of characteristics (attributes).

Short DisplayCollection of characteristics (attributes)
Cardinality0..*
Terminology BindingLocation Characteristic (Example)
TypeCodeableConcept
Summaryfalse
Comments

These could be such things as is wheelchair accessible.

Location.hoursOfOperation
Element IdLocation.hoursOfOperation
Definition

What days/times during a week is this location usually open, and any exceptions where the location is not available.

Short DisplayWhat days/times during a week is this location usually open (including exceptions)
Cardinality0..*
TypeAvailability
Summaryfalse
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.

Systems may choose to render availability differently than it is exchanged on the interface. For example, rather than "Mon, Tue, Wed, Thur, Fri from 9am-12am; Mon, Tue, Wed, Thur, Fri from 1pm-5pm" as would be implied by two availableTime repetitions, an application could render this information as "Mon-Fri 9-12am and 1-5pm".

The availableStartTime is the opening time, and the availableEndTime is the closing time.

Location.virtualService
Element IdLocation.virtualService
Definition

Connection details of a virtual service (e.g. shared conference call facility with dedicated number/details).

Short DisplayConnection details of a virtual service (e.g. conference call)
Cardinality0..*
TypeVirtualServiceDetail
Summaryfalse
Comments

There are two types of virtual meetings that often exist:

  • a persistent, virtual meeting room that can only be used for a single purpose at a time,
  • and a dynamic virtual meeting room that is generated on demand for a specific purpose.

Implementers may consider using Appointment.virtualService for virtual meeting rooms that are generated on-demand.

Location.endpoint
Element IdLocation.endpoint
Definition

Technical endpoints providing access to services operated for the location.

Short DisplayTechnical 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.

Summaryfalse