0. References
Profile: Location |
HL7 FHIR STU3 Resource: Location |
User Stories: User Stories |
1. Read
Return a single Location for the specified id.
All requests SHALL contain a valid ‘Authorization’ header and SHALL 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/json+fhir or application/xml+fhir.
1.1. Response
A full set of response codes can be found here API Response Codes. FHIR Servers SHALL support the following response codes:
| 200 | successful operation |
| 404 | resource not found |
| 410 | resource deleted |
2. Search
Fetches a bundle of all Location resources for the specified search criteria.
All requests SHALL contain a valid ‘Authorization’ header and SHALL 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/json+fhir or application/xml+fhir.
2.1. Search Parameters
This implementation guide outlines some suggested search parameters for the Location resource in the table below. To be conformant, provider systems are required to implement all of the SHALL parameters. Provider systems may implement the full list of search parameters for the Location resource (HL7 FHIR STU3 Location).
| Name | Type | Description | Conformance | Path |
|---|---|---|---|---|
adddress-postcode |
string |
A postalCode specified in an address | MAY | Location.address.postalCode |
identifier |
token |
Any identifier for the location (e.g. SDS/ODS code) | MAY | Location.identifier |
2.1.1. address-postcode
See string for details on this parameter.
GET [baseUrl]/Location?address-postcode=NG10%201RY
Return all Location resources with Post Code of NG10 1RY.2.1.2. identifier (SDS/ODS Code)
GET [baseUrl]/Location?identifier=[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.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 SHALL 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; if one is sent it SHALL NOT include any errors, and it shall be marked with an entry mode of include.
A full set of response codes can be found here API Response Codes. FHIR Servers SHALL support the following response codes:
| 200 | successful operation |
| 404 | resource not found |
| 410 | resource deleted |
3. Example
3.1 Request Query
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.
3.1.1. cURL
curl -H 'Accept: application/xml+fhir' -H 'Authorization: BEARER [token]' -X GET '[baseUrl]/Location?identifier=https://fhir.nhs.uk/Id/ods-site-code|RTG08'