Overview of the Explore section
Important: This site is under active development by NHS Digital to develop the eRS APIs. This project is being developed using an agile methodology so iterative updates to content will be added on a regular basis.
1. Pre-Requisites for FHIR Servers
1.1 API Requirements
- SHALL support HL7 FHIR STU3 version 3.0.1.
-
SHALL Implement REST behavior according to the FHIR specification
-
Resources SHALL identify the profile supported as part of the FHIR Base Resource
-
SHALL support XML or JSON formats for all API interactions and SHOULD support both formats.
1.2 FHIR Conformance
SHALL declare a Conformance identifying the list of profiles, operations and search parameters supported.
In order to be a compliant FHIR server, client systems need to expose a valid FHIR CapabilityStatement profile.
Contribute: Get in touch with interoperabilityteam@nhs.net to improve the Prerequisites.
2. Resource API Structure
The FHIR profile API’s described in the Explore section of this implementation guide have been structured consistently in the following way:
0.References1.Read2.Search Parameters3.Example
2.1 Resource API Structure Details
| General | Description |
|---|---|
| 0. References | Links to other parts of the implementation guide which might help with context and understanding the API's described |
| 1. Read | A description of how to get the API |
| 2. Search Parameters | List of search parameters for the profile being described, including any tips for searching. This section shows examples of how to search using the provided search parameters |
| 3. Example | Description of of the Request & Response headers, example of how to search on a server and the expected response body as an example |