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.
Retrieve PatientFlags
Overview
For high level requirements, Home.
Use Case
A Patient Flag Record may be retrieved if it exists. It will be possible to determine that adjustment flags exist by searching for a England Flag Patient Flag with:
- England Flag Patient Flag and patient search parameter.
System Interaction
Queries
Using FHIR search capabilities, it is possible to retrieve the Patient Flag records in several ways.
Flag endpoint search
This section describes how to query from the Flag endpoint using FHIR search
This will return all associated Flag resources for a given Patient.
GET [baseUrl]/Flag?patient=[patientNHSNumber]
e.g:
GET [baseUrl]/Flag?patient=9449306753
This limits the search to Flags for the patient that has the identifier 9449306753
This query relies on the Flag.patient SearchParameter.