--- title: "Get proxy roles" method: GET path: "/Consent" --- # Get proxy roles `GET /Consent` ## Overview Use this endpoint to get the details about proxy roles, including current status, based on a provided NHS Number. Either `performer:identifier` or `patient:identifier` request parameters must be provided. `performer:identifier` and `patient:identifier` can be used together. You can (optionally) include a `status={status}` query string parameter to filter the response to records with a given status bound to the http://hl7.org/fhir/consent-state-codes CodeSystem e.g. `status=active` or `status=proposed,active`. 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: - Patient access - Healthcare worker access - Application-restricted access ## Sandbox test scenarios You can test the following scenarios in our sandbox environment: | Scenario | Request | Response | | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- | | Multiple proxy relationships filtered by 'active' status including details | `performer:identifier=9000000017&_include=Consent:patient&_include=Consent:performer&status=active` | HTTP Status 200 Bundle containing a multiple active proxy relationships including performer and patient details | | Multiple proxy relationships filtered by 'inactive' status | `performer:identifier=9000000017&status=inactive` | HTTP Status 200 Bundle containing a multiple inactive proxy relationships | | Multiple proxy relationships filtered by 'proposed' and 'active' status | `performer:identifier=9000000017&status=proposed,active` | HTTP Status 200 Bundle containing a multiple proposed and active proxy relationships | | Multiple proxy relationships without filtering and details | `performer:identifier=9000000022` | HTTP Status 200 Bundle containing a multiple proxy relationships without details | | Multiple proxy relationships including performer details | `performer:identifier=9000000022&_include=Consent:performer` | HTTP Status 200 Bundle containing a multiple proxy relationships including performer details | | Multiple proxy relationships including patient details | `performer:identifier=9000000022&_include=Consent:patient` | HTTP Status 200 Bundle containing a multiple proxy relationships including patient details | | Multiple proxy relationships including performer and patient details | `performer:identifier=9000000022&_include=Consent:patient&_include=Consent:performer` | HTTP Status 200 Bundle containing a multiple proxy relationships including performer and patient details | | Multiple proxy relationships, single patient | `patient:identifier=9000000100` | HTTP Status 200 Bundle containing a multiple proxy relationships including performer and patient details | | Multiple proxy relationships, single patient, including proxy details | `patient:identifier=9000000100&_include=Consent:performer` | HTTP Status 200 Bundle containing a multiple proxy relationships including proxy details | | Multiple proxy relationships, single patient, including patient details | `patient:identifier=9000000100&_include=Consent:patient` | HTTP Status 200 Bundle containing a multiple proxy relationships including patient details | | Multiple proxy relationships, single patient, including proxy and patient details | `patient:identifier=9000000100&_include=Consent:patient&_include=Consent:performer` | HTTP Status 200 Bundle containing a multiple proxy relationships including proxy and patient details | | No proxy relationships | `performer:identifier=9000000025&_include=Consent:patient&_include=Consent:performer&status=active` | HTTP Status 200 empty bundle | | A single proxy relationship between consenting adults | `performer:identifier=9000000010` and/or `patient:identifier=9000000005` | HTTP Status 200 Bundle containing a single proxy relationship | | A single proxy relationship between consenting adults including details | `performer:identifier=9000000010` and/or `patient:identifier=9000000005&_include=Consent:patient&_include=Consent:performer` | HTTP Status 200 Bundle containing a single proxy relationship including performer and patient details | | A single proxy relationship between a mother and child | `performer:identifier=9000000019` and/or `patient:identifier=9000000009` | HTTP Status 200 Bundle containing a single proxy relationship | | A single proxy relationship between a mother and child including details | `performer:identifier=9000000019` and/or `patient:identifier=9000000009&_include=Consent:patient&_include=Consent:performer` | HTTP Status 200 Bundle containing a single proxy relationship including performer and patient details | | A single proxy relationship between a mother and child with legal basis unknown | `performer:identifier=9000000111` and/or `patient:identifier=9000000119` | HTTP Status 200 Bundle containing a single proxy relationship with legal basis unknown | | Invalid status parameter | `performer:identifier=9000000019` and/or `patient:identifier=9000000009&status=test` | HTTP Status 422 and INVALID_PARAMETER error response | | Invalid include parameter | `performer:identifier=9000000019` and/or `patient:identifier=9000000009&_include=test` | HTTP Status 422 and INVALID_PARAMETER error response | | Missing identifier | `patient:identifier=9000000009` | HTTP Status 400 and MISSING_IDENTIFIER_VALUE error response | | Invalid identifier | `identifier=900000000` Note: This identifier is 9 characters long, too short to be NHS Number | HTTP Status 422 and INVALID_IDENTIFIER_VALUE error response | | Invalid identifier system | `identifier=https://fhir.nhs.uk/Id/nhs-number/9730675929` | HTTP Status 422 and INVALID_IDENTIFIER_SYSTEM error response | | No performer record found | `identifier=9000000999` | HTTP Status 404 and INVALIDATED_RESOURCE error response | | GP Practice not found | `identifier=9000000012` | HTTP Status 404 and GP_PRACTICE_NOT_FOUND error response | ### Sandbox constraints The sandbox environment has the following constraints for this endpoint: - Request headers are not tested. `X-IM1-Connection-Params`, `X-Request-ID` and `X-Correlation-ID` are disregarded. ## Query parameters - `performer:identifier` string, token - `patient:identifier` string, token - `status` string[] - `_include` string[] ## Headers - `Authorization` string, ^Bearer\ [[:ascii:]]+$, required - `X-Request-ID` string, uuid, required - `X-Correlation-ID` string, uuid - `X-IM1-Connection-Params` string ## Response `200` Information successfully returned. ## Other responses - `4XX` — Errors will be returned for the first error encountered in the request. An error occurred as follows: | HTTP status | Error code | Description | | ----------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. | | 404 | `INVALIDATED_RESOURCE` | Resource that has been marked as invalid was requested - invalid resources cannot be retrieved | | 404 | `GP_PRACTICE_NOT_FOUND` | GP Practice not found. | | 405 | `METHOD_NOT_ALLOWED` | The method is not allowed. | | 408 | `TIMEOUT` | Request timed out. | | 422 | `INVALID_PARAMETER` | Invalid parameter. For details, see the `diagnostics` field. | | 429 | `THROTTLED` | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). | - `5XX` — Errors will be returned for the first error encountered in the request. An error occurred as follows: | HTTP status | Error code | Description | | ----------- | -------------------------- | ------------------------------------------------------------- | | 500 | `SERVER_ERROR` | An unexpected internal server error has occurred. | | 502 | `BAD_GATEWAY` | Connection to the backend service failed. | | 503 | `DOWNSTREAM_SERVICE_ERROR` | A downstream service has failed, request cannot be completed. | ## Changes - **2026-07-14** `aea99a883175` — 2 warning, 4 info - added the new `APPLICATION_REJECTED_PROXY_NOT_LIVING_IN_ENGLAND_OR_WALES` enum value to the `allOf[subschema #3]/entry/items/anyOf[#/components/schemas/ConsentBundleEntry]/resource/allOf[#/components/schemas/Consent]/extension/items/anyOf[#/components/schemas/StatusReasonExtension]/valueCodeableConcept/coding/items/code` response property for the response status `200` - added the new `ROLE_DEACTIVATED_PROXY_NOT_LIVING_IN_ENGLAND_OR_WALES` enum value to the `allOf[subschema #3]/entry/items/anyOf[#/components/schemas/ConsentBundleEntry]/resource/allOf[#/components/schemas/Consent]/extension/items/anyOf[#/components/schemas/StatusReasonExtension]/valueCodeableConcept/coding/items/code` response property for the response status `200` - removed the `APPLICATION_REJECTED_COERCION` enum value from the `allOf[subschema #3]/entry/items/anyOf[#/components/schemas/ConsentBundleEntry]/resource/allOf[#/components/schemas/Consent]/extension/items/anyOf[#/components/schemas/StatusReasonExtension]/valueCodeableConcept/coding/items/code` response property for the response status `200` - removed the `APPLICATION_REJECTED_PROXY_ABROAD` enum value from the `allOf[subschema #3]/entry/items/anyOf[#/components/schemas/ConsentBundleEntry]/resource/allOf[#/components/schemas/Consent]/extension/items/anyOf[#/components/schemas/StatusReasonExtension]/valueCodeableConcept/coding/items/code` response property for the response status `200` - …2 more - …earlier changes not shown [Full history](https://skmtc.dev/nhs/apis/validated-relationships-service-api-2/changes/Consent/get.md) --- [API](https://skmtc.dev/nhs/apis/validated-relationships-service-api-2.md) · [All operations](https://skmtc.dev/nhs/apis/validated-relationships-service-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nhs/validated-relationships-service-api-2/revisions/f212e0c81005/schema)