WARNING
This guidance is under active development by NHS England and content may be added or updated on a regular basis.This FHIR IG is ahead of the current PatientFlag API specification build. Please refer to that document for technical build and integration requirements, and to the PatientFlag programme for roadmap information.
FGM record
This page shows the functional use cases provided by the Female Genital Mutilation implementation within the PatientFlag API:
- Retrieve a set of top-level Flag
- Add an FGM Flag
- Remove a top-level Flag (which will remove all associated resources)
Retrieve PatientFlags
Overview
For high level requirements, see Home.
This use case operates as per Retrieve PatientFlags
Add an FGM Flag
Overview
For high level requirements, see Home.
Use Case
System Interactions
The practitioner decides to record a
Queries
Using FHIR create capabilities, it is possible to create/write the FGM Patient Flag record.
Flag endpoint write
FGM records are created by POSTing the resource, conformant to England Flag Patient Flag to the relevant /Flag resource type endpoint.
POST [baseURL]/Flag
Examples
Remove an FGM Flag
Overview
For high level requirements, see Home.
Use Case
System Interactions
Queries
Using FHIR conditional delete capabilities, it is possible to delete the entire FGM Flag record for a given patient.
Flag endpoint write
Following the standard FHIR conditional delete ReST pattern DELETE [baseURL]/[resourceType] for delete operations, to:
Remove entire FGM record
Use DELETE [baseURL]/Flag?[searchParameters]
Include searchParameters:
- 'patient' - [patientNHSNumber]
- 'code' - [patientFlagCode]
Provide a Removal reason string as header:
x-removal: [removalReason]
e.g. DELETE [baseURL]/Flag?patient=9449306753&code=female-genital-mutilation-flag
The following resource types will be deleted from the record:
This query relies on the Flag patient and England FlagCode search parameters.