Overview of the Resources section
Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully develop the APIs. This project is being developed using an agile methodology so iterative updates to content will be added on a regular basis.
Warning: This site is provided for information only and is intended for those engaged with NHS Digital on the development of the APIs. It is advised not to develop against these specifications until a formal announcement has been made.
1. Pre-Requisites for FHIR Servers
1.1 API Requirements
- SHALL support HL7 FHIR STU3
- 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 CareConnectAPI interactions and SHOULD support both formats.
1.2 FHIR Conformance
SHALL declare a Conformance identifying the list of profiles, operations, search parameter supported.
1.3 NHS Number
Only verified NHS Number SHALL be used with profiles. This can be achieved using a spine accredited system, a Demographics Batch Service (DBS) batch-traced record (CSV), or using a Spine Mini Services Provider (HL7v3) to verify the NHS Number.
Contribute: Get in touch with careconnect@interopen.org to improve the Prerequisites.
2. Resource API Structure
The FHIR Visitors and Migrants profile API’s described in the Explore section of this implementation guide have been structured consistently in the following way:
-
0.References -
1.Read -
2.Search Parameters -
3.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 |
3. Resource API’s
This section looks at the Visitors and Migrants profile API’s covered within this implementation guide.
| Clinical | ||
|---|---|---|
| Diagnostics | ||
| Prescription-Exemption-Observation |
| Foundation | ||
|---|---|---|
| Conformance | Terminology | |
| Capability Statement | ValueSet |