Location - FHIR Resource (r4)
This Location Resource uses the FHIR API standard for access and structure.
Validate an Location FHIR Resource (r4)
Location Attributes
AttributeField is listTypeDescription
Description: Unique code or number identifying the location to its users
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"value": "B1-S.F2"
}
]Learn more about the (Location) identifier FHIR attribute
Description: active | suspended | inactive
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (Location) status FHIR attribute
Description: The operational status of the location (typically only for a bed/room)
FHIR Version: r4
Attribute Type : Coding
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"operationalStatus": Learn more about the (Location) operationalStatus FHIR attribute
Description: Name of the location as used by humans
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": "South Wing, second floor"Learn more about the (Location) name FHIR attribute
Description: A list of alternate names that the location is known as, or was known as, in the past
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"alias": [
"BU MC, SW, F2",
"Burgers University Medical Center, South Wing, second floor"
]Learn more about the (Location) alias FHIR attribute
Description: Additional details about the location that could be displayed as further information to identify the location beyond its name
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": "Second floor of the Old South Wing, formerly in use by Psychiatry"Learn more about the (Location) description FHIR attribute
Description: instance | kind
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"mode": "instance"Learn more about the (Location) mode FHIR attribute
Description: Type of function performed
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (Location) type FHIR attribute
Description: Contact details of the location
FHIR Version: r4
Attribute Type : ContactPoint
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"telecom": [
{
"system": "phone",
"value": "2328",
"use": "work"
},
{
"system": "fax",
"value": "2329",
"use": "work"
},
{
"system": "email",
"value": "second wing admissions"
},
{
"system": "url",
"value": "http://sampleorg.com/southwing",
"use": "work"
}
]Learn more about the (Location) telecom FHIR attribute
Description: Physical location
FHIR Version: r4
Attribute Type : Address
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"address": {
"use": "work",
"line": [
"Galapagosweg 91, Building A"
],
"city": "Den Burg",
"postalCode": "9105 PZ",
"country": "NLD"
}Learn more about the (Location) address FHIR attribute
Description: Physical form of the location
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"physicalType": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
"code": "wi",
"display": "Wing"
}
]
}Learn more about the (Location) physicalType FHIR attribute
Description: The absolute geographic location
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"position": {
"longitude": -83.6945691,
"latitude": 42.25475478,
"altitude": 0
}Learn more about the (Location) position FHIR attribute
Description: Organization responsible for provisioning and upkeep
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"managingOrganization": {
"reference": "Organization/f001"
}Learn more about the (Location) managingOrganization FHIR attribute
Description: Another Location this one is physically a part of
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"partOf": Learn more about the (Location) partOf FHIR attribute
Description: What days/times during a week is this location usually open
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"hoursOfOperation": Learn more about the (Location) hoursOfOperation FHIR attribute
Description: Description of availability exceptions
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"availabilityExceptions": Learn more about the (Location) availabilityExceptions FHIR attribute
Description: Technical endpoints providing access to services operated for the location
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"endpoint": [
{
"reference": "Endpoint/example"
}
]Learn more about the (Location) endpoint FHIR attribute
Location Example
{
"resourceType": "Location",
"id": "1",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Burgers UMC, South Wing, second floor</div>"
},
"identifier": [
{
"value": "B1-S.F2"
}
],
"status": "active",
"name": "South Wing, second floor",
"alias": [
"BU MC, SW, F2",
"Burgers University Medical Center, South Wing, second floor"
],
"description": "Second floor of the Old South Wing, formerly in use by Psychiatry",
"mode": "instance",
"telecom": [
{
"system": "phone",
"value": "2328",
"use": "work"
},
{
"system": "fax",
"value": "2329",
"use": "work"
},
{
"system": "email",
"value": "second wing admissions"
},
{
"system": "url",
"value": "http://sampleorg.com/southwing",
"use": "work"
}
],
"address": {
"use": "work",
"line": [
"Galapagosweg 91, Building A"
],
"city": "Den Burg",
"postalCode": "9105 PZ",
"country": "NLD"
},
"physicalType": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
"code": "wi",
"display": "Wing"
}
]
},
"position": {
"longitude": -83.6945691,
"latitude": 42.25475478,
"altitude": 0
},
"managingOrganization": {
"reference": "Organization/f001"
},
"endpoint": [
{
"reference": "Endpoint/example"
}
]
}Location Structure
{
"resourceType" : "Location",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Unique code or number identifying the location to its users
"status" : "<code>", // active | suspended | inactive
"operationalStatus" : { Coding }, // The operational status of the location (typically only for a bed/room)
"name" : "<string>", // Name of the location as used by humans
"alias" : ["<string>"], // A list of alternate names that the location is known as, or was known as, in the past
"description" : "<string>", // Additional details about the location that could be displayed as further information to identify the location beyond its name
"mode" : "<code>", // instance | kind
"type" : [{ CodeableConcept }], // Type of function performed
"telecom" : [{ ContactPoint }], // Contact details of the location
"address" : { Address }, // Physical location
"physicalType" : { CodeableConcept }, // Physical form of the location
"position" : { // The absolute geographic location
"longitude" : <decimal>, // R! Longitude with WGS84 datum
"latitude" : <decimal>, // R! Latitude with WGS84 datum
"altitude" : <decimal> // Altitude with WGS84 datum
},
"managingOrganization" : { Reference(Organization) }, // Organization responsible for provisioning and upkeep
"partOf" : { Reference(Location) }, // Another Location this one is physically a part of
"hoursOfOperation" : [{ // What days/times during a week is this location usually open
"daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun
"allDay" : <boolean>, // The Location is open all day
"openingTime" : "<time>", // Time that the Location opens
"closingTime" : "<time>" // Time that the Location closes
}],
"availabilityExceptions" : "<string>", // Description of availability exceptions
"endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to services operated for the location
}
Location Search Parameters
The following search parameters can be used to query Location resources. Just submit them like so:
https://api.1up.health/fhir/r4/Location?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
address | text | address |
address-city | text | address.city |
address-country | text | address.country |
address-postalcode | text | address.postalCode |
address-state | text | address.state |
address-use | text | address.use |
endpoint | reference | endpoint |
identifier | text | identifier |
name | text | name |
near | special | position |
operational-status | text | operationalStatus |
organization | reference | managingOrganization |
partof | reference | partOf |
status | text | status |
type | text | type |
