WARNING
This guidance is under active development by NHS England and content may be added or updated on a regular basis.Design overview
The FGM-IS FHIR API provides an R4 FHIR Application Programming Interface (API) to allow connecting systems to search and update FGM-IS 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 FGM FHIR DSTU2 API for common use cases.
An FGM-IS indicator (family history of FGM) 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 FGM-IS indicator. Refer to - Interactions.
As a pre-requisite for calling the FGM-IS 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 FGM-IS FHIR R4 API will be hosted on the NHS England API Platform. Refer to - Authentication.