Patient Flags - NHS England - Implementation Guide STU1 - Local Development build (v0.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Retrieve Patient Flag Record

Overview

For high level requirements, see Key purposes of the Patient Flag

Usecase

A Patient Flag Record may be retrieved if it exists. It will be possible to determine that a adjustment flags exist by searching for a Patient Flag with:

• Programme Flags
• Programme Flags with a category of NRAF
• or the code NRAF,

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 Patient Flag.

GET /PatientFlag?patient=9449306753

This limits the search to Flags for the patient that has the identifier 9449306753

patient=9449306753

The following queries will return all or some of the resources constituing a Patient Flag record, i.e.

• Patient Flag resources
• Any Additional Supporting resources

This query relies on the FlagCategory and 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. See TODO – link to add interaction diagram.

If the flag-detail extension is used, then references to all Reasonable Adjustment resources can be included the Patient Flag resource.

This will return all associated flag resources for Reasonable Adjustments.

http://localhost:8080/fhir/Flag?patient.identifier=9912003888&_include=Flag:detail&_include=Flag:patient

This limits the search to patients thant have the identifier 9912003888

patient.identifier=9912003888=9912003888

This includes all references in the flag detail extension that have been defined in the FlagDetail SearchParameter.

&_include=Flag:detail

This includes the associated patient resource.

&_include=Flag:patient

This query relies on the FlagCategory, FlagCode and FlagDetail SearchParameters.