Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.

0. References

1. Read

Return a single Location for the specified id.

All requests MUST contain a valid ‘Authorization’ header and SHOULD contain an ‘Accept’ header. The `Accept` header indicates the format of the response the client is able to understand, this will be one of the following application/fhir+json or application/fhir+xml.

1.1. Response

A full set of response codes can be found here API Response Codes. FHIR Servers MUST support the following response codes:

200 successful operation
400 invalid parameter
401/4xx unauthorized request
403 insufficient scope
404 resource not found
410 resource deleted

Fetches a bundle of all Location resources for the specified search criteria.

All requests MUST contain a valid ‘Authorization’ header and SHOULD contain an ‘Accept’ header. The `Accept` header indicates the format of the response the client is able to understand, this will be one of the following application/fhir+xml or application/fhir+json.

2.1. Search Parameters

The search parameters that are mandated as a minimum in the API for the Location resource are detailed below.

Query parameters conformance will be categorised as:

MUST - these search parameters MUST be implemented for the specified resource type.

SHOULD - these search parameters are expected to be implemented, if the data to support the query is present in the host system.

Additional search parameters MAY be added to reflect local requirements.

To be conformant, provider systems are required to implement all of the MUST parameters.

The parameters can be used independently to help refine the search results returned.

Name Type Description Conformance Path
address string A (part of the) address of the location SHOULD Location.address
address-city string A city specified in an address SHOULD Location.address.city
address-postalcode string A postal code specified in an address SHOULD Location.address.postalCode
identifier token Any identifier for the location (e.g. SDS/ODS code) MUST Location.identifier
name string A portion of the location's name or alias MUST Location.name

2.1.1. address

See string for details on this parameter.

GET [baseUrl]/Location?address=York

Return all Location resources with address string of York.

2.1.2. address-city

See string for details on this parameter.

GET [baseUrl]/Location?address-city=London

Return all Location resources with city of London.

2.1.3. address-postcode

See string for details on this parameter.

GET [baseUrl]/Location?address-postcode=N19%205NF

Return all Location resources with postcode of N19 5NF.

2.1.4. identifier (SDS/ODS Code)

See token for details on this parameter.

GET [baseUrl]/Location?identifier=https://fhir.nhs.uk/Id/ods-site-code|RTG08

Return all Location resources with NHS Trust Site of RTG08 (Long Eaton Clinic).

2.1.5. name

See string for details on this parameter.

GET [baseUrl]/Location?name=York Hospital

Return all Location resources with name string of York Hospital.

2.2. Search Response

If the search fails (cannot be executed, not that there is no matches), the return value is a status code 4xx or 5xx with an OperationOutcome.

If the search succeeds, the return content is a Bundle with type = searchset containing the results of the search as a list of resources in a defined order. The result list can be long, so servers MAY use paging. If they do, they MUST use this Paging method for breaking the list into pages if appropriate. The server MAY also return an OperationOutcome resource with additional information about the search.

A full set of response codes can be found here API Response Codes. FHIR Servers MUST support the following response codes:

200 successful operation
400 invalid parameter
401/4xx unauthorized request
403 insufficient scope
404 resource not found
410 resource deleted
## 3. Example ##

3.1 cURL

Return all Location resources with a Trust Site code of RTG08, the format of the response body will be xml. Replace 'baseUrl' with the actual base Url of the FHIR Server. 
curl -X GET -H 'Accept: application/fhir+xml' -H 'Authorisation: BEARER [token]' -v 'https://data.developer.nhs.uk/ccri-fhir/STU3/Location?identifier=RTG08'

3.2 Explore the Response

Explore the response in XML & JSON on the Reference Implementation below 
Reference Implementation

XML ODS Code search RI viewer
JSON ODS Code search RI viewer

Tags: fhir