WARNING
This guidance is under active development by NHS England and content may be added or updated on a regular basis.It is NOT currently recommended to develop against this guidance.
Add FGM Flag Record
Overview
For high level requirements, see Home.
Use Case
System Interactions
The practitioner decides to record a
Examples
Retrieve FGM Flag Record
Overview
For high level requirements, see Home.
Use Case
An FGM Flag Record may be retrieved if it exists. It will be possible to determine that an flags exist by searching for a England Flag Patient Flag with:
- the code
female-genital-mutilation-flag
England Flag Category Patient
System Interaction
Queries
Using FHIR search capabilities, it is possible to retrieve the reasonable adjustment records in several ways.
Patient endpoint search
This section describes how to query from the Patient endpoint using FHIR search
This will return all associated flag resources for Female Genital Mutilation records.
GET /Patient?identifier=9912003888&_has:Flag:patient:code=FGM
This limits the search to patients that have the identifier 9912003888
identifier=9912003888
This limits the search to patients that have Flag resources linked via patient and have the code FGM, and also includes the resource in the returned searchset Bundle.
&_has:Flag:patient:code=FGM&_revinclude=Flag:patient
The following queries will return all or some of the resources constituting a Female Genital Mutilation record:
- England Flag Patient Flag resources
This query relies on the England FlagCategory and England FlagCode SearchParameters.
Flag endpoint search
This section describes how to query from the Flag endpoint using FHIR search
NOTE: For every additional record/resource added, the flag-detail element in the Patient Flag resource will need updated.
If the flag-detail extension is used, then references to all Reasonable Adjustment resources can be included in the Patient Flag resource.
This will return all associated flag resources for Female Genital Mutilation records.
http://localhost:8080/fhir/Flag?patient.identifier=9912003888&_include=Flag:detail&_include=Flag:patient
This limits the search to patients that have the identifier 9912003888
patient.identifier=9912003888
This includes all references in the flag detail extension that have been defined in the England FlagDetail SearchParameter.
&_include=Flag:detail
This includes the associated patient resource.
&_include=Flag:patient
This query relies on the England FlagCategory, England FlagCode, and England FlagDetail SearchParameters.
Remove FGM Flag Record
Overview
For high level requirements, see Home.