FHIR Location

Overview

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. A FHIR 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

Must support elements, mandatory and optional search parameters

FHIR Location must support these elements:

status
name
telecom
address
line
city
state
postalCode
managingOrganization

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?address-city=[string]

**PARAMS**

- [base url] - [FHIR base url](./service-base-urls.md)
- [string] - Location's name

**HEADERS**

The Authorization token SHALL be obtained during Authentication and Authorization process. Goto [Authentication and Authorization](./authentication-authorization.md) for further details.

|Header| Type | Required/Optional | Value |
|------|------|------------------|-------|
|Authorization| **string** |required| 'Bearer' <token> |

**RESPONSES**

|Code|Description|Comment|
|----|-----------|-------|
| 200| OK | The request was processed successfully|
| 400| Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401| Unauthorized| This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource|
| 404| no Route matched with those values| The request was able to communicate with a given server, but the server could not find what was requested|
| 500| Internal Server Error| The server has encountered a situation it doesn't know how to handle|

**EXAMPLE:**

curl --location --request GET 'https://demo.kodjin.com/fhir/Location?name=Health' \ --header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'

## Location By Address

Get Location by address string.

**METHOD** *GET*

GET [base url]/Location?address=[string]

**PARAMS**

- [base url] - [FHIR base url](./service-base-urls.md)
- [string] - Address string

**HEADERS**

The Authorization token SHALL be obtained during Authentication and Authorization process. Goto [Authentication and Authorization](./authentication-authorization.md) for further details.

|Header| Type | Required/Optional | Value |
|------|------|------------------|-------|
|Authorization| **string** |required| 'Bearer' <token> |

**RESPONSES**
|Code|Description|Comment|
|----|-----------|-------|
| 200| OK | The request was processed successfully|
| 400| Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401| Unauthorized| This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource|
| 404| no Route matched with those values| The request was able to communicate with a given server, but the server could not find what was requested|
| 500| Internal Server Error| The server has encountered a situation it doesn't know how to handle|

**EXAMPLE:**

curl --location --request GET 'https://demo.kodjin.com/fhir/Location?address=Arbor' \ --header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'

## Location by address-city

Get Locations by city name:

**METHOD** *GET*

GET [bas url]/Location?address-city=[string]

**PARAMS**

- [base url] - [FHIR base url](./service-base-urls.md)
- [string] - city


**HEADERS**

The Authorization token SHALL be obtained during Authentication and Authorization process. Goto [Authentication and Authorization](./authentication-authorization.md) for further details.

|Header| Type | Required/Optional | Value |
|------|------|------------------|-------|
|Authorization| **string** |required| 'Bearer' <token> |

**RESPONSES**

|Code|Description|Comment|
|----|-----------|-------|
| 200| OK | The request was processed successfully|
| 400| Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401| Unauthorized| This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource|
| 404| no Route matched with those values| The request was able to communicate with a given server, but the server could not find what was requested|
| 500| Internal Server Error| The server has encountered a situation it doesn't know how to handle|

**EXAMPLE:**

curl --location --request GET 'https://demo.kodjin.com/fhir/Location?address-city=Ann Arbor' \ --header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'

## Location by address-state

Get Locations by the state:

**METHOD** *GET*

GET [bas url]/Location?address-state=[string]

**PARAMS**

- [base url] - [FHIR base url](./service-base-urls.md)
- [string] - state


**HEADERS**

The Authorization token SHALL be obtained during Authentication and Authorization process. Goto [Authentication and Authorization](./authentication-authorization.md) for further details.

|Header| Type | Required/Optional | Value |
|------|------|------------------|-------|
|Authorization| **string** |required| 'Bearer' <token> |

**RESPONSES**

|Code|Description|Comment|
|----|-----------|-------|
| 200| OK | The request was processed successfully|
| 400| Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401| Unauthorized| This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource|
| 404| no Route matched with those values| The request was able to communicate with a given server, but the server could not find what was requested|
| 500| Internal Server Error| The server has encountered a situation it doesn't know how to handle|

**EXAMPLE:**

curl --location --request GET 'https://demo.kodjin.com/fhir/Location?address-state=MI' \ --header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'

## Location by postal code

Get Locations by the postal code:

**METHOD** *GET*

GET [bas url]/Location?address-postalcode=[string]

**PARAMS**

- [base url] - [FHIR base url](./service-base-urls.md)
- [string] - postal-code


**HEADERS**

The Authorization token SHALL be obtained during Authentication and Authorization process. Goto [Authentication and Authorization](./authentication-authorization.md) for further details.

|Header| Type | Required/Optional | Value |
|------|------|------------------|-------|
|Authorization| **string** |required| 'Bearer' <token> |

**RESPONSES**

|Code|Description|Comment|
|----|-----------|-------|
| 200| OK | The request was processed successfully|
| 400| Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401| Unauthorized| This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource|
| 404| no Route matched with those values| The request was able to communicate with a given server, but the server could not find what was requested|
| 500| Internal Server Error| The server has encountered a situation it doesn't know how to handle|

**EXAMPLE:**

curl --location --request GET 'https://demo.kodjin.com/fhir/Location?address-postalcode=48104' \ --header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd' ```