The Location resource implements the FHIR R4 Location specification and US Core v3.1.1 Location profile
Fields
| Name | Type | Cardinality | Required | Description |
|---|---|---|---|---|
| identifier | Identifier | 0..* | Unique code or number identifying the location to its users | |
| status | code | 0..1 | active | suspended | inactive | |
| operationalStatus | Coding | 0..1 | The Operational status of the location (typically only for a bed/room) | |
| name | string | 1..1 | * | Name of the location as used by humans |
| alias | string | 0..* | A list of alternate names that the location is known as, or was known as in the past | |
| description | string | 0..1 | Additional details about the location that could be displayed as further information to identify the location beyond its name | |
| mode | code | 0..1 | instance | kind | |
| type | CodeableConcept | 0..* | Type of function performed | |
| telecom | ContactPoint | 0..* | Contact details of the location | |
| address | Address | 0..1 | Physical location | |
| address.line | string | 0..* | Street name, number, direction & P.O. Box etc. | |
| address.city | string | 0..1 | Name of city, town etc. | |
| address.state | string | 0..1 | Sub-unit of country (abbreviations ok) - Binding | |
| address.postalCode | string | 0..1 | US Zip Codes | |
| physicalType | CodeableConcept | 0..1 | Physical form of the location | |
| position | BackboneElement | 0..1 | The absolute geographic location | |
| managingOrganization | Reference(US Core Organization Profile) | 0..1 | Organization responsible for provisioning and upkeep | |
| partOf | Reference | 0..1 | Another Location this one is physically part of | |
| hoursOfOperation | BackboneElement | 0..* | What days/times during a week is this location usually open | |
| availabilityExceptions | string | 0..1 | Description of availability exceptions | |
| endpoint | Reference | 0..* | Technical endpoints providing access to services operated for the location |
Interactions
Read
Get an Location entry by id
GET /Location/:id
Search
Query Location resources
GET /Location?:query_parameters
Parameters
| Name | Type | Description |
|---|---|---|
| address | string | A (part of the) address of the location |
| identifier | token | An identifier for the location |
| name | string | A portion of the location’s name or alias |
| organization | reference | Searches for locations that are managed by the provided organization |
| partof | reference | A location of which this location is a part |
| status | token | Searches for locations with a specific kind of status |
| type | token | A code for the type of location |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |