FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

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 Id Location
Definition

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

Short Display Details and position information for a place
Cardinality 0..*
Type DomainResource
Summary false
Location.identifier
Element Id Location.identifier
Definition

Unique code or number identifying the location to its users.

Short Display 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 operationalStatus, or by a schedule/slots if they are configured for the location.

Short Display active | suspended | inactive
Cardinality 0..1
Terminology Binding Location Status (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.

Short Display The operational status of the location (typically only for a bed/room)
Cardinality 0..1
Terminology Binding hl7VS-bedStatus icon (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.

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

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

Summary false
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.

Short Display Additional details about the location that could be displayed as further information to identify the location beyond its name
Cardinality 0..1
Type markdown
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.

Short Display instance | kind
Cardinality 0..1
Terminology Binding Location Mode (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.

Short Display Type of function performed
Cardinality 0..*
Terminology Binding Service type icon (Preferred)
Type CodeableConcept
Summary true
Location.contact
Element Id Location.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 Display Official contact details for the location
Cardinality 0..*
Type ExtendedContactDetail
Requirements

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

Summary false
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 Id Location.address
Definition

Physical location.

Short Display Physical location
Cardinality 0..1
Type Address
Requirements

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

Summary false
Comments

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

Location.form
Element Id Location.form
Definition

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

Short Display Physical form of the location
Cardinality 0..1
Terminology Binding Location Form (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).

Short Display The absolute geographic location
Cardinality 0..1
Requirements

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

Summary false
Comments

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

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

Short Display Longitude with WGS84 datum
Cardinality 1..1
Type decimal
Summary false
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 on Location main page).

Short Display Latitude with WGS84 datum
Cardinality 1..1
Type decimal
Summary false
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 on Location main page).

Short Display Altitude with WGS84 datum
Cardinality 0..1
Type decimal
Summary false
Location.managingOrganization
Element Id Location.managingOrganization
Definition

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

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

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

Summary false
Location.characteristic
Element Id Location.characteristic
Definition

Collection of characteristics (attributes).

Short Display Collection of characteristics (attributes)
Cardinality 0..*
Terminology Binding Location Characteristic (Example)
Type CodeableConcept
Summary false
Comments

These could be such things as is wheelchair accessible.

Location.hoursOfOperation
Element Id Location.hoursOfOperation
Definition

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

Short Display What days/times during a week is this location usually open (including exceptions)
Cardinality 0..1
Type Availability
Summary false
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 Id Location.virtualService
Definition

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

Short Display Connection details of a virtual service (e.g. conference call)
Cardinality 0..*
Type VirtualServiceDetail
Summary false
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 Id Location.endpoint
Definition

Technical endpoints providing access to services operated for the location.

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

Summary false