Location
Overview
The Location resource describes physical places where healthcare services are provided. In Millennium, facilities are the top level of the patient location hierarchy. A facility is also an Organization resource at which patient locations are associated. All facilities are organizations, but not all organizations are facilities. A location can also be an ambulatory patient care area like a clinic or an emergency room. The location hierarchy from highest to lowest is facility, building, nursing unit, room, and bed.
-
The following HL7® FHIR® US Core Implementation Guide STU 4.0.0 Profiles are supported by this resource:
The following fields are returned if valued:
- Location id
- Status
- Name
- Alias
- Identifier
- Mode
- Telecom
- Address
- Physical Type
- Managing Organization
- Part Of
- Extensions including custom attribute
Terminology Bindings
Location.identifier.type |
|
Location.physicalType |
|
Location.extension[x].extension[x].valueCodeableConcept |
|
Location.status |
|
Location.mode |
|
Location.telecom |
|
Location.type |
|
Location.use |
|
Extensions
Custom Extensions
All URLs for custom extensions are defined as https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}
ID | Value[x] Type | Description |
---|---|---|
custom-attribute |
None (contains nested extensions) | A client defined custom attribute for the resource. Attribute values can be of type integer , string , or CodeableConcept . |
Search
Search for Locations that meet supplied query parameters:
GET /Location?:parameters
Authorization Types
Parameters
Name | Required? | Type | Description |
---|---|---|---|
_id |
This or -physicalType
|
token |
The logical resource id associated with the resource. |
-physicalType |
This or _id
|
token |
The location’s physical type. Example: http://terminology.hl7.org/CodeSystem/location-physical-type|ro
|
identifier |
no | token |
The location’s identifier. Example: 653385|FSI^~BUILD^~NU
|
_count |
no | number |
The maximum number of results to return. Defaults to 100 . |
address |
no | string |
A (part of the) address of the location. |
address-city |
no | string |
A city specified in an address |
address-state |
no | string |
A state specified in an address |
address-postalcode |
no | string |
A postal code specified in an address |
name |
no | string |
A portion of the location’s name or alias |
organization |
no | reference |
Searches for locations that are managed by the provided organization |
Notes:
- The
-physicalType
parameter- Searching by Millennium proprietary codes is not supported.
- The
-address-city
parameter- needs address-state or address-postalcode while searching with address-city
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?_id=21250409
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "902e1b49-b9c4-4786-b90b-c9612d478f2a",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?_id=21250409"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location/21250409",
"resource": {
"resourceType": "Location",
"id": "21250409",
"meta": {
"versionId": "6",
"lastUpdated": "2018-06-12T18:45:00Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Location</b></p><p><b>Name</b>: BE 1 North</p><p><b>Alias</b>: BE 1N</p><p><b>Managing Organization</b>: Baseline East Medical Center</p><p><b>Part Of</b>: 21250403</p><p><b>Physical Type</b>: Facility(s)</p><p><b>Status</b>: Active</p></div>"
},
"extension": [
{
"extension": [
{
"id": "20356268",
"valueString": "Core Measure Locations",
"url": "custom-attribute-name"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4678015",
"code": "20140683",
"display": "ED",
"userSelected": true
}
],
"text": "ED"
},
"url": "custom-attribute-value"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute"
}
],
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/73",
"code": "ACCTRECEIVABLE",
"display": "FIN NBR",
"userSelected": true
}
]
},
"system": "FIN NBR",
"value": "16000"
}
],
"status": "active",
"name": "BE 1 North",
"alias": [
"BE 1N"
],
"mode": "instance",
"address": {
"text": "Cerner H2 building\nLevel 4\nManyata embassy business park\nNagawara cicle\nBangalore, AA \nIreland",
"line": [
"Cerner H2 building",
"Level 4",
"Manyata embassy business park",
"Nagawara cicle"
],
"city": "Bangalore",
"district": "Indian River",
"state": "AA",
"country": "Ireland"
},
"physicalType": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/222",
"code": "783",
"display": "Facility(s)",
"userSelected": true
}
],
"text": "Facility(s)"
},
"managingOrganization": {
"reference": "Organization/13971625",
"display": "Baseline East Medical Center"
},
"partOf": {
"reference": "Location/21250403"
}
}
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Example with identifier
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?identifier=653385|FSI^~BUILD^~NU
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "902e1b49-b9c4-4786-b90b-c9612d478f2a",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?_id=21250409"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location/21250409",
"resource": {
"resourceType": "Location",
"id": "21250409",
"meta": {
"versionId": "6",
"lastUpdated": "2018-06-12T18:45:00Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Location</b></p><p><b>Name</b>: BE 1 North</p><p><b>Alias</b>: BE 1N</p><p><b>Managing Organization</b>: Baseline East Medical Center</p><p><b>Part Of</b>: 21250403</p><p><b>Physical Type</b>: Facility(s)</p><p><b>Status</b>: Active</p></div>"
},
"extension": [
{
"extension": [
{
"id": "20356268",
"valueString": "Core Measure Locations",
"url": "custom-attribute-name"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4678015",
"code": "20140683",
"display": "ED",
"userSelected": true
}
],
"text": "ED"
},
"url": "custom-attribute-value"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute"
}
],
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/73",
"code": "ACCTRECEIVABLE",
"display": "FIN NBR",
"userSelected": true
}
]
},
"system": "FIN NBR",
"value": "16000"
}
],
"status": "active",
"name": "BE 1 North",
"alias": [
"BE 1N"
],
"mode": "instance",
"address": {
"text": "Cerner H2 building\nLevel 4\nManyata embassy business park\nNagawara cicle\nBangalore, AA \nIreland",
"line": [
"Cerner H2 building",
"Level 4",
"Manyata embassy business park",
"Nagawara cicle"
],
"city": "Bangalore",
"district": "Indian River",
"state": "AA",
"country": "Ireland"
},
"physicalType": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/222",
"code": "783",
"display": "Facility(s)",
"userSelected": true
}
],
"text": "Facility(s)"
},
"managingOrganization": {
"reference": "Organization/13971625",
"display": "Baseline East Medical Center"
},
"partOf": {
"reference": "Location/21250403"
}
}
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Example with address
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address=PA
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "f4749f7a-e67d-49d1-8b92-ddbef46eae15",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address=PA"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address=PA",
"resource": {
"resourceType": "Location",
"id": "982243103",
"meta": {
"versionId": "0",
"lastUpdated": "2019-03-29T14:40:50Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Location</b></p><p><b>Name</b>: Anushka Org One</p><p><b>Alias</b>: ADOne</p><p><b>Managing Organization</b>: Anushka Org One</p><p><b>Physical Type</b>: Facility(s)</p><p><b>Status</b>: Active</p></div>"
},
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/73",
"code": "ACCTRECEIVABLE",
"display": "FIN NBR",
"userSelected": true
}
]
},
"system": "FIN NBR",
"value": "16000"
}
],
"status": "active",
"name": "Anushka Org One",
"alias": [
"ADOne"
],
"mode": "instance",
"address": {
"use": "work",
"text": "111th West st\nMalvern, PA 19355\nUSA",
"line": [
"111th West st"
],
"city": "Malvern",
"state": "PA",
"postalCode": "19355",
"country": "USA"
},
"physicalType": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/222",
"code": "783",
"display": "Facility(s)",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
"code": "si",
"display": "Site"
}
],
"text": "Facility(s)"
},
"managingOrganization": {
"reference": "Organization/28096355",
"display": "Anushka Org One"
}
}
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Example address-city with address-state
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address-state=PA&address-city=Malvern
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "418d018e-ef93-43a0-b880-4888218ed3c6",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address-state=PA&address-city=Malvern"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address-state=PA&address-city=Malvern",
"resource": {
"resourceType": "Location",
"id": "982243103",
"meta": {
"versionId": "0",
"lastUpdated": "2019-03-29T14:40:50Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Location</b></p><p><b>Name</b>: Anushka Org One</p><p><b>Alias</b>: ADOne</p><p><b>Managing Organization</b>: Anushka Org One</p><p><b>Physical Type</b>: Facility(s)</p><p><b>Status</b>: Active</p></div>"
},
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/73",
"code": "ACCTRECEIVABLE",
"display": "FIN NBR",
"userSelected": true
}
]
},
"system": "FIN NBR",
"value": "16000"
}
],
"status": "active",
"name": "Anushka Org One",
"alias": [
"ADOne"
],
"mode": "instance",
"address": {
"use": "work",
"text": "111th West st\nMalvern, PA 19355\nUSA",
"line": [
"111th West st"
],
"city": "Malvern",
"state": "PA",
"postalCode": "19355",
"country": "USA"
},
"physicalType": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/222",
"code": "783",
"display": "Facility(s)",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
"code": "si",
"display": "Site"
}
],
"text": "Facility(s)"
},
"managingOrganization": {
"reference": "Organization/28096355",
"display": "Anushka Org One"
}
}
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Example with name
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address=kansas&name=ABC
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "af79f094-3b5e-4472-86bf-4044aeb4193c",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address=kansas&name=ABC"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location/2554914033",
"resource": {
"resourceType": "Location",
"id": "2554914033",
"meta": {
"versionId": "0",
"lastUpdated": "2017-09-19T17:38:08Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Location</b></p> <p><b>Name</b>: ABC Taxi Company</p><p><b>Alias</b>: ABC Taxi</p><p><b>Managing Organization</b>: ABC Taxi Company</p> <p><b>Physical Type</b>: Facility(s)</p><p><b>Status</b>: Active</p></div>"
},
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/73",
"code": "ACCTRECEIVABLE",
"display": "FIN NBR",
"userSelected": true
}
]
},
"system": "FIN NBR",
"value": "16000"
}
],
"status": "active",
"name": "ABC Taxi Company",
"alias": [
"ABC Taxi"
],
"mode": "instance",
"telecom": [
{
"system": "phone",
"value": "8168769999"
}
],
"address": {
"use": "work",
"text": "123 Main Street\nKansas City, MO 64117\nUS",
"line": [
"123 Main Street"
],
"city": "Kansas City",
"state": "MO",
"postalCode": "64117",
"country": "US"
},
"physicalType": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/222",
"code": "783",
"display": "Facility(s)",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
"code": "si",
"display": "Site"
}
],
"text": "Facility(s)"
},
"managingOrganization": {
"reference": "Organization/3054032",
"display": "ABC Taxi Company"
}
}
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Example with organization
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address=kansas&organization=3054032
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "a05b2157-824e-4908-b94e-f4617d6ab95e",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?address=kansas&organization=3054032"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location/2554914033",
"resource": {
"resourceType": "Location",
"id": "2554914033",
"meta": {
"versionId": "0",
"lastUpdated": "2017-09-19T17:38:08Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Location</b></p><p><b>Name</b>: ABC Taxi Company</p><p><b>Alias</b>: ABC Taxi</p><p><b>Managing Organization</b>: ABC Taxi Company</p><p><b>Physical Type</b>: Facility(s)</p><p><b>Status</b>: Active</p></div>"
},
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/73",
"code": "ACCTRECEIVABLE",
"display": "FIN NBR",
"userSelected": true
}
]
},
"system": "FIN NBR",
"value": "16000"
}
],
"status": "active",
"name": "ABC Taxi Company",
"alias": [
"ABC Taxi"
],
"mode": "instance",
"telecom": [
{
"system": "phone",
"value": "8168769999"
}
],
"address": {
"use": "work",
"text": "123 Main Street\nKansas City, MO 64117\nUS",
"line": [
"123 Main Street"
],
"city": "Kansas City",
"state": "MO",
"postalCode": "64117",
"country": "US"
},
"physicalType": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/222",
"code": "783",
"display": "Facility(s)",
"userSelected": true
},
{
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
"code": "si",
"display": "Site"
}
],
"text": "Facility(s)"
},
"managingOrganization": {
"reference": "Organization/3054032",
"display": "ABC Taxi Company"
}
}
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Retrieve by id
List an individual Location by its id:
GET /Location/:id
Authorization Types
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location/21250409
Response
Status: 200 OK
{
"resourceType": "Location",
"id": "21250409",
"meta": {
"versionId": "6",
"lastUpdated": "2018-06-12T18:45:00Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Location</b></p><p><b>Name</b>: BE 1 North</p><p><b>Alias</b>: BE 1N</p><p><b>Managing Organization</b>: Baseline East Medical Center</p><p><b>Part Of</b>: 21250403</p><p><b>Physical Type</b>: Facility(s)</p><p><b>Status</b>: Active</p></div>"
},
"extension": [
{
"extension": [
{
"id": "20356268",
"valueString": "Core Measure Locations",
"url": "custom-attribute-name"
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4678015",
"code": "20140683",
"display": "ED",
"userSelected": true
}
],
"text": "ED"
},
"url": "custom-attribute-value"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute"
}
],
"identifier": [
{
"use": "official",
"type": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/73",
"code": "ACCTRECEIVABLE",
"display": "FIN NBR",
"userSelected": true
}
]
},
"system": "FIN NBR",
"value": "16000"
}
],
"status": "active",
"name": "BE 1 North",
"alias": [
"BE 1N"
],
"mode": "instance",
"address": {
"text": "Cerner H2 building\nLevel 4\nManyata embassy business park\nNagawara cicle\nBangalore, AA \nIreland",
"line": [
"Cerner H2 building",
"Level 4",
"Manyata embassy business park",
"Nagawara cicle"
],
"city": "Bangalore",
"district": "Indian River",
"state": "AA",
"country": "Ireland"
},
"physicalType": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/222",
"code": "783",
"display": "Facility(s)",
"userSelected": true
}
],
"text": "Facility(s)"
},
"managingOrganization": {
"reference": "Organization/13971625",
"display": "Baseline East Medical Center"
},
"partOf": {
"reference": "Location/21250403"
}
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.