Skip to main content

​
Overview

Location Information addresses: Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. This profile meets the U.S. Core Data for Interoperability (USCDI) v3 requirements for Location Information. 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. Each Location has next elements:
  • a name
Each Location supports next elements:
  • Location.status
  • Location.name
  • Location.telecom
  • Location.address
  • managingOrganization
Location response will be provided in JSON (refers to Capability Statement) format as per FHIR standard R4 version. This resource refers to US Core Location Profile 6.1.0.

​
Must support elements, mandatory and optional search parameters

Location must support these elements:
  • status
  • name
  • telecom
  • address
    • line
    • city
    • state
    • postalCode
  • managingOrganization
Each Location Must Have (Mandatory):
  • name
Location response will be provided in JSON (refers to Capability Statement) format as per FHIR standard R4 version. The following search parameters and search parameter combinations SHALL be supported (mandatory): The syntax used to describe the interactions is described here. SHALL support searching by location name using the name search parameter: GET [base url]/Location?name=[string] SHALL support searching location based on text address using the address search parameter: GET [base url]/Location?address=[string] The following search parameter combinations SHOULD be supported (optional): SHOULD support searching using the address-city search parameter: GET [base url]/Location?address-city=[string] SHOULD support searching using the address-state search parameter: GET [base url]/Location?address-state=[string] SHOULD support searching using the address-postalcode search parameter: GET [base url]/Location?address-postalcode=[string] The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.

​
Location By Name

Search for Location by location’s name. METHOD GET 
GET [base url]/Location?name=[string]
PARAMS [base url] - FHIR base url [string] - Location’s name HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>
RESPONSES
CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404No route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn’t know how to handle
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome. EXAMPLE: 
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Location?name=Health' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'

​
Location By Address

Search for Location by address string. METHOD GET 
GET [base url]/Location?address=[string]
PARAMS [base url] - FHIR base url [string] - Address string HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>
RESPONSES
CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404No route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn’t know how to handle
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome. EXAMPLE: 
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Location?address=Arbor' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'

​
Location by Address-City

Search for Locations by city name. METHOD GET 
GET [base url]/Location?address-city=[string]
PARAMS [base url] - FHIR base url [string] - City name HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>
RESPONSES
CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404No route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn’t know how to handle
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome. EXAMPLE: 
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Location?address-city=Ann%20Arbor' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'

​
Location by Address-State

Search for Locations by state. METHOD GET 
GET [base url]/Location?address-state=[string]
PARAMS [base url] - FHIR base url [string] - State name or abbreviation HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>
RESPONSES
CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404No route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn’t know how to handle
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome. EXAMPLE: 
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Location?address-state=MI' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'

​
Location by Postal Code

Search for Locations by postal code. METHOD GET 
GET [base url]/Location?address-postalcode=[string]
PARAMS [base url] - FHIR base url [string] - Postal code HEADERS The Authorization token SHALL be obtained during the Authentication and Authorization process. Go to Authentication and Authorization for further details.
HeaderTypeRequired/OptionalValue
AuthorizationstringrequiredBearer <token>
RESPONSES
CodeDescriptionComment
200OKThe request was processed successfully
400Bad requestInvalid request parameters or FHIR operation outcome resource returned
401UnauthorizedThis code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404No route matched with those valuesThe request was able to communicate with a given server, but the server could not find what was requested
500Internal Server ErrorThe server has encountered a situation it doesn’t know how to handle
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome. EXAMPLE: 
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Location?address-postalcode=48104' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'