v50

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

Update consent details

Overview

Use this endpoint to update details regarding the patient's consent to share a Reasonable Adjustment Flag record, as well as 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. Consent is usually obtained by a suitable member of staff discussing the Reasonable Adjustment Flag with the patient, their carer or the appropriate patient representative. The member of staff will then record the type of consent captured, along with some free text details providing more information about who provided the consent.

For full details of this API resource see RARecord-Consent-1

put/Consent/{consentID}

Path parameters

consentIDstring required
Example:5900026175.11eccc9b-4a6f-4467-a76b-1b8a82bafd65

The id of the record. To retrieve the consentID, you need to do a GET /Consent first. The successful response from GET /Consent endpoint contains the consentID. See the example of successful response in Get consent details section. See the example below to know the consentID 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.