Add Patient Flag Record

Overview

For high level requirements, see Home.

Use Case

System Interactions

The practitioner decides to record patient flag information.

This could be done with individual calls to the required endpoints, or can be done in a single transaction Bundle. A transaction Bundle can help with data integrity requirements and also help to reduce required http calls.

Examples

The following set of examples constitute the individual associated resources with the initial addition of a flag for Reasonable Adjustment. This include a patient Flag resource, the adjustment Flag resource and the associated Condition resource. All resources have contained provenances.

A transaction Bundle is also given that allows these resources (plus the patient) to be entered in an atomic traction. It uses PUTs, where in the case of an initial update, it may be done as a conditional update

The following set of examples are for the same patient, and constitute an addition flag and condition. The transaction Bundle here illustrates an idempotent update by simply adding the new resources to the first transaction Bundle.

Retrieve Patient Flag Record

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:

System Interaction

Queries

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 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 constituting a Patient Flag record, i.e.

This query relies on the England FlagCategory and England 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.

If the flag-detail extension is used, then references to all Reasonable Adjustment resources can be included in the England Flag 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 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 Patient Flag Record

Overview

For high level requirements, see Home.

Use Case

System Interactions

In the following sequence diagram, a patient and/or practitioner decide to remove the patient flag.

The following resource types will be deleted from the record:

Example

Multiple resources can be deleted using a transaction bundle. This RemoveRARecord-Bundle-Example: