v50

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

Update impairments

Overview

Use this endpoint to update a list of impairments held within the Reasonable Adjustment Flag information held on the NHS Spine. These impairments will likely have been captured during the discussion between the clinician and the patient or their carer. Patients may however decline to provide details of their impairments if they do not want to share them. To capture an impairment the member of staff selects an impairment type and then provides additional information using a free text field. For more details regards impairments see How the Reasonable Adjustment Flag works.

For full details of this API resource see CareConnect-RARecord-List-1

put/List/{listID}

Path parameters

listIDstring required
Example:5900026175.3d368fbe-e621-4c0b-be74-9a59b4f0e467

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