Location resource implementation guidance
Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully develop applications using the FHIR® CDS API.
Location: Implementation Guidance
Usage
Within the Clinical Decision Support API implementation, the Location resource will be used to carry the current location of a patient when calling $check-services
.
The table below gives implementation guidance in relation to the elements within a Location
:
Name | Cardinality | Type | FHIR Documentation | CDS Implementation Guidance |
---|---|---|---|---|
id |
0..1 |
id | Logical id of this artifact | Note that this will always be populated except when the resource is being created (initial creation call) |
meta |
0..1 |
Meta | Metadata about the resource | |
implicitRules |
0..1 |
uri | A set of rules under which this content was created | |
language |
0..1 |
code | Language of the resource content. Common Languages (Extensible but limited to All Languages) |
|
text |
0..1 |
Narrative | Text summary of the resource, for human interpretation | |
contained |
0..* |
Resource | Contained, inline Resources | This SHOULD NOT be populated |
extension |
0..* |
Extension | Additional Content defined by implementations | |
modifierExtension |
0..* |
Extension | Extensions that cannot be ignored | |
idenfitier |
0..* |
Identifier | Unique code or number identifying the location to its users | |
status |
0..1 |
code | active | suspended | inactive LocationStatus (Required) |
|
operationalStatus |
0..1 |
Coding | The Operational status of the location (typically only for a bed/room) v2 Bed Status (Preferred) |
|
name |
0..1 |
string | Unique code or number identifying the location to its users | |
alias |
0..* |
string | A list of alternate names that the location is known as, or was known as in the past | |
description |
0..1 |
string | 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 LocationMode (Required) |
|
type |
0..1 |
CodeableConcept | Type of function performed ServiceDeliveryLocationRoleType (Extensible) |
|
telecom |
0..* |
ContactPoint | Contact details of the location | |
address |
0..1 |
Address | Physical location | This MUST be populated if position is not. Where populated address.postcode MUST be populated |
physicalType |
0..1 |
CodeableConcept | Physical form of the location LocationType (Example) |
|
position |
0..1 |
BackboneElement | The absolute geographic location | This MUST be populated if address.postcode is not |
longitude |
1..1 |
decimal | Longitude with WGS84 datum | |
latitude |
1..1 |
decimal | Latitude with WGS84 datum | |
altitude |
0..1 |
decimal | Altitude with WGS84 datum | |
managingOrganization |
0..1 |
Reference(Organization) | Organization responsible for provisioning and upkeep | |
partOf |
0..1 |
Reference(Location) | Another Location this one is physically part of | |
endpoint |
0..* |
Reference(Endpoint) | Technical endpoints providing access to services operated for the location | This SHOULD NOT be populated. |