DSTU2 STU 3 Candidate
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R5 R4B R4 R3 R2

5.15 5.17 Resource Location - Content Resource Location - Content

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.
Patient Administration Patient Administration Work Group Work Group Maturity Level : 1 Maturity Level : 1 Compartments : Not linked to any defined compartments : Not linked to any defined compartments

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

5.15.1 Scope and Usage 5.17.1 Scope and Usage A Location includes both incidental locations (a place which is used for healthcare without prior designation or authorization) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages. Examples of Locations are: Building, ward, corridor, room or bed Mobile Clinic Freezer, incubator Vehicle or lift Home, shed, or a garage Road, parking place, a park Ambulance (generic) Ambulance (specific) Patient's Home (generic)

A Location includes both incidental locations (a place which is used for healthcare without prior designation or authorization) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages.

Examples of Locations are:

  • Building, ward, corridor, room or bed
  • Mobile Clinic
  • Freezer, incubator
  • Vehicle or lift
  • Home, shed, or a garage
  • Road, parking place, a park
  • Ambulance (generic)
  • Ambulance (specific)
  • Patient's Home (generic)
  • Jurisdiction These locations are not intended to cover locations on a patient where something occurred (i.e. a patient's broken leg), but can hapily cover the location where the patient broke the leg (the playground)

These locations are not intended to cover locations on a patient where something occurred (i.e. a patient's broken leg), but can hapily cover the location where the patient broke the leg (the playground)

5.15.2 Boundaries and Relationships 5.17.2 Boundaries and Relationships Locations and Organizations are very closely related resources and can often be mixed/matched/confused. The Location is intended to describe the more physical structures managed/operated by an organization, whereas the Organization is intended to represent the more conceptual hierarchies, such as a ward. A Location is valid without an address in cases where it could be purely described by a geo-coded location in remote areas, or when recorded by a device. Locations with a mode = "kind" would also likely not have an address, as they are just a type of location, but could also have an address where they can be found at the address. Another use of location could be for describing a Jurisdiction. This jurisdiction may be considered a classified boundary which could be a combination of a physical boundary, and some other discriminator(s): Nation - Country wide community or Federal Government (Ministry of Health) Province or State (community or Government) Business (throughout an enterprise) Business scope (CDC/FDA) Business segment (UK Pharmacy) This resource is referenced by

Locations and Organizations are very closely related resources and can often be mixed/matched/confused.
The Location is intended to describe the more physical structures managed/operated by an organization, whereas the Organization is intended to represent the more conceptual hierarchies, such as a ward.

A Location is valid without an address in cases where it could be purely described by a geo-coded location in remote areas, or when recorded by a device. Locations with a mode = "kind" would also likely not have an address, as they are just a type of location, but could also have an address where they can be found at the address.

Another use of location could be for describing a Jurisdiction. This jurisdiction may be considered a classified boundary which could be a combination of a physical boundary, and some other discriminator(s):

  • Nation - Country wide community or Federal Government (Ministry of Health)
  • Province or State (community or Government)
  • Business (throughout an enterprise)
  • Business scope (CDC/FDA)
  • Business segment (UK Pharmacy)

This resource is referenced by Account , , Appointment , , AppointmentResponse , , AuditEvent , , CarePlan , , Claim , , Contract , , Device , , DiagnosticOrder , , DiagnosticReport , , EligibilityRequest , Encounter , , ExplanationOfBenefit , Flag , , HealthcareService , , Immunization , , List , , MedicationDispense , , Observation , , Practitioner , , PractitionerRole , Procedure , , Protocol , Provenance , , Schedule and and SupplyDelivery

5.15.3 Resource Content 5.17.3 Resource Content

Structure

Name Flags Card. Type Description & Constraints Description & Constraints doco
. . Location DomainResource Details and position information for a physical place Details and position information for a physical place
. . . identifier Σ 0..* Identifier Unique code or number identifying the location to its users Unique code or number identifying the location to its users
. . . status ?! ?! Σ 0..1 code active | suspended | inactive active | suspended | inactive
LocationStatus ( ( Required )
. . . name Σ 0..1 string Name of the location as used by humans Name of the location as used by humans
. . . description Σ 0..1 string Description of the location Additional details about the location that could be displayed as further information to identify the location beyond its name
. . . mode ?! ?! Σ 0..1 code instance | kind instance | kind
LocationMode ( ( Required )
. . . type Σ 0..1 CodeableConcept Type of function performed Type of function performed
ServiceDeliveryLocationRoleType ( ( Extensible )
. . . telecom 0..* ContactPoint Contact details of the location Contact details of the location
. . . address 0..1 Address Physical location Physical location
. . . physicalType Σ 0..1 CodeableConcept Physical form of the location Physical form of the location
LocationType ( ( Example )
. . . position 0..1 BackboneElement The absolute geographic location The absolute geographic location
. . . . longitude 1..1 decimal Longitude with WGS84 datum Longitude with WGS84 datum
. . . . latitude 1..1 decimal Latitude with WGS84 datum Latitude with WGS84 datum
. . . . altitude 0..1 decimal Altitude with WGS84 datum Altitude with WGS84 datum
. . . managingOrganization Σ 0..1 Reference ( Organization ) Organization responsible for provisioning and upkeep Organization responsible for provisioning and upkeep
. . . partOf 0..1 Reference ( Location ) Another Location this one is physically part of Another Location this one is physically part of

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram

Location ( ( DomainResource ) Unique code or number identifying the location to its users Unique code or number identifying the location to its users identifier : : Identifier [0..*] [0..*] active | suspended | inactive (this element modifies the meaning of other elements) active | suspended | inactive (this element modifies the meaning of other elements) status : : code [0..1] « [0..1] « Indicates whether the location is still in use. (Strength=Required) Indicates whether the location is still in use. (Strength=Required) LocationStatus ! » ! » Name of the location as used by humans. Does not need to be unique Name of the location as used by humans. Does not need to be unique name : : string [0..1] [0..1] Description of the Location, which helps in finding or referencing the place Description of the Location, which helps in finding or referencing the place description : : string [0..1] [0..1] Indicates whether a resource instance represents a specific location or a class of locations (this element modifies the meaning of other elements) Indicates whether a resource instance represents a specific location or a class of locations (this element modifies the meaning of other elements) mode : : code [0..1] « [0..1] « Indicates whether a resource instance represents a specific location or a class of locations. (Strength=Required) Indicates whether a resource instance represents a specific location or a class of locations. (Strength=Required) LocationMode ! » ! » Indicates the type of function performed at the location Indicates the type of function performed at the location type : : CodeableConcept [0..1] « [0..1] « Indicates the type of function performed at the location. (Strength=Extensible) Indicates the type of function performed at the location. (Strength=Extensible) ServiceDeliveryLocationRoleTy... + » + » The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites telecom : : ContactPoint [0..*] [0..*] Physical location Physical location address : : Address [0..1] [0..1] Physical form of the location, e.g. building, room, vehicle, road Physical form of the location, e.g. building, room, vehicle, road physicalType : : CodeableConcept [0..1] « [0..1] « Physical form of the location (Strength=Example) Physical form of the location (Strength=Example) LocationType ?? » ?? » The organization responsible for the provisioning and upkeep of the location The organization responsible for the provisioning and upkeep of the location managingOrganization : : Reference [0..1] « [0..1] « Organization » » Another Location which this Location is physically part of Another Location which this Location is physically part of partOf : : Reference [0..1] « [0..1] « Location » » Position Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below) Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below) longitude : : decimal [1..1] [1..1] Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below) Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below) latitude : : decimal [1..1] [1..1] Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below) Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below) altitude : : decimal [0..1] [0..1] The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML) The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML) position [0..1]

XML Template XML Template

Structure

Name Flags Card. Type Description & Constraints Description & Constraints doco
. . Location DomainResource Details and position information for a physical place Details and position information for a physical place
. . . identifier Σ 0..* Identifier Unique code or number identifying the location to its users Unique code or number identifying the location to its users
. . . status ?! ?! Σ 0..1 code active | suspended | inactive active | suspended | inactive
LocationStatus ( ( Required )
. . . name Σ 0..1 string Name of the location as used by humans Name of the location as used by humans
. . . description Σ 0..1 string Description of the location Additional details about the location that could be displayed as further information to identify the location beyond its name
. . . mode ?! ?! Σ 0..1 code instance | kind instance | kind
LocationMode ( ( Required )
. . . type Σ 0..1 CodeableConcept Type of function performed Type of function performed
ServiceDeliveryLocationRoleType ( ( Extensible )
. . . telecom 0..* ContactPoint Contact details of the location Contact details of the location
. . . address 0..1 Address Physical location Physical location
. . . physicalType Σ 0..1 CodeableConcept Physical form of the location Physical form of the location
LocationType ( ( Example )
. . . position 0..1 BackboneElement The absolute geographic location The absolute geographic location
. . . . longitude 1..1 decimal Longitude with WGS84 datum Longitude with WGS84 datum
. . . . latitude 1..1 decimal Latitude with WGS84 datum Latitude with WGS84 datum
. . . . altitude 0..1 decimal Altitude with WGS84 datum Altitude with WGS84 datum
. . . managingOrganization Σ 0..1 Reference ( Organization ) Organization responsible for provisioning and upkeep Organization responsible for provisioning and upkeep
. . . partOf 0..1 Reference ( Location ) Another Location this one is physically part of Another Location this one is physically part of

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram

Location ( ( DomainResource ) Unique code or number identifying the location to its users Unique code or number identifying the location to its users identifier : : Identifier [0..*] [0..*] active | suspended | inactive (this element modifies the meaning of other elements) active | suspended | inactive (this element modifies the meaning of other elements) status : : code [0..1] « [0..1] « Indicates whether the location is still in use. (Strength=Required) Indicates whether the location is still in use. (Strength=Required) LocationStatus ! » ! » Name of the location as used by humans. Does not need to be unique Name of the location as used by humans. Does not need to be unique name : : string [0..1] [0..1] Description of the Location, which helps in finding or referencing the place Description of the Location, which helps in finding or referencing the place description : : string [0..1] [0..1] Indicates whether a resource instance represents a specific location or a class of locations (this element modifies the meaning of other elements) Indicates whether a resource instance represents a specific location or a class of locations (this element modifies the meaning of other elements) mode : : code [0..1] « [0..1] « Indicates whether a resource instance represents a specific location or a class of locations. (Strength=Required) Indicates whether a resource instance represents a specific location or a class of locations. (Strength=Required) LocationMode ! » ! » Indicates the type of function performed at the location Indicates the type of function performed at the location type : : CodeableConcept [0..1] « [0..1] « Indicates the type of function performed at the location. (Strength=Extensible) Indicates the type of function performed at the location. (Strength=Extensible) ServiceDeliveryLocationRoleTy... + » + » The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites telecom : : ContactPoint [0..*] [0..*] Physical location Physical location address : : Address [0..1] [0..1] Physical form of the location, e.g. building, room, vehicle, road Physical form of the location, e.g. building, room, vehicle, road physicalType : : CodeableConcept [0..1] « [0..1] « Physical form of the location (Strength=Example) Physical form of the location (Strength=Example) LocationType ?? » ?? » The organization responsible for the provisioning and upkeep of the location The organization responsible for the provisioning and upkeep of the location managingOrganization : : Reference [0..1] « [0..1] « Organization » » Another Location which this Location is physically part of Another Location which this Location is physically part of partOf : : Reference [0..1] « [0..1] « Location » » Position Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below) Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below) longitude : : decimal [1..1] [1..1] Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below) Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below) latitude : : decimal [1..1] [1..1] Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below) Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below) altitude : : decimal [0..1] [0..1] The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML) The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML) position [0..1]

XML Template XML Template

  Alternate definitions:

Alternate definitions: Schema / Schematron , Resource Profile ( , Resource Profile ( XML , , JSON ), ), Questionnaire

5.15.3.1 Terminology Bindings 5.17.3.1 Terminology Bindings

Path Definition Type Reference
Location.status Location.status Indicates whether the location is still in use. Indicates whether the location is still in use. Required LocationStatus
Location.mode Location.mode Indicates whether a resource instance represents a specific location or a class of locations. Indicates whether a resource instance represents a specific location or a class of locations. Required LocationMode
Location.type Location.type Indicates the type of function performed at the location. Indicates the type of function performed at the location. Extensible ServiceDeliveryLocationRoleType
Location.physicalType Location.physicalType Physical form of the location Physical form of the location Example LocationType

5.15.4 Notes 5.17.4 Notes Multiple Organizations or Practitioners may provide services at a Location. These references are not kept in Location, but can be found in the models for

5.15.4.1 5.17.4.1 Location Mode Location Mode The Location.mode element can be used to indicate whether a Location resource represents a specific (potentially identifiable) Location ('instance'), or a class of Locations ('kind'). Especially Resources capturing orders, resource scheduling, plans and definitions may refer to Locations in 'kind' mode. For these domains, it is often not necessary to refer to a specific Location, but rather to a class of Locations. An example of this is found in planning, where we need to allocate an "isolation room" for a patient, or need to dispatch "an ambulance" at a certain time. In these cases it is not important exactly which isolation room or ambulance is allocated, and it is sufficient to just indicate a 'kind' of Location. Note that 'kind' should not be used to represent Locations where an actual instance of a Location was involved, but identifying information is missing. E.g. when a patient arrived 'by ambulance', but it is not known by which ambulance, this should be represented using a Location in 'instance' mode with a missing identifier, not a Location of 'kind' ambulance. Some of Location's data elements are only relevant when mode is 'instance' and should not be used when mode is 'kind': (however this information could still be included if was relevant, such as when it is a generic item, but not globally generic, e.g. a Burgers MU ambulance)

The Location.mode element can be used to indicate whether a Location resource represents a specific (potentially identifiable) Location ('instance'), or a class of Locations ('kind'). Especially Resources capturing orders, resource scheduling, plans and definitions may refer to Locations in 'kind' mode. For these domains, it is often not necessary to refer to a specific Location, but rather to a class of Locations. An example of this is found in planning, where we need to allocate an "isolation room" for a patient, or need to dispatch "an ambulance" at a certain time. In these cases it is not important exactly which isolation room or ambulance is allocated, and it is sufficient to just indicate a 'kind' of Location.

Note that 'kind' should not be used to represent Locations where an actual instance of a Location was involved, but identifying information is missing. E.g. when a patient arrived 'by ambulance', but it is not known by which ambulance, this should be represented using a Location in 'instance' mode with a missing identifier, not a Location of 'kind' ambulance.

Some of Location's data elements are only relevant when mode is 'instance' and should not be used when mode is 'kind':
(however this information could still be included if was relevant, such as when it is a generic item, but not globally generic, e.g. a Burgers MU ambulance)

  • Location.identifier
  • Location.telecom
  • Location.address
  • Location.position
  • Location.status
  • Location.managingOrganization

5.15.5 Example Location Hierarchy 5.17.5 Example Location Hierarchy An example location hierarchy should help give some guidance as to one example of how a location hierarchy could look within a fictitious Hospital. (The nesting here would be the "part-of" structure of the location)

An example location hierarchy should help give some guidance as to one example of how a location hierarchy could look within a fictitious Hospital.
(The nesting here would be the "part-of" structure of the location)

Hospital A Building C (instance)
    East Wing (instance)
        Level 1 (instance)
            Reception (instance)
            Nurses Station EM-ns1 (instance)
                Medication Cupboard A (instance)
            Room 1 (instance)
                Room 1a (instance) - space in room separatable via a curtain
                    Bed 1a (instance) - always in this room
                Room 1b (instance)
                    Trolley 43 (instance) - moves about
                Room 1d (instance)
                    Trolley 19 (instance) - moves about
                Room 2 (instance)
                    ...
            Theatre EM-TA (instance)
            Coridor (generic)
        Level 2 (instance)
            Reception (instance)
                ...
            Nurses Station EM-ns1 (instance)
                Medication Cupboard A (instance)
            Coridor (generic)
Mobile Services (kind)
    Ambulance (kind)
        Ambulance AMB1 (instance)
        Ambulance AMB2 (instance)
Note:
Wards/departments
are
not
part
of
this
structure
-
these
would
form
part
of
the
Organizational
Hierarchy.

Note: Wards/departments are not part of this structure - these would form part of the Organizational Hierarchy.

5.15.6 Search Parameters 5.17.6 Search Parameters Search parameters for this resource. The common parameters also apply. See

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services. for more information about searching in REST, messaging, and services.

© HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:43+1100. Links: Search
Name Type Description Paths
address string A (part of the) address of the location A (part of the) address of the location Location.address
address-city string A city specified in an address A city specified in an address Location.address.city
address-country string A country specified in an address A country specified in an address Location.address.country
address-postalcode string A postal code specified in an address A postal code specified in an address Location.address.postalCode
address-state string A state specified in an address A state specified in an address Location.address.state
address-use token A use code specified in an address A use code specified in an address Location.address.use
identifier token Unique code or number identifying the location to its users Unique code or number identifying the location to its users Location.identifier
name string A (portion of the) name of the location A (portion of the) name of the location Location.name
near token The coordinates expressed as [lat],[long] (using the WGS84 datum, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency) The coordinates expressed as [lat],[long] (using the WGS84 datum, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency) Location.position
near-distance token A distance quantity to limit the near search to locations within a specific distance A distance quantity to limit the near search to locations within a specific distance Location.position
organization reference Searches for locations that are managed by the provided organization Searches for locations that are managed by the provided organization Location.managingOrganization
( Organization )
partof reference The location of which this location is a part The location of which this location is a part Location.partOf
( Location )
status token Searches for locations with a specific kind of status Searches for locations with a specific kind of status Location.status
type token A code for the type of location A code for the type of location Location.type