Skip to main content
Table of contents

Reasonable Adjustment Flag - FHIR API

Overview

Use this API to access and update the Reasonable Adjustment Flag - a national record which indicates that a patient requires reasonable adjustments and optionally includes details of impairments and adjustments to be considered. You can:

check if a Reasonable Adjustment Flag exists

read a Reasonable Adjustment Flag

create a Reasonable Adjustment Flag

update a Reasonable Adjustment Flag

remove a Reasonable Adjustment Flag

The flag consists of three parts:

details of consent to share the Flag and how this was obtained. Consent may have been given by the patient or via a 'best interest decision' under the Mental Capacity Act (2005). In some cases consent can also be obtained from a lasting power of attorney for health and welfare or a court appointed deputy.

details of impairments, which enable clinicians to understand the range of adjustments the patient may require. Note that the patient may decline to say what their impairments are.

details of reasonable adjustments to services which are needed by the patient when providing their care.

This API can only be used by relevant health and care staff providing direct care, authenticated with an NHS smartcard or equivalent. The existance of a flag is intended to be visible to all staff who have access to the patient record. The contents of the Flag may only be visible to clinical staff - as determined by role-based access controls (RBAC). For more details see Registration authorities and smartcards. To find out more about how the flag works, categories and types of adjustments and the recording of impairments see How the Reasonable Adjustment Flag works. To watch a video of a Reasonable Adjustment Flag being created in SCRa see Creating a Reasonable Adjustment Flag on the NHS Spine.

Documentation

Reasonable Adjustment Flag - FHIR API documentation

Endpoint

https://digital.nhs.uk/developer/api-catalogue/reasonable-adjustment-flag-fhir

Contact

https://digital.nhs.uk/developer/help-and-support