NHnhs

Get proxy role

Overview

Use this endpoint to get the details of a proxy role, including current status, based on a provided id.

You can (optionally) include the _include=Consent:performer request parameter to include the proxy's details in the response.

You can (optionally) include the _include=Consent:patient request parameter to include the patient's details in the response.

Access modes

This endpoint supports the following access modes:

  • Healthcare worker access
  • Application-restricted access

Sandbox test scenarios

You can test the following scenarios in our sandbox environment:

ScenarioRequestResponse
Retrieve single consenting adult relationshipValid request with ID 74eed847-ca25-4e76-8cf2-f2c2d7842a7aHTTP Status 200 Bundle containing a single active proxy relationship
Retrieve single consenting adult relationship with patient detailsValid request with ID 74eed847-ca25-4e76-8cf2-f2c2d7842a7a?_include=Consent:patientHTTP Status 200 Bundle containing a single active proxy relationship with patient details
Retrieve single consenting adult relationship with performer detailsValid request with ID 74eed847-ca25-4e76-8cf2-f2c2d7842a7a?_include=Consent:performerHTTP Status 200 Bundle containing a single active proxy relationship with performer details
Retrieve single consenting adult relationship with performer and patient detailsValid request with ID 74eed847-ca25-4e76-8cf2-f2c2d7842a7a?_include=Consent:performer&_include=Consent:patientHTTP Status 200 Bundle containing a single active proxy relationship with performer and patient details
Retrieve single mother-child relationshipValid request with ID 39df03a2-1b14-4d19-b1dc-d5d8cbf96948HTTP Status 200 Bundle containing a single active proxy relationship
Retrieve single mother-child relationship with patient detailsValid request with ID 39df03a2-1b14-4d19-b1dc-d5d8cbf96948?_include=Consent:patientHTTP Status 200 Bundle containing a single active proxy relationship with patient details
Retrieve single mother-child relationship with performer detailsValid request with ID 39df03a2-1b14-4d19-b1dc-d5d8cbf96948?_include=Consent:performerHTTP Status 200 Bundle containing a single active proxy relationship with performer details
Retrieve single mother-child relationship with performer and patient detailsValid request with ID 39df03a2-1b14-4d19-b1dc-d5d8cbf96948?_include=Consent:performer&_include=Consent:patientHTTP Status 200 Bundle containing a single active proxy relationship with performer and patient details

Sandbox constraints

The sandbox environment has the following constraints for this endpoint:

  • Request headers are not tested. X-Request-ID and X-Correlation-ID are disregarded.
get/Consent/{id}

Request

  • Base URL
    https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4
  • URL
    https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/{id}
  • Auth
    none declared. Required headers: Authorization, X-Request-ID

Path parameters

idstring uuid required
Example:74eed847-ca25-4e76-8cf2-f2c2d7842a7a

The logical id of the Consent resource

Query parameters

_includestring[]

Include referenced resources in the bundle response by specifying one or more _include parameters. Further info here.

Headers

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

An OAuth 2.0 bearer token.

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

A globally unique identifier (GUID) for the request, which we use to correlate logs through different components. Must be a universally unique identifier (UUID) (ideally version 4). Mirrored back in a response header.

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

An optional ID which you can use to track transactions across multiple systems. Must be a universally unique identifier (UUID) (ideally version 4). Mirrored back in a response header.

Response

Information successfully returned.

resourceType'Bundle'

FHIR resource type.

timestampstring date-time

The UTC date and time the search results were returned.

totalnumber

The number of resources contained within the Bundle.

type'searchset'

Denotes that the Bundle is a collection of resources returned as a result of a search.

Example response

{
  "entry": [
    {
      "search": {
        "mode": "match"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.