Patient Flags - NHS England - Implementation Guide STU1
0.4.0 - ci-build
Patient Flags - NHS England - Implementation Guide STU1
0.4.0 - ci-build
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
For high level requirements, see Key purposes of the FGM Flag
An FGM Flag Record may be retrieved if it exists. It will be possible to determine that an flags exist by searching for a Patient Flag with the code FGM
Using FHIR search capabilities, it is possible to retrieve the reasonable adjustment records in several ways.
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 thant 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 constituing a Female Genital Mutilation record:
This query relies on the FlagCategory and FlagCode SearchParameters.
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 Female Genital Mutilation records.
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.
IG © Copyright © 2024+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. NHS England. Package patient-flags.stu1#0.4.0 based on FHIR 4.0.1. Generated 2024-07-02
