v50

latestOpenAPI 3.0.0raw.githubusercontent.com2024-03-041415119.9 KB

Update reasonable adjustments

Overview

Use this endpoint to update a Reasonable Adjustment Flag against the patient record on the NHS Spine. This will describe the adjustment that the patient needs and will either be a coded national adjustment as defined by SNOMED CT, or an adjustment which has been manually keyed by a clinician. You can also use this endpoint to delete an existing adjustment. To find out more about the different types of adjustments see How the Reasonable Adjustment Flag works.

For full details of this API resource see RARecord-Flag-1.

put/Flag/{flagID}

Path parameters

flagIDstring required
Example:5900026175.b1fe6cc0-7bf5-453c-a396-1ae97cfad72a

The id of the flag. To retrieve the flagID, you need to do a GET /Flag first. The successful response from GET /Flag endpoint contains the flagID. See the example of successful response in Get reasonable adjustments section. See the example below to know the flagID from that response.

Headers

Authorizationstring ^Bearer\ [[:ascii:]]+$
Example:Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM

An OAuth 2.0 bearer token.

Note: This parameter is required unless interacting with the Sandbox.

NHSD-Session-URIDstring
Example:555021935107

The user role ID (URID) for the current session. Also known as a user role profile ID (URPID).

If you are using User-restricted RESTful APIs - NHS login combined authentication and authorisation, See determine the user's role guidance. If you are using User-restricted RESTful APIs - NHS login separate authentication and authorisation, See determine the user's role guidance.

This field is optional.

X-Correlation-IDstring
Example:11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA

A globally unique identifier (GUID) for the request, which we use to trace the request if you contact our helpdesk. Mirrored back in a response header. Avoid characters.

X-Request-IDstring
Example:60E0B220-8136-4CA5-AE46-1D97EF59D068

A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests. Must be a universally unique identifier (UUID) (ideally version 4). If you re-send a failed request, use the same value in this header. Mirrored back in a response header.

Required in all environments except sandbox.

If-Matchstring required
Example:W/"2"

Latest known version identifier enclosed in quotes preceded by W/. Send the value of the patient's ETag response header on patient retrieval when updating a patient. This is to ensure that any updates are applied against an up-to-date version of the patient resource.

Response

Successful response.