v50

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

Get underlying condition

Overview

Use this endpoint to view underlying conditions against the patient record on the NHS Spine.

get/UnderlyingConditionList

Query parameters

patientstring required
Example:5900026175

The patient's NHS number. The primary identifier of a patient, unique within NHS England and Wales. Always 10 digits and must be a valid NHS number.

statusstring required
Example:active

The status of the patient resource. Active or Inactive.

categorystring required
Example:https://fhir.nhs.uk/STU3/CodeSystem/RARecord-FlagCategory-1|NRAF

The category of the resource being interacted with.

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.

Response

Successful response.