type: resource-definitionsresource: Location

Location Definitions

Location

Details and position information for a place

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

Cardinality: 0..*

Mappings: rim=.Role[classCode=SDLC]; interface=ParticipantContactable; w5=administrative.entity

Location.identifier

Unique code or number identifying the location to its users

Definition: Unique code or number identifying the location to its users.

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

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: w5=FiveWs.identifier; rim=.id; interface=Participant.identifier

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.

Cardinality: 0..1

Type: code

Binding: required:location-status

Summary: true

Is Modifier: true (Reason: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid)

Mappings: w5=FiveWs.status; rim=.statusCode; interface=Participant.active

Location.operationalStatus

The operational status of the location (typically only for a bed/room)

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.

Cardinality: 0..1

Type: Coding

Binding: preferred:v2-0116

Summary: true

Mappings: w5=FiveWs.status; rim=n/a

Location.code

Codes that identify this location

Definition: A coded representation of this Location, where the codes may be found in a geospatial system.

Comments: Location.code may be used when there are existing code sets for geospatial or administrative regions, such as states, districts, municipalities, etc., where the code represents the geospatial identity of the Location. When indicating that a Location is located within some broader geospatial or administrative Location. When representing unique identifiers for intra-facility locations like rooms, beds, etc., Location.identifier is preferable. Further details will be available in the Administration Incubator.

Cardinality: 0..*

Type: CodeableConcept

Binding: example:iso3166-1-2

Summary: true

Location.name

Name of the location as used by humans

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

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.

Cardinality: 0..1

Type: string

Summary: true

Mappings: rim=.name; interface=Participant.name

Location.alias

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

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

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.

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.

Cardinality: 0..*

Type: string

Mappings: rim=.name

Location.description

Additional details about the location that could be displayed as further information to identify the location beyond its name

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

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

Cardinality: 0..1

Type: markdown

Summary: true

Mappings: rim=.playingEntity[classCode=PLC determinerCode=INSTANCE].desc

Location.mode

instance | kind

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

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.

Cardinality: 0..1

Type: code

Binding: required:location-mode

Summary: true

Mappings: w5=FiveWs.class; rim=.playingEntity[classCode=PLC].determinerCode

Location.type

Types of services available at this location

Definition: Indicates the type of services that are available at this location.

Cardinality: 0..*

Type: CodeableConcept

Binding: preferred:service-type

Summary: true

Mappings: w5=FiveWs.class; rim=.code

Location.contact

Official contact details for the location

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.

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.

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

Cardinality: 0..*

Type: ExtendedContactDetail

Mappings: rim=.telecom and .addr and other .role(relevant datatype properties mapped from role into extendedcontactdetail)

Location.address

Physical location

Definition: Physical location.

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

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

Cardinality: 0..1

Type: Address

Mappings: rim=.addr; interface=ParticipantContactable.address

Location.form

Physical form of the location

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

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

Cardinality: 0..1

Type: CodeableConcept

Binding: example:location-form

Summary: true

Mappings: w5=FiveWs.class; rim=.playingEntity [classCode=PLC].code

Location.position

The absolute geographic location

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

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

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

Cardinality: 0..1

Type: BackboneElement

Mappings: rim=.playingEntity [classCode=PLC determinerCode=INSTANCE].positionText

Location.position.longitude

Longitude with WGS84 datum

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

Cardinality: 1..1

Type: decimal

Mappings: rim=(RIM Opted not to map the sub-elements of GPS location, is now an OBS)

Location.position.latitude

Latitude with WGS84 datum

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

Cardinality: 1..1

Type: decimal

Mappings: rim=(RIM Opted not to map the sub-elements of GPS location, is now an OBS)

Location.position.altitude

Altitude with WGS84 datum

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

Cardinality: 0..1

Type: decimal

Mappings: rim=(RIM Opted not to map the sub-elements of GPS location, is now an OBS)

Location.managingOrganization

Organization responsible for provisioning and upkeep

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

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.

Requirements: Need to know who manages the location.

Cardinality: 0..1

Type: Reference(Organization)

Summary: true

Mappings: rim=.scopingEntity[classCode=ORG determinerKind=INSTANCE]

Location.partOf

Another Location this one is physically a part of

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

Requirements: For purposes of location, display and identification, knowing which locations are located within other locations is important.

Cardinality: 0..1

Type: Reference(Location)

Mappings: rim=.inboundLink[typeCode=PART].source[classCode=SDLOC]

Location.characteristic

Collection of characteristics (attributes)

Definition: Collection of characteristics (attributes).

Comments: These could be such things as is wheelchair accessible.

Cardinality: 0..*

Type: CodeableConcept

Binding: example:location-characteristic

Mappings: rim=.actrelationship[typeCode=PERT].observation

Location.hoursOfOperation

What days/times during a week is this location usually open (including exceptions)

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

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.

Cardinality: 0..1

Type: Availability

Mappings: rim=.effectiveTime

Location.virtualService

Connection details of a virtual service (e.g. conference call)

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

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.

Cardinality: 0..*

Type: VirtualServiceDetail

Mappings: rim=N/A

Location.endpoint

Technical endpoints providing access to services operated for the location

Definition: Technical endpoints providing access to services operated for the location.

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.

Cardinality: 0..*

Type: Reference(Endpoint)

Mappings: rim=n/a