Design overview

The [xyz] FHIR API provides an R4 FHIR Application Programming Interface (API) to allow connecting systems to search and update [xyz] indicators.

• The API provides a FHIR RESTful interface within which transactions are performed directly on the server resource using synchronous endpoints using GET, POST and PUT HTTP verbs.

• The API is intended to supersede the [xyz] FHIR DSTU2 API for common use cases.

• An [xyz] indicator has been modelled around a FHIR R4 Flag. Refer to - Data mapping.

• The API will allow a healthcare professional to query, add and remove a [xyz] indicator. Refer to - Interactions.

• As a pre-requisite for calling the [xyz] FHIR R4 API , client systems MUST have traced the patient on PDS to ensure they have the correct NHS number for the patient. The Spine Core API spec outlines the approaches available for this demographic trace.

• The [xyz] FHIR R4 API will be hosted on the NHS England API Platform. Refer to - Authentication.

• The [xyz]e allows [abc] to [pqr] in a FHIR format that conforms to the proposed R4 guidance, and UK Core.

• The [xyz] uses a variety of FHIR resources that can be found on the FHIR Assets page.