diff --git a/postman/validated_relationship_service.integration.postman_collection.json b/postman/validated_relationship_service.integration.postman_collection.json index 0fae9ab5..df1bfa7e 100644 --- a/postman/validated_relationship_service.integration.postman_collection.json +++ b/postman/validated_relationship_service.integration.postman_collection.json @@ -1,10794 +1,10794 @@ { - "info": { - "_postman_id": "f3bd080f-9a07-40c2-8d58-cd2f178e7504", - "name": "Validated Relationship Service - Integration - 24/02/26", - "description": "## About the collection\n\nThe collection has been organised by API endpoint - you will find a folder for each one.\n\nWithin those endpoints are requests covering success and error response scenarios.\n\nEach request has at least 1 example against it. This shows the expected response for that request. Some requests have multiple examples showing how the response differs when different parameters are provided.\n\n### Authorization types\n\nWhen you send a request to the Validated Relationship Service, your request will first be authorised by the API Management service (APIM).\n\nThe Validated Relationship Service has 3 types of authorization:\n\n- CIS2 - For healthcare practitioners\n- App-restricted - for service-to-service authorization\n- Login - For patient/proxy access via the NHS App\n \n\nEach VRS API endpoint uses a different combination of these auth types depending on their use case.\n\nYou will need to follow the steps in the 'Getting Started' section below to set the correct authorization tokens for each of these types.\n\nPlease see the folder-level docs for each endpoint for details about what auth types are available to use.\n\n## Getting started\n\n### Environment variables\n\nYou will need to add the following environment variables to the collection.\n\n#### `cis2_token`\n\nAuthorization token value for CIS2 (healthcare practitioner access).\n\n_Only required when using endponts that require this auth method._\n\nThis value can be generated by running the `get_cis2_access_token_int.py` script . See more details in the 'How to create a valid Authorization header' section below.\n\n#### `login_token`\n\nAuthorization token value for NHS Login (patient access).\n\n_Only required when using endponts that require this auth method._\n\nThis value can be generated by running the `get_nhs_login_access_token_int.py` script . See more details in the 'How to create a valid Authorization header' section below.\n\n#### `vrs_api_private_key`\n\n**(This is not the same as the private key in the NHS Developer Account portal.)**\n\nAPI private key for the Validated Relationship Service integration application.\n\n_Only required when using endponts that use the app restricted auth method._\n\nThis value can be copied from the /main/vrs-app-credentials-{id} secret in **AWS Secrets Manager** or requested to be sent securely from a member of the VRS team.\n\n#### `nhs_developer_account_api_key`\n\nAPI app key for the Validated Relationship Service integration application.\n\n_Only required when using endponts that use the app restricted auth method._\n\nThis value can be copied from the NHS - Proxy Core Services - Integration environment resource in the NHS Developer Account portal.\n\n#### `consent_app_auth_header_value` (Generated automatically)\n\nAuthorization token value for app restricted auth.\n\n_Only required when using endponts that use the app restricted auth method._\n\n**You do not need to change this value as it is automatically set in the pre-request script.**\n\n#### `tpp_9674998535_access_token`, `tpp_9674998454_access_token`, `emis_9692113698_access_token,` and `emis_9692113612_access_token`\n\nAuthorization token value for connecting to GPIT supplier systems in NAM tests (Get proxy roles only).\n\n_Only required when running the_ `_Get proxy roles (GET/Consent) Valid request - NAM - Get proxy roles_` _requests._\n\nValues for these environment variables can be found on the [Test data page in Confluence](https://nhsd-confluence.digital.nhs.uk/spaces/NPA/pages/950553445/Test+data+and+accounts+repository+-+NPA#TestdataandaccountsrepositoryNPA-GPITtestaccountsforEXT).\n\n### How to create a valid Authorization header\n\n#### Manually through Python scripts (required for Login and CIS2)\n\n##### Pre-requisites\n\nAccess the token generation scripts from the [validated-relationships-service-api repo](https://github.com/NHSDigital/validated-relationships-service-api/tree/master/scripts):\n\n- get_app_access_token_int.py - for app restricted authorization\n- get_cis2_access_token_int.py - for CIS2 authorization\n- get_nhs_login_access_token_int.py - for Login user authorization\n \n\nSee the [README](https://github.com/NHSDigital/validated-relationships-service-api/tree/master/scripts/README.md) for information about how to run them and what environment variables are needed.\n\n##### Steps\n\n1. Generate bearer tokens for each of the above methods using the provided scripts\n2. Go to the Authorization tab for this Postman request\n3. Select 'Bearer token' from the drop-down\n4. Copy just the 'access_request' value from the script output into the Token field. You do **not** need to add the word 'bearer' before the value.\n \n\nTokens expire every 5 minutes. Once expired, you will receive an 'Unauthorised' response from the API endpoints. At this point, a new token will need to be generated by repeating the above steps.\n\n#### Automatically through pre-request script (for App-restricted)\n\nA pre-request script has been added to the endpoints where app-restricted auth can be used to obtain app-restricted tokens automatically. For this to work, you will need to add values for the following environment variables:\n\n- `private_key`\n- `api_key`\n \n\nIf those values are set and valid, then no further action is required.\n\n## Running a request\n\nOnce you have completed the above 'Getting Started' steps you will be able to send requests by either clicking the 'Send' button on each request, or the 'Try' button on each example.\n\nThe pre-prod environments are not constricted to just the requests provided in this collection. Feel free to change and create requests/examples as you require. However, only the test users provided will work in these environments.\n\n## Test data\n\nAll of the requests in the collection use test data and users that have been set up to demonstrate each specific scenario. No sensitive data is stored in this collection.\n\nSee each scenario for information about what test users are being used.", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "_exporter_id": "46399153", - "_collection_link": "https://www.postman.com/leohoward/workspace/vrsa-24-02-2026/collection/46399153-f3bd080f-9a07-40c2-8d58-cd2f178e7504?action=share&source=collection_link&creator=46399153" - }, - "item": [ - { - "name": "Get proxy roles (GET /Consent)", - "item": [ - { - "name": "Valid request - NPS - Get proxy roles for performer", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - }, - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898148", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898148" - } - ] - }, - "description": "This request and its examples will only retrieve proxy roles from the National Proxy Store and not directly from GPIT suppliers via NAM.\n\nSee folder-level docs for more info.\n\n## Example scenario\n\n**Given** proxy roles exist for a performer (proxy) in the National Proxy Store (NPS) \n**When** a GET /Consent request is sent with the performer identifier \n**Then** the proxy roles in NPS are returned\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." - }, - "response": [ - { - "name": "Proxy roles returned - No patient or grantee details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "1c190795-98fc-40d0-b13d-4b566650950a", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "3bedabd0-b86f-4d7b-92d9-94f020b4a834", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898148", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898148" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 10:48:19 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "3486" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "cf3a99a3-7592-4968-893c-e443d6cb27c8" - }, - { - "key": "x-amz-apigw-id", - "value": "VD0FoHiurPEFXqQ=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-693166f0-1bb8c61dd3aa101687d0b754" - }, - { - "key": "X-Request-ID", - "value": "d3ec5ec8-088f-4db6-8342-1a21d2a2af16" - }, - { - "key": "X-Correlation-ID", - "value": "656bfa49-711b-48c4-9427-1ed8fa34260f" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T10:48:19Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898148\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"resource\": {\n \"id\": \"7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:46:27Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"resource\": {\n \"id\": \"b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:47:43Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy roles returned - Include patient details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898148&_include=Consent:patient", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898148" - }, - { - "key": "_include", - "value": "Consent:patient" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 10:50:25 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "6923" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "edd035fd-2cdb-4c7a-a55c-a55e6faf5743" - }, - { - "key": "x-amz-apigw-id", - "value": "VD0ZXFA2LPEFYqg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6931676e-74035c00139aae000a60b5d7" - }, - { - "key": "X-Request-ID", - "value": "64b0f06f-a35e-44bb-baf4-33de94895236" - }, - { - "key": "X-Correlation-ID", - "value": "6a95b411-9936-49bb-bbcb-8e6776417762" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T10:50:25Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898148&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"resource\": {\n \"id\": \"7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:46:27Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"resource\": {\n \"id\": \"b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:47:43Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898644\",\n \"resource\": {\n \"id\": \"9736898644\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"29706100\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"gDmhc\",\n \"line\": [\n \"BRAMBLE COTTAGE\",\n \"OLD VICARAGE PARK\",\n \"SCAWBY\",\n \"BRIGG\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2021-09-10\"\n },\n \"postalCode\": \"DN20 9RL\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2015-09-26\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"gDHTb\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2018-08-22\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898717\",\n \"resource\": {\n \"id\": \"9736898717\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"16654057\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"YoGEf\",\n \"line\": [\n \"GLENVILLE\",\n \"FERRY ROAD\",\n \"GOXHILL\",\n \"BARROW-UPON-HUMBER\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2016-04-09\"\n },\n \"postalCode\": \"DN19 7JY\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2010-05-31\",\n \"gender\": \"male\",\n \"generalPractitioner\": [\n {\n \"id\": \"bYoHa\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2016-02-12\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n ],\n \"name\": [\n {\n \"family\": \"CASH\",\n \"given\": [\n \"Jacob\",\n \"Chas\"\n ],\n \"period\": {\n \"start\": \"2025-07-22\"\n },\n \"prefix\": [\n \"MR\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy roles returned - Include grantee details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898148&_include=Consent:grantee", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898148" - }, - { - "key": "_include", - "value": "Consent:grantee" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 10:50:45 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "5289" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "60649be0-6363-4601-b792-d631af45a966" - }, - { - "key": "x-amz-apigw-id", - "value": "VD0cyFTYLPEF-Fg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316784-cee1c757e6d4e43fb4837684" - }, - { - "key": "X-Request-ID", - "value": "8a113b57-8af9-4d34-b300-100c84059319" - }, - { - "key": "X-Correlation-ID", - "value": "a3683a8c-6172-44a7-8410-0e78a705907b" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T10:50:45Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898148&_include=Consent%3Agrantee\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"resource\": {\n \"id\": \"7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:46:27Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"resource\": {\n \"id\": \"b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:47:43Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/ZfgKO\",\n \"resource\": {\n \"id\": \"ZfgKO\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/UwTCq\",\n \"resource\": {\n \"id\": \"UwTCq\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy roles returned - Include patient and grantee details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898148&_include=Consent:grantee&_include=Consent:patient", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898148" - }, - { - "key": "_include", - "value": "Consent:grantee" - }, - { - "key": "_include", - "value": "Consent:patient" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 10:51:06 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "8726" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "2b36e22f-2649-44c9-b3ce-929ea840df0f" - }, - { - "key": "x-amz-apigw-id", - "value": "VD0gJFjQLPEF_Ew=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6931679a-aa7dfa232b694d8fdbd9823f" - }, - { - "key": "X-Request-ID", - "value": "d5743541-7330-4347-b9c7-9067feb4b144" - }, - { - "key": "X-Correlation-ID", - "value": "af030657-aad8-45f4-9c70-85e4755a189f" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T10:51:06Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898148&_include=Consent%3Agrantee&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"resource\": {\n \"id\": \"7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:46:27Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"resource\": {\n \"id\": \"b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:47:43Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898644\",\n \"resource\": {\n \"id\": \"9736898644\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"29706100\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"gDmhc\",\n \"line\": [\n \"BRAMBLE COTTAGE\",\n \"OLD VICARAGE PARK\",\n \"SCAWBY\",\n \"BRIGG\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2021-09-10\"\n },\n \"postalCode\": \"DN20 9RL\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2015-09-26\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"gDHTb\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2018-08-22\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898717\",\n \"resource\": {\n \"id\": \"9736898717\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"16654057\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"YoGEf\",\n \"line\": [\n \"GLENVILLE\",\n \"FERRY ROAD\",\n \"GOXHILL\",\n \"BARROW-UPON-HUMBER\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2016-04-09\"\n },\n \"postalCode\": \"DN19 7JY\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2010-05-31\",\n \"gender\": \"male\",\n \"generalPractitioner\": [\n {\n \"id\": \"bYoHa\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2016-02-12\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n ],\n \"name\": [\n {\n \"family\": \"CASH\",\n \"given\": [\n \"Jacob\",\n \"Chas\"\n ],\n \"period\": {\n \"start\": \"2025-07-22\"\n },\n \"prefix\": [\n \"MR\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/ZfgKO\",\n \"resource\": {\n \"id\": \"ZfgKO\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/UwTCq\",\n \"resource\": {\n \"id\": \"UwTCq\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy roles returned - Filtered by status 'inactive'", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898156&status=inactive", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898156" - }, - { - "key": "status", - "value": "inactive" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:09:14 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "1888" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "290a4ffd-6021-435c-af76-8d6c80492b72" - }, - { - "key": "x-amz-apigw-id", - "value": "VD3JoHOkrPEFSoA=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316bd6-5bd69e7021cf6e4e0696d153" - }, - { - "key": "X-Request-ID", - "value": "8b8298dc-a9a4-4257-a6b9-f99d5ff65983" - }, - { - "key": "X-Correlation-ID", - "value": "5af5dfe2-b247-4624-8268-bb4e78593eb3" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:09:14Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898156&status=inactive\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/750cb586-eb9b-46c7-a1a5-711307a087af\",\n \"resource\": {\n \"id\": \"750cb586-eb9b-46c7-a1a5-711307a087af\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:55:53Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898652\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2025-12-05\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"inactive\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy roles returned - Filtered by status 'active' and include patient and grantee details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898156&status=active&_include=Consent:grantee&_include=Consent:patient", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898156" - }, - { - "key": "status", - "value": "active" - }, - { - "key": "_include", - "value": "Consent:grantee" - }, - { - "key": "_include", - "value": "Consent:patient" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:09:41 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "4528" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "44c6f0cf-6bdb-4b96-8889-55ebe68b8c60" - }, - { - "key": "x-amz-apigw-id", - "value": "VD3M5FGYrPEFZVg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316beb-f2f5e05791f831ed34fb0afa" - }, - { - "key": "X-Request-ID", - "value": "73bded49-9645-4418-bf08-ebd13d92c2a1" - }, - { - "key": "X-Correlation-ID", - "value": "15b5d9d5-9909-458a-91c5-64ee20e93a01" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:09:40Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898156&status=active&_include=Consent%3Agrantee&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"resource\": {\n \"id\": \"4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:08:46Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-12-05\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898660\",\n \"resource\": {\n \"id\": \"9736898660\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"19976537\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"pBQDr\",\n \"line\": [\n \"CARLTON\",\n \"VICARAGE LANE\",\n \"REDBOURNE\",\n \"GAINSBOROUGH\",\n \"LINCS\"\n ],\n \"period\": {\n \"start\": \"2025-07-15\"\n },\n \"postalCode\": \"DN21 4QW\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2012-04-24\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"xSEnH\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2024-11-06\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n ],\n \"name\": [\n {\n \"family\": \"GODREY\",\n \"given\": [\n \"Davina\",\n \"Linda\"\n ],\n \"period\": {\n \"start\": \"2017-04-22\"\n },\n \"prefix\": [\n \"MISS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/nVLgl\",\n \"resource\": {\n \"id\": \"nVLgl\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - } - ] - }, - { - "name": "Valid request - NPS - Get proxy roles for patient", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - }, - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?patient:identifier=9736898644", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "patient:identifier", - "value": "9736898644" - } - ] - }, - "description": "This request and its examples will only retrieve proxy roles from the National Proxy Store and not directly from GPIT suppliers via NAM.\n\nSee folder level docs for more info.\n\n## Example scenario\n\n**Given** proxy roles exist for a patient in the National Proxy Store (NPS) \n**When** a GET /Consent request is sent with the patient identifier \n**Then** the proxy roles in NPS are returned\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." - }, - "response": [ - { - "name": "Proxy roles returned - No patient or grantee details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "a8fe6a8d-44c5-4451-b8e8-5cf5adc2db03", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "43c2ad8f-43a2-4cfc-8d3a-2b4298ab2b6d", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?patient:identifier=9736898644", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "patient:identifier", - "value": "9736898644" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:17:19 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "3484" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "cd84643e-5789-445f-9d2f-eb53fe6b57c5" - }, - { - "key": "x-amz-apigw-id", - "value": "VD4VeEsnLPEFmxA=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316dbc-851b7fe822d672bb07d0be6d" - }, - { - "key": "X-Request-ID", - "value": "b7120974-233d-4634-80e2-f404e817f80b" - }, - { - "key": "X-Correlation-ID", - "value": "73e7ab39-f339-4f53-8090-d4320c6a1fc5" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:17:19Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient%3Aidentifier=9736898644\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"resource\": {\n \"id\": \"7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:46:27Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"resource\": {\n \"id\": \"553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:15:26Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy roles returned - Include grantee details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?patient:identifier=9736898644&_include=Consent:grantee", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "patient:identifier", - "value": "9736898644" - }, - { - "key": "_include", - "value": "Consent:grantee" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:17:45 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "5287" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "d6ea589d-359b-43a5-ac3d-6b570eec9cac" - }, - { - "key": "x-amz-apigw-id", - "value": "VD4YuGlSLPEF7zw=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316dd1-47a064ac1a1d588355c13564" - }, - { - "key": "X-Request-ID", - "value": "eb00dad3-5e15-4ade-8ee9-f3597bfab4d3" - }, - { - "key": "X-Correlation-ID", - "value": "a496e8bd-c333-4e87-9927-bbe9ead436a4" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:17:45Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient%3Aidentifier=9736898644&_include=Consent%3Agrantee\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"resource\": {\n \"id\": \"7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:46:27Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"resource\": {\n \"id\": \"553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:15:26Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/ZfgKO\",\n \"resource\": {\n \"id\": \"ZfgKO\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/EAONj\",\n \"resource\": {\n \"id\": \"EAONj\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy roles returned - Include patient details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?patient:identifier=9736898644&_include=Consent:patient", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "patient:identifier", - "value": "9736898644" - }, - { - "key": "_include", - "value": "Consent:patient" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:18:02 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "5218" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "3a81d012-80ef-4350-8d7b-1f8cda1ef809" - }, - { - "key": "x-amz-apigw-id", - "value": "VD4cPGnErPEFYsw=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316de7-bb724d308ffa3272269bfba9" - }, - { - "key": "X-Request-ID", - "value": "ada44c4a-9dcc-4666-a97e-72ebce5630a8" - }, - { - "key": "X-Correlation-ID", - "value": "cfa6112c-4235-41a4-9e58-f4f04d4f7614" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:18:02Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient%3Aidentifier=9736898644&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"resource\": {\n \"id\": \"7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:46:27Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"resource\": {\n \"id\": \"553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:15:26Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898644\",\n \"resource\": {\n \"id\": \"9736898644\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"29706100\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"gDmhc\",\n \"line\": [\n \"BRAMBLE COTTAGE\",\n \"OLD VICARAGE PARK\",\n \"SCAWBY\",\n \"BRIGG\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2021-09-10\"\n },\n \"postalCode\": \"DN20 9RL\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2015-09-26\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"gDHTb\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2018-08-22\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy roles returned - Include patient and grantee details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?patient:identifier=9736898644&_include=Consent:grantee&_include=Consent:patient", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "patient:identifier", - "value": "9736898644" - }, - { - "key": "_include", - "value": "Consent:grantee" - }, - { - "key": "_include", - "value": "Consent:patient" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:18:17 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "7021" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "013f49d1-ffbe-4880-bfd6-1b92d13d08a3" - }, - { - "key": "x-amz-apigw-id", - "value": "VD4evE6yLPEFZZA=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316df7-175910d69cd894708a0921b9" - }, - { - "key": "X-Request-ID", - "value": "9ce9a6d5-2bd2-4d5e-a984-2c78a457f4d4" - }, - { - "key": "X-Correlation-ID", - "value": "02eabdf7-0a76-4fec-9c99-306273ea8da5" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:18:17Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient%3Aidentifier=9736898644&_include=Consent%3Agrantee&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"resource\": {\n \"id\": \"7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:46:27Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"resource\": {\n \"id\": \"553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:15:26Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898644\",\n \"resource\": {\n \"id\": \"9736898644\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"29706100\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"gDmhc\",\n \"line\": [\n \"BRAMBLE COTTAGE\",\n \"OLD VICARAGE PARK\",\n \"SCAWBY\",\n \"BRIGG\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2021-09-10\"\n },\n \"postalCode\": \"DN20 9RL\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2015-09-26\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"gDHTb\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2018-08-22\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/ZfgKO\",\n \"resource\": {\n \"id\": \"ZfgKO\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/EAONj\",\n \"resource\": {\n \"id\": \"EAONj\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy roles returned - Filtered by status 'inactive'", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?patient:identifier=9736898717&status=inactive", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "patient:identifier", - "value": "9736898717" - }, - { - "key": "status", - "value": "inactive" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:18:37 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "1886" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "595418c1-5c22-46b6-907c-e799e9fdf609" - }, - { - "key": "x-amz-apigw-id", - "value": "VD4iFHTWLPEFnHA=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316e0c-b334c67c9e4d72fd5809672a" - }, - { - "key": "X-Request-ID", - "value": "e6ad06af-45a7-4f98-92c2-88300871c3bc" - }, - { - "key": "X-Correlation-ID", - "value": "8d75c837-bd9e-4784-ac40-84322ee4d188" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:18:37Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient%3Aidentifier=9736898717&status=inactive\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/cf7bc8e6-f8e0-41c5-8d08-1741eee5a256\",\n \"resource\": {\n \"id\": \"cf7bc8e6-f8e0-41c5-8d08-1741eee5a256\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:16:43Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"inactive\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy roles returned - Filtered by status 'active' and include patient and grantee details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?patient:identifier=9736898717&status=active&_include=Consent:grantee&_include=Consent:patient", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "patient:identifier", - "value": "9736898717" - }, - { - "key": "status", - "value": "active" - }, - { - "key": "_include", - "value": "Consent:grantee" - }, - { - "key": "_include", - "value": "Consent:patient" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:18:51 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "4528" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "bd5079fb-1fc3-428c-ab53-5ba1dfacc510" - }, - { - "key": "x-amz-apigw-id", - "value": "VD4kRHuoLPEF-DQ=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316e1a-0dc7c19d64d48ad8a86c4518" - }, - { - "key": "X-Request-ID", - "value": "8da5a25e-ef8b-4cec-84c0-81af22e5132f" - }, - { - "key": "X-Correlation-ID", - "value": "ce7840a8-db71-4897-9853-d06c699adca9" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:18:51Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient%3Aidentifier=9736898717&status=active&_include=Consent%3Agrantee&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"resource\": {\n \"id\": \"b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:47:43Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898717\",\n \"resource\": {\n \"id\": \"9736898717\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"16654057\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"YoGEf\",\n \"line\": [\n \"GLENVILLE\",\n \"FERRY ROAD\",\n \"GOXHILL\",\n \"BARROW-UPON-HUMBER\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2016-04-09\"\n },\n \"postalCode\": \"DN19 7JY\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2010-05-31\",\n \"gender\": \"male\",\n \"generalPractitioner\": [\n {\n \"id\": \"bYoHa\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2016-02-12\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n ],\n \"name\": [\n {\n \"family\": \"CASH\",\n \"given\": [\n \"Jacob\",\n \"Chas\"\n ],\n \"period\": {\n \"start\": \"2025-07-22\"\n },\n \"prefix\": [\n \"MR\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/UwTCq\",\n \"resource\": {\n \"id\": \"UwTCq\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - } - ] - }, - { - "name": "Valid request - NPS - Get proxy roles for patient and proxy", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - }, - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898121&patient:identifier=9736898644", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898121" - }, - { - "key": "patient:identifier", - "value": "9736898644" - } - ] - }, - "description": "This request and its examples will only retrieve proxy roles from the National Proxy Store and not directly from GPIT suppliers via NAM.\n\nSee folder level docs for more info.\n\n## Example scenario\n\n**Given** proxy roles exist for a patient in the National Proxy Store (NPS) \n**When** a GET /Consent request is sent with the performer and patient identifier \n**Then** a single proxy role from NPS is returned\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." - }, - "response": [ - { - "name": "Proxy roles returned - No patient or grantee details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "4d896833-170b-4dc9-a455-66db155cb5c1", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "1525b9dd-abde-44c0-a226-c93af7e47d8e", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898121&patient:identifier=9736898644", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898121" - }, - { - "key": "patient:identifier", - "value": "9736898644" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:19:27 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "1902" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "3d56eb4c-4bc0-47d8-bc61-a55b098dfd9c" - }, - { - "key": "x-amz-apigw-id", - "value": "VD4p_GRgrPEFVPA=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316e3f-6ddd811fdb997165b9c6a0d5" - }, - { - "key": "X-Request-ID", - "value": "f8ac2f03-2a5f-4ff7-8ada-093f55fb9c38" - }, - { - "key": "X-Correlation-ID", - "value": "8fc4ed98-4b94-41e1-bff0-0065b6058201" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:19:27Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898121&patient%3Aidentifier=9736898644\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"resource\": {\n \"id\": \"553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:15:26Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy roles returned - Include grantee details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898121&patient:identifier=9736898644&_include=Consent:grantee", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898121" - }, - { - "key": "patient:identifier", - "value": "9736898644" - }, - { - "key": "_include", - "value": "Consent:grantee" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:19:44 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "2818" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "12da5c87-c8eb-4085-ad09-ab9df3923150" - }, - { - "key": "x-amz-apigw-id", - "value": "VD4slFJ5rPEF6Mg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316e50-a15563e078d9633ab0d45fb6" - }, - { - "key": "X-Request-ID", - "value": "51afba5e-eea1-415e-a0c3-bc5d47e884fd" - }, - { - "key": "X-Correlation-ID", - "value": "c31bc807-8bc9-4aa5-b531-f44fbfeeef0c" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:19:44Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898121&patient%3Aidentifier=9736898644&_include=Consent%3Agrantee\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"resource\": {\n \"id\": \"553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:15:26Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/EAONj\",\n \"resource\": {\n \"id\": \"EAONj\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy roles returned - Include patient details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898121&patient:identifier=9736898644&_include=Consent:patient", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898121" - }, - { - "key": "patient:identifier", - "value": "9736898644" - }, - { - "key": "_include", - "value": "Consent:patient" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:19:57 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "3636" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "341e64dd-974f-4307-a16b-e775c0777fdd" - }, - { - "key": "x-amz-apigw-id", - "value": "VD4uhGhjLPEF8-A=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316e5c-16469b05761a5ee0d5ffe220" - }, - { - "key": "X-Request-ID", - "value": "2762b971-bfcc-42c6-be87-b2d2a98cf5b5" - }, - { - "key": "X-Correlation-ID", - "value": "94e42484-2c4d-46fc-8364-027c06a21798" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:19:56Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898121&patient%3Aidentifier=9736898644&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"resource\": {\n \"id\": \"553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:15:26Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898644\",\n \"resource\": {\n \"id\": \"9736898644\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"29706100\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"gDmhc\",\n \"line\": [\n \"BRAMBLE COTTAGE\",\n \"OLD VICARAGE PARK\",\n \"SCAWBY\",\n \"BRIGG\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2021-09-10\"\n },\n \"postalCode\": \"DN20 9RL\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2015-09-26\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"gDHTb\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2018-08-22\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy roles returned - Include patient and grantee details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898121&patient:identifier=9736898644&_include=Consent:grantee&_include=Consent:patient", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898121" - }, - { - "key": "patient:identifier", - "value": "9736898644" - }, - { - "key": "_include", - "value": "Consent:grantee" - }, - { - "key": "_include", - "value": "Consent:patient" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:20:24 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "4552" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "306d5243-752e-45e4-9c44-f175a008c1de" - }, - { - "key": "x-amz-apigw-id", - "value": "VD4y2Gg1rPEFcxQ=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316e78-df1338116d16a7272e1de2dc" - }, - { - "key": "X-Request-ID", - "value": "b05f7a59-c008-47d8-868c-011cbdf17500" - }, - { - "key": "X-Correlation-ID", - "value": "95f4ebb0-274e-4757-91f3-91a5fc0a3f0f" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:20:24Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898121&patient%3Aidentifier=9736898644&_include=Consent%3Agrantee&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"resource\": {\n \"id\": \"553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:15:26Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898644\",\n \"resource\": {\n \"id\": \"9736898644\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"29706100\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"gDmhc\",\n \"line\": [\n \"BRAMBLE COTTAGE\",\n \"OLD VICARAGE PARK\",\n \"SCAWBY\",\n \"BRIGG\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2021-09-10\"\n },\n \"postalCode\": \"DN20 9RL\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2015-09-26\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"gDHTb\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2018-08-22\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/EAONj\",\n \"resource\": {\n \"id\": \"EAONj\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy roles returned - Filtered by status 'inactive'", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898156&patient:identifier=9736898652&status=inactive", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898156" - }, - { - "key": "patient:identifier", - "value": "9736898652" - }, - { - "key": "status", - "value": "inactive" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:21:09 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "1920" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "24bfc7a0-5f30-47b4-a751-7534837f5224" - }, - { - "key": "x-amz-apigw-id", - "value": "VD455ErXrPEFuaQ=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316ea5-6c272d90a7d3656142da3073" - }, - { - "key": "X-Request-ID", - "value": "67a71930-24b3-4baa-8b13-65f27c413a41" - }, - { - "key": "X-Correlation-ID", - "value": "dd934795-88bf-44a3-a2c3-eff757413bfb" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:21:09Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898156&patient%3Aidentifier=9736898652&status=inactive\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/750cb586-eb9b-46c7-a1a5-711307a087af\",\n \"resource\": {\n \"id\": \"750cb586-eb9b-46c7-a1a5-711307a087af\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:55:53Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898652\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2025-12-05\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"inactive\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy roles returned - Filtered by status 'active' and include patient and grantee details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "some_token;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898156&patient:identifier=9736898652&status=active&_include=Consent:grantee&_include=Consent:patient", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898156" - }, - { - "key": "patient:identifier", - "value": "9736898652" - }, - { - "key": "status", - "value": "active" - }, - { - "key": "_include", - "value": "Consent:grantee" - }, - { - "key": "_include", - "value": "Consent:patient" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:21:28 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "2038" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "f44b69f0-f814-4e0f-89eb-349f1f7e143d" - }, - { - "key": "x-amz-apigw-id", - "value": "VD48uEKHLPEF67A=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316eb7-00b15aebe653e94192bc60ee" - }, - { - "key": "X-Request-ID", - "value": "8f40b74e-99fa-4401-bcf1-def08a63da50" - }, - { - "key": "X-Correlation-ID", - "value": "1460d166-ba8d-4d1c-8822-83394abe1169" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:21:27Z\",\n \"total\": 0,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898156&patient%3Aidentifier=9736898652&status=active&_include=Consent%3Agrantee&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898652\",\n \"resource\": {\n \"id\": \"9736898652\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"6290975\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"RPnzd\",\n \"line\": [\n \"77 ANGERSTEIN ROAD\",\n \"SCUNTHORPE\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2019-11-10\"\n },\n \"postalCode\": \"DN17 2NB\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2013-09-02\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"yIjPV\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2021-01-07\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898652\"\n }\n ],\n \"name\": [\n {\n \"family\": \"CLYDE\",\n \"given\": [\n \"Deanne\",\n \"Tara\"\n ],\n \"period\": {\n \"start\": \"2018-06-16\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - } - ] - }, - { - "name": "Valid request - NAM - Get proxy roles", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - }, - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "{{tpp_9674998535_access_token}};A82648", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=false;nam-cache-enabled=false;nam-enabled=true;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9674998535", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9674998535" - } - ] - }, - "description": "This request and its examples will only retrieve proxy roles directly from GPIT suppliers via NAM and not from the National Proxy Store.\n\nSee folder level docs for more info.\n\n## Example scenario\n\n**Given** proxy roles exist for a patient/performer in a GPIT system \n**And** no proxy roles exist in the National Proxy Store (NPS) for the patient/performer \n**When** a GET /Consent request is sent with the performer/patient identifier \n**Then** the proxy roles from GPIT are returned\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." - }, - "response": [ - { - "name": "No linked profiles returned from NAM - TPP user", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "83892b1a-6369-4657-a0c3-f6071a25e226", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "b496d552-f0c3-4e20-b362-cfc0c80724e3", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "{{tpp_9674998535_access_token}};A82648", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=false;nam-cache-enabled=false;nam-enabled=true;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9674998535&_include=Consent:grantee&_include=Consent:patient", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9674998535" - }, - { - "key": "_include", - "value": "Consent:grantee" - }, - { - "key": "_include", - "value": "Consent:patient" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:22:00 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "5773" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "94465816-7aaa-4d03-81c9-e19156606316" - }, - { - "key": "x-amz-apigw-id", - "value": "VD5BAEGOLPEFVPA=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316ed8-af72bfe69942b25c155a4daa" - }, - { - "key": "X-Request-ID", - "value": "ed28025a-9c27-468c-85fd-9b1b8f794198" - }, - { - "key": "X-Correlation-ID", - "value": "fbd025d4-c7e1-4085-8bf8-d11b84652f8d" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:22:00Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9674998535&_include=Consent%3Agrantee&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/3a86ad92\",\n \"resource\": {\n \"id\": \"3a86ad92\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998535\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:21:58.915488+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9692113736\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998535\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/5c0c47d9\",\n \"resource\": {\n \"id\": \"5c0c47d9\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998535\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:21:58.915640+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998454\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998535\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/0b36c4e0\",\n \"resource\": {\n \"id\": \"0b36c4e0\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998535\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9692113736\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/bd6da0a0\",\n \"resource\": {\n \"id\": \"bd6da0a0\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998535\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998454\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/e41dfa63\",\n \"resource\": {\n \"id\": \"e41dfa63\",\n \"meta\": {\n \"profile\": [\n \"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient\"\n ],\n \"security\": [\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ]\n },\n \"birthDate\": \"1985-05-29\",\n \"generalPractitioner\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A82648\"\n }\n }\n ],\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9692113736\"\n }\n ],\n \"name\": [\n {\n \"text\": \"Mr Kevin Barry\",\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/2d10a3d9\",\n \"resource\": {\n \"id\": \"2d10a3d9\",\n \"meta\": {\n \"profile\": [\n \"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient\"\n ],\n \"security\": [\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ]\n },\n \"birthDate\": \"1921-10-17\",\n \"generalPractitioner\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A82648\"\n }\n }\n ],\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998454\"\n }\n ],\n \"name\": [\n {\n \"text\": \"Mr Landon Fahey\",\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - }, - { - "name": "Linked profiles returned from NAM - TPP user", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "{{tpp_9674998454_access_token}};A82648", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=false;nam-cache-enabled=false;nam-enabled=true;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9674998454&_include=Consent:patient", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9674998454" - }, - { - "key": "_include", - "value": "Consent:patient" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:22:15 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "4370" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "1b190446-e56f-4a64-8c54-25688af8f8f7" - }, - { - "key": "x-amz-apigw-id", - "value": "VD5EAFv1rPEF7zw=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316ee6-9925773ab605850282f2d18c" - }, - { - "key": "X-Request-ID", - "value": "dfa182c6-8f6a-46e9-bdc1-1ef5a00740c1" - }, - { - "key": "X-Correlation-ID", - "value": "d50ce1da-c025-451c-847e-c405c299115f" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:22:15Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9674998454&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/92a66114\",\n \"resource\": {\n \"id\": \"92a66114\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998454\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:22:15.290954+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998640\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998454\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/0b02be0a\",\n \"resource\": {\n \"id\": \"0b02be0a\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998454\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:22:15.290994+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998543\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998454\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/934bfd54\",\n \"resource\": {\n \"id\": \"934bfd54\",\n \"meta\": {\n \"profile\": [\n \"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient\"\n ],\n \"security\": [\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ]\n },\n \"birthDate\": \"1998-11-14\",\n \"generalPractitioner\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A82648\"\n }\n }\n ],\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998640\"\n }\n ],\n \"name\": [\n {\n \"text\": \"Mr Harry Hood\",\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/29b6ab39\",\n \"resource\": {\n \"id\": \"29b6ab39\",\n \"meta\": {\n \"profile\": [\n \"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient\"\n ],\n \"security\": [\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ]\n },\n \"birthDate\": \"1930-11-02\",\n \"generalPractitioner\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A82648\"\n }\n }\n ],\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998543\"\n }\n ],\n \"name\": [\n {\n \"text\": \"Miss Lisa Hankey\",\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - }, - { - "name": "No linked profiles returned from NAM - EMIS user", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "{{emis_9692113612_access_token}};A29928", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=false;nam-cache-enabled=false;nam-enabled=true;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9692113612&_include=Consent:patient", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9692113612" - }, - { - "key": "_include", - "value": "Consent:patient" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:22:37 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "283" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "15121c1a-99de-4830-86c7-00925d4faf3a" - }, - { - "key": "x-amz-apigw-id", - "value": "VD5HEE6MLPEFz5w=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316ef9-58a10d83bc130c381cdb0b44" - }, - { - "key": "X-Request-ID", - "value": "1828501c-86dc-4baf-9a13-e37a822e327f" - }, - { - "key": "X-Correlation-ID", - "value": "b891fe97-7778-4db5-be39-b23c03879d2d" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:22:36Z\",\n \"total\": 0,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9692113612&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": []\n}" - }, - { - "name": "Linked profiles returned from NAM - EMIS user", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "{{emis_9692113698_access_token}};A00002", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=false;nam-cache-enabled=false;nam-enabled=true;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9692113698&_include=Consent:grantee", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9692113698" - }, - { - "key": "_include", - "value": "Consent:patient", - "disabled": true - }, - { - "key": "_include", - "value": "Consent:grantee" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:24:08 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "17617" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "739313dc-9917-4df2-9b9d-e59bf36d8c4e" - }, - { - "key": "x-amz-apigw-id", - "value": "VD5U-FHkLPEF0fw=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69316f52-1205235fe7d41983ba807831" - }, - { - "key": "X-Request-ID", - "value": "2eb98c87-f421-4902-a885-ecc408bd8d89" - }, - { - "key": "X-Correlation-ID", - "value": "4ac19b94-25d4-4de6-9be6-fe5a4a520d15" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:24:08Z\",\n \"total\": 9,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9692113698&_include=Consent%3Agrantee\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/2993b769\",\n \"resource\": {\n \"id\": \"2993b769\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874676+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9661034451\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/c0d48822\",\n \"resource\": {\n \"id\": \"c0d48822\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874715+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998403\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/75d0c9dc\",\n \"resource\": {\n \"id\": \"75d0c9dc\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874739+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9661034400\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/2bed6c1e\",\n \"resource\": {\n \"id\": \"2bed6c1e\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874762+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9661034168\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/ed77c791\",\n \"resource\": {\n \"id\": \"ed77c791\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874785+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9253046414\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/02e9fe06\",\n \"resource\": {\n \"id\": \"02e9fe06\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874807+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9930725970\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/70f274ba\",\n \"resource\": {\n \"id\": \"70f274ba\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874830+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9803007025\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/87501704\",\n \"resource\": {\n \"id\": \"87501704\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874852+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9734615173\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/022a7290\",\n \"resource\": {\n \"id\": \"022a7290\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874874+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9694154065\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/4931d7ae\",\n \"resource\": {\n \"id\": \"4931d7ae\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9661034451\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/34e6ba88\",\n \"resource\": {\n \"id\": \"34e6ba88\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998403\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/1b0f7204\",\n \"resource\": {\n \"id\": \"1b0f7204\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9661034400\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/7115d670\",\n \"resource\": {\n \"id\": \"7115d670\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9661034168\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/63bd0423\",\n \"resource\": {\n \"id\": \"63bd0423\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9253046414\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/04683858\",\n \"resource\": {\n \"id\": \"04683858\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9930725970\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/e0cff956\",\n \"resource\": {\n \"id\": \"e0cff956\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9803007025\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/a9f54c1c\",\n \"resource\": {\n \"id\": \"a9f54c1c\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9734615173\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/8b794ba5\",\n \"resource\": {\n \"id\": \"8b794ba5\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9694154065\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - } - ] - }, - { - "name": "Valid request - No proxy roles returned - Get proxy roles", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - }, - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?patient:identifier=9736898199", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "patient:identifier", - "value": "9736898199" - } - ] - }, - "description": "## Example scenario\n\n**Given** no proxy roles exist for a patient/performer in NPS or GPIT systems \n**When** a GET /Consent request is sent with the performer/patient identifier \n**Then** no proxy roles are returned\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." - }, - "response": [ - { - "name": "No roles returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "b8b052ae-6841-4b64-bdf0-c969d32d94bd", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "e9920101-1ae7-4644-8ae9-5298f7bdda3b", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?patient:identifier=9736898199", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "patient:identifier", - "value": "9736898199" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Thu, 27 Nov 2025 15:20:11 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "254" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "62f7a9ef-477a-4a24-8bba-c3da1f684805" - }, - { - "key": "x-amz-apigw-id", - "value": "UtXWqH7MLPEFkaw=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69286c2a-60c4f8c5c094e6753e2352ce" - }, - { - "key": "X-Request-ID", - "value": "31683198-4901-4516-8522-baf7a3de343a" - }, - { - "key": "X-Correlation-ID", - "value": "bdc29a81-c2c3-4622-b1cb-6b0d939ef622" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2025-11-27T15:20:11Z\",\n \"total\": 0,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient%3Aidentifier=9736898199\"\n }\n ],\n \"entry\": []\n}" - } - ] - }, - { - "name": "Invalid status parameter - Get proxy roles", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?patient:identifier=9736898199&status=test", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "patient:identifier", - "value": "9736898199" - }, - { - "key": "status", - "value": "test" - } - ] - }, - "description": "## Example scenario\n\n**Given** proxy roles exist for a patient/performer in NPS or a GPIT system \n**When** a GET /Consent request is sent with an invalid status parameter \n**Then** a 422 error is returned with the detail 'Required parameter(s) are invalid.'\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." - }, - "response": [ - { - "name": "Invalid status parameter error returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "dcc26889-b2fe-4794-9531-88c887f7e134", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "91e70db5-6a5d-4382-bfc1-027d2b81bc3c", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?patient:identifier=9736898199&status=test", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "patient:identifier", - "value": "9736898199" - }, - { - "key": "status", - "value": "test" - } - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Thu, 27 Nov 2025 16:45:57 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "375" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "072d3fa4-9703-4b80-88ba-e679c01b3129" - }, - { - "key": "x-amz-apigw-id", - "value": "Utj6vHGjLPEFvyQ=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69288044-9a8fa9560202aeb1b9390e51" - }, - { - "key": "X-Request-ID", - "value": "0437a831-fa18-43ca-a376-21b2a8f33900" - }, - { - "key": "X-Correlation-ID", - "value": "8cf2b8d1-d98e-4b93-bb62-34583b31f0ea" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_PARAMETER\",\n \"display\": \"Required parameter(s) are invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Invalid request with error - status parameter is invalid.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Invalid include parameter - Get proxy roles", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898148&_include=Consent:test", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898148" - }, - { - "key": "_include", - "value": "Consent:test" - } - ] - }, - "description": "## Gherkin scenario\n\n**Given** proxy roles exist for a patient/performer in NPS or a GPIT system \n**When** a GET /Consent request is sent with an invalid include parameter \n**Then** a 422 error is returned with the detail 'Required parameter(s) are invalid.'\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." - }, - "response": [ - { - "name": "Invalid include parameter error returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "b14c0f0f-ad95-45e4-9b2a-9286fb050453", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "e7e0d226-d580-44a6-8688-2aeb0deedf00", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9736898148&_include=Consent:test", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898148" - }, - { - "key": "_include", - "value": "Consent:test" - } - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Thu, 27 Nov 2025 16:46:36 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "377" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "e9f62008-61ec-417a-8231-506b51d07844" - }, - { - "key": "x-amz-apigw-id", - "value": "UtkBAFkIrPEFuvQ=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6928806c-3f5337b27e75f90c703fd6b0" - }, - { - "key": "X-Request-ID", - "value": "fb15a103-bf9a-499e-a7b1-24dc6563eb13" - }, - { - "key": "X-Correlation-ID", - "value": "f5ec5ae0-c762-4efb-95e3-317628c5cd80" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_PARAMETER\",\n \"display\": \"Required parameter(s) are invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Invalid request with error - _include parameter is invalid.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Invalid performer identifier - Get proxy roles", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=90000000", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "90000000" - } - ] - }, - "description": "## Example scenario\n\n**Given** proxy roles exist for a patient/performer in NPS or a GPIT system \n**When** a GET /Consent request is sent with an invalid performer identifier \n**Then** a 422 error is returned with the detail 'Required parameter(s) are invalid.'\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." - }, - "response": [ - { - "name": "Invalid performer identifier returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "6e975672-d1b4-402c-b47d-0994d55e1517", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "268d0936-6ffb-474a-a7bf-f44d4214e36e", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=90000000", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "90000000" - } - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Thu, 27 Nov 2025 16:47:01 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "428" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "2c57ff69-fe19-498b-8163-00b392e47313" - }, - { - "key": "x-amz-apigw-id", - "value": "UtkE-EaXLPEFV9Q=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69288085-dfbdd45a57543fb9bb4ebd8b" - }, - { - "key": "X-Request-ID", - "value": "2d274752-140d-49de-ab31-56012d28c2cb" - }, - { - "key": "X-Correlation-ID", - "value": "7187bca7-8d57-4561-b0f2-a5aba91ec94c" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_IDENTIFIER_VALUE\",\n \"display\": \"Required parameter(s) are invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Invalid request with error - performer:identifier or patient:identifier parameter is invalid.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Invalid performer identifier system - Get proxy roles", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=invalid|9736898199", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "invalid|9736898199" - } - ] - }, - "description": "## Example scenario\n\n**Given** proxy roles exist for a patient/performer in NPS or a GPIT system \n**When** a GET /Consent request is sent with an invalid performer identifier system \n**Then** a 422 error is returned with the detail 'Required parameter(s) are invalid.'\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." - }, - "response": [ - { - "name": "Invalid performer identifier system error returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "995e5222-fce7-40e2-8424-1e920d920491", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "16ec5418-1591-45f7-a84c-e95cbcd5cd67", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=invalid|9736898199", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "invalid|9736898199" - } - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Thu, 27 Nov 2025 16:47:46 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "426" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "8a8529b6-34ac-46b1-8868-0a6ec0440151" - }, - { - "key": "x-amz-apigw-id", - "value": "UtkL-HDVLPEFVxg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-692880b2-6286da8b511f08a6d7ccf9db" - }, - { - "key": "X-Request-ID", - "value": "9cc2d0ef-8f7a-46b7-89c9-c884bf61cc3a" - }, - { - "key": "X-Correlation-ID", - "value": "57948f02-5db0-4267-a6b7-cae30485e5eb" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_IDENTIFIER_SYSTEM\",\n \"display\": \"Required parameter(s) are invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Invalid request with error - performer:identifier or patient:identifier system parameter is invalid.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Missing performer identifier value - Get proxy roles", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ] - }, - "description": "## Example scenario\n\n**Given** proxy roles exist for a patient/performer in NPS or a GPIT system \n**When** a GET /Consent request is sent with an missing performer identifier value \n**Then** a 400 error is returned with the detail 'Required parameter(s) are missing.'\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." - }, - "response": [ - { - "name": "Missing performer identifier value error returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "53b3ca95-ad9d-4cd5-a194-78a42daff0df", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "88aaae3f-7168-4f69-b71a-60641082ab4b", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Thu, 27 Nov 2025 16:48:15 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "417" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "4984ba67-d994-4f08-910e-e25024a8ba57" - }, - { - "key": "x-amz-apigw-id", - "value": "UtkQdERvrPEFrBg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-692880cf-614067cb88aa075eca482015" - }, - { - "key": "X-Request-ID", - "value": "f536a55f-7115-4ab4-a1c9-3049ca919351" - }, - { - "key": "X-Correlation-ID", - "value": "636e5f80-53b3-4bcf-9176-2967325a9e85" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_IDENTIFIER_VALUE\",\n \"display\": \"Required parameter(s) are missing.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Invalid request with error - performer:identifier or patient:identifier parameter not found.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "GP practice not found - Get proxy roles", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=false;nam-cache-enabled=false;nam-enabled=true;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898229", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898229" - } - ] - }, - "description": "## Example scenario\n\n**Given** a performer/patient is not registered at a GP \n**And** the performer/patient has no proxy roles in the National Proxy Store \n**When** a GET /Consent request is sent for the performer/patient \n**Then** a 404 error is returned with the detail 'GP Practice could not be found - invalid resources cannot be retrieved'\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." - }, - "response": [ - { - "name": "GP practice not found error returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "7c22ece1-b0a0-4067-8ad7-56f8bceced93", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "f1b40261-0aa6-44de-8563-3bfcc5813510", - "type": "text" - }, - { - "key": "X-IM1-Connection-Params", - "value": "SomeToken;A20047", - "type": "text" - }, - { - "key": "X-Test-Routing-Flag", - "value": "nps-enabled=false;nam-cache-enabled=false;nam-enabled=true;use-nam-mock=false", - "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent?performer:identifier=9736898229", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ], - "query": [ - { - "key": "performer:identifier", - "value": "9736898229" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Thu, 27 Nov 2025 16:48:38 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "391" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "e0bae044-bde7-4def-a600-199f72ea2e50" - }, - { - "key": "x-amz-apigw-id", - "value": "UtkTcEIOLPEF5aQ=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-692880e2-7d058bc8fc71f9ee272f339d" - }, - { - "key": "X-Request-ID", - "value": "c1f8bed5-6729-4b9f-b20c-180b069809ed" - }, - { - "key": "X-Correlation-ID", - "value": "3132cc74-64ef-465d-aac9-502f27c6ac1d" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"processing\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"GP_PRACTICE_NOT_FOUND\",\n \"display\": \"GP Practice could not be found - invalid resources cannot be retrieved\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"GP Practice could not be found\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - } - ], - "description": "## Authorization\n\n### Allowed auth methods\n\n- App restricted token\n \n- NHS Login token - Auth with test user `9730675929`\n \n- CIS2 token - Auth with test user `656005750108`\n \n\nSee collection level documentation for info about how to get authorization tokens.\n\n## NPS and NAM routing\n\nYou will notice that there are 'Valid request - NPS' and 'Valid request - NAM' requests and examples within this folder. These are set up to retrieve the proxy roles from different data sources:\n\n- **Valid request - NPS**: Retrieves the roles from the National Proxy Store (NPS) only. Following the eventual migration of all proxy and related person data from GPIT to NPS, this will become the only route for all requests.\n \n- **Valid request - NAM:** Retrives the roles as related person data from the GPIT suppliers via NAM without checking if any exist in NPS first. This requires specific connection parameters to authorise with the GPIT supplier systems\n \n\nThis routing is controlled in the requests by the `X-Test-Routing-Flag` header. This header is used in the VRS pre-prod environments to control where the proxy roles are retrieved from. It is intended to be used for testing purposes only. Omission of this header will cause the default routing settings for the given environment to be followed instead. This is typically for roles to be retrieved from NPS, with NAM used as a fallback if none are found.", - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{consent_app_auth_header_value}}", - "type": "string" - } - ] - }, - "event": [ - { - "listen": "prerequest", - "script": { - "type": "text/javascript", - "packages": {}, - "requests": {}, - "exec": [ - "var uuid = require('uuid');", - "", - "var privateKey = pm.environment.get('vrs_api_private_key') || '';", - "var api_key_value = pm.environment.get('nhs_developer_account_api_key') || '';", - "", - "if (!privateKey) {", - " throw new Error(\"Variable vrs_api_private_key must be set with your private key for signed JWT authentication.\");", - "}", - "", - "// Replace any '/n' new lines with actual new lines", - "privateKey = privateKey.replace(/\\\\n/g, '\\n');", - "", - "if (!api_key_value) {", - " throw new Error(\"Variable nhs_developer_account_app_key must be set with your integration testing application API key.\");", - "}", - "", - "var auth_url = 'https://int.api.service.nhs.uk/oauth2-mock/token';", - "var navigator = {};", - "var window = {};", - "const interval = setTimeout(() => {}, 2147483647);", - "", - "return new Promise((resolve, reject) => { ", - " if (pm.globals.has('jsrsasign-js') && pm.globals.get('jsrsasign-js') !== \"\") {", - " return resolve();", - " }", - "", - " pm.sendRequest(", - " {", - " url: 'https://kjur.github.io/jsrsasign/jsrsasign-all-min.js',", - " method: 'GET'", - " }, function (err, res) {", - " if (err) {", - " return reject(err);", - " }", - "", - " pm.globals.set('jsrsasign-js', res.text()); ", - " return resolve();", - " }", - " );", - "}).then(() => { ", - " eval(pm.globals.get(\"jsrsasign-js\")); ", - "", - " // Set headers for JWT", - " var header = {", - " 'typ': 'JWT',", - " 'alg': 'RS512',", - " 'kid': 'VRS-dev-12-nov-2025'", - " };", - "", - " // Prepare timestamp in seconds", - " var currentTimestamp = Math.floor(Date.now() / 1000)", - " var uuid = require('uuid');", - " var jti_value = uuid.v4();", - " var data = {", - " 'sub': api_key_value,", - " 'iss': api_key_value,", - " 'jti': jti_value,", - " 'aud': auth_url,", - " 'exp': currentTimestamp + 180, // expiry time is 180 seconds from time of creation", - " } ", - "", - " var sJWT = KJUR.jws.JWS.sign(header.alg, JSON.stringify(header), JSON.stringify(data), privateKey); ", - " return new Promise((resolve, reject) => { ", - " pm.sendRequest({", - " url: auth_url,", - " method: \"POST\",", - " header: {", - " \"Content-Type\": \"application/x-www-form-urlencoded\"", - " },", - " body: {", - " mode: \"urlencoded\",", - " urlencoded: [", - " {", - " key: \"grant_type\",", - " value: \"client_credentials\"", - " },", - " {", - " key: \"client_assertion_type\",", - " value: \"urn:ietf:params:oauth:client-assertion-type:jwt-bearer\",", - " },", - " {", - " key: \"client_assertion\",", - " value: sJWT", - " }", - " ]", - " }", - " }, function (err, res) { ", - " if (err) {", - " return reject(err);", - " }", - "", - " //assign the authorization header value", - " pm.environment.set('consent_app_auth_header_value', `${res.json().access_token}`);", - "", - " return resolve();", - " }); ", - " });", - "}).then(() => { ", - " clearTimeout(interval);", - "}).catch((err) => { ", - " console.error(err); ", - " clearTimeout(interval); ", - "});" - ] - } - }, - { - "listen": "test", - "script": { - "type": "text/javascript", - "packages": {}, - "requests": {}, - "exec": [ - "" - ] - } - } - ] - }, - { - "name": "Get proxy role (GET /Consent/{id})", - "item": [ - { - "name": "Valid request - Get proxy role", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role exists between a performer and a patient in the National Proxy Store \n**When** a GET /Consent/{id} request is sent with the consent id of the proxy role \n**Then** the proxy role is returned" - }, - "response": [ - { - "name": "Proxy role returned - No patient or grantee details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "4b1a8cf8-aa7e-4aa2-b465-44a5d25be876", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "b09740bc-b71f-4d04-a597-c89ab3804f90", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:28:18 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "1873" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "23636f8d-f5ef-4050-8c67-51e393b47c87" - }, - { - "key": "x-amz-apigw-id", - "value": "VD581F_4LPEFyDg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69317051-6384bdf9e3106d26096daa32" - }, - { - "key": "X-Request-ID", - "value": "784fb8d0-37ff-4716-bf77-81a395fd20f8" - }, - { - "key": "X-Correlation-ID", - "value": "ec404ce9-1721-4158-91af-2064ad3e7ea4" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:28:18Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"resource\": {\n \"id\": \"4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:08:46Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-12-05\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy role returned - Include grantee details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id?_include=Consent:grantee", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "query": [ - { - "key": "_include", - "value": "Consent:grantee" - } - ], - "variable": [ - { - "key": "consent_id", - "value": "4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:28:48 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "2789" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "a1f034c1-6ee8-499e-aa60-eea157ad4bd9" - }, - { - "key": "x-amz-apigw-id", - "value": "VD6AYFQMrPEFgjw=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69317068-3a18b175fb02b76c68acfce1" - }, - { - "key": "X-Request-ID", - "value": "e8a5dada-5577-4738-abd5-7a09251e8c3b" - }, - { - "key": "X-Correlation-ID", - "value": "5eeb9d78-133f-4132-b121-649162a6bc14" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:28:47Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40?_include=Consent%3Agrantee\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"resource\": {\n \"id\": \"4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:08:46Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-12-05\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/nVLgl\",\n \"resource\": {\n \"id\": \"nVLgl\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy role returned - Include patient details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id?_include=Consent:patient", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "query": [ - { - "key": "_include", - "value": "Consent:patient" - } - ], - "variable": [ - { - "key": "consent_id", - "value": "4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:29:08 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "3601" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "b6cb5439-d1a8-4f95-bd3e-9dca7bed9e88" - }, - { - "key": "x-amz-apigw-id", - "value": "VD6ErHoPLPEF1rg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69317083-b57a368a7776107b8b3e5f7a" - }, - { - "key": "X-Request-ID", - "value": "22ca0610-1b6e-4e3a-aa1a-ede697da4a1d" - }, - { - "key": "X-Correlation-ID", - "value": "71035b63-936a-4ce4-b036-3d592c764d88" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:29:08Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40?_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"resource\": {\n \"id\": \"4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:08:46Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-12-05\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898660\",\n \"resource\": {\n \"id\": \"9736898660\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"19976537\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"pBQDr\",\n \"line\": [\n \"CARLTON\",\n \"VICARAGE LANE\",\n \"REDBOURNE\",\n \"GAINSBOROUGH\",\n \"LINCS\"\n ],\n \"period\": {\n \"start\": \"2025-07-15\"\n },\n \"postalCode\": \"DN21 4QW\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2012-04-24\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"xSEnH\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2024-11-06\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n ],\n \"name\": [\n {\n \"family\": \"GODREY\",\n \"given\": [\n \"Davina\",\n \"Linda\"\n ],\n \"period\": {\n \"start\": \"2017-04-22\"\n },\n \"prefix\": [\n \"MISS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - }, - { - "name": "Proxy role returned - Include performer and patient details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id?_include=Consent:patient&_include=Consent:grantee", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "query": [ - { - "key": "_include", - "value": "Consent:patient" - }, - { - "key": "_include", - "value": "Consent:grantee" - } - ], - "variable": [ - { - "key": "consent_id", - "value": "4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 11:29:26 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "4517" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "9db19dac-df92-4494-8f31-076621ab3d1a" - }, - { - "key": "x-amz-apigw-id", - "value": "VD6HkGFkrPEFxmw=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69317096-6ad930e767f145f7dd07b977" - }, - { - "key": "X-Request-ID", - "value": "5fd5c3dc-1f5c-4ac5-a9b4-018fdd7f1a0b" - }, - { - "key": "X-Correlation-ID", - "value": "fd7368b4-0828-40b0-97fa-6d19fb51a9e0" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:29:26Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40?_include=Consent%3Apatient&_include=Consent%3Agrantee\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"resource\": {\n \"id\": \"4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:08:46Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-12-05\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898660\",\n \"resource\": {\n \"id\": \"9736898660\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"19976537\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"pBQDr\",\n \"line\": [\n \"CARLTON\",\n \"VICARAGE LANE\",\n \"REDBOURNE\",\n \"GAINSBOROUGH\",\n \"LINCS\"\n ],\n \"period\": {\n \"start\": \"2025-07-15\"\n },\n \"postalCode\": \"DN21 4QW\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2012-04-24\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"xSEnH\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2024-11-06\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n ],\n \"name\": [\n {\n \"family\": \"GODREY\",\n \"given\": [\n \"Davina\",\n \"Linda\"\n ],\n \"period\": {\n \"start\": \"2017-04-22\"\n },\n \"prefix\": [\n \"MISS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/nVLgl\",\n \"resource\": {\n \"id\": \"nVLgl\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" - } - ] - }, - { - "name": "Invalid consent id - Get proxy role", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "invalid" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role exists between a performer and a patient in the National Proxy Store \n**When** a GET /Consent/{id} request is sent where the ID is invalid \n**Then** a 400 error is returned with details including 'Required parameter(s) are invalid.'" - }, - "response": [ - { - "name": "Invalid consent id error returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "6ada3f0b-6520-4517-a71c-8ee93616f52b", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "ac9c9714-f361-44f2-92be-ea1eb00f9990", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "invalid" - } - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Thu, 27 Nov 2025 16:49:51 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "370" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "8bae29b7-2cf9-4f6f-b054-0ff6133092b7" - }, - { - "key": "x-amz-apigw-id", - "value": "UtkfVE6VLPEFmDg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6928812e-f15d362bb65b30e32885ea32" - }, - { - "key": "X-Request-ID", - "value": "51f1c948-51e0-4719-8307-fd1f987809a1" - }, - { - "key": "X-Correlation-ID", - "value": "cf91adbc-f994-4a56-9d6b-2b324c0af196" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"diagnostics\": \"Invalid request with error - ID must be a valid UUID.\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_ID_VALUE\",\n \"display\": \"Required parameter(s) are invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Invalid include parameter - Get proxy role", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id?_include=Consent:invalid", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "query": [ - { - "key": "_include", - "value": "Consent:invalid" - } - ], - "variable": [ - { - "key": "consent_id", - "value": "77363c92-8c33-490f-b5c9-9ef81c2cf16f" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role exists between a performer and a patient in the National Proxy Store \n**When** a GET /Consent/{id} request is sent with an invalid include parameter \n**Then** a 422 error is returned with details including 'Required parameter(s) are invalid.'" - }, - "response": [ - { - "name": "Invalid include parameter error returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "b6656a79-4fde-4def-b9ae-5cb1d5667d8f", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "7ae117a4-5b43-4aac-aa00-5fcc0c460fac", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id?_include=Consent:invalid", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "query": [ - { - "key": "_include", - "value": "Consent:invalid" - } - ], - "variable": [ - { - "key": "consent_id", - "value": "77363c92-8c33-490f-b5c9-9ef81c2cf16f" - } - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Thu, 27 Nov 2025 16:50:07 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "377" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "6da48428-7512-4d8b-9856-b2cc37713381" - }, - { - "key": "x-amz-apigw-id", - "value": "Utkh9GPDLPEF3pw=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6928813f-6ca71472e425ed45ed5bd0a5" - }, - { - "key": "X-Request-ID", - "value": "2dbb0b8c-a6c8-4bf2-9005-ec19ff68f5b2" - }, - { - "key": "X-Correlation-ID", - "value": "ec9a3692-5922-491d-8df1-da17fe8e473b" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_PARAMETER\",\n \"display\": \"Required parameter(s) are invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Invalid request with error - _include parameter is invalid.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Proxy role not found - Get proxy role", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "4cfccac1-673c-4fea-9b73-54b1a605c9a0" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role does not exist between a performer and a patient in the National Proxy Store \n**When** a GET /Consent/{id} request is sent \n**Then** a 404 error is returned with details including 'Resource that has been marked as invalid was requested - invalid resources cannot be retrieved'" - }, - "response": [ - { - "name": "Proxy role not found error response", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "ed862755-76fc-47b5-9381-9578062418e3", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "5095096c-4f78-4544-b812-ba9a4b21d08d", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "4cfccac1-673c-4fea-9b73-54b1a605c9a0" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Thu, 27 Nov 2025 16:50:22 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "478" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "ece32b72-4d4a-43c9-b42a-e47b729e04da" - }, - { - "key": "x-amz-apigw-id", - "value": "UtkkIHJprPEFiYw=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6928814d-5023dcb7c8009889ccde4f3d" - }, - { - "key": "X-Request-ID", - "value": "3ec49ee6-c56c-4df9-aa7a-f54bb6b3e795" - }, - { - "key": "X-Correlation-ID", - "value": "74eb5dd5-2d74-4b3a-a482-5480e1ad6464" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"processing\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\",\n \"code\": \"INVALIDATED_RESOURCE\",\n \"display\": \"Resource that has been marked as invalid was requested - invalid resources cannot be retrieved\"\n }\n ]\n },\n \"diagnostics\": \"Resource that has been marked as invalid was requested - invalid resources cannot be retrieved\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Missing consent id value - Get proxy role", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent/", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - "" - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role exists between a performer and a patient in the National Proxy Store \n**When** a GET /Consent/{id} request is sent with the ID value missing \n**Then** a 400 error is returned with details including 'Required parameter(s) are missing.'" - }, - "response": [ - { - "name": "Missing consent id value error returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "7c50dc2d-fc25-4bed-8ce8-d58b4811f58c", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "210ede12-efec-4195-b2cd-1a04d1827a81", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/Consent/", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - "" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Thu, 27 Nov 2025 16:51:00 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "417" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "c4a3d99b-0ea1-40de-82bf-5cd2fa60afd6" - }, - { - "key": "x-amz-apigw-id", - "value": "UtkqLGF_rPEFcMw=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69288173-c5d997b9110a61bf7b655fe7" - }, - { - "key": "X-Request-ID", - "value": "de0e2e5b-1f1b-4448-a7ee-42d0236b88a6" - }, - { - "key": "X-Correlation-ID", - "value": "6f458de2-64c6-4764-9044-34a5617d3d43" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_IDENTIFIER_VALUE\",\n \"display\": \"Required parameter(s) are missing.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Invalid request with error - performer:identifier or patient:identifier parameter not found.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - } - ], - "description": "## Allowed auth methods\n\n- NHS Login token - Auth with test user `9730675929`\n \n- CIS2 token - Auth with test user `656005750108`\n \n\nSee collection level documentation for info about how to get authorization tokens.", - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "event": [ - { - "listen": "prerequest", - "script": { - "type": "text/javascript", - "packages": {}, - "requests": {}, - "exec": [ - "" - ] - } - }, - { - "listen": "test", - "script": { - "type": "text/javascript", - "packages": {}, - "requests": {}, - "exec": [ - "" - ] - } - } - ] - }, - { - "name": "Create a new access request (POST /QuestionnaireResponse)", - "item": [ - { - "name": "Valid request - Proxy applicant - New adult to adult access request", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Use-National-Proxy-Store", - "value": "False", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"QuestionnaireResponse\",\n \"status\": \"completed\",\n \"authored\": \"{{$isoTimestamp}}\",\n \"source\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"subject\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898202\"\n }\n },\n \"questionnaire\": \"Questionnaire/{{$randomUUID}}\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson\",\n \"text\": \"relatedPerson\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9730675929\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name\",\n \"text\": \"relatedPerson_name\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Betty\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"MORLEY\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2005-01-20\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_basisForAccess\",\n \"text\": \"Basis For Access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_relationship\",\n \"text\": \"Relationship\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient\",\n \"text\": \"patient\",\n \"item\": [\n {\n \"linkId\": \"patient_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9736898202\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name\",\n \"text\": \"patient_name\",\n \"item\": [\n {\n \"linkId\": \"patient_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"URIEL\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"ROTH\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"1988-11-10\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess\",\n \"text\": \"requestedAccess\",\n \"item\": [\n {\n \"linkId\": \"requestedAccess_accessLevel\",\n \"text\": \"Requested access level\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"APPT\",\n \"display\": \"Appointment Booking\"\n }\n },\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"VACC\",\n \"display\": \"Vaccination Records\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccess\",\n \"text\": \"Reason for access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess\",\n \"code\": \"COMB\",\n \"display\": \"Communication Barriers\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccessMoreinfo\",\n \"text\": \"Reason for access - further information\",\n \"answer\": [\n {\n \"valueString\": \"No internet connection\"\n }\n ]\n }\n ]\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/QuestionnaireResponse", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "QuestionnaireResponse" - ] - }, - "description": "## Example scenario\n\n**Given** no proxy role exists between two adults \n**When** a valid access request is sent with the proxy as the applicant \n**Then** a 201 response is returned" - }, - "response": [ - { - "name": "A2A proxy applicant access request created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "5ef96245-493a-468c-9936-06fb46e387af", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "15ace5c8-dc43-435f-baf8-3437b76ffdbf", - "type": "text" - }, - { - "key": "X-Use-National-Proxy-Store", - "value": "False", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"QuestionnaireResponse\",\n \"status\": \"completed\",\n \"authored\": \"2026-01-12T15:09:45.790Z\",\n \"source\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"subject\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898202\"\n }\n },\n \"questionnaire\": \"Questionnaire/2e61ba16-f2ee-4e16-8526-194873d63f24\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson\",\n \"text\": \"relatedPerson\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9730675929\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name\",\n \"text\": \"relatedPerson_name\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Betty\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"MORLEY\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2005-01-20\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_basisForAccess\",\n \"text\": \"Basis For Access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_relationship\",\n \"text\": \"Relationship\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient\",\n \"text\": \"patient\",\n \"item\": [\n {\n \"linkId\": \"patient_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9736898202\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name\",\n \"text\": \"patient_name\",\n \"item\": [\n {\n \"linkId\": \"patient_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"URIEL\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"ROTH\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"1988-11-10\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess\",\n \"text\": \"requestedAccess\",\n \"item\": [\n {\n \"linkId\": \"requestedAccess_accessLevel\",\n \"text\": \"Requested access level\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"APPT\",\n \"display\": \"Appointment Booking\"\n }\n },\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"VACC\",\n \"display\": \"Vaccination Records\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccess\",\n \"text\": \"Reason for access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess\",\n \"code\": \"COMB\",\n \"display\": \"Communication Barriers\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccessMoreinfo\",\n \"text\": \"Reason for access - further information\",\n \"answer\": [\n {\n \"valueString\": \"No internet connection\"\n }\n ]\n }\n ]\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "QuestionnaireResponse" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Mon, 01 Dec 2025 16:09:01 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "186" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "720499ae-68fe-495a-8485-862105f276a9" - }, - { - "key": "x-amz-apigw-id", - "value": "U6qQkGxVrPEFeoA=" - }, - { - "key": "location", - "value": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse/e185e5e3-901e-4b6a-bfe2-f9adb0b311a4" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-692dbd9c-999e6478f9613be345a68c77" - }, - { - "key": "X-Request-ID", - "value": "687bfc1b-b7a7-4681-a7bf-01ac6e7dd97a" - }, - { - "key": "X-Correlation-ID", - "value": "6adda3bb-aacf-4e4f-a459-a2a0fe6d34be" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"19C01XB6WC\",\n \"display\": \"19C01XB6WC\"\n }\n ]\n }\n }\n ]\n}" - } - ] - }, - { - "name": "Valid request - Patient applicant - New adult to adult access request", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Use-National-Proxy-Store", - "value": "False", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"QuestionnaireResponse\",\n \"status\": \"completed\",\n \"authored\": \"{{$isoTimestamp}}\",\n \"source\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"subject\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"questionnaire\": \"Questionnaire/{{$randomUUID}}\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson\",\n \"text\": \"relatedPerson\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9736898164\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name\",\n \"text\": \"relatedPerson_name\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Heidi\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"LAW\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"1997-09-15\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_basisForAccess\",\n \"text\": \"Basis For Access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_relationship\",\n \"text\": \"Relationship\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient\",\n \"text\": \"patient\",\n \"item\": [\n {\n \"linkId\": \"patient_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9730675929\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name\",\n \"text\": \"patient_name\",\n \"item\": [\n {\n \"linkId\": \"patient_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Betty\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"MORLEY\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2005-01-20\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess\",\n \"text\": \"requestedAccess\",\n \"item\": [\n {\n \"linkId\": \"requestedAccess_accessLevel\",\n \"text\": \"Requested access level\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"APPT\",\n \"display\": \"Appointment Booking\"\n }\n },\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"VACC\",\n \"display\": \"Vaccination Records\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccess\",\n \"text\": \"Reason for access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess\",\n \"code\": \"COMB\",\n \"display\": \"Communication Barriers\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccessMoreinfo\",\n \"text\": \"Reason for access - further information\",\n \"answer\": [\n {\n \"valueString\": \"No internet connection\"\n }\n ]\n }\n ]\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/QuestionnaireResponse", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "QuestionnaireResponse" - ] - }, - "description": "## Example scenario\n\n**Given** no proxy role exists between two adults \n**When** a valid access request is sent with the patient as the applicant \n**Then** a 201 response is returned" - }, - "response": [ - { - "name": "A2A patient applicant access request created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "8af428cd-7e1e-4ed3-b127-0b751d6ae98d", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "e5cc0a6d-ea0d-433b-9307-30c988926969", - "type": "text" - }, - { - "key": "X-Use-National-Proxy-Store", - "value": "False", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"QuestionnaireResponse\",\n \"status\": \"completed\",\n \"authored\": \"2026-01-12T15:09:46.233Z\",\n \"source\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"subject\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"questionnaire\": \"Questionnaire/aa952e3f-3657-4ec3-bec0-25d881ed2e20\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson\",\n \"text\": \"relatedPerson\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9736898164\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name\",\n \"text\": \"relatedPerson_name\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Heidi\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"LAW\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"1997-09-15\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_basisForAccess\",\n \"text\": \"Basis For Access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_relationship\",\n \"text\": \"Relationship\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient\",\n \"text\": \"patient\",\n \"item\": [\n {\n \"linkId\": \"patient_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9730675929\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name\",\n \"text\": \"patient_name\",\n \"item\": [\n {\n \"linkId\": \"patient_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Betty\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"MORLEY\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2005-01-20\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess\",\n \"text\": \"requestedAccess\",\n \"item\": [\n {\n \"linkId\": \"requestedAccess_accessLevel\",\n \"text\": \"Requested access level\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"APPT\",\n \"display\": \"Appointment Booking\"\n }\n },\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"VACC\",\n \"display\": \"Vaccination Records\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccess\",\n \"text\": \"Reason for access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess\",\n \"code\": \"COMB\",\n \"display\": \"Communication Barriers\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccessMoreinfo\",\n \"text\": \"Reason for access - further information\",\n \"answer\": [\n {\n \"valueString\": \"No internet connection\"\n }\n ]\n }\n ]\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/QuestionnaireResponse", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "QuestionnaireResponse" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Mon, 01 Dec 2025 16:10:22 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "186" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "d15e2ba0-3698-4fcf-80fe-d73279dd89a8" - }, - { - "key": "x-amz-apigw-id", - "value": "U6qdWHFfLPEFoUA=" - }, - { - "key": "location", - "value": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse/bdbba534-6e11-4491-aa3a-1631b0009628" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-692dbdee-08b18875f6f85ab2a7353bd4" - }, - { - "key": "X-Request-ID", - "value": "82cb14a5-09d0-41d4-8f73-2936794c32de" - }, - { - "key": "X-Correlation-ID", - "value": "73873b5d-1e2e-4a42-9dc3-83f1292f944b" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"19C0177GRI\",\n \"display\": \"19C0177GRI\"\n }\n ]\n }\n }\n ]\n}" - } - ] - }, - { - "name": "Valid request - New adult to child access request", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Use-National-Proxy-Store", - "value": "False", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"QuestionnaireResponse\",\n \"status\": \"completed\",\n \"authored\": \"{{$isoTimestamp}}\",\n \"source\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"subject\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898245\"\n }\n },\n \"questionnaire\": \"Questionnaire/01dc6813-3421-4d14-948d-a4888241add1\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson\",\n \"text\": \"relatedPerson\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9730675929\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name\",\n \"text\": \"relatedPerson_name\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Betty\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"MORLEY\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2005-01-20\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_basisForAccess\",\n \"text\": \"Basis For Access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_relationship\",\n \"text\": \"Relationship\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails\",\n \"text\": \"parentalApplicationSupplementaryDetails\",\n \"item\": [\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_evidenceOfResponsibility\",\n \"text\": \"Evidence of parental responsibility\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-EvidenceOfResponsibility\",\n \"code\": \"BRTH\",\n \"display\": \"Birth certificate\"\n }\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_evidenceOfResponsibilityMoreinfo\",\n \"text\": \"Evidence of responsibility - Further Information\",\n \"answer\": [\n {\n \"valueString\": \"Birth Certificate is original\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_isCurrentAddressConfirmed\",\n \"text\": \"Is current address confirmed?\",\n \"answer\": [\n {\n \"valueString\": \"Yes\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_newAddress\",\n \"text\": \"parentalApplicationSupplementaryDetails_newAddress\",\n \"item\": [\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line1\",\n \"text\": \"Address Line 1\",\n \"answer\": [\n {\n \"valueString\": \"101 MESSINGHAM ROAD\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line2\",\n \"text\": \"Address Line 2\",\n \"answer\": [\n {\n \"valueString\": \"\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line3\",\n \"text\": \"Address Line 3\",\n \"answer\": [\n {\n \"valueString\": \"\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_city\",\n \"text\": \"Town / City\",\n \"answer\": [\n {\n \"valueString\": \"SCUNTHORPE\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_district\",\n \"text\": \"County\",\n \"answer\": [\n {\n \"valueString\": \"S HUMBERSIDE\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_postalCode\",\n \"text\": \"Postcode\",\n \"answer\": [\n {\n \"valueString\": \"DN17 2LN\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_liveAtSameAddress\",\n \"text\": \"Do the adult and child live at the same address?\",\n \"answer\": [\n {\n \"valueString\": \"Yes\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_canChildConsent\",\n \"text\": \"Can the child consent?\",\n \"answer\": [\n {\n \"valueString\": \"No\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_reasonNoChildConsent\",\n \"text\": \"Reason the child cannot consent\",\n \"answer\": [\n {\n \"valueString\": \"Child is too young\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient\",\n \"text\": \"patient\",\n \"item\": [\n {\n \"linkId\": \"patient_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9736898245\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name\",\n \"text\": \"patient_name\",\n \"item\": [\n {\n \"linkId\": \"patient_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Amber\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"TUCKER\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2017-06-09\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess\",\n \"text\": \"requestedAccess\",\n \"item\": [\n {\n \"linkId\": \"requestedAccess_accessLevel\",\n \"text\": \"Requested access level\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"APPT\",\n \"display\": \"Appointment Booking\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccess\",\n \"text\": \"Reason for access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess\",\n \"code\": \"COMB\",\n \"display\": \"Communication Barriers\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccessMoreinfo\",\n \"text\": \"Reason for access - further information\",\n \"answer\": [\n {\n \"valueString\": \"No internet connection\"\n }\n ]\n }\n ]\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/QuestionnaireResponse", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "QuestionnaireResponse" - ] - }, - "description": "## Example scenario\n\n**Given** no proxy role exists between an adult and child \n**When** a valid access request is sent with the proxy as the applicant \n**Then** a 201 response is returned" - }, - "response": [ - { - "name": "A2C access request created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "d6f3b8fe-0041-4c34-aeb4-eac71020170d", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "46efa85e-d5c4-403b-a38a-1945f33bac2c", - "type": "text" - }, - { - "key": "X-Use-National-Proxy-Store", - "value": "False", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"QuestionnaireResponse\",\n \"status\": \"completed\",\n \"authored\": \"2026-01-12T15:09:46.453Z\",\n \"source\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"subject\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898245\"\n }\n },\n \"questionnaire\": \"Questionnaire/01dc6813-3421-4d14-948d-a4888241add1\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson\",\n \"text\": \"relatedPerson\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9730675929\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name\",\n \"text\": \"relatedPerson_name\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Betty\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"MORLEY\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2005-01-20\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_basisForAccess\",\n \"text\": \"Basis For Access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_relationship\",\n \"text\": \"Relationship\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails\",\n \"text\": \"parentalApplicationSupplementaryDetails\",\n \"item\": [\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_evidenceOfResponsibility\",\n \"text\": \"Evidence of parental responsibility\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-EvidenceOfResponsibility\",\n \"code\": \"BRTH\",\n \"display\": \"Birth certificate\"\n }\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_evidenceOfResponsibilityMoreinfo\",\n \"text\": \"Evidence of responsibility - Further Information\",\n \"answer\": [\n {\n \"valueString\": \"Birth Certificate is original\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_isCurrentAddressConfirmed\",\n \"text\": \"Is current address confirmed?\",\n \"answer\": [\n {\n \"valueString\": \"Yes\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_newAddress\",\n \"text\": \"parentalApplicationSupplementaryDetails_newAddress\",\n \"item\": [\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line1\",\n \"text\": \"Address Line 1\",\n \"answer\": [\n {\n \"valueString\": \"101 MESSINGHAM ROAD\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line2\",\n \"text\": \"Address Line 2\",\n \"answer\": [\n {\n \"valueString\": \"\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line3\",\n \"text\": \"Address Line 3\",\n \"answer\": [\n {\n \"valueString\": \"\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_city\",\n \"text\": \"Town / City\",\n \"answer\": [\n {\n \"valueString\": \"SCUNTHORPE\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_district\",\n \"text\": \"County\",\n \"answer\": [\n {\n \"valueString\": \"S HUMBERSIDE\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_postalCode\",\n \"text\": \"Postcode\",\n \"answer\": [\n {\n \"valueString\": \"DN17 2LN\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_liveAtSameAddress\",\n \"text\": \"Do the adult and child live at the same address?\",\n \"answer\": [\n {\n \"valueString\": \"Yes\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_canChildConsent\",\n \"text\": \"Can the child consent?\",\n \"answer\": [\n {\n \"valueString\": \"No\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_reasonNoChildConsent\",\n \"text\": \"Reason the child cannot consent\",\n \"answer\": [\n {\n \"valueString\": \"Child is too young\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient\",\n \"text\": \"patient\",\n \"item\": [\n {\n \"linkId\": \"patient_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9736898245\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name\",\n \"text\": \"patient_name\",\n \"item\": [\n {\n \"linkId\": \"patient_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Amber\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"TUCKER\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2017-06-09\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess\",\n \"text\": \"requestedAccess\",\n \"item\": [\n {\n \"linkId\": \"requestedAccess_accessLevel\",\n \"text\": \"Requested access level\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"APPT\",\n \"display\": \"Appointment Booking\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccess\",\n \"text\": \"Reason for access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess\",\n \"code\": \"COMB\",\n \"display\": \"Communication Barriers\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccessMoreinfo\",\n \"text\": \"Reason for access - further information\",\n \"answer\": [\n {\n \"valueString\": \"No internet connection\"\n }\n ]\n }\n ]\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/QuestionnaireResponse", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "QuestionnaireResponse" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Mon, 01 Dec 2025 16:11:33 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "186" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "4eba2237-3c13-4bab-afb1-1261b5ac6a19" - }, - { - "key": "x-amz-apigw-id", - "value": "U6qoVF-JLPEFXqQ=" - }, - { - "key": "location", - "value": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse/29a7f71a-2554-4e53-87de-07553d40d5ec" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-692dbe34-f306ba0e1a55aba127add964" - }, - { - "key": "X-Request-ID", - "value": "848e592d-a42e-4fee-b529-8ac484fd459c" - }, - { - "key": "X-Correlation-ID", - "value": "73de9aa5-5951-4d30-8f2d-e64482fb1990" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"19C01N8Q37\",\n \"display\": \"19C01N8Q37\"\n }\n ]\n }\n }\n ]\n}" - }, - { - "name": "A2C access request created - Verified relationship", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Use-National-Proxy-Store", - "value": "False", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"QuestionnaireResponse\",\n \"status\": \"completed\",\n \"authored\": \"{{$isoTimestamp}}\",\n \"source\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"subject\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675422\"\n }\n },\n \"questionnaire\": \"Questionnaire/01dc6813-3421-4d14-948d-a4888241add1\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson\",\n \"text\": \"relatedPerson\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9730675929\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name\",\n \"text\": \"relatedPerson_name\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Betty\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"MORLEY\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2005-01-20\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_basisForAccess\",\n \"text\": \"Basis For Access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_relationship\",\n \"text\": \"Relationship\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails\",\n \"text\": \"parentalApplicationSupplementaryDetails\",\n \"item\": [\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_evidenceOfResponsibility\",\n \"text\": \"Evidence of parental responsibility\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-EvidenceOfResponsibility\",\n \"code\": \"BRTH\",\n \"display\": \"Birth certificate\"\n }\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_evidenceOfResponsibilityMoreinfo\",\n \"text\": \"Evidence of responsibility - Further Information\",\n \"answer\": [\n {\n \"valueString\": \"Birth Certificate is original\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_isCurrentAddressConfirmed\",\n \"text\": \"Is current address confirmed?\",\n \"answer\": [\n {\n \"valueString\": \"Yes\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_newAddress\",\n \"text\": \"parentalApplicationSupplementaryDetails_newAddress\",\n \"item\": [\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line1\",\n \"text\": \"Address Line 1\",\n \"answer\": [\n {\n \"valueString\": \"101 MESSINGHAM ROAD\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line2\",\n \"text\": \"Address Line 2\",\n \"answer\": [\n {\n \"valueString\": \"\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line3\",\n \"text\": \"Address Line 3\",\n \"answer\": [\n {\n \"valueString\": \"\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_city\",\n \"text\": \"Town / City\",\n \"answer\": [\n {\n \"valueString\": \"SCUNTHORPE\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_district\",\n \"text\": \"County\",\n \"answer\": [\n {\n \"valueString\": \"S HUMBERSIDE\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_postalCode\",\n \"text\": \"Postcode\",\n \"answer\": [\n {\n \"valueString\": \"DN17 2LN\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_liveAtSameAddress\",\n \"text\": \"Do the adult and child live at the same address?\",\n \"answer\": [\n {\n \"valueString\": \"Yes\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_canChildConsent\",\n \"text\": \"Can the child consent?\",\n \"answer\": [\n {\n \"valueString\": \"No\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_reasonNoChildConsent\",\n \"text\": \"Reason the child cannot consent\",\n \"answer\": [\n {\n \"valueString\": \"Child is too young\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient\",\n \"text\": \"patient\",\n \"item\": [\n {\n \"linkId\": \"patient_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9730675422\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name\",\n \"text\": \"patient_name\",\n \"item\": [\n {\n \"linkId\": \"patient_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Rowena\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"HIRST\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2015-08-09\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess\",\n \"text\": \"requestedAccess\",\n \"item\": [\n {\n \"linkId\": \"requestedAccess_accessLevel\",\n \"text\": \"Requested access level\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"APPT\",\n \"display\": \"Appointment Booking\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccess\",\n \"text\": \"Reason for access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess\",\n \"code\": \"COMB\",\n \"display\": \"Communication Barriers\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccessMoreinfo\",\n \"text\": \"Reason for access - further information\",\n \"answer\": [\n {\n \"valueString\": \"No internet connection\"\n }\n ]\n }\n ]\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/QuestionnaireResponse", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "QuestionnaireResponse" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Mon, 01 Dec 2025 16:11:33 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "186" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "4eba2237-3c13-4bab-afb1-1261b5ac6a19" - }, - { - "key": "x-amz-apigw-id", - "value": "U6qoVF-JLPEFXqQ=" - }, - { - "key": "location", - "value": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse/29a7f71a-2554-4e53-87de-07553d40d5ec" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-692dbe34-f306ba0e1a55aba127add964" - }, - { - "key": "X-Request-ID", - "value": "848e592d-a42e-4fee-b529-8ac484fd459c" - }, - { - "key": "X-Correlation-ID", - "value": "73de9aa5-5951-4d30-8f2d-e64482fb1990" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"19C01N8Q37\",\n \"display\": \"19C01N8Q37\"\n }\n ]\n }\n }\n ]\n}" - } - ] - }, - { - "name": "Invalid request body - New adult to adult access request", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Use-National-Proxy-Store", - "value": "False", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/QuestionnaireResponse", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "QuestionnaireResponse" - ] - }, - "description": "## Example scenario\n\n**Given** no proxy role exists between two adults \n**When** a access request is sent with invalid body \n**Then** a 400 error response is returned with code 'INVALID_VALUE'" - }, - "response": [ - { - "name": "Invalid request body error response", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "94d7227f-f801-465f-b04c-8dd7494faf5f", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "7f829c8e-bec6-4cbe-8ed0-d71bf981095b", - "type": "text" - }, - { - "key": "X-Use-National-Proxy-Store", - "value": "False", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/QuestionnaireResponse", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "QuestionnaireResponse" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Mon, 01 Dec 2025 16:13:37 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "377" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "28073546-4513-47c5-9d2e-17caeb920a78" - }, - { - "key": "x-amz-apigw-id", - "value": "U6q7zHXFLPEF3Bg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-692dbeb1-7dd1e1125d0b5422386cffe9" - }, - { - "key": "X-Request-ID", - "value": "d82f5db5-1c08-4251-a94b-50684ea1a06b" - }, - { - "key": "X-Correlation-ID", - "value": "7eeca365-bf2b-4859-9e2c-b5c7731bbe1b" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"BAD_REQUEST\",\n \"display\": \"The request could not be processed.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"The supplied input is not a valid FHIR QuestionnaireResponse.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - } - ], - "description": "## Allowed auth methods\n\n- NHS Login token - Auth with test user `9730675929`\n \n\nSee collection level documentation for info about how to get authorization tokens.", - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{login_token}}", - "type": "string" - } - ] - }, - "event": [ - { - "listen": "prerequest", - "script": { - "type": "text/javascript", - "packages": {}, - "requests": {}, - "exec": [ - "" - ] - } - }, - { - "listen": "test", - "script": { - "type": "text/javascript", - "packages": {}, - "requests": {}, - "exec": [ - "" - ] - } - } - ] - }, - { - "name": "Get access request (GET /QuestionnaireResponse/{id})", - "item": [ - { - "name": "Valid request - Get access request", - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/QuestionnaireResponse/:access_request_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "QuestionnaireResponse", - ":access_request_id" - ], - "variable": [ - { - "key": "access_request_id", - "value": "32a5cc78-eb64-4367-abea-cfdb6e9fa2e4" - } - ] - }, - "description": "## Example scenario\n\n**Given** a valid access request has been sent to VRS \n**When** a GET /QuestionnaireResponse/{id} request is sent with the access request UUID \n**Then** the access request is returned" - }, - "response": [] - }, - { - "name": "No access request found - Get access request", - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/QuestionnaireResponse/:access_request_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "QuestionnaireResponse", - ":access_request_id" - ], - "variable": [ - { - "key": "access_request_id", - "value": "32a5cc78-eb64-4367-abea-cfdb6e9fa2e4" - } - ] - }, - "description": "## Example scenario\n\n**Given** a valid access request has been sent to VRS \n**When** a GET /QuestionnaireResponse/{id} request is sent with a random UUID \n**Then** a 404 error is returned with message 'QUESTIONNAIRE_RESPONSE_NOT_FOUND'" - }, - "response": [ - { - "name": "No access request found error returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "074b07d8-104e-4574-abd7-bdc5181280da", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "f47a9a68-34a5-4a11-881b-8b45695f2e76", - "type": "text" - } - ], - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse/:access_request_id", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "QuestionnaireResponse", - ":access_request_id" - ], - "variable": [ - { - "key": "access_request_id", - "value": "32a5cc78-eb64-4367-abea-cfdb6e9fa2e4" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Mon, 01 Dec 2025 14:37:04 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "400" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "64959769-f136-4d27-9369-b4e01224c066" - }, - { - "key": "x-amz-apigw-id", - "value": "U6cyYE4brPEFXvw=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-692da80e-520fcf28565fe1ea77ceb7fc" - }, - { - "key": "X-Request-ID", - "value": "f6fe610a-d80b-4436-b727-67960c9687a1" - }, - { - "key": "X-Correlation-ID", - "value": "076421a4-1c56-43e4-95a9-6139434516a7" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"not-found\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"QUESTIONNAIRE_RESPONSE_NOT_FOUND\",\n \"display\": \"Questionnaire response not found\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\"\n }\n ]\n },\n \"diagnostics\": \"The Questionnaire response could not be found using the provided access request ID.\"\n }\n ]\n}" - } - ] - }, - { - "name": "No access request UUID - Get access request", - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/QuestionnaireResponse/", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "QuestionnaireResponse", - "" - ] - }, - "description": "## Example scenario\n\n**Given** a valid access request has been sent to VRS \n**When** a GET /QuestionnaireResponse/{id} request is sent without a UUID \n**Then** a 400 error is returned with message 'METHOD_NOT_ALLOWED'" - }, - "response": [ - { - "name": "No access request UUID invalid response", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "6e763c1c-b24b-4ffe-8598-e2983ae5e3cf", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "87ed4d25-05d6-4ab6-985e-a254cdd26339", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/QuestionnaireResponse/", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "QuestionnaireResponse", - "" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Mon, 01 Dec 2025 15:15:37 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "370" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "42e98c18-f152-4e8f-8cd2-fc0ba2bcc590" - }, - { - "key": "x-amz-apigw-id", - "value": "U6ibrGjDrPEFgRQ=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-692db117-2a87f1ac0c50e6702fcbc5ce" - }, - { - "key": "X-Request-ID", - "value": "4270ae5f-3cc9-418e-a6f8-aab43372486a" - }, - { - "key": "X-Correlation-ID", - "value": "a23d9c20-bcf2-4e03-ba6b-092a703947f3" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"not-supported\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"METHOD_NOT_ALLOWED\",\n \"display\": \"The method is not allowed.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"The method is not allowed for the requested resource.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Invalid access request UUID - Get access request", - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/QuestionnaireResponse/invalid", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "QuestionnaireResponse", - "invalid" - ] - }, - "description": "## Example scenario\n\n**Given** a valid access request has been sent to VRS \n**When** a GET /QuestionnaireResponse/{id} request is sent with an invalid UUID \n**Then** a 400 error is returned with message 'INVALID_IDENTIFIER_VALUE'" - }, - "response": [ - { - "name": "Invalid access request UUID invalid response", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "30e863b4-b90b-439e-a757-06eadf3cae48", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "79bc7284-1f65-407a-bc5e-1e5bd8d0496b", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/QuestionnaireResponse/invalid", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "QuestionnaireResponse", - "invalid" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Mon, 01 Dec 2025 15:15:37 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "370" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "42e98c18-f152-4e8f-8cd2-fc0ba2bcc590" - }, - { - "key": "x-amz-apigw-id", - "value": "U6ibrGjDrPEFgRQ=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-692db117-2a87f1ac0c50e6702fcbc5ce" - }, - { - "key": "X-Request-ID", - "value": "4270ae5f-3cc9-418e-a6f8-aab43372486a" - }, - { - "key": "X-Correlation-ID", - "value": "a23d9c20-bcf2-4e03-ba6b-092a703947f3" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1\",\n \"code\": \"INVALID_IDENTIFIER_VALUE\",\n \"display\": \"Invalid identifier value\"\n }\n ]\n },\n \"diagnostics\": \"The specified access request ID is invalid. Access request IDs must be a valid UUID.\"\n }\n ]\n}" - } - ] - } - ], - "description": "## Allowed auth methods\n\n- CIS2 token - Auth with test user `656005750108`\n \n- NHS Login token - Auth with test user `9730675929`\n \n\nSee collection level documentation for info about how to get authorization tokens.", - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "event": [ - { - "listen": "prerequest", - "script": { - "type": "text/javascript", - "packages": {}, - "requests": {}, - "exec": [ - "" - ] - } - }, - { - "listen": "test", - "script": { - "type": "text/javascript", - "packages": {}, - "requests": {}, - "exec": [ - "" - ] - } - } - ] - }, - { - "name": "Create a new proxy role (POST /Consent)", - "item": [ - { - "name": "Valid request - New proxy role", - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ] - }, - "description": "## Important - duplicates\n\nWe cannot currently accept duplicate proxy role requests for testing purposes.\n\nThis may lead to you experiencing 409 errors on the 'valid request' scenarios if the same request has already been sent.\n\n## Example scenario\n\n**Given** no proxy role exists in NPS between a proxy and patient \n**When** I send a POST /Consent request for the proxy and patient \n**Then** a 201 success response is returned" - }, - "response": [ - { - "name": "Adult to child - New proxy role created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "df29a1cb-3861-4d7f-918d-3bcf6f5ef362", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "0b7ed233-3055-48ac-93ef-c71922ccc577", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n\t\"resourceType\": \"Consent\",\n\t\"status\": \"active\",\n\t\"scope\": {\n\t\t\"coding\": [\n\t\t\t{\n\t\t\t\t\"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n\t\t\t\t\"code\": \"patient-privacy\",\n\t\t\t\t\"display\": \"Privacy Consent\"\n\t\t\t}\n\t\t]\n\t},\n\t\"category\": [\n\t\t{\n\t\t\t\"coding\": [\n\t\t\t\t{\n\t\t\t\t\t\"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n\t\t\t\t\t\"code\": \"INFA\",\n\t\t\t\t\t\"display\": \"information access\"\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t],\n\t\"patient\": {\n\t\t\"type\": \"Patient\",\n\t\t\"identifier\": {\n\t\t\t\"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n\t\t\t\"value\": \"9736898717\"\n\t\t}\n\t},\n\t\"dateTime\": \"2026-02-09T13:50:10.090Z\",\n\t\"provision\": {\n\t\t\"period\": {\n\t\t\t\"start\": \"2025-12-02\",\n\t\t\t\"end\": \"2030-11-23\"\n\t\t},\n\t\t\"actor\": [\n\t\t\t{\n\t\t\t\t\"role\": {\n\t\t\t\t\t\"coding\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n\t\t\t\t\t\t\t\"code\": \"parental-responsibility\",\n\t\t\t\t\t\t\t\"display\": \"Parental responsibility\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t\"reference\": {\n\t\t\t\t\t\"type\": \"RelatedPerson\",\n\t\t\t\t\t\"identifier\": {\n\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n\t\t\t\t\t\t\"value\": \"9736898148\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t},\n\t\"extension\": [\n\t\t{\n\t\t\t\"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n\t\t\t\"valueCodeableConcept\": {\n\t\t\t\t\"coding\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n\t\t\t\t\t\t\"code\": \"ROLE_CREATED\",\n\t\t\t\t\t\t\"display\": \"Role created\"\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n\t\t\t\"valueReference\": {\n\t\t\t\t\"identifier\": {\n\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n\t\t\t\t\t\"value\": \"9736898148\"\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n\t\t\t\"valueReference\": {\n\t\t\t\t\"identifier\": {\n\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n\t\t\t\t\t\"value\": \"G8101234\"\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n\t\t\t\"valueCodeableConcept\": {\n\t\t\t\t\"coding\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n\t\t\t\t\t\t\"code\": \"ROLE_CREATED\",\n\t\t\t\t\t\t\"display\": \"Role created\"\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t}\n\t]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent" - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 15:14:39 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "101" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "bf6bc3d8-1829-4a81-9433-c0b1c21376d6" - }, - { - "key": "x-amz-apigw-id", - "value": "Uwpe7FCjrPEF5aQ=" - }, - { - "key": "location", - "value": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4f15f399-d381-4949-a744-25f9cbfecfb3" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929bc5f-f6012c539553033b0859994a" - }, - { - "key": "X-Request-ID", - "value": "46baf4c8-5bb5-4a6e-9bd4-264452817dab" - }, - { - "key": "X-Correlation-ID", - "value": "65bdf903-1cb2-4722-a291-d5056c44e712" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\"\n }\n ]\n}" - }, - { - "name": "Adult to adult - New proxy role created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898202\"\n }\n },\n \"dateTime\": \"{{$isoTimestamp}}\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"UNK\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898164\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n ,\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898164\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 15:14:39 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "101" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "bf6bc3d8-1829-4a81-9433-c0b1c21376d6" - }, - { - "key": "x-amz-apigw-id", - "value": "Uwpe7FCjrPEF5aQ=" - }, - { - "key": "location", - "value": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4f15f399-d381-4949-a744-25f9cbfecfb3" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929bc5f-f6012c539553033b0859994a" - }, - { - "key": "X-Request-ID", - "value": "46baf4c8-5bb5-4a6e-9bd4-264452817dab" - }, - { - "key": "X-Correlation-ID", - "value": "65bdf903-1cb2-4722-a291-d5056c44e712" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\"\n }\n ]\n}" - } - ] - }, - { - "name": "Duplicate role - New proxy role", - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"{{$isoTimestamp}}\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"UNK\",\n \"display\": \"Unknown\"\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n },\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role already exists in NPS between a proxy and patient \n**When** I send a POST /Consent request for the same proxy and patient \n**Then** a 409 error is returned with code 'DUPLICATE_RELATIONSHIP'" - }, - "response": [ - { - "name": "Duplicate role error returned", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "8616edc0-f04b-4d56-ac54-4c5dd8930d87", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "42cf4c55-e180-4b8f-abe3-60acd1780311", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"{{$isoTimestamp}}\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"UNK\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent" - ] - } - }, - "status": "Conflict", - "code": 409, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 12:41:31 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "352" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "de65a534-5cee-45c1-845e-023e9ffab375" - }, - { - "key": "x-amz-apigw-id", - "value": "UwTC8H42LPEFggg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69299878-54ea0e3b7bd5d7e836eaea8f" - }, - { - "key": "X-Request-ID", - "value": "dd90c863-82e3-4ef8-9568-3e68a64de1e0" - }, - { - "key": "X-Correlation-ID", - "value": "b08cd6b6-96fc-410c-84a9-e52732fcbc09" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"DUPLICATE_RELATIONSHIP\",\n \"display\": \"Request must be for a new proxy role.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Proxy role already exists.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Missing scope - New proxy role", - "request": { - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"{{$isoTimestamp}}\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-11-23\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"MTH\",\n \"display\": \"Mother\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"TBC\",\n \"display\": \"TBC\"\n }\n ]\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ] - } - }, - "response": [ - { - "name": "Missing scope error returned", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "2aa3293e-ad0e-4389-a466-d3209ebbfa4e", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "425ca0da-e10c-4010-86b4-93ca9bf737eb", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-16T08:13:06.480Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-11-23\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"MTH\",\n \"display\": \"Mother\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"TBC\",\n \"display\": \"TBC\"\n }\n ]\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 15:18:49 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "353" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "75bfd563-8f97-4b8a-8d50-a08643917d89" - }, - { - "key": "x-amz-apigw-id", - "value": "UwqGBE7MLPEFySQ=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929bd59-918cef993de61bcebe339d3e" - }, - { - "key": "X-Request-ID", - "value": "2ca06d13-2568-4f70-b06c-077af0f57137" - }, - { - "key": "X-Correlation-ID", - "value": "8c8ffb79-cc4c-4cb0-a62e-31dc1310a387" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_SCOPE\",\n \"display\": \"Required values are missing.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Unable to find scope\",\n \"expression\": [\n \"scope\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Invalid status - New proxy role", - "request": { - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"invalid\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"{{$isoTimestamp}}\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-11-23\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"MTH\",\n \"display\": \"Mother\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"TBC\",\n \"display\": \"TBC\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ] - } - }, - "response": [ - { - "name": "Invalid status - New proxy role", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "1e0a0136-6025-4190-8450-5676ada97c3c", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "bc404ec3-52fa-465c-9401-2b70484989bc", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"invalid\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"{{$isoTimestamp}}\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-11-23\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"MTH\",\n \"display\": \"Mother\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"TBC\",\n \"display\": \"TBC\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent" - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 15:27:32 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "339" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "47dd1183-4b49-44f1-a524-79fe459589a9" - }, - { - "key": "x-amz-apigw-id", - "value": "UwrXkFOZrPEF1ZA=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929bf63-31132bda7b3f654ea3534f15" - }, - { - "key": "X-Request-ID", - "value": "e23fbdd1-027c-4281-b37d-094691df9fc7" - }, - { - "key": "X-Correlation-ID", - "value": "226277b1-9d7c-411a-b3fd-3a4a70a4d90e" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_STATUS\",\n \"display\": \"Invalid status.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Status is invalid\",\n \"expression\": [\n \"status\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Missing free text for Other", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ],\n \"text\": \"Patient Privacy Consent\"\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"Information Access\"\n }\n ],\n \"text\": \"Information Access Consent\"\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-01-12T15:09:49.458Z\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"OTHER\",\n \"display\": \"Other reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ] - }, - "description": "## Example scenario\n\n**Given** no proxy role exists in NPS between a proxy and patient \n**When** I send a POST /Consent request for the proxy and patient with an invalid performer id \n**Then** a 422 error response is returned with code 'INVALID_IDENTIFIER_VALUE'" - }, - "response": [ - { - "name": "Missing free text code error returned", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "22f85b02-35ff-475f-808f-e0fb2bc93393", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "860406c9-ef53-4fed-939c-b6efbe8106f7", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ],\n \"text\": \"Patient Privacy Consent\"\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"Information Access\"\n }\n ],\n \"text\": \"Information Access Consent\"\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-01-12T15:09:49.458Z\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"OTHER\",\n \"display\": \"Other reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent" - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 12:46:09 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "402" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "369c4598-e093-44d1-8d27-015c1e1f8a40" - }, - { - "key": "x-amz-apigw-id", - "value": "UwTu1FORLPEFh3Q=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69299991-27f38de5fa687e1e7d4659b3" - }, - { - "key": "X-Request-ID", - "value": "70591ef1-fbe0-442b-bd9a-545fb5713859" - }, - { - "key": "X-Correlation-ID", - "value": "037cf36b-1014-4177-bcc6-c1cd647aae42" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_FREE_TEXT_FOR_OTHER\",\n \"display\": \"Free text must be provided for OTHER reason codes.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Free text is required when reason code is OTHER.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Missing grantor", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n\t\"resourceType\": \"Consent\",\n\t\"status\": \"active\",\n\t\"scope\": {\n\t\t\"coding\": [\n\t\t\t{\n\t\t\t\t\"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n\t\t\t\t\"code\": \"patient-privacy\",\n\t\t\t\t\"display\": \"Privacy Consent\"\n\t\t\t}\n\t\t]\n\t},\n\t\"category\": [\n\t\t{\n\t\t\t\"coding\": [\n\t\t\t\t{\n\t\t\t\t\t\"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n\t\t\t\t\t\"code\": \"INFA\",\n\t\t\t\t\t\"display\": \"information access\"\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t],\n\t\"patient\": {\n\t\t\"type\": \"Patient\",\n\t\t\"identifier\": {\n\t\t\t\"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n\t\t\t\"value\": \"9736898717\"\n\t\t}\n\t},\n\t\"dateTime\": \"2026-02-09T13:50:10.090Z\",\n\t\"provision\": {\n\t\t\"period\": {\n\t\t\t\"start\": \"2025-12-02\",\n\t\t\t\"end\": \"2030-11-23\"\n\t\t},\n\t\t\"actor\": [\n\t\t\t{\n\t\t\t\t\"role\": {\n\t\t\t\t\t\"coding\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n\t\t\t\t\t\t\t\"code\": \"parental-responsibility\",\n\t\t\t\t\t\t\t\"display\": \"Parental responsibility\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t\"reference\": {\n\t\t\t\t\t\"type\": \"RelatedPerson\",\n\t\t\t\t\t\"identifier\": {\n\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n\t\t\t\t\t\t\"value\": \"9736898148\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t},\n\t\"extension\": [\n\t\t{\n\t\t\t\"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n\t\t\t\"valueCodeableConcept\": {\n\t\t\t\t\"coding\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n\t\t\t\t\t\t\"code\": \"ROLE_CREATED\",\n\t\t\t\t\t\t\"display\": \"Role created\"\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n\t\t\t\"valueReference\": {\n\t\t\t\t\"identifier\": {\n\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n\t\t\t\t\t\"value\": \"9736898148\"\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ] - }, - "description": "## Example scenario\n\n**Given** no proxy role exists in NPS between a proxy and patient \n**When** I send a POST /Consent request for the proxy and patient with an invalid performer id \n**Then** a 422 error response is returned with code 'INVALID_IDENTIFIER_VALUE'" - }, - "response": [ - { - "name": "Missing grantor error", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n\t\"resourceType\": \"Consent\",\n\t\"status\": \"active\",\n\t\"scope\": {\n\t\t\"coding\": [\n\t\t\t{\n\t\t\t\t\"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n\t\t\t\t\"code\": \"patient-privacy\",\n\t\t\t\t\"display\": \"Privacy Consent\"\n\t\t\t}\n\t\t]\n\t},\n\t\"category\": [\n\t\t{\n\t\t\t\"coding\": [\n\t\t\t\t{\n\t\t\t\t\t\"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n\t\t\t\t\t\"code\": \"INFA\",\n\t\t\t\t\t\"display\": \"information access\"\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t],\n\t\"patient\": {\n\t\t\"type\": \"Patient\",\n\t\t\"identifier\": {\n\t\t\t\"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n\t\t\t\"value\": \"9736898717\"\n\t\t}\n\t},\n\t\"dateTime\": \"2026-02-09T13:50:10.090Z\",\n\t\"provision\": {\n\t\t\"period\": {\n\t\t\t\"start\": \"2025-12-02\",\n\t\t\t\"end\": \"2030-11-23\"\n\t\t},\n\t\t\"actor\": [\n\t\t\t{\n\t\t\t\t\"role\": {\n\t\t\t\t\t\"coding\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n\t\t\t\t\t\t\t\"code\": \"parental-responsibility\",\n\t\t\t\t\t\t\t\"display\": \"Parental responsibility\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t\"reference\": {\n\t\t\t\t\t\"type\": \"RelatedPerson\",\n\t\t\t\t\t\"identifier\": {\n\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n\t\t\t\t\t\t\"value\": \"9736898148\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t},\n\t\"extension\": [\n\t\t{\n\t\t\t\"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n\t\t\t\"valueCodeableConcept\": {\n\t\t\t\t\"coding\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n\t\t\t\t\t\t\"code\": \"ROLE_CREATED\",\n\t\t\t\t\t\t\"display\": \"Role created\"\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n\t\t\t\"valueReference\": {\n\t\t\t\t\"identifier\": {\n\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n\t\t\t\t\t\"value\": \"9736898148\"\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 12:46:09 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "402" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "369c4598-e093-44d1-8d27-015c1e1f8a40" - }, - { - "key": "x-amz-apigw-id", - "value": "UwTu1FORLPEFh3Q=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69299991-27f38de5fa687e1e7d4659b3" - }, - { - "key": "X-Request-ID", - "value": "70591ef1-fbe0-442b-bd9a-545fb5713859" - }, - { - "key": "X-Correlation-ID", - "value": "037cf36b-1014-4177-bcc6-c1cd647aae42" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_GRANTOR\",\n \"display\": \"Grantor required for active status\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Grantor extension is required when creating/updating an active proxy role\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor')\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Missing grantor reference", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ] - }, - "description": "## Example scenario\n\n**Given** no proxy role exists in NPS between a proxy and patient \n**When** I send a POST /Consent request for the proxy and patient with an invalid performer id \n**Then** a 422 error response is returned with code 'INVALID_IDENTIFIER_VALUE'" - }, - "response": [ - { - "name": "Missing grantor reference error", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "f059df53-0d68-4551-8233-8dedb7de5ba0", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "2a759f36-a989-4392-b0ed-95b2425d92f9", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent" - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 12:46:09 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "402" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "369c4598-e093-44d1-8d27-015c1e1f8a40" - }, - { - "key": "x-amz-apigw-id", - "value": "UwTu1FORLPEFh3Q=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69299991-27f38de5fa687e1e7d4659b3" - }, - { - "key": "X-Request-ID", - "value": "70591ef1-fbe0-442b-bd9a-545fb5713859" - }, - { - "key": "X-Correlation-ID", - "value": "037cf36b-1014-4177-bcc6-c1cd647aae42" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_GRANTOR_REFERENCE\",\n \"display\": \"Missing grantor reference\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Grantor extension must contain a valueReference\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Missing grantor identifier", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {}\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ] - }, - "description": "## Example scenario\n\n**Given** no proxy role exists in NPS between a proxy and patient \n**When** I send a POST /Consent request for the proxy and patient with an invalid performer id \n**Then** a 422 error response is returned with code 'INVALID_IDENTIFIER_VALUE'" - }, - "response": [ - { - "name": "Missing grantor identifier error", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "f059df53-0d68-4551-8233-8dedb7de5ba0", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "2a759f36-a989-4392-b0ed-95b2425d92f9", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {}\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent" - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 12:46:09 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "402" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "369c4598-e093-44d1-8d27-015c1e1f8a40" - }, - { - "key": "x-amz-apigw-id", - "value": "UwTu1FORLPEFh3Q=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69299991-27f38de5fa687e1e7d4659b3" - }, - { - "key": "X-Request-ID", - "value": "70591ef1-fbe0-442b-bd9a-545fb5713859" - }, - { - "key": "X-Correlation-ID", - "value": "037cf36b-1014-4177-bcc6-c1cd647aae42" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_GRANTOR_IDENTIFIER\",\n \"display\": \"Missing grantor identifier\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Grantor extension must contain a valueIdentifier\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Invalid grantor identifier system", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"BAD\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ] - }, - "description": "## Example scenario\n\n**Given** no proxy role exists in NPS between a proxy and patient \n**When** I send a POST /Consent request for the proxy and patient with an invalid performer id \n**Then** a 422 error response is returned with code 'INVALID_IDENTIFIER_VALUE'" - }, - "response": [ - { - "name": "Invalid grantor identifier system error", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "2a747914-9044-4543-90b0-ef09b2efbb7a", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "fabc4a6e-83ed-49e9-a2dd-cf0024f12a56", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"BAD\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent" - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 12:46:09 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "402" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "369c4598-e093-44d1-8d27-015c1e1f8a40" - }, - { - "key": "x-amz-apigw-id", - "value": "UwTu1FORLPEFh3Q=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69299991-27f38de5fa687e1e7d4659b3" - }, - { - "key": "X-Request-ID", - "value": "70591ef1-fbe0-442b-bd9a-545fb5713859" - }, - { - "key": "X-Correlation-ID", - "value": "037cf36b-1014-4177-bcc6-c1cd647aae42" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_GRANTOR_SYSTEM\",\n \"display\": \"Invalid grantor identifier system\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Valid grantor extension identifier system is required when creating/updating a consent with status 'active'\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier.system\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Invalid grantor identifier value", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"\"\n }\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ] - }, - "description": "## Example scenario\n\n**Given** no proxy role exists in NPS between a proxy and patient \n**When** I send a POST /Consent request for the proxy and patient with an invalid performer id \n**Then** a 422 error response is returned with code 'INVALID_IDENTIFIER_VALUE'" - }, - "response": [ - { - "name": "Invalid grantor identifier error", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "961d83de-6b2c-4d5f-8aaf-d48a65bf94b3", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "5093a1e0-f616-4565-b4f1-24c93774e0a0", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"\"\n }\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent" - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 12:46:09 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "402" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "369c4598-e093-44d1-8d27-015c1e1f8a40" - }, - { - "key": "x-amz-apigw-id", - "value": "UwTu1FORLPEFh3Q=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-69299991-27f38de5fa687e1e7d4659b3" - }, - { - "key": "X-Request-ID", - "value": "70591ef1-fbe0-442b-bd9a-545fb5713859" - }, - { - "key": "X-Correlation-ID", - "value": "037cf36b-1014-4177-bcc6-c1cd647aae42" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_GRANTOR_VALUE\",\n \"display\": \"Invalid grantor identifier value\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Valid grantor extension identifier value is required when creating/updating a consent with status 'active'\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier.value\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Invalid identifer system - New proxy role", - "request": { - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number/invalid\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"{{$isoTimestamp}}\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-11-23\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"MTH\",\n \"display\": \"Mother\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"TBC\",\n \"display\": \"TBC\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent" - ] - } - }, - "response": [ - { - "name": "Invalid status error returned", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "X-Request-ID", - "value": "004491e4-b270-4882-99c8-af4e387a505f", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "5f51e084-afd4-442b-b229-5470a750de52", - "type": "text" - }, - { - "key": "Content-Type", - "value": "application/fhir+json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number/invalid\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-16T08:22:13.462Z\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n \"provision\": {\n \"period\": {\n \"start\": \"2025-11-23\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"MTH\",\n \"display\": \"Mother\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"TBC\",\n \"display\": \"TBC\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent" - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 15:29:32 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "399" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "9ca19fe7-0a06-4da0-9b72-9e6135da40f1" - }, - { - "key": "x-amz-apigw-id", - "value": "UwrqcGPaLPEFWkg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929bfdc-4e9f2ada8f5faf65f1630c1c" - }, - { - "key": "X-Request-ID", - "value": "21cc43ac-e531-477d-bc97-3e77e9657b52" - }, - { - "key": "X-Correlation-ID", - "value": "aeeaa71d-0a78-4e83-8c81-3b2884371ae9" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_IDENTIFIER_SYSTEM\",\n \"display\": \"Invalid identifier system.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Patient identifier system is invalid\",\n \"expression\": [\n \"patient.identifier.system\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - } - ], - "description": "## Allowed auth methods\n\n- CIS2 token - Auth with test user `656005750108`\n \n\nSee collection level documentation for info about how to get authorization tokens.", - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "event": [ - { - "listen": "prerequest", - "script": { - "type": "text/javascript", - "packages": {}, - "requests": {}, - "exec": [ - "" - ] - } - }, - { - "listen": "test", - "script": { - "type": "text/javascript", - "packages": {}, - "requests": {}, - "exec": [ - "" - ] - } - } - ] - }, - { - "name": "Update proxy role (PATCH /Consent/{id})", - "item": [ - { - "name": "Valid request - Single update - Update proxy role", - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\"op\": \"replace\", \"path\": \"/status\", \"value\": \"inactive\"},\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_DEACTIVATED_PATIENT_REQUEST\",\n \"display\": \"At patient request\"\n }\n ]\n }\n }\n ]\n }\n]\n", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store (NPS) \n**When** I send a PATCH /Consent request to update the proxy role \n**Then** a 200 response is returned and the role is updated" - }, - "response": [ - { - "name": "Proxy role updated to 'inactive' status", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "37a39814-060e-4100-b2ea-7057679112ec", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "bc983fc5-8066-4373-a87b-30d8cc0f905a", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\"op\": \"replace\", \"path\": \"/status\", \"value\": \"inactive\"},\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_DEACTIVATED_PATIENT_REQUEST\",\n \"display\": \"At patient request\"\n }\n ]\n }\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 16:23:31 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "101" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "5b03d759-c55a-462d-ba3c-e2dbf92d031a" - }, - { - "key": "x-amz-apigw-id", - "value": "UwzkUE0urPEFqHg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929cc81-0d146fcdbc79baf5a5279c3d" - }, - { - "key": "X-Request-ID", - "value": "4555113e-aa4d-409d-bac0-41b0ed91cfc2" - }, - { - "key": "X-Correlation-ID", - "value": "b8c69a60-667d-4b0f-89c7-9de6d4e289a4" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\"\n }\n ]\n}" - }, - { - "name": "Proxy role end date updated", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/provision/period/end\",\n \"value\": \"2026-12-31\"\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 15:48:46 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "101" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "eb0a2130-76e5-41a0-9916-e7c8aa25a4ea" - }, - { - "key": "x-amz-apigw-id", - "value": "VEgG2Hh6LPEFXRQ=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6931ad5e-d4506ade6d4f3410b20618b9" - }, - { - "key": "X-Request-ID", - "value": "90a9a964-db4c-4ec7-9498-76087f979bb5" - }, - { - "key": "X-Correlation-ID", - "value": "2aa6936b-c5ba-437d-898e-c58794601a01" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\"\n }\n ]\n}" - }, - { - "name": "Proxy role policy rule updated", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"op\": \"add\",\n \"path\": \"/policyRule\",\n \"value\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 15:54:54 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "101" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "63072889-896c-43b1-aff1-0e4eceb2b4d4" - }, - { - "key": "x-amz-apigw-id", - "value": "VEg_9FQxLPEF1mA=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6931aecc-d571f76cb8f3900088a01c45" - }, - { - "key": "X-Request-ID", - "value": "e436ebda-5011-431a-9de3-1d0749c6f45e" - }, - { - "key": "X-Correlation-ID", - "value": "930a58a1-7ca9-4a89-ac33-a24f5277b1d9" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\"\n }\n ]\n}" - } - ] - }, - { - "name": "Missing grantor", - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/status\",\n \"value\": \"active\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store (NPS) \n**When** I send a PATCH /Consent request to update the proxy role \n**Then** a 200 response is returned and the role is updated" - }, - "response": [ - { - "name": "Missing grantor error", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "91ffa031-c7d8-46c9-acd7-5c7c81c7ad3e", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "24af4521-3ca5-4123-92a7-b255daa5f561", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n\t{\n\t\t\"op\": \"replace\",\n\t\t\"path\": \"/status\",\n\t\t\"value\": \"active\"\n\t},\n\t{\n\t\t\"op\": \"add\",\n\t\t\"path\": \"/extension/-\",\n\t\t\"value\": [\n\t\t\t{\n\t\t\t\t\"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n\t\t\t\t\"valueCodeableConcept\": {\n\t\t\t\t\t\"coding\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n\t\t\t\t\t\t\t\"code\": \"ROLE_CREATED\",\n\t\t\t\t\t\t\t\"display\": \"Role created\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Mon, 09 Feb 2026 13:44:16 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "490" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "35c94f51-ceed-4544-973b-6666dce5a447" - }, - { - "key": "x-amz-apigw-id", - "value": "YhCroEoNLPEFfxg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6989e4b0-ed8360e8a73f108f4753cf19" - }, - { - "key": "X-Request-ID", - "value": "e210658f-9b3e-4b3f-a41a-706ef045619f" - }, - { - "key": "X-Correlation-ID", - "value": "5ad4f9a4-07bc-4e98-a3e0-552a3a990631" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_GRANTOR\",\n \"display\": \"Grantor required for active status\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Grantor extension is required when creating/updating an active proxy role\",\n \"severity\": \"error\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor')\"\n ]\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Missing grantor reference", - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n\t{\n\t\t\"op\": \"replace\",\n\t\t\"path\": \"/status\",\n\t\t\"value\": \"active\"\n\t},\n\t{\n\t\t\"op\": \"add\",\n\t\t\"path\": \"/extension/-\",\n\t\t\"value\": [\n\t\t\t{\n\t\t\t\t\"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n\t\t\t\t\"valueCodeableConcept\": {\n\t\t\t\t\t\"coding\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n\t\t\t\t\t\t\t\"code\": \"ROLE_CREATED\",\n\t\t\t\t\t\t\t\"display\": \"Role created\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\"\n\t\t\t}\n\t\t]\n\t}\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store (NPS) \n**When** I send a PATCH /Consent request to update the proxy role \n**Then** a 200 response is returned and the role is updated" - }, - "response": [ - { - "name": "Missing grantor reference error", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "91ffa031-c7d8-46c9-acd7-5c7c81c7ad3e", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "24af4521-3ca5-4123-92a7-b255daa5f561", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/status\",\n \"value\": \"active\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\"\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Mon, 09 Feb 2026 13:44:16 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "490" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "35c94f51-ceed-4544-973b-6666dce5a447" - }, - { - "key": "x-amz-apigw-id", - "value": "YhCroEoNLPEFfxg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6989e4b0-ed8360e8a73f108f4753cf19" - }, - { - "key": "X-Request-ID", - "value": "e210658f-9b3e-4b3f-a41a-706ef045619f" - }, - { - "key": "X-Correlation-ID", - "value": "5ad4f9a4-07bc-4e98-a3e0-552a3a990631" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_GRANTOR_REFERENCE\",\n \"display\": \"Missing grantor reference\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Grantor extension must contain a valueReference\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Missing grantor identifier", - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/status\",\n \"value\": \"active\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store (NPS) \n**When** I send a PATCH /Consent request to update the proxy role \n**Then** a 200 response is returned and the role is updated" - }, - "response": [ - { - "name": "Missing grantor identifier error", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "91ffa031-c7d8-46c9-acd7-5c7c81c7ad3e", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "24af4521-3ca5-4123-92a7-b255daa5f561", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/status\",\n \"value\": \"active\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Mon, 09 Feb 2026 13:44:16 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "490" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "35c94f51-ceed-4544-973b-6666dce5a447" - }, - { - "key": "x-amz-apigw-id", - "value": "YhCroEoNLPEFfxg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6989e4b0-ed8360e8a73f108f4753cf19" - }, - { - "key": "X-Request-ID", - "value": "e210658f-9b3e-4b3f-a41a-706ef045619f" - }, - { - "key": "X-Correlation-ID", - "value": "5ad4f9a4-07bc-4e98-a3e0-552a3a990631" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_GRANTOR_IDENTIFIER\",\n \"display\": \"Missing grantor identifier\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Grantor extension must contain a valueIdentifier\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Invalid grantor system", - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/status\",\n \"value\": \"active\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://wrong-system.com\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store (NPS) \n**When** I send a PATCH /Consent request to update the proxy role \n**Then** a 200 response is returned and the role is updated" - }, - "response": [ - { - "name": "Invalid grantor system error", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "91ffa031-c7d8-46c9-acd7-5c7c81c7ad3e", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "24af4521-3ca5-4123-92a7-b255daa5f561", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/status\",\n \"value\": \"active\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://wrong-system.com\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Mon, 09 Feb 2026 13:44:16 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "490" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "35c94f51-ceed-4544-973b-6666dce5a447" - }, - { - "key": "x-amz-apigw-id", - "value": "YhCroEoNLPEFfxg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6989e4b0-ed8360e8a73f108f4753cf19" - }, - { - "key": "X-Request-ID", - "value": "e210658f-9b3e-4b3f-a41a-706ef045619f" - }, - { - "key": "X-Correlation-ID", - "value": "5ad4f9a4-07bc-4e98-a3e0-552a3a990631" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_GRANTOR_SYSTEM\",\n \"display\": \"Invalid grantor identifier system\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Valid grantor extension identifier system is required when creating/updating a consent with status 'active'\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier.system\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Invalid grantor value", - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n\t{\n\t\t\"op\": \"replace\",\n\t\t\"path\": \"/status\",\n\t\t\"value\": \"active\"\n\t},\n\t{\n\t\t\"op\": \"add\",\n\t\t\"path\": \"/extension/-\",\n\t\t\"value\": [\n\t\t\t{\n\t\t\t\t\"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n\t\t\t\t\"valueCodeableConcept\": {\n\t\t\t\t\t\"coding\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n\t\t\t\t\t\t\t\"code\": \"ROLE_ACTIVATED\",\n\t\t\t\t\t\t\t\"display\": \"Role activated\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n\t\t\t\t\"valueReference\": {\n\t\t\t\t\t\"identifier\": {\n\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store (NPS) \n**When** I send a PATCH /Consent request to update the proxy role \n**Then** a 200 response is returned and the role is updated" - }, - "response": [ - { - "name": "Invalid grantor value error", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "91ffa031-c7d8-46c9-acd7-5c7c81c7ad3e", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "24af4521-3ca5-4123-92a7-b255daa5f561", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n\t{\n\t\t\"op\": \"replace\",\n\t\t\"path\": \"/status\",\n\t\t\"value\": \"active\"\n\t},\n\t{\n\t\t\"op\": \"add\",\n\t\t\"path\": \"/extension/-\",\n\t\t\"value\": [\n\t\t\t{\n\t\t\t\t\"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n\t\t\t\t\"valueCodeableConcept\": {\n\t\t\t\t\t\"coding\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n\t\t\t\t\t\t\t\"code\": \"ROLE_ACTIVATED\",\n\t\t\t\t\t\t\t\"display\": \"Role activated\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n\t\t\t\t\"valueReference\": {\n\t\t\t\t\t\"identifier\": {\n\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Mon, 09 Feb 2026 13:44:16 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "490" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "35c94f51-ceed-4544-973b-6666dce5a447" - }, - { - "key": "x-amz-apigw-id", - "value": "YhCroEoNLPEFfxg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6989e4b0-ed8360e8a73f108f4753cf19" - }, - { - "key": "X-Request-ID", - "value": "e210658f-9b3e-4b3f-a41a-706ef045619f" - }, - { - "key": "X-Correlation-ID", - "value": "5ad4f9a4-07bc-4e98-a3e0-552a3a990631" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_GRANTOR_VALUE\",\n \"display\": \"Invalid grantor identifier value\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Valid grantor extension identifier value is required when creating/updating a consent with status 'active'\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier.value\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Valid request - Multiple updates - Update proxy role", - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\"op\": \"replace\", \"path\": \"/status\", \"value\": \"inactive\"},\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_DEACTIVATED_PATIENT_REQUEST\",\n \"display\": \"At patient request\"\n }\n ]\n }\n }\n ]\n },\n {\n \"op\": \"replace\",\n \"path\": \"/provision/period/end\",\n \"value\": \"2026-12-31\"\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store (NPS) \n**When** I send a PATCH /Consent request with multiple updates for the proxy role \n**Then** a 200 response is returned and the role is updated" - }, - "response": [ - { - "name": "Proxy role status updated with end date", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "30e9b272-a646-4868-a2ce-6950f65bd736", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "7b9ded57-0c7a-497e-85c8-f2f00a6e0104", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\"op\": \"replace\", \"path\": \"/status\", \"value\": \"inactive\"},\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_DEACTIVATED_PATIENT_REQUEST\",\n \"display\": \"At patient request\"\n }\n ]\n }\n }\n ]\n },\n {\n \"op\": \"replace\",\n \"path\": \"/provision/period/end\",\n \"value\": \"2026-12-31\"\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Thu, 04 Dec 2025 15:56:16 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "348" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "fbb23fc6-d143-4ad4-ab95-fef1276bf7d0" - }, - { - "key": "x-amz-apigw-id", - "value": "VEhNJE2VrPEFXkA=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6931af20-0cc7e03b708f8949fc05bdfa" - }, - { - "key": "X-Request-ID", - "value": "0aa389b6-9542-428f-9e1c-b5411ff0a531" - }, - { - "key": "X-Correlation-ID", - "value": "e3845975-3d6b-4185-81cb-22a80f7ed0da" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\"\n }\n ]\n}" - } - ] - }, - { - "name": "Resource not found - Update proxy role", - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/status\",\n \"value\": \"inactive\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_DEACTIVATED_PATIENT_REQUEST\",\n \"display\": \"At patient request\"\n }\n ]\n }\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "{{$randomUUID}}" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store for a given UUID \n**When** a PATCH /Consent request is sent using the UUID \n**Then** a 404 error is returned with code 'RESOURCE_NOT_FOUND'" - }, - "response": [ - { - "name": "Resource not found error response", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "eb4bff55-95ce-4943-bd54-4b69266c2bb3", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "5e38ba2b-57db-42b5-b20b-00ae83957239", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/status\",\n \"value\": \"inactive\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_DEACTIVATED_PATIENT_REQUEST\",\n \"display\": \"At patient request\"\n }\n ]\n }\n }\n ]\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "127149ab-d560-4f76-a72a-0207a1d09a7f" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 16:51:31 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "348" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "5940dd45-0b04-4e71-8fce-6a69665b256e" - }, - { - "key": "x-amz-apigw-id", - "value": "Uw3q4HTZrPEFxLQ=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929d312-f383a46c595faa9361bb8326" - }, - { - "key": "X-Request-ID", - "value": "4cfc1e62-1d97-47b2-825e-2f72eed5e29e" - }, - { - "key": "X-Correlation-ID", - "value": "db86232d-68a5-492d-96e3-02613a3cf6bf" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"diagnostics\": \"Proxy role not found.\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"display\": \"Request must be for a existing proxy role.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Invalid status code - Update proxy role", - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\"op\": \"replace\", \"path\": \"/status\", \"value\": \"invalid_status\"},\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"ROLE_DEACTIVATED_PATIENT_REQUEST\",\n \"display\": \"At patient request\"\n }\n ]\n }\n }\n ]\n }\n]\n", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store for a given UUID \n**When** a PATCH /Consent request is sent using the UUID \n**Then** a 404 error is returned with code 'RESOURCE_NOT_FOUND'" - }, - "response": [ - { - "name": "Invalid status code error returned", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "45daf0e4-81b4-49a2-94ec-6893977a394c", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "ac7cb80e-309a-4e40-b3dc-44ed631e1943", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\"op\": \"replace\", \"path\": \"/status\", \"value\": \"invalid_status\"},\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"ROLE_DEACTIVATED_PATIENT_REQUEST\",\n \"display\": \"At patient request\"\n }\n ]\n }\n }\n ]\n }\n]\n", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "aa58f9b7-2a02-45a2-9cb4-0d6fefe07a02" - } - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 16:56:26 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "329" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "557c0652-9a38-434c-99c1-f979920055bf" - }, - { - "key": "x-amz-apigw-id", - "value": "Uw4ZOEOOLPEFggg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929d43a-6c636f683c11b4ac83776aa6" - }, - { - "key": "X-Request-ID", - "value": "1a4ee8bf-0d2b-4398-950f-b3fd9332e7d3" - }, - { - "key": "X-Correlation-ID", - "value": "986fe591-c2f0-422d-9e1e-c99628e9a1df" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_STATUS_CODE\",\n \"display\": \"Status code is invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Invalid status code.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Invalid state transition - Update proxy role", - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n\t{\n\t\t\"op\": \"replace\",\n\t\t\"path\": \"/status\",\n\t\t\"value\": \"proposed\"\n\t},\n\t{\n\t\t\"op\": \"add\",\n\t\t\"path\": \"/extension/-\",\n\t\t\"value\": [\n\t\t\t{\n\t\t\t\t\"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n\t\t\t\t\"valueCodeableConcept\": {\n\t\t\t\t\t\"coding\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n\t\t\t\t\t\t\t\"code\": \"APPLICATION_RESUBMITTED\",\n\t\t\t\t\t\t\t\"display\": \"Application re-submitted\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store for a given UUID \n**When** a PATCH /Consent request is sent using the UUID \n**Then** a 404 error is returned with code 'RESOURCE_NOT_FOUND'" - }, - "response": [ - { - "name": "Invalid state transition error returned", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n\t{\n\t\t\"op\": \"replace\",\n\t\t\"path\": \"/status\",\n\t\t\"value\": \"proposed\"\n\t},\n\t{\n\t\t\"op\": \"add\",\n\t\t\"path\": \"/extension/-\",\n\t\t\"value\": [\n\t\t\t{\n\t\t\t\t\"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n\t\t\t\t\"valueCodeableConcept\": {\n\t\t\t\t\t\"coding\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n\t\t\t\t\t\t\t\"code\": \"APPLICATION_RESUBMITTED\",\n\t\t\t\t\t\t\t\"display\": \"Application re-submitted\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 16:56:26 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "329" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "557c0652-9a38-434c-99c1-f979920055bf" - }, - { - "key": "x-amz-apigw-id", - "value": "Uw4ZOEOOLPEFggg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929d43a-6c636f683c11b4ac83776aa6" - }, - { - "key": "X-Request-ID", - "value": "1a4ee8bf-0d2b-4398-950f-b3fd9332e7d3" - }, - { - "key": "X-Correlation-ID", - "value": "986fe591-c2f0-422d-9e1e-c99628e9a1df" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"diagnostics\": \"Patch attempting invalid status change.\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_STATE_TRANSITION\",\n \"display\": \"Status change is invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Invalid path - Update proxy role", - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/someotherpath\",\n \"value\": \"active\"\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store for a given UUID \n**When** a PATCH /Consent request with an invalid path is sent using the UUID \n**Then** a 400 error is returned with code 'INVALID_PATCH_PATH'" - }, - "response": [ - { - "name": "Invalid path error returned", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "75fdd97a-89c6-49b8-84ad-aa9a770cecf0", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "95b73d30-9701-4e35-a93f-09677cae5b34", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/someotherpath\",\n \"value\": \"active\"\n }\n]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "aa58f9b7-2a02-45a2-9cb4-0d6fefe07a02" - } - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 16:58:39 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "346" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "9c37f3a0-d1af-4a9d-8664-20edf45bd111" - }, - { - "key": "x-amz-apigw-id", - "value": "Uw4t7HzBrPEFTsw=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929d4bf-e038f4c128983e6e945b14ad" - }, - { - "key": "X-Request-ID", - "value": "3e5e943f-2647-4a09-b216-7d3551a637e7" - }, - { - "key": "X-Correlation-ID", - "value": "65dc6940-bcb3-466d-b25d-0a10ab98d7e6" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_PATCH_PATH\",\n \"display\": \"Patch target is invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Patch targeting non-existent element.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Missing free text for Other", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\"op\": \"replace\", \"path\": \"/status\", \"value\": \"inactive\"},\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"OTHER\",\n \"display\": \"Other reason\"\n }\n ]\n }\n }\n ]\n }\n]\n", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{api_base_url}}/Consent/:consent_id", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store for a given UUID \n**When** a PATCH /Consent request with a missing free text and status reason of 'Other' is sent using the UUID \n**Then** a 400 error is returned with code 'MISSING_FREE_TEXT_FOR_OTHER'" - }, - "response": [ - { - "name": "Missing free text error", - "originalRequest": { - "method": "PATCH", - "header": [ - { - "key": "Content-Type", - "value": "application/json-patch+json", - "type": "text" - }, - { - "key": "X-Request-ID", - "value": "c8809963-1a8e-4df1-965e-64b2c3dfed0f", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "3070bc8d-baf4-4a66-a7ba-c6c4d092f805", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\"op\": \"replace\", \"path\": \"/status\", \"value\": \"inactive\"},\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"OTHER\",\n \"display\": \"Other reason\"\n }\n ]\n }\n }\n ]\n }\n]\n", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", - "protocol": "https", - "host": [ - "int", - "api", - "service", - "nhs", - "uk" - ], - "path": [ - "validated-relationships", - "FHIR", - "R4", - "Consent", - ":consent_id" - ], - "variable": [ - { - "key": "consent_id", - "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" - } - ] - } - }, - "status": "Unprocessable Entity (WebDAV) (RFC 4918)", - "code": 422, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 16:58:39 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "346" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "9c37f3a0-d1af-4a9d-8664-20edf45bd111" - }, - { - "key": "x-amz-apigw-id", - "value": "Uw4t7HzBrPEFTsw=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929d4bf-e038f4c128983e6e945b14ad" - }, - { - "key": "X-Request-ID", - "value": "3e5e943f-2647-4a09-b216-7d3551a637e7" - }, - { - "key": "X-Correlation-ID", - "value": "65dc6940-bcb3-466d-b25d-0a10ab98d7e6" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_FREE_TEXT_FOR_OTHER\",\n \"display\": \"Free text must be provided for OTHER reason codes.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Free text is required when reason code is OTHER.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - } - ], - "description": "## Allowed auth methods\n\n- CIS2 token - Auth with test user `656005750108`\n \n- NHS Login token - Auth with test user `9730675929`\n \n\nSee collection level documentation for info about how to get authorization tokens." - }, - { - "name": "Get verified candidate relationships (GET /RelatedPerson)", - "item": [ - { - "name": "Valid request - Get verified candidate relationships", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/RelatedPerson?identifier=9736898121", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "RelatedPerson" - ], - "query": [ - { - "key": "identifier", - "value": "9736898121", - "description": "NHS number of the user to retrieve verified relationships for" - } - ] - }, - "description": "## Example scenario\n\n**Given** an NHS user has multiple related person relationships in PDS \n**When** a GET /RelatedPerson request is sent for the user \n**Then** the relationships are returned" - }, - "response": [ - { - "name": "Candidate relationship returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/RelatedPerson?identifier=9736898148", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "RelatedPerson" - ], - "query": [ - { - "key": "identifier", - "value": "9736898148", - "description": "NHS number of the user to retrieve verified relationships for" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 17:10:29 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "927" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "3c77c3f5-2f94-4718-b4df-a994b49a9c8d" - }, - { - "key": "x-amz-apigw-id", - "value": "Uw6coGWKLPEFyvQ=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929d783-8368a433a0eae3395c7136cb" - }, - { - "key": "X-Request-ID", - "value": "e464b1c8-ad9b-41a2-9de3-2dd0e34d0fce" - }, - { - "key": "X-Correlation-ID", - "value": "056c8f1f-9d95-44b2-a4f7-582554f53387" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/IyKYB\",\n \"resource\": {\n \"id\": \"IyKYB\",\n \"birthDate\": \"2015-09-26\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"MTH\",\n \"display\": \"mother\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ],\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?identifier=9736898148\"\n }\n ],\n \"timestamp\": \"2025-11-28T17:10:29.231159+00:00\",\n \"total\": 1,\n \"type\": \"searchset\",\n \"resourceType\": \"Bundle\"\n}" - }, - { - "name": "Candidate relationship returned with patient details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/RelatedPerson?identifier=9736898148&_include=RelatedPerson:patient", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "RelatedPerson" - ], - "query": [ - { - "key": "identifier", - "value": "9736898148", - "description": "NHS number of the user to retrieve verified relationships for" - }, - { - "key": "_include", - "value": "RelatedPerson:patient" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 17:13:27 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "1395" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "a34914f5-c757-4a7c-b8e6-2061793de970" - }, - { - "key": "x-amz-apigw-id", - "value": "Uw63LFuCLPEFtfA=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929d82d-7210a91047b09608692e6ff6" - }, - { - "key": "X-Request-ID", - "value": "c46487fa-a7a9-4adb-82ec-dc7702fa66d4" - }, - { - "key": "X-Correlation-ID", - "value": "755116de-f4ef-406b-8088-1af14dd85c8d" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898644\",\n \"resource\": {\n \"id\": \"9736898644\",\n \"birthDate\": \"2015-09-26\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/IyKYB\",\n \"resource\": {\n \"id\": \"IyKYB\",\n \"birthDate\": \"2015-09-26\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"MTH\",\n \"display\": \"mother\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ],\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?identifier=9736898148&_include=RelatedPerson%3Apatient\"\n }\n ],\n \"timestamp\": \"2025-11-28T17:13:27.630813+00:00\",\n \"total\": 1,\n \"type\": \"searchset\",\n \"resourceType\": \"Bundle\"\n}" - } - ] - }, - { - "name": "Valid request - No relationships returned - Get verified candidate relationships", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/RelatedPerson?identifier=9736898199", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "RelatedPerson" - ], - "query": [ - { - "key": "identifier", - "value": "9736898199", - "description": "NHS number of the user to retrieve verified relationships for" - } - ] - }, - "description": "## Example scenario\n\n**Given** an NHS user has no related person relationships in PDS \n**When** a GET /RelatedPerson request is sent for the user \n**Then** no relationships are returned" - }, - "response": [ - { - "name": "No relationships returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/RelatedPerson?identifier=9736898199", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "RelatedPerson" - ], - "query": [ - { - "key": "identifier", - "value": "9736898199", - "description": "NHS number of the user to retrieve verified relationships for" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 17:15:06 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "249" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "9305e61b-2b8b-4a0c-84dd-0be9c4e1ce72" - }, - { - "key": "x-amz-apigw-id", - "value": "Uw7IDHSxrPEF7gg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929d899-c345d4868005c5dc5999d598" - }, - { - "key": "X-Request-ID", - "value": "189b9dd8-722e-4e1b-b76b-75d2dd05fd00" - }, - { - "key": "X-Correlation-ID", - "value": "38045e59-8b2a-4f52-a1a5-834c91c25a9f" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?identifier=9736898199\"\n }\n ],\n \"timestamp\": \"2025-11-28T17:15:05.994606+00:00\",\n \"total\": 0,\n \"type\": \"searchset\",\n \"resourceType\": \"Bundle\"\n}" - } - ] - }, - { - "name": "Valid request - Verify relationship - Get verified candidate relationships", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/RelatedPerson?identifier=9736898148&patient:identifier=9736898644", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "RelatedPerson" - ], - "query": [ - { - "key": "identifier", - "value": "9736898148", - "description": "NHS number of the user to retrieve verified relationships for" - }, - { - "key": "patient:identifier", - "value": "9736898644" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy has a related person relationship in PDS \n**When** a GET /RelatedPerson request is sent for the proxy and the patient \n**Then** the relationship is returned" - }, - "response": [ - { - "name": "Verified relationship returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/RelatedPerson?identifier=9736898148&patient:identifier=9736898644", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "RelatedPerson" - ], - "query": [ - { - "key": "identifier", - "value": "9736898148", - "description": "NHS number of the user to retrieve verified relationships for" - }, - { - "key": "patient:identifier", - "value": "9736898644" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 17:19:37 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "959" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "2ac409be-e9ce-4d73-a4b4-3c8a791aa51e" - }, - { - "key": "x-amz-apigw-id", - "value": "Uw7x4HIMrPEF-Fg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929d9a5-d9df4059c3c602feabe873fc" - }, - { - "key": "X-Request-ID", - "value": "88367407-4953-4b64-9da0-6308c007b120" - }, - { - "key": "X-Correlation-ID", - "value": "8b55ca15-93fb-4ce9-be1b-eb0eb5e728fa" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/IyKYB\",\n \"resource\": {\n \"id\": \"IyKYB\",\n \"birthDate\": \"2015-09-26\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"MTH\",\n \"display\": \"mother\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ],\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?identifier=9736898148&patient%3Aidentifier=9736898644\"\n }\n ],\n \"timestamp\": \"2025-11-28T17:19:37.300736+00:00\",\n \"total\": 1,\n \"type\": \"searchset\",\n \"resourceType\": \"Bundle\"\n}" - }, - { - "name": "Verified relationship returned with patient details", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/RelatedPerson?identifier=9736898148&patient:identifier=9736898644&_include=RelatedPerson:patient", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "RelatedPerson" - ], - "query": [ - { - "key": "identifier", - "value": "9736898148", - "description": "NHS number of the user to retrieve verified relationships for" - }, - { - "key": "patient:identifier", - "value": "9736898644" - }, - { - "key": "_include", - "value": "RelatedPerson:patient" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 17:19:37 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "959" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "2ac409be-e9ce-4d73-a4b4-3c8a791aa51e" - }, - { - "key": "x-amz-apigw-id", - "value": "Uw7x4HIMrPEF-Fg=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929d9a5-d9df4059c3c602feabe873fc" - }, - { - "key": "X-Request-ID", - "value": "88367407-4953-4b64-9da0-6308c007b120" - }, - { - "key": "X-Correlation-ID", - "value": "8b55ca15-93fb-4ce9-be1b-eb0eb5e728fa" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/IyKYB\",\n \"resource\": {\n \"id\": \"IyKYB\",\n \"birthDate\": \"2015-09-26\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"MTH\",\n \"display\": \"mother\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ],\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?identifier=9736898148&patient%3Aidentifier=9736898644\"\n }\n ],\n \"timestamp\": \"2025-11-28T17:19:37.300736+00:00\",\n \"total\": 1,\n \"type\": \"searchset\",\n \"resourceType\": \"Bundle\"\n}" - } - ] - }, - { - "name": "Missing identifier value - Get verified candidate relationships", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/RelatedPerson", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "RelatedPerson" - ] - }, - "description": "## Example scenario\n\n**Given** a proxy has a related person relationship in PDS \n**When** a GET /RelatedPerson request is sent with no identifier \n**Then** a 400 error is returned with code 'MISSING_IDENTIFIER_VALUE'" - }, - "response": [ - { - "name": "Missing identifier value error returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/RelatedPerson", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "RelatedPerson" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 17:45:09 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "362" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "f524a29e-b0e9-45b0-af70-ad23fd87158c" - }, - { - "key": "x-amz-apigw-id", - "value": "Uw_h7GQFrPEF8xw=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929dfa5-ca879ed8f2a8b5c139182a8b" - }, - { - "key": "X-Request-ID", - "value": "28dbd904-517c-4e42-a3f6-37772b2da578" - }, - { - "key": "X-Correlation-ID", - "value": "e1229f7b-b14f-4858-b4fd-dcb3c9151a99" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_IDENTIFIER_VALUE\",\n \"display\": \"Missing RelatedPerson NHS number.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"The 'identifier' parameter is required\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Invalid identifier value - Get verified candidate relationships", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/RelatedPerson?identifier=invalid", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "RelatedPerson" - ], - "query": [ - { - "key": "identifier", - "value": "invalid" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy has a related person relationship in PDS \n**When** a GET /RelatedPerson request is sent with an invalid identifier \n**Then** a 400 error is returned with code 'INVALID_IDENTIFIER_VALUE'" - }, - "response": [ - { - "name": "Invalid identifier value error returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/RelatedPerson?identifier=invalid", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "RelatedPerson" - ], - "query": [ - { - "key": "identifier", - "value": "invalid" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 17:47:15 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "422" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "7a627dc1-8fe7-4a07-9a17-5e8a7c77963b" - }, - { - "key": "x-amz-apigw-id", - "value": "Uw_1hFJWLPEFbKQ=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929e022-4dc5c06769a0b866a6456227" - }, - { - "key": "X-Request-ID", - "value": "c695d77b-b94e-4e04-9e2b-f7e34ef2e414" - }, - { - "key": "X-Correlation-ID", - "value": "46db2d38-e52b-4fcc-a8cf-2617fec4557a" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"diagnostics\": \"Not a valid NHS Number provided for the 'identifier' parameter\",\n \"expression\": [\n \"RelatedPerson.identifier\"\n ],\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\",\n \"code\": \"INVALID_IDENTIFIER_VALUE\",\n \"display\": \"Provided value is invalid\"\n }\n ]\n },\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - }, - { - "name": "Invalid identifier system - Get verified candidate relationships", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {}, - "requests": {} - } - } - ], - "request": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number/invalid|730675929", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "RelatedPerson" - ], - "query": [ - { - "key": "identifier", - "value": "https://fhir.nhs.uk/Id/nhs-number/invalid|730675929" - } - ] - }, - "description": "## Example scenario\n\n**Given** a proxy has a related person relationship in PDS \n**When** a GET /RelatedPerson request is sent with an invalid identifier \n**Then** a 400 error is returned with code 'INVALID_IDENTIFIER_VALUE'" - }, - "response": [ - { - "name": "Invalid identifier value error returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "X-Request-ID", - "value": "{{$guid}}", - "type": "text" - }, - { - "key": "X-Correlation-ID", - "value": "{{$guid}}", - "type": "text" - } - ], - "url": { - "raw": "{{api_base_url}}/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number/invalid|730675929", - "host": [ - "{{api_base_url}}" - ], - "path": [ - "RelatedPerson" - ], - "query": [ - { - "key": "identifier", - "value": "https://fhir.nhs.uk/Id/nhs-number/invalid|730675929" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "Text", - "header": [ - { - "key": "Date", - "value": "Fri, 28 Nov 2025 17:48:42 GMT" - }, - { - "key": "Content-Type", - "value": "application/fhir+json" - }, - { - "key": "Content-Length", - "value": "352" - }, - { - "key": "Connection", - "value": "keep-alive" - }, - { - "key": "x-amzn-RequestId", - "value": "66e70023-f78b-48aa-a29f-3df08e3e895c" - }, - { - "key": "x-amz-apigw-id", - "value": "UxADKEqiLPEFbWw=" - }, - { - "key": "X-Amzn-Trace-Id", - "value": "Root=1-6929e07a-ade89162a2d0b573830554ca" - }, - { - "key": "X-Request-ID", - "value": "a6c275c6-3964-4d18-8860-fcf25e510f14" - }, - { - "key": "X-Correlation-ID", - "value": "1d7ecfb8-29fb-461a-9904-e28216b510f8" - }, - { - "key": "Strict-Transport-Security", - "value": "max-age=31536000; includeSubDomains" - } - ], - "cookie": [], - "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_IDENTIFIER_SYSTEM\",\n \"display\": \"Invalid identifier system\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"The identifier system is not valid.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" - } - ] - } - ], - "description": "## Allowed auth methods\n\n- NHS Login token - Auth with test user `9730675929`\n \n- CIS2 token - Auth with test user `656005750108`\n \n\nSee collection level documentation for info about how to get authorization tokens.", - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{cis2_token}}", - "type": "string" - } - ] - }, - "event": [ - { - "listen": "prerequest", - "script": { - "type": "text/javascript", - "packages": {}, - "requests": {}, - "exec": [ - "" - ] - } - }, - { - "listen": "test", - "script": { - "type": "text/javascript", - "packages": {}, - "requests": {}, - "exec": [ - "" - ] - } - } - ] - } - ], - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{vault:authorization-secret}}", - "type": "string" - } - ] - }, - "event": [ - { - "listen": "prerequest", - "script": { - "type": "text/javascript", - "packages": {}, - "exec": [ - "" - ] - } - }, - { - "listen": "test", - "script": { - "type": "text/javascript", - "packages": {}, - "exec": [ - "" - ] - } - } - ], - "variable": [ - { - "key": "nps_enabled", - "value": "" - }, - { - "key": "nam_cache_enabled", - "value": "" - }, - { - "key": "nam_enabled", - "value": "" - }, - { - "key": "use_nam_mock", - "value": "" - } - ] + "info": { + "_postman_id": "f3bd080f-9a07-40c2-8d58-cd2f178e7504", + "name": "Validated Relationship Service - Integration - 24/02/26", + "description": "## About the collection\n\nThe collection has been organised by API endpoint - you will find a folder for each one.\n\nWithin those endpoints are requests covering success and error response scenarios.\n\nEach request has at least 1 example against it. This shows the expected response for that request. Some requests have multiple examples showing how the response differs when different parameters are provided.\n\n### Authorization types\n\nWhen you send a request to the Validated Relationship Service, your request will first be authorised by the API Management service (APIM).\n\nThe Validated Relationship Service has 3 types of authorization:\n\n- CIS2 - For healthcare practitioners\n- App-restricted - for service-to-service authorization\n- Login - For patient/proxy access via the NHS App\n \n\nEach VRS API endpoint uses a different combination of these auth types depending on their use case.\n\nYou will need to follow the steps in the 'Getting Started' section below to set the correct authorization tokens for each of these types.\n\nPlease see the folder-level docs for each endpoint for details about what auth types are available to use.\n\n## Getting started\n\n### Environment variables\n\nYou will need to add the following environment variables to the collection.\n\n#### `cis2_token`\n\nAuthorization token value for CIS2 (healthcare practitioner access).\n\n_Only required when using endponts that require this auth method._\n\nThis value can be generated by running the `get_cis2_access_token_int.py` script . See more details in the 'How to create a valid Authorization header' section below.\n\n#### `login_token`\n\nAuthorization token value for NHS Login (patient access).\n\n_Only required when using endponts that require this auth method._\n\nThis value can be generated by running the `get_nhs_login_access_token_int.py` script . See more details in the 'How to create a valid Authorization header' section below.\n\n#### `vrs_api_private_key`\n\n**(This is not the same as the private key in the NHS Developer Account portal.)**\n\nAPI private key for the Validated Relationship Service integration application.\n\n_Only required when using endponts that use the app restricted auth method._\n\nThis value can be copied from the /main/vrs-app-credentials-{id} secret in **AWS Secrets Manager** or requested to be sent securely from a member of the VRS team.\n\n#### `nhs_developer_account_api_key`\n\nAPI app key for the Validated Relationship Service integration application.\n\n_Only required when using endponts that use the app restricted auth method._\n\nThis value can be copied from the NHS - Proxy Core Services - Integration environment resource in the NHS Developer Account portal.\n\n#### `consent_app_auth_header_value` (Generated automatically)\n\nAuthorization token value for app restricted auth.\n\n_Only required when using endponts that use the app restricted auth method._\n\n**You do not need to change this value as it is automatically set in the pre-request script.**\n\n#### `tpp_9674998535_access_token`, `tpp_9674998454_access_token`, `emis_9692113698_access_token,` and `emis_9692113612_access_token`\n\nAuthorization token value for connecting to GPIT supplier systems in NAM tests (Get proxy roles only).\n\n_Only required when running the_ `_Get proxy roles (GET/Consent) Valid request - NAM - Get proxy roles_` _requests._\n\nValues for these environment variables can be found on the [Test data page in Confluence](https://nhsd-confluence.digital.nhs.uk/spaces/NPA/pages/950553445/Test+data+and+accounts+repository+-+NPA#TestdataandaccountsrepositoryNPA-GPITtestaccountsforEXT).\n\n### How to create a valid Authorization header\n\n#### Manually through Python scripts (required for Login and CIS2)\n\n##### Pre-requisites\n\nAccess the token generation scripts from the [validated-relationships-service-api repo](https://github.com/NHSDigital/validated-relationships-service-api/tree/master/scripts):\n\n- get_app_access_token_int.py - for app restricted authorization\n- get_cis2_access_token_int.py - for CIS2 authorization\n- get_nhs_login_access_token_int.py - for Login user authorization\n \n\nSee the [README](https://github.com/NHSDigital/validated-relationships-service-api/tree/master/scripts/README.md) for information about how to run them and what environment variables are needed.\n\n##### Steps\n\n1. Generate bearer tokens for each of the above methods using the provided scripts\n2. Go to the Authorization tab for this Postman request\n3. Select 'Bearer token' from the drop-down\n4. Copy just the 'access_request' value from the script output into the Token field. You do **not** need to add the word 'bearer' before the value.\n \n\nTokens expire every 5 minutes. Once expired, you will receive an 'Unauthorised' response from the API endpoints. At this point, a new token will need to be generated by repeating the above steps.\n\n#### Automatically through pre-request script (for App-restricted)\n\nA pre-request script has been added to the endpoints where app-restricted auth can be used to obtain app-restricted tokens automatically. For this to work, you will need to add values for the following environment variables:\n\n- `private_key`\n- `api_key`\n \n\nIf those values are set and valid, then no further action is required.\n\n## Running a request\n\nOnce you have completed the above 'Getting Started' steps you will be able to send requests by either clicking the 'Send' button on each request, or the 'Try' button on each example.\n\nThe pre-prod environments are not constricted to just the requests provided in this collection. Feel free to change and create requests/examples as you require. However, only the test users provided will work in these environments.\n\n## Test data\n\nAll of the requests in the collection use test data and users that have been set up to demonstrate each specific scenario. No sensitive data is stored in this collection.\n\nSee each scenario for information about what test users are being used.", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "_exporter_id": "46399153", + "_collection_link": "https://www.postman.com/leohoward/workspace/vrsa-24-02-2026/collection/46399153-f3bd080f-9a07-40c2-8d58-cd2f178e7504?action=share&source=collection_link&creator=46399153" + }, + "item": [ + { + "name": "Get proxy roles (GET /Consent)", + "item": [ + { + "name": "Valid request - NPS - Get proxy roles for performer", + "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + }, + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898148", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898148" + } + ] + }, + "description": "This request and its examples will only retrieve proxy roles from the National Proxy Store and not directly from GPIT suppliers via NAM.\n\nSee folder-level docs for more info.\n\n## Example scenario\n\n**Given** proxy roles exist for a performer (proxy) in the National Proxy Store (NPS) \n**When** a GET /Consent request is sent with the performer identifier \n**Then** the proxy roles in NPS are returned\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." + }, + "response": [ + { + "name": "Proxy roles returned - No patient or performer details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "1c190795-98fc-40d0-b13d-4b566650950a", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "3bedabd0-b86f-4d7b-92d9-94f020b4a834", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898148", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898148" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 10:48:19 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "3486" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "cf3a99a3-7592-4968-893c-e443d6cb27c8" + }, + { + "key": "x-amz-apigw-id", + "value": "VD0FoHiurPEFXqQ=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-693166f0-1bb8c61dd3aa101687d0b754" + }, + { + "key": "X-Request-ID", + "value": "d3ec5ec8-088f-4db6-8342-1a21d2a2af16" + }, + { + "key": "X-Correlation-ID", + "value": "656bfa49-711b-48c4-9427-1ed8fa34260f" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T10:48:19Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898148\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"resource\": {\n \"id\": \"7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:46:27Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"resource\": {\n \"id\": \"b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:47:43Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy roles returned - Include patient details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898148&_include=Consent:patient", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898148" + }, + { + "key": "_include", + "value": "Consent:patient" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 10:50:25 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "6923" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "edd035fd-2cdb-4c7a-a55c-a55e6faf5743" + }, + { + "key": "x-amz-apigw-id", + "value": "VD0ZXFA2LPEFYqg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6931676e-74035c00139aae000a60b5d7" + }, + { + "key": "X-Request-ID", + "value": "64b0f06f-a35e-44bb-baf4-33de94895236" + }, + { + "key": "X-Correlation-ID", + "value": "6a95b411-9936-49bb-bbcb-8e6776417762" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T10:50:25Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898148&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"resource\": {\n \"id\": \"7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:46:27Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"resource\": {\n \"id\": \"b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:47:43Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898644\",\n \"resource\": {\n \"id\": \"9736898644\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"29706100\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"gDmhc\",\n \"line\": [\n \"BRAMBLE COTTAGE\",\n \"OLD VICARAGE PARK\",\n \"SCAWBY\",\n \"BRIGG\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2021-09-10\"\n },\n \"postalCode\": \"DN20 9RL\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2015-09-26\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"gDHTb\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2018-08-22\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898717\",\n \"resource\": {\n \"id\": \"9736898717\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"16654057\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"YoGEf\",\n \"line\": [\n \"GLENVILLE\",\n \"FERRY ROAD\",\n \"GOXHILL\",\n \"BARROW-UPON-HUMBER\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2016-04-09\"\n },\n \"postalCode\": \"DN19 7JY\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2010-05-31\",\n \"gender\": \"male\",\n \"generalPractitioner\": [\n {\n \"id\": \"bYoHa\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2016-02-12\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n ],\n \"name\": [\n {\n \"family\": \"CASH\",\n \"given\": [\n \"Jacob\",\n \"Chas\"\n ],\n \"period\": {\n \"start\": \"2025-07-22\"\n },\n \"prefix\": [\n \"MR\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy roles returned - Include performer details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898148&_include=Consent:performer", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898148" + }, + { + "key": "_include", + "value": "Consent:performer" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 10:50:45 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "5289" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "60649be0-6363-4601-b792-d631af45a966" + }, + { + "key": "x-amz-apigw-id", + "value": "VD0cyFTYLPEF-Fg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316784-cee1c757e6d4e43fb4837684" + }, + { + "key": "X-Request-ID", + "value": "8a113b57-8af9-4d34-b300-100c84059319" + }, + { + "key": "X-Correlation-ID", + "value": "a3683a8c-6172-44a7-8410-0e78a705907b" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T10:50:45Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898148&_include=Consent%3Aperformer\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"resource\": {\n \"id\": \"7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:46:27Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"resource\": {\n \"id\": \"b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:47:43Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/ZfgKO\",\n \"resource\": {\n \"id\": \"ZfgKO\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/UwTCq\",\n \"resource\": {\n \"id\": \"UwTCq\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy roles returned - Include patient and performer details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898148&_include=Consent:performer&_include=Consent:patient", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898148" + }, + { + "key": "_include", + "value": "Consent:performer" + }, + { + "key": "_include", + "value": "Consent:patient" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 10:51:06 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "8726" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "2b36e22f-2649-44c9-b3ce-929ea840df0f" + }, + { + "key": "x-amz-apigw-id", + "value": "VD0gJFjQLPEF_Ew=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6931679a-aa7dfa232b694d8fdbd9823f" + }, + { + "key": "X-Request-ID", + "value": "d5743541-7330-4347-b9c7-9067feb4b144" + }, + { + "key": "X-Correlation-ID", + "value": "af030657-aad8-45f4-9c70-85e4755a189f" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T10:51:06Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898148&_include=Consent%3Aperformer&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"resource\": {\n \"id\": \"7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:46:27Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"resource\": {\n \"id\": \"b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:47:43Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898644\",\n \"resource\": {\n \"id\": \"9736898644\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"29706100\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"gDmhc\",\n \"line\": [\n \"BRAMBLE COTTAGE\",\n \"OLD VICARAGE PARK\",\n \"SCAWBY\",\n \"BRIGG\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2021-09-10\"\n },\n \"postalCode\": \"DN20 9RL\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2015-09-26\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"gDHTb\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2018-08-22\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898717\",\n \"resource\": {\n \"id\": \"9736898717\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"16654057\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"YoGEf\",\n \"line\": [\n \"GLENVILLE\",\n \"FERRY ROAD\",\n \"GOXHILL\",\n \"BARROW-UPON-HUMBER\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2016-04-09\"\n },\n \"postalCode\": \"DN19 7JY\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2010-05-31\",\n \"gender\": \"male\",\n \"generalPractitioner\": [\n {\n \"id\": \"bYoHa\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2016-02-12\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n ],\n \"name\": [\n {\n \"family\": \"CASH\",\n \"given\": [\n \"Jacob\",\n \"Chas\"\n ],\n \"period\": {\n \"start\": \"2025-07-22\"\n },\n \"prefix\": [\n \"MR\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/ZfgKO\",\n \"resource\": {\n \"id\": \"ZfgKO\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/UwTCq\",\n \"resource\": {\n \"id\": \"UwTCq\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy roles returned - Filtered by status 'inactive'", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898156&status=inactive", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898156" + }, + { + "key": "status", + "value": "inactive" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:09:14 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "1888" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "290a4ffd-6021-435c-af76-8d6c80492b72" + }, + { + "key": "x-amz-apigw-id", + "value": "VD3JoHOkrPEFSoA=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316bd6-5bd69e7021cf6e4e0696d153" + }, + { + "key": "X-Request-ID", + "value": "8b8298dc-a9a4-4257-a6b9-f99d5ff65983" + }, + { + "key": "X-Correlation-ID", + "value": "5af5dfe2-b247-4624-8268-bb4e78593eb3" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:09:14Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898156&status=inactive\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/750cb586-eb9b-46c7-a1a5-711307a087af\",\n \"resource\": {\n \"id\": \"750cb586-eb9b-46c7-a1a5-711307a087af\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:55:53Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898652\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2025-12-05\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"inactive\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy roles returned - Filtered by status 'active' and include patient and performer details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898156&status=active&_include=Consent:performer&_include=Consent:patient", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898156" + }, + { + "key": "status", + "value": "active" + }, + { + "key": "_include", + "value": "Consent:performer" + }, + { + "key": "_include", + "value": "Consent:patient" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:09:41 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "4528" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "44c6f0cf-6bdb-4b96-8889-55ebe68b8c60" + }, + { + "key": "x-amz-apigw-id", + "value": "VD3M5FGYrPEFZVg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316beb-f2f5e05791f831ed34fb0afa" + }, + { + "key": "X-Request-ID", + "value": "73bded49-9645-4418-bf08-ebd13d92c2a1" + }, + { + "key": "X-Correlation-ID", + "value": "15b5d9d5-9909-458a-91c5-64ee20e93a01" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:09:40Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898156&status=active&_include=Consent%3Aperformer&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"resource\": {\n \"id\": \"4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:08:46Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-12-05\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898660\",\n \"resource\": {\n \"id\": \"9736898660\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"19976537\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"pBQDr\",\n \"line\": [\n \"CARLTON\",\n \"VICARAGE LANE\",\n \"REDBOURNE\",\n \"GAINSBOROUGH\",\n \"LINCS\"\n ],\n \"period\": {\n \"start\": \"2025-07-15\"\n },\n \"postalCode\": \"DN21 4QW\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2012-04-24\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"xSEnH\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2024-11-06\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n ],\n \"name\": [\n {\n \"family\": \"GODREY\",\n \"given\": [\n \"Davina\",\n \"Linda\"\n ],\n \"period\": {\n \"start\": \"2017-04-22\"\n },\n \"prefix\": [\n \"MISS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/nVLgl\",\n \"resource\": {\n \"id\": \"nVLgl\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + } + ] + }, + { + "name": "Valid request - NPS - Get proxy roles for patient", + "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + }, + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?patient:identifier=9736898644", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "patient:identifier", + "value": "9736898644" + } + ] + }, + "description": "This request and its examples will only retrieve proxy roles from the National Proxy Store and not directly from GPIT suppliers via NAM.\n\nSee folder level docs for more info.\n\n## Example scenario\n\n**Given** proxy roles exist for a patient in the National Proxy Store (NPS) \n**When** a GET /Consent request is sent with the patient identifier \n**Then** the proxy roles in NPS are returned\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." + }, + "response": [ + { + "name": "Proxy roles returned - No patient or performer details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "a8fe6a8d-44c5-4451-b8e8-5cf5adc2db03", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "43c2ad8f-43a2-4cfc-8d3a-2b4298ab2b6d", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?patient:identifier=9736898644", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "patient:identifier", + "value": "9736898644" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:17:19 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "3484" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "cd84643e-5789-445f-9d2f-eb53fe6b57c5" + }, + { + "key": "x-amz-apigw-id", + "value": "VD4VeEsnLPEFmxA=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316dbc-851b7fe822d672bb07d0be6d" + }, + { + "key": "X-Request-ID", + "value": "b7120974-233d-4634-80e2-f404e817f80b" + }, + { + "key": "X-Correlation-ID", + "value": "73e7ab39-f339-4f53-8090-d4320c6a1fc5" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:17:19Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient%3Aidentifier=9736898644\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"resource\": {\n \"id\": \"7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:46:27Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"resource\": {\n \"id\": \"553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:15:26Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy roles returned - Include performer details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?patient:identifier=9736898644&_include=Consent:performer", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "patient:identifier", + "value": "9736898644" + }, + { + "key": "_include", + "value": "Consent:performer" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:17:45 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "5287" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "d6ea589d-359b-43a5-ac3d-6b570eec9cac" + }, + { + "key": "x-amz-apigw-id", + "value": "VD4YuGlSLPEF7zw=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316dd1-47a064ac1a1d588355c13564" + }, + { + "key": "X-Request-ID", + "value": "eb00dad3-5e15-4ade-8ee9-f3597bfab4d3" + }, + { + "key": "X-Correlation-ID", + "value": "a496e8bd-c333-4e87-9927-bbe9ead436a4" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:17:45Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient%3Aidentifier=9736898644&_include=Consent%3Aperformer\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"resource\": {\n \"id\": \"7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:46:27Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"resource\": {\n \"id\": \"553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:15:26Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/ZfgKO\",\n \"resource\": {\n \"id\": \"ZfgKO\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/EAONj\",\n \"resource\": {\n \"id\": \"EAONj\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy roles returned - Include patient details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?patient:identifier=9736898644&_include=Consent:patient", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "patient:identifier", + "value": "9736898644" + }, + { + "key": "_include", + "value": "Consent:patient" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:18:02 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "5218" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "3a81d012-80ef-4350-8d7b-1f8cda1ef809" + }, + { + "key": "x-amz-apigw-id", + "value": "VD4cPGnErPEFYsw=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316de7-bb724d308ffa3272269bfba9" + }, + { + "key": "X-Request-ID", + "value": "ada44c4a-9dcc-4666-a97e-72ebce5630a8" + }, + { + "key": "X-Correlation-ID", + "value": "cfa6112c-4235-41a4-9e58-f4f04d4f7614" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:18:02Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient%3Aidentifier=9736898644&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"resource\": {\n \"id\": \"7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:46:27Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"resource\": {\n \"id\": \"553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:15:26Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898644\",\n \"resource\": {\n \"id\": \"9736898644\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"29706100\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"gDmhc\",\n \"line\": [\n \"BRAMBLE COTTAGE\",\n \"OLD VICARAGE PARK\",\n \"SCAWBY\",\n \"BRIGG\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2021-09-10\"\n },\n \"postalCode\": \"DN20 9RL\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2015-09-26\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"gDHTb\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2018-08-22\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy roles returned - Include patient and performer details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?patient:identifier=9736898644&_include=Consent:performer&_include=Consent:patient", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "patient:identifier", + "value": "9736898644" + }, + { + "key": "_include", + "value": "Consent:performer" + }, + { + "key": "_include", + "value": "Consent:patient" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:18:17 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "7021" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "013f49d1-ffbe-4880-bfd6-1b92d13d08a3" + }, + { + "key": "x-amz-apigw-id", + "value": "VD4evE6yLPEFZZA=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316df7-175910d69cd894708a0921b9" + }, + { + "key": "X-Request-ID", + "value": "9ce9a6d5-2bd2-4d5e-a984-2c78a457f4d4" + }, + { + "key": "X-Correlation-ID", + "value": "02eabdf7-0a76-4fec-9c99-306273ea8da5" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:18:17Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient%3Aidentifier=9736898644&_include=Consent%3Aperformer&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"resource\": {\n \"id\": \"7597397b-ac6e-4eb7-b49e-bb1636115d2e\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:46:27Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"resource\": {\n \"id\": \"553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:15:26Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898644\",\n \"resource\": {\n \"id\": \"9736898644\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"29706100\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"gDmhc\",\n \"line\": [\n \"BRAMBLE COTTAGE\",\n \"OLD VICARAGE PARK\",\n \"SCAWBY\",\n \"BRIGG\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2021-09-10\"\n },\n \"postalCode\": \"DN20 9RL\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2015-09-26\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"gDHTb\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2018-08-22\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/ZfgKO\",\n \"resource\": {\n \"id\": \"ZfgKO\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/EAONj\",\n \"resource\": {\n \"id\": \"EAONj\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy roles returned - Filtered by status 'inactive'", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?patient:identifier=9736898717&status=inactive", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "patient:identifier", + "value": "9736898717" + }, + { + "key": "status", + "value": "inactive" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:18:37 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "1886" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "595418c1-5c22-46b6-907c-e799e9fdf609" + }, + { + "key": "x-amz-apigw-id", + "value": "VD4iFHTWLPEFnHA=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316e0c-b334c67c9e4d72fd5809672a" + }, + { + "key": "X-Request-ID", + "value": "e6ad06af-45a7-4f98-92c2-88300871c3bc" + }, + { + "key": "X-Correlation-ID", + "value": "8d75c837-bd9e-4784-ac40-84322ee4d188" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:18:37Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient%3Aidentifier=9736898717&status=inactive\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/cf7bc8e6-f8e0-41c5-8d08-1741eee5a256\",\n \"resource\": {\n \"id\": \"cf7bc8e6-f8e0-41c5-8d08-1741eee5a256\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:16:43Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"inactive\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy roles returned - Filtered by status 'active' and include patient and performer details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?patient:identifier=9736898717&status=active&_include=Consent:performer&_include=Consent:patient", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "patient:identifier", + "value": "9736898717" + }, + { + "key": "status", + "value": "active" + }, + { + "key": "_include", + "value": "Consent:performer" + }, + { + "key": "_include", + "value": "Consent:patient" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:18:51 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "4528" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "bd5079fb-1fc3-428c-ab53-5ba1dfacc510" + }, + { + "key": "x-amz-apigw-id", + "value": "VD4kRHuoLPEF-DQ=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316e1a-0dc7c19d64d48ad8a86c4518" + }, + { + "key": "X-Request-ID", + "value": "8da5a25e-ef8b-4cec-84c0-81af22e5132f" + }, + { + "key": "X-Correlation-ID", + "value": "ce7840a8-db71-4897-9853-d06c699adca9" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:18:51Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient%3Aidentifier=9736898717&status=active&_include=Consent%3Aperformer&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"resource\": {\n \"id\": \"b22d6068-fe78-40f4-b71a-b916dac48c0b\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:47:43Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898717\",\n \"resource\": {\n \"id\": \"9736898717\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"16654057\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"YoGEf\",\n \"line\": [\n \"GLENVILLE\",\n \"FERRY ROAD\",\n \"GOXHILL\",\n \"BARROW-UPON-HUMBER\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2016-04-09\"\n },\n \"postalCode\": \"DN19 7JY\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2010-05-31\",\n \"gender\": \"male\",\n \"generalPractitioner\": [\n {\n \"id\": \"bYoHa\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2016-02-12\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n ],\n \"name\": [\n {\n \"family\": \"CASH\",\n \"given\": [\n \"Jacob\",\n \"Chas\"\n ],\n \"period\": {\n \"start\": \"2025-07-22\"\n },\n \"prefix\": [\n \"MR\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/UwTCq\",\n \"resource\": {\n \"id\": \"UwTCq\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + } + ] + }, + { + "name": "Valid request - NPS - Get proxy roles for patient and proxy", + "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + }, + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898121&patient:identifier=9736898644", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898121" + }, + { + "key": "patient:identifier", + "value": "9736898644" + } + ] + }, + "description": "This request and its examples will only retrieve proxy roles from the National Proxy Store and not directly from GPIT suppliers via NAM.\n\nSee folder level docs for more info.\n\n## Example scenario\n\n**Given** proxy roles exist for a patient in the National Proxy Store (NPS) \n**When** a GET /Consent request is sent with the performer and patient identifier \n**Then** a single proxy role from NPS is returned\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." + }, + "response": [ + { + "name": "Proxy roles returned - No patient or performer details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "4d896833-170b-4dc9-a455-66db155cb5c1", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "1525b9dd-abde-44c0-a226-c93af7e47d8e", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898121&patient:identifier=9736898644", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898121" + }, + { + "key": "patient:identifier", + "value": "9736898644" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:19:27 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "1902" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "3d56eb4c-4bc0-47d8-bc61-a55b098dfd9c" + }, + { + "key": "x-amz-apigw-id", + "value": "VD4p_GRgrPEFVPA=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316e3f-6ddd811fdb997165b9c6a0d5" + }, + { + "key": "X-Request-ID", + "value": "f8ac2f03-2a5f-4ff7-8ada-093f55fb9c38" + }, + { + "key": "X-Correlation-ID", + "value": "8fc4ed98-4b94-41e1-bff0-0065b6058201" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:19:27Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898121&patient%3Aidentifier=9736898644\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"resource\": {\n \"id\": \"553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:15:26Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy roles returned - Include performer details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898121&patient:identifier=9736898644&_include=Consent:performer", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898121" + }, + { + "key": "patient:identifier", + "value": "9736898644" + }, + { + "key": "_include", + "value": "Consent:performer" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:19:44 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "2818" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "12da5c87-c8eb-4085-ad09-ab9df3923150" + }, + { + "key": "x-amz-apigw-id", + "value": "VD4slFJ5rPEF6Mg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316e50-a15563e078d9633ab0d45fb6" + }, + { + "key": "X-Request-ID", + "value": "51afba5e-eea1-415e-a0c3-bc5d47e884fd" + }, + { + "key": "X-Correlation-ID", + "value": "c31bc807-8bc9-4aa5-b531-f44fbfeeef0c" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:19:44Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898121&patient%3Aidentifier=9736898644&_include=Consent%3Aperformer\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"resource\": {\n \"id\": \"553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:15:26Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/EAONj\",\n \"resource\": {\n \"id\": \"EAONj\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy roles returned - Include patient details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898121&patient:identifier=9736898644&_include=Consent:patient", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898121" + }, + { + "key": "patient:identifier", + "value": "9736898644" + }, + { + "key": "_include", + "value": "Consent:patient" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:19:57 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "3636" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "341e64dd-974f-4307-a16b-e775c0777fdd" + }, + { + "key": "x-amz-apigw-id", + "value": "VD4uhGhjLPEF8-A=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316e5c-16469b05761a5ee0d5ffe220" + }, + { + "key": "X-Request-ID", + "value": "2762b971-bfcc-42c6-be87-b2d2a98cf5b5" + }, + { + "key": "X-Correlation-ID", + "value": "94e42484-2c4d-46fc-8364-027c06a21798" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:19:56Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898121&patient%3Aidentifier=9736898644&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"resource\": {\n \"id\": \"553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:15:26Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898644\",\n \"resource\": {\n \"id\": \"9736898644\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"29706100\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"gDmhc\",\n \"line\": [\n \"BRAMBLE COTTAGE\",\n \"OLD VICARAGE PARK\",\n \"SCAWBY\",\n \"BRIGG\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2021-09-10\"\n },\n \"postalCode\": \"DN20 9RL\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2015-09-26\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"gDHTb\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2018-08-22\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy roles returned - Include patient and performer details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898121&patient:identifier=9736898644&_include=Consent:performer&_include=Consent:patient", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898121" + }, + { + "key": "patient:identifier", + "value": "9736898644" + }, + { + "key": "_include", + "value": "Consent:performer" + }, + { + "key": "_include", + "value": "Consent:patient" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:20:24 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "4552" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "306d5243-752e-45e4-9c44-f175a008c1de" + }, + { + "key": "x-amz-apigw-id", + "value": "VD4y2Gg1rPEFcxQ=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316e78-df1338116d16a7272e1de2dc" + }, + { + "key": "X-Request-ID", + "value": "b05f7a59-c008-47d8-868c-011cbdf17500" + }, + { + "key": "X-Correlation-ID", + "value": "95f4ebb0-274e-4757-91f3-91a5fc0a3f0f" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:20:24Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898121&patient%3Aidentifier=9736898644&_include=Consent%3Aperformer&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"resource\": {\n \"id\": \"553ee1cd-1acd-48bb-a918-4a6434ab39b2\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:15:26Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-11-23\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898121\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898644\",\n \"resource\": {\n \"id\": \"9736898644\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"29706100\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"gDmhc\",\n \"line\": [\n \"BRAMBLE COTTAGE\",\n \"OLD VICARAGE PARK\",\n \"SCAWBY\",\n \"BRIGG\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2021-09-10\"\n },\n \"postalCode\": \"DN20 9RL\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2015-09-26\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"gDHTb\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2018-08-22\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/EAONj\",\n \"resource\": {\n \"id\": \"EAONj\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy roles returned - Filtered by status 'inactive'", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898156&patient:identifier=9736898652&status=inactive", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898156" + }, + { + "key": "patient:identifier", + "value": "9736898652" + }, + { + "key": "status", + "value": "inactive" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:21:09 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "1920" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "24bfc7a0-5f30-47b4-a751-7534837f5224" + }, + { + "key": "x-amz-apigw-id", + "value": "VD455ErXrPEFuaQ=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316ea5-6c272d90a7d3656142da3073" + }, + { + "key": "X-Request-ID", + "value": "67a71930-24b3-4baa-8b13-65f27c413a41" + }, + { + "key": "X-Correlation-ID", + "value": "dd934795-88bf-44a3-a2c3-eff757413bfb" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:21:09Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898156&patient%3Aidentifier=9736898652&status=inactive\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/750cb586-eb9b-46c7-a1a5-711307a087af\",\n \"resource\": {\n \"id\": \"750cb586-eb9b-46c7-a1a5-711307a087af\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T10:55:53Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898652\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2025-12-05\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"inactive\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy roles returned - Filtered by status 'active' and include patient and performer details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "some_token;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898156&patient:identifier=9736898652&status=active&_include=Consent:performer&_include=Consent:patient", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898156" + }, + { + "key": "patient:identifier", + "value": "9736898652" + }, + { + "key": "status", + "value": "active" + }, + { + "key": "_include", + "value": "Consent:performer" + }, + { + "key": "_include", + "value": "Consent:patient" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:21:28 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "2038" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "f44b69f0-f814-4e0f-89eb-349f1f7e143d" + }, + { + "key": "x-amz-apigw-id", + "value": "VD48uEKHLPEF67A=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316eb7-00b15aebe653e94192bc60ee" + }, + { + "key": "X-Request-ID", + "value": "8f40b74e-99fa-4401-bcf1-def08a63da50" + }, + { + "key": "X-Correlation-ID", + "value": "1460d166-ba8d-4d1c-8822-83394abe1169" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:21:27Z\",\n \"total\": 0,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9736898156&patient%3Aidentifier=9736898652&status=active&_include=Consent%3Aperformer&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898652\",\n \"resource\": {\n \"id\": \"9736898652\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"6290975\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"RPnzd\",\n \"line\": [\n \"77 ANGERSTEIN ROAD\",\n \"SCUNTHORPE\",\n \"S HUMBERSIDE\"\n ],\n \"period\": {\n \"start\": \"2019-11-10\"\n },\n \"postalCode\": \"DN17 2NB\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2013-09-02\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"yIjPV\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2021-01-07\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898652\"\n }\n ],\n \"name\": [\n {\n \"family\": \"CLYDE\",\n \"given\": [\n \"Deanne\",\n \"Tara\"\n ],\n \"period\": {\n \"start\": \"2018-06-16\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + } + ] + }, + { + "name": "Valid request - NAM - Get proxy roles", + "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + }, + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "{{tpp_9674998535_access_token}};A82648", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=false;nam-cache-enabled=false;nam-enabled=true;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9674998535", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9674998535" + } + ] + }, + "description": "This request and its examples will only retrieve proxy roles directly from GPIT suppliers via NAM and not from the National Proxy Store.\n\nSee folder level docs for more info.\n\n## Example scenario\n\n**Given** proxy roles exist for a patient/performer in a GPIT system \n**And** no proxy roles exist in the National Proxy Store (NPS) for the patient/performer \n**When** a GET /Consent request is sent with the performer/patient identifier \n**Then** the proxy roles from GPIT are returned\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." + }, + "response": [ + { + "name": "No linked profiles returned from NAM - TPP user", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "83892b1a-6369-4657-a0c3-f6071a25e226", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "b496d552-f0c3-4e20-b362-cfc0c80724e3", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "{{tpp_9674998535_access_token}};A82648", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=false;nam-cache-enabled=false;nam-enabled=true;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9674998535&_include=Consent:performer&_include=Consent:patient", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9674998535" + }, + { + "key": "_include", + "value": "Consent:performer" + }, + { + "key": "_include", + "value": "Consent:patient" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:22:00 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "5773" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "94465816-7aaa-4d03-81c9-e19156606316" + }, + { + "key": "x-amz-apigw-id", + "value": "VD5BAEGOLPEFVPA=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316ed8-af72bfe69942b25c155a4daa" + }, + { + "key": "X-Request-ID", + "value": "ed28025a-9c27-468c-85fd-9b1b8f794198" + }, + { + "key": "X-Correlation-ID", + "value": "fbd025d4-c7e1-4085-8bf8-d11b84652f8d" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:22:00Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9674998535&_include=Consent%3Aperformer&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/3a86ad92\",\n \"resource\": {\n \"id\": \"3a86ad92\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:21:58.915488+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9692113736\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998535\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998535\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/5c0c47d9\",\n \"resource\": {\n \"id\": \"5c0c47d9\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:21:58.915640+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998454\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998535\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998535\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/0b36c4e0\",\n \"resource\": {\n \"id\": \"0b36c4e0\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998535\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9692113736\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/bd6da0a0\",\n \"resource\": {\n \"id\": \"bd6da0a0\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998535\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998454\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/e41dfa63\",\n \"resource\": {\n \"id\": \"e41dfa63\",\n \"meta\": {\n \"profile\": [\n \"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient\"\n ],\n \"security\": [\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ]\n },\n \"birthDate\": \"1985-05-29\",\n \"generalPractitioner\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A82648\"\n }\n }\n ],\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9692113736\"\n }\n ],\n \"name\": [\n {\n \"text\": \"Mr Kevin Barry\",\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/2d10a3d9\",\n \"resource\": {\n \"id\": \"2d10a3d9\",\n \"meta\": {\n \"profile\": [\n \"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient\"\n ],\n \"security\": [\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ]\n },\n \"birthDate\": \"1921-10-17\",\n \"generalPractitioner\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A82648\"\n }\n }\n ],\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998454\"\n }\n ],\n \"name\": [\n {\n \"text\": \"Mr Landon Fahey\",\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + }, + { + "name": "Linked profiles returned from NAM - TPP user", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "{{tpp_9674998454_access_token}};A82648", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=false;nam-cache-enabled=false;nam-enabled=true;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9674998454&_include=Consent:patient", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9674998454" + }, + { + "key": "_include", + "value": "Consent:patient" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:22:15 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "4370" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "1b190446-e56f-4a64-8c54-25688af8f8f7" + }, + { + "key": "x-amz-apigw-id", + "value": "VD5EAFv1rPEF7zw=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316ee6-9925773ab605850282f2d18c" + }, + { + "key": "X-Request-ID", + "value": "dfa182c6-8f6a-46e9-bdc1-1ef5a00740c1" + }, + { + "key": "X-Correlation-ID", + "value": "d50ce1da-c025-451c-847e-c405c299115f" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:22:15Z\",\n \"total\": 2,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9674998454&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/92a66114\",\n \"resource\": {\n \"id\": \"92a66114\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:22:15.290954+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998640\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998454\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998454\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/0b02be0a\",\n \"resource\": {\n \"id\": \"0b02be0a\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:22:15.290994+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998543\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998454\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998454\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/934bfd54\",\n \"resource\": {\n \"id\": \"934bfd54\",\n \"meta\": {\n \"profile\": [\n \"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient\"\n ],\n \"security\": [\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ]\n },\n \"birthDate\": \"1998-11-14\",\n \"generalPractitioner\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A82648\"\n }\n }\n ],\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998640\"\n }\n ],\n \"name\": [\n {\n \"text\": \"Mr Harry Hood\",\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/29b6ab39\",\n \"resource\": {\n \"id\": \"29b6ab39\",\n \"meta\": {\n \"profile\": [\n \"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient\"\n ],\n \"security\": [\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ]\n },\n \"birthDate\": \"1930-11-02\",\n \"generalPractitioner\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A82648\"\n }\n }\n ],\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998543\"\n }\n ],\n \"name\": [\n {\n \"text\": \"Miss Lisa Hankey\",\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + }, + { + "name": "No linked profiles returned from NAM - EMIS user", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "{{emis_9692113612_access_token}};A29928", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=false;nam-cache-enabled=false;nam-enabled=true;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9692113612&_include=Consent:patient", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9692113612" + }, + { + "key": "_include", + "value": "Consent:patient" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:22:37 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "283" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "15121c1a-99de-4830-86c7-00925d4faf3a" + }, + { + "key": "x-amz-apigw-id", + "value": "VD5HEE6MLPEFz5w=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316ef9-58a10d83bc130c381cdb0b44" + }, + { + "key": "X-Request-ID", + "value": "1828501c-86dc-4baf-9a13-e37a822e327f" + }, + { + "key": "X-Correlation-ID", + "value": "b891fe97-7778-4db5-be39-b23c03879d2d" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:22:36Z\",\n \"total\": 0,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9692113612&_include=Consent%3Apatient\"\n }\n ],\n \"entry\": []\n}" + }, + { + "name": "Linked profiles returned from NAM - EMIS user", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "{{emis_9692113698_access_token}};A00002", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=false;nam-cache-enabled=false;nam-enabled=true;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9692113698&_include=Consent:performer", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9692113698" + }, + { + "key": "_include", + "value": "Consent:patient", + "disabled": true + }, + { + "key": "_include", + "value": "Consent:performer" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:24:08 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "17617" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "739313dc-9917-4df2-9b9d-e59bf36d8c4e" + }, + { + "key": "x-amz-apigw-id", + "value": "VD5U-FHkLPEF0fw=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69316f52-1205235fe7d41983ba807831" + }, + { + "key": "X-Request-ID", + "value": "2eb98c87-f421-4902-a885-ecc408bd8d89" + }, + { + "key": "X-Correlation-ID", + "value": "4ac19b94-25d4-4de6-9be6-fe5a4a520d15" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:24:08Z\",\n \"total\": 9,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer%3Aidentifier=9692113698&_include=Consent%3Aperformer\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/2993b769\",\n \"resource\": {\n \"id\": \"2993b769\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874676+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9661034451\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/c0d48822\",\n \"resource\": {\n \"id\": \"c0d48822\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874715+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998403\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/75d0c9dc\",\n \"resource\": {\n \"id\": \"75d0c9dc\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874739+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9661034400\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/2bed6c1e\",\n \"resource\": {\n \"id\": \"2bed6c1e\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874762+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9661034168\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/ed77c791\",\n \"resource\": {\n \"id\": \"ed77c791\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874785+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9253046414\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/02e9fe06\",\n \"resource\": {\n \"id\": \"02e9fe06\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874807+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9930725970\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/70f274ba\",\n \"resource\": {\n \"id\": \"70f274ba\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874830+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9803007025\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/87501704\",\n \"resource\": {\n \"id\": \"87501704\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874852+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9734615173\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/022a7290\",\n \"resource\": {\n \"id\": \"022a7290\",\n \"extension\": [\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:24:07.874874+00:00\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9694154065\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n },\n \"type\": \"RelatedPerson\"\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/CodeSystem/proxy-legal-basis\"\n }\n ]\n }\n }\n ]\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"unknown\",\n \"display\": \"Unknown\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/4931d7ae\",\n \"resource\": {\n \"id\": \"4931d7ae\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9661034451\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/34e6ba88\",\n \"resource\": {\n \"id\": \"34e6ba88\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9674998403\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/1b0f7204\",\n \"resource\": {\n \"id\": \"1b0f7204\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9661034400\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/7115d670\",\n \"resource\": {\n \"id\": \"7115d670\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9661034168\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/63bd0423\",\n \"resource\": {\n \"id\": \"63bd0423\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9253046414\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/04683858\",\n \"resource\": {\n \"id\": \"04683858\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9930725970\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/e0cff956\",\n \"resource\": {\n \"id\": \"e0cff956\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9803007025\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/a9f54c1c\",\n \"resource\": {\n \"id\": \"a9f54c1c\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9734615173\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/8b794ba5\",\n \"resource\": {\n \"id\": \"8b794ba5\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"5785592290\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9694154065\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + } + ] + }, + { + "name": "Valid request - No proxy roles returned - Get proxy roles", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + }, + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?patient:identifier=9736898199", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "patient:identifier", + "value": "9736898199" + } + ] + }, + "description": "## Example scenario\n\n**Given** no proxy roles exist for a patient/performer in NPS or GPIT systems \n**When** a GET /Consent request is sent with the performer/patient identifier \n**Then** no proxy roles are returned\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." + }, + "response": [ + { + "name": "No roles returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "b8b052ae-6841-4b64-bdf0-c969d32d94bd", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "e9920101-1ae7-4644-8ae9-5298f7bdda3b", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?patient:identifier=9736898199", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "patient:identifier", + "value": "9736898199" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Thu, 27 Nov 2025 15:20:11 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "254" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "62f7a9ef-477a-4a24-8bba-c3da1f684805" + }, + { + "key": "x-amz-apigw-id", + "value": "UtXWqH7MLPEFkaw=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69286c2a-60c4f8c5c094e6753e2352ce" + }, + { + "key": "X-Request-ID", + "value": "31683198-4901-4516-8522-baf7a3de343a" + }, + { + "key": "X-Correlation-ID", + "value": "bdc29a81-c2c3-4622-b1cb-6b0d939ef622" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2025-11-27T15:20:11Z\",\n \"total\": 0,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient%3Aidentifier=9736898199\"\n }\n ],\n \"entry\": []\n}" + } + ] + }, + { + "name": "Invalid status parameter - Get proxy roles", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?patient:identifier=9736898199&status=test", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "patient:identifier", + "value": "9736898199" + }, + { + "key": "status", + "value": "test" + } + ] + }, + "description": "## Example scenario\n\n**Given** proxy roles exist for a patient/performer in NPS or a GPIT system \n**When** a GET /Consent request is sent with an invalid status parameter \n**Then** a 422 error is returned with the detail 'Required parameter(s) are invalid.'\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." + }, + "response": [ + { + "name": "Invalid status parameter error returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "dcc26889-b2fe-4794-9531-88c887f7e134", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "91e70db5-6a5d-4382-bfc1-027d2b81bc3c", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?patient:identifier=9736898199&status=test", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "patient:identifier", + "value": "9736898199" + }, + { + "key": "status", + "value": "test" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Thu, 27 Nov 2025 16:45:57 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "375" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "072d3fa4-9703-4b80-88ba-e679c01b3129" + }, + { + "key": "x-amz-apigw-id", + "value": "Utj6vHGjLPEFvyQ=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69288044-9a8fa9560202aeb1b9390e51" + }, + { + "key": "X-Request-ID", + "value": "0437a831-fa18-43ca-a376-21b2a8f33900" + }, + { + "key": "X-Correlation-ID", + "value": "8cf2b8d1-d98e-4b93-bb62-34583b31f0ea" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_PARAMETER\",\n \"display\": \"Required parameter(s) are invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Invalid request with error - status parameter is invalid.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Invalid include parameter - Get proxy roles", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898148&_include=Consent:test", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898148" + }, + { + "key": "_include", + "value": "Consent:test" + } + ] + }, + "description": "## Gherkin scenario\n\n**Given** proxy roles exist for a patient/performer in NPS or a GPIT system \n**When** a GET /Consent request is sent with an invalid include parameter \n**Then** a 422 error is returned with the detail 'Required parameter(s) are invalid.'\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." + }, + "response": [ + { + "name": "Invalid include parameter error returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "b14c0f0f-ad95-45e4-9b2a-9286fb050453", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "e7e0d226-d580-44a6-8688-2aeb0deedf00", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9736898148&_include=Consent:test", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898148" + }, + { + "key": "_include", + "value": "Consent:test" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Thu, 27 Nov 2025 16:46:36 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "377" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "e9f62008-61ec-417a-8231-506b51d07844" + }, + { + "key": "x-amz-apigw-id", + "value": "UtkBAFkIrPEFuvQ=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6928806c-3f5337b27e75f90c703fd6b0" + }, + { + "key": "X-Request-ID", + "value": "fb15a103-bf9a-499e-a7b1-24dc6563eb13" + }, + { + "key": "X-Correlation-ID", + "value": "f5ec5ae0-c762-4efb-95e3-317628c5cd80" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_PARAMETER\",\n \"display\": \"Required parameter(s) are invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Invalid request with error - _include parameter is invalid.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Invalid performer identifier - Get proxy roles", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=90000000", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "90000000" + } + ] + }, + "description": "## Example scenario\n\n**Given** proxy roles exist for a patient/performer in NPS or a GPIT system \n**When** a GET /Consent request is sent with an invalid performer identifier \n**Then** a 422 error is returned with the detail 'Required parameter(s) are invalid.'\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." + }, + "response": [ + { + "name": "Invalid performer identifier returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "6e975672-d1b4-402c-b47d-0994d55e1517", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "268d0936-6ffb-474a-a7bf-f44d4214e36e", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=90000000", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "90000000" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Thu, 27 Nov 2025 16:47:01 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "428" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "2c57ff69-fe19-498b-8163-00b392e47313" + }, + { + "key": "x-amz-apigw-id", + "value": "UtkE-EaXLPEFV9Q=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69288085-dfbdd45a57543fb9bb4ebd8b" + }, + { + "key": "X-Request-ID", + "value": "2d274752-140d-49de-ab31-56012d28c2cb" + }, + { + "key": "X-Correlation-ID", + "value": "7187bca7-8d57-4561-b0f2-a5aba91ec94c" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_IDENTIFIER_VALUE\",\n \"display\": \"Required parameter(s) are invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Invalid request with error - performer:identifier or patient:identifier parameter is invalid.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Invalid performer identifier system - Get proxy roles", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=invalid|9736898199", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "invalid|9736898199" + } + ] + }, + "description": "## Example scenario\n\n**Given** proxy roles exist for a patient/performer in NPS or a GPIT system \n**When** a GET /Consent request is sent with an invalid performer identifier system \n**Then** a 422 error is returned with the detail 'Required parameter(s) are invalid.'\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." + }, + "response": [ + { + "name": "Invalid performer identifier system error returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "995e5222-fce7-40e2-8424-1e920d920491", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "16ec5418-1591-45f7-a84c-e95cbcd5cd67", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=invalid|9736898199", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "invalid|9736898199" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Thu, 27 Nov 2025 16:47:46 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "426" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "8a8529b6-34ac-46b1-8868-0a6ec0440151" + }, + { + "key": "x-amz-apigw-id", + "value": "UtkL-HDVLPEFVxg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-692880b2-6286da8b511f08a6d7ccf9db" + }, + { + "key": "X-Request-ID", + "value": "9cc2d0ef-8f7a-46b7-89c9-c884bf61cc3a" + }, + { + "key": "X-Correlation-ID", + "value": "57948f02-5db0-4267-a6b7-cae30485e5eb" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_IDENTIFIER_SYSTEM\",\n \"display\": \"Required parameter(s) are invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Invalid request with error - performer:identifier or patient:identifier system parameter is invalid.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Missing performer identifier value - Get proxy roles", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ] + }, + "description": "## Example scenario\n\n**Given** proxy roles exist for a patient/performer in NPS or a GPIT system \n**When** a GET /Consent request is sent with an missing performer identifier value \n**Then** a 400 error is returned with the detail 'Required parameter(s) are missing.'\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." + }, + "response": [ + { + "name": "Missing performer identifier value error returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "53b3ca95-ad9d-4cd5-a194-78a42daff0df", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "88aaae3f-7168-4f69-b71a-60641082ab4b", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=true;nam-cache-enabled=false;nam-enabled=false;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Thu, 27 Nov 2025 16:48:15 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "417" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "4984ba67-d994-4f08-910e-e25024a8ba57" + }, + { + "key": "x-amz-apigw-id", + "value": "UtkQdERvrPEFrBg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-692880cf-614067cb88aa075eca482015" + }, + { + "key": "X-Request-ID", + "value": "f536a55f-7115-4ab4-a1c9-3049ca919351" + }, + { + "key": "X-Correlation-ID", + "value": "636e5f80-53b3-4bcf-9176-2967325a9e85" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_IDENTIFIER_VALUE\",\n \"display\": \"Required parameter(s) are missing.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Invalid request with error - performer:identifier or patient:identifier parameter not found.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "GP practice not found - Get proxy roles", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=false;nam-cache-enabled=false;nam-enabled=true;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898229", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898229" + } + ] + }, + "description": "## Example scenario\n\n**Given** a performer/patient is not registered at a GP \n**And** the performer/patient has no proxy roles in the National Proxy Store \n**When** a GET /Consent request is sent for the performer/patient \n**Then** a 404 error is returned with the detail 'GP Practice could not be found - invalid resources cannot be retrieved'\n\n## Authorization\n\nPlease see the folder overview for details of how to generate tokens for this endpoint." + }, + "response": [ + { + "name": "GP practice not found error returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "7c22ece1-b0a0-4067-8ad7-56f8bceced93", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "f1b40261-0aa6-44de-8563-3bfcc5813510", + "type": "text" + }, + { + "key": "X-IM1-Connection-Params", + "value": "SomeToken;A20047", + "type": "text" + }, + { + "key": "X-Test-Routing-Flag", + "value": "nps-enabled=false;nam-cache-enabled=false;nam-enabled=true;use-nam-mock=false", + "description": "For pre-prod only - Used to control where data is gathered from to fulfill the request ", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent?performer:identifier=9736898229", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ], + "query": [ + { + "key": "performer:identifier", + "value": "9736898229" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Thu, 27 Nov 2025 16:48:38 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "391" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "e0bae044-bde7-4def-a600-199f72ea2e50" + }, + { + "key": "x-amz-apigw-id", + "value": "UtkTcEIOLPEF5aQ=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-692880e2-7d058bc8fc71f9ee272f339d" + }, + { + "key": "X-Request-ID", + "value": "c1f8bed5-6729-4b9f-b20c-180b069809ed" + }, + { + "key": "X-Correlation-ID", + "value": "3132cc74-64ef-465d-aac9-502f27c6ac1d" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"processing\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"GP_PRACTICE_NOT_FOUND\",\n \"display\": \"GP Practice could not be found - invalid resources cannot be retrieved\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"GP Practice could not be found\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + } + ], + "description": "## Authorization\n\n### Allowed auth methods\n\n- App restricted token\n \n- NHS Login token - Auth with test user `9730675929`\n \n- CIS2 token - Auth with test user `656005750108`\n \n\nSee collection level documentation for info about how to get authorization tokens.\n\n## NPS and NAM routing\n\nYou will notice that there are 'Valid request - NPS' and 'Valid request - NAM' requests and examples within this folder. These are set up to retrieve the proxy roles from different data sources:\n\n- **Valid request - NPS**: Retrieves the roles from the National Proxy Store (NPS) only. Following the eventual migration of all proxy and related person data from GPIT to NPS, this will become the only route for all requests.\n \n- **Valid request - NAM:** Retrives the roles as related person data from the GPIT suppliers via NAM without checking if any exist in NPS first. This requires specific connection parameters to authorise with the GPIT supplier systems\n \n\nThis routing is controlled in the requests by the `X-Test-Routing-Flag` header. This header is used in the VRS pre-prod environments to control where the proxy roles are retrieved from. It is intended to be used for testing purposes only. Omission of this header will cause the default routing settings for the given environment to be followed instead. This is typically for roles to be retrieved from NPS, with NAM used as a fallback if none are found.", + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{consent_app_auth_header_value}}", + "type": "string" + } + ] + }, + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "packages": {}, + "requests": {}, + "exec": [ + "var uuid = require('uuid');", + "", + "var privateKey = pm.environment.get('vrs_api_private_key') || '';", + "var api_key_value = pm.environment.get('nhs_developer_account_api_key') || '';", + "", + "if (!privateKey) {", + " throw new Error(\"Variable vrs_api_private_key must be set with your private key for signed JWT authentication.\");", + "}", + "", + "// Replace any '/n' new lines with actual new lines", + "privateKey = privateKey.replace(/\\\\n/g, '\\n');", + "", + "if (!api_key_value) {", + " throw new Error(\"Variable nhs_developer_account_app_key must be set with your integration testing application API key.\");", + "}", + "", + "var auth_url = 'https://int.api.service.nhs.uk/oauth2-mock/token';", + "var navigator = {};", + "var window = {};", + "const interval = setTimeout(() => {}, 2147483647);", + "", + "return new Promise((resolve, reject) => { ", + " if (pm.globals.has('jsrsasign-js') && pm.globals.get('jsrsasign-js') !== \"\") {", + " return resolve();", + " }", + "", + " pm.sendRequest(", + " {", + " url: 'https://kjur.github.io/jsrsasign/jsrsasign-all-min.js',", + " method: 'GET'", + " }, function (err, res) {", + " if (err) {", + " return reject(err);", + " }", + "", + " pm.globals.set('jsrsasign-js', res.text()); ", + " return resolve();", + " }", + " );", + "}).then(() => { ", + " eval(pm.globals.get(\"jsrsasign-js\")); ", + "", + " // Set headers for JWT", + " var header = {", + " 'typ': 'JWT',", + " 'alg': 'RS512',", + " 'kid': 'VRS-dev-12-nov-2025'", + " };", + "", + " // Prepare timestamp in seconds", + " var currentTimestamp = Math.floor(Date.now() / 1000)", + " var uuid = require('uuid');", + " var jti_value = uuid.v4();", + " var data = {", + " 'sub': api_key_value,", + " 'iss': api_key_value,", + " 'jti': jti_value,", + " 'aud': auth_url,", + " 'exp': currentTimestamp + 180, // expiry time is 180 seconds from time of creation", + " } ", + "", + " var sJWT = KJUR.jws.JWS.sign(header.alg, JSON.stringify(header), JSON.stringify(data), privateKey); ", + " return new Promise((resolve, reject) => { ", + " pm.sendRequest({", + " url: auth_url,", + " method: \"POST\",", + " header: {", + " \"Content-Type\": \"application/x-www-form-urlencoded\"", + " },", + " body: {", + " mode: \"urlencoded\",", + " urlencoded: [", + " {", + " key: \"grant_type\",", + " value: \"client_credentials\"", + " },", + " {", + " key: \"client_assertion_type\",", + " value: \"urn:ietf:params:oauth:client-assertion-type:jwt-bearer\",", + " },", + " {", + " key: \"client_assertion\",", + " value: sJWT", + " }", + " ]", + " }", + " }, function (err, res) { ", + " if (err) {", + " return reject(err);", + " }", + "", + " //assign the authorization header value", + " pm.environment.set('consent_app_auth_header_value', `${res.json().access_token}`);", + "", + " return resolve();", + " }); ", + " });", + "}).then(() => { ", + " clearTimeout(interval);", + "}).catch((err) => { ", + " console.error(err); ", + " clearTimeout(interval); ", + "});" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "packages": {}, + "requests": {}, + "exec": [ + "" + ] + } + } + ] + }, + { + "name": "Get proxy role (GET /Consent/{id})", + "item": [ + { + "name": "Valid request - Get proxy role", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role exists between a performer and a patient in the National Proxy Store \n**When** a GET /Consent/{id} request is sent with the consent id of the proxy role \n**Then** the proxy role is returned" + }, + "response": [ + { + "name": "Proxy role returned - No patient or performer details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "4b1a8cf8-aa7e-4aa2-b465-44a5d25be876", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "b09740bc-b71f-4d04-a597-c89ab3804f90", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:28:18 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "1873" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "23636f8d-f5ef-4050-8c67-51e393b47c87" + }, + { + "key": "x-amz-apigw-id", + "value": "VD581F_4LPEFyDg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69317051-6384bdf9e3106d26096daa32" + }, + { + "key": "X-Request-ID", + "value": "784fb8d0-37ff-4716-bf77-81a395fd20f8" + }, + { + "key": "X-Correlation-ID", + "value": "ec404ce9-1721-4158-91af-2064ad3e7ea4" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:28:18Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"resource\": {\n \"id\": \"4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:08:46Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-12-05\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy role returned - Include performer details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id?_include=Consent:performer", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "query": [ + { + "key": "_include", + "value": "Consent:performer" + } + ], + "variable": [ + { + "key": "consent_id", + "value": "4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:28:48 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "2789" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "a1f034c1-6ee8-499e-aa60-eea157ad4bd9" + }, + { + "key": "x-amz-apigw-id", + "value": "VD6AYFQMrPEFgjw=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69317068-3a18b175fb02b76c68acfce1" + }, + { + "key": "X-Request-ID", + "value": "e8a5dada-5577-4738-abd5-7a09251e8c3b" + }, + { + "key": "X-Correlation-ID", + "value": "5eeb9d78-133f-4132-b121-649162a6bc14" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:28:47Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40?_include=Consent%3Aperformer\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"resource\": {\n \"id\": \"4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:08:46Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-12-05\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/nVLgl\",\n \"resource\": {\n \"id\": \"nVLgl\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy role returned - Include patient details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id?_include=Consent:patient", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "query": [ + { + "key": "_include", + "value": "Consent:patient" + } + ], + "variable": [ + { + "key": "consent_id", + "value": "4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:29:08 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "3601" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "b6cb5439-d1a8-4f95-bd3e-9dca7bed9e88" + }, + { + "key": "x-amz-apigw-id", + "value": "VD6ErHoPLPEF1rg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69317083-b57a368a7776107b8b3e5f7a" + }, + { + "key": "X-Request-ID", + "value": "22ca0610-1b6e-4e3a-aa1a-ede697da4a1d" + }, + { + "key": "X-Correlation-ID", + "value": "71035b63-936a-4ce4-b036-3d592c764d88" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:29:08Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40?_include=Consent%3Apatient\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"resource\": {\n \"id\": \"4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:08:46Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-12-05\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898660\",\n \"resource\": {\n \"id\": \"9736898660\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"19976537\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"pBQDr\",\n \"line\": [\n \"CARLTON\",\n \"VICARAGE LANE\",\n \"REDBOURNE\",\n \"GAINSBOROUGH\",\n \"LINCS\"\n ],\n \"period\": {\n \"start\": \"2025-07-15\"\n },\n \"postalCode\": \"DN21 4QW\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2012-04-24\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"xSEnH\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2024-11-06\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n ],\n \"name\": [\n {\n \"family\": \"GODREY\",\n \"given\": [\n \"Davina\",\n \"Linda\"\n ],\n \"period\": {\n \"start\": \"2017-04-22\"\n },\n \"prefix\": [\n \"MISS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + }, + { + "name": "Proxy role returned - Include performer and patient details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id?_include=Consent:patient&_include=Consent:performer", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "query": [ + { + "key": "_include", + "value": "Consent:patient" + }, + { + "key": "_include", + "value": "Consent:performer" + } + ], + "variable": [ + { + "key": "consent_id", + "value": "4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 11:29:26 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "4517" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "9db19dac-df92-4494-8f31-076621ab3d1a" + }, + { + "key": "x-amz-apigw-id", + "value": "VD6HkGFkrPEFxmw=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69317096-6ad930e767f145f7dd07b977" + }, + { + "key": "X-Request-ID", + "value": "5fd5c3dc-1f5c-4ac5-a9b4-018fdd7f1a0b" + }, + { + "key": "X-Correlation-ID", + "value": "fd7368b4-0828-40b0-97fa-6d19fb51a9e0" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"Bundle\",\n \"type\": \"searchset\",\n \"timestamp\": \"2026-16-01T11:29:26Z\",\n \"total\": 1,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40?_include=Consent%3Apatient&_include=Consent%3Aperformer\"\n }\n ],\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"resource\": {\n \"id\": \"4ee397cb-f4b8-4b8e-adfc-8d63a2b68b40\",\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"INFA\",\n \"display\": \"information access\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\"\n }\n ]\n }\n ],\n \"dateTime\": \"2025-12-04T11:08:46Z\",\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n },\n \"policy\": [\n {\n \"authority\": \"https://www.england.nhs.uk\",\n \"uri\": \"\"\n }\n ],\n \"provision\": {\n \"actor\": [\n {\n \"reference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n },\n \"role\": {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n }\n ],\n \"period\": {\n \"end\": \"2030-12-05\",\n \"start\": \"2025-12-02\"\n }\n },\n \"scope\": {\n \"coding\": [\n {\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\",\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\"\n }\n ]\n },\n \"status\": \"active\",\n \"resourceType\": \"Consent\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898156\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n },\n \"search\": {\n \"mode\": \"match\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898660\",\n \"resource\": {\n \"id\": \"9736898660\",\n \"meta\": {\n \"security\": [\n {\n \"code\": \"U\",\n \"display\": \"unrestricted\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-Confidentiality\"\n },\n {\n \"code\": \"P9\",\n \"display\": \"High level verification (P9)\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel\"\n }\n ],\n \"versionId\": \"4\"\n },\n \"address\": [\n {\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"type\",\n \"valueCoding\": {\n \"code\": \"PAF\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType\"\n }\n },\n {\n \"url\": \"value\",\n \"valueString\": \"19976537\"\n }\n ],\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey\"\n }\n ],\n \"id\": \"pBQDr\",\n \"line\": [\n \"CARLTON\",\n \"VICARAGE LANE\",\n \"REDBOURNE\",\n \"GAINSBOROUGH\",\n \"LINCS\"\n ],\n \"period\": {\n \"start\": \"2025-07-15\"\n },\n \"postalCode\": \"DN21 4QW\",\n \"use\": \"home\"\n }\n ],\n \"birthDate\": \"2012-04-24\",\n \"gender\": \"female\",\n \"generalPractitioner\": [\n {\n \"id\": \"xSEnH\",\n \"identifier\": {\n \"period\": {\n \"start\": \"2024-11-06\"\n },\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"A20047\"\n }\n }\n ],\n \"identifier\": [\n {\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"code\": \"01\",\n \"display\": \"Number present and verified\",\n \"system\": \"https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n }\n ],\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n ],\n \"name\": [\n {\n \"family\": \"GODREY\",\n \"given\": [\n \"Davina\",\n \"Linda\"\n ],\n \"period\": {\n \"start\": \"2017-04-22\"\n },\n \"prefix\": [\n \"MISS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/nVLgl\",\n \"resource\": {\n \"id\": \"nVLgl\",\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator\",\n \"valueBoolean\": true\n }\n ],\n \"active\": true,\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898660\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"CHILD\",\n \"display\": \"child\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"Personal\",\n \"display\": \"Personal relationship with the patient\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/UKCore-AdditionalRelatedPersonRole\"\n }\n ]\n },\n {\n \"coding\": [\n {\n \"code\": \"N\",\n \"display\": \"Next-of-Kin\",\n \"system\": \"http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n }\n ]\n}" + } + ] + }, + { + "name": "Invalid consent id - Get proxy role", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "invalid" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role exists between a performer and a patient in the National Proxy Store \n**When** a GET /Consent/{id} request is sent where the ID is invalid \n**Then** a 400 error is returned with details including 'Required parameter(s) are invalid.'" + }, + "response": [ + { + "name": "Invalid consent id error returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "6ada3f0b-6520-4517-a71c-8ee93616f52b", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "ac9c9714-f361-44f2-92be-ea1eb00f9990", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "invalid" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Thu, 27 Nov 2025 16:49:51 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "370" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "8bae29b7-2cf9-4f6f-b054-0ff6133092b7" + }, + { + "key": "x-amz-apigw-id", + "value": "UtkfVE6VLPEFmDg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6928812e-f15d362bb65b30e32885ea32" + }, + { + "key": "X-Request-ID", + "value": "51f1c948-51e0-4719-8307-fd1f987809a1" + }, + { + "key": "X-Correlation-ID", + "value": "cf91adbc-f994-4a56-9d6b-2b324c0af196" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"diagnostics\": \"Invalid request with error - ID must be a valid UUID.\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_ID_VALUE\",\n \"display\": \"Required parameter(s) are invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Invalid include parameter - Get proxy role", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id?_include=Consent:invalid", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "query": [ + { + "key": "_include", + "value": "Consent:invalid" + } + ], + "variable": [ + { + "key": "consent_id", + "value": "77363c92-8c33-490f-b5c9-9ef81c2cf16f" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role exists between a performer and a patient in the National Proxy Store \n**When** a GET /Consent/{id} request is sent with an invalid include parameter \n**Then** a 422 error is returned with details including 'Required parameter(s) are invalid.'" + }, + "response": [ + { + "name": "Invalid include parameter error returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "b6656a79-4fde-4def-b9ae-5cb1d5667d8f", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "7ae117a4-5b43-4aac-aa00-5fcc0c460fac", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id?_include=Consent:invalid", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "query": [ + { + "key": "_include", + "value": "Consent:invalid" + } + ], + "variable": [ + { + "key": "consent_id", + "value": "77363c92-8c33-490f-b5c9-9ef81c2cf16f" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Thu, 27 Nov 2025 16:50:07 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "377" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "6da48428-7512-4d8b-9856-b2cc37713381" + }, + { + "key": "x-amz-apigw-id", + "value": "Utkh9GPDLPEF3pw=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6928813f-6ca71472e425ed45ed5bd0a5" + }, + { + "key": "X-Request-ID", + "value": "2dbb0b8c-a6c8-4bf2-9005-ec19ff68f5b2" + }, + { + "key": "X-Correlation-ID", + "value": "ec9a3692-5922-491d-8df1-da17fe8e473b" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_PARAMETER\",\n \"display\": \"Required parameter(s) are invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Invalid request with error - _include parameter is invalid.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Proxy role not found - Get proxy role", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "4cfccac1-673c-4fea-9b73-54b1a605c9a0" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role does not exist between a performer and a patient in the National Proxy Store \n**When** a GET /Consent/{id} request is sent \n**Then** a 404 error is returned with details including 'Resource that has been marked as invalid was requested - invalid resources cannot be retrieved'" + }, + "response": [ + { + "name": "Proxy role not found error response", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "ed862755-76fc-47b5-9381-9578062418e3", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "5095096c-4f78-4544-b812-ba9a4b21d08d", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "4cfccac1-673c-4fea-9b73-54b1a605c9a0" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Thu, 27 Nov 2025 16:50:22 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "478" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "ece32b72-4d4a-43c9-b42a-e47b729e04da" + }, + { + "key": "x-amz-apigw-id", + "value": "UtkkIHJprPEFiYw=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6928814d-5023dcb7c8009889ccde4f3d" + }, + { + "key": "X-Request-ID", + "value": "3ec49ee6-c56c-4df9-aa7a-f54bb6b3e795" + }, + { + "key": "X-Correlation-ID", + "value": "74eb5dd5-2d74-4b3a-a482-5480e1ad6464" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"processing\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\",\n \"code\": \"INVALIDATED_RESOURCE\",\n \"display\": \"Resource that has been marked as invalid was requested - invalid resources cannot be retrieved\"\n }\n ]\n },\n \"diagnostics\": \"Resource that has been marked as invalid was requested - invalid resources cannot be retrieved\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Missing consent id value - Get proxy role", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent/", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + "" + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role exists between a performer and a patient in the National Proxy Store \n**When** a GET /Consent/{id} request is sent with the ID value missing \n**Then** a 400 error is returned with details including 'Required parameter(s) are missing.'" + }, + "response": [ + { + "name": "Missing consent id value error returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "7c50dc2d-fc25-4bed-8ce8-d58b4811f58c", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "210ede12-efec-4195-b2cd-1a04d1827a81", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/Consent/", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + "" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Thu, 27 Nov 2025 16:51:00 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "417" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "c4a3d99b-0ea1-40de-82bf-5cd2fa60afd6" + }, + { + "key": "x-amz-apigw-id", + "value": "UtkqLGF_rPEFcMw=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69288173-c5d997b9110a61bf7b655fe7" + }, + { + "key": "X-Request-ID", + "value": "de0e2e5b-1f1b-4448-a7ee-42d0236b88a6" + }, + { + "key": "X-Correlation-ID", + "value": "6f458de2-64c6-4764-9044-34a5617d3d43" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_IDENTIFIER_VALUE\",\n \"display\": \"Required parameter(s) are missing.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Invalid request with error - performer:identifier or patient:identifier parameter not found.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + } + ], + "description": "## Allowed auth methods\n\n- NHS Login token - Auth with test user `9730675929`\n \n- CIS2 token - Auth with test user `656005750108`\n \n\nSee collection level documentation for info about how to get authorization tokens.", + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "packages": {}, + "requests": {}, + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "packages": {}, + "requests": {}, + "exec": [ + "" + ] + } + } + ] + }, + { + "name": "Create a new access request (POST /QuestionnaireResponse)", + "item": [ + { + "name": "Valid request - Proxy applicant - New adult to adult access request", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Use-National-Proxy-Store", + "value": "False", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"QuestionnaireResponse\",\n \"status\": \"completed\",\n \"authored\": \"{{$isoTimestamp}}\",\n \"source\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"subject\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898202\"\n }\n },\n \"questionnaire\": \"Questionnaire/{{$randomUUID}}\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson\",\n \"text\": \"relatedPerson\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9730675929\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name\",\n \"text\": \"relatedPerson_name\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Betty\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"MORLEY\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2005-01-20\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_basisForAccess\",\n \"text\": \"Basis For Access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_relationship\",\n \"text\": \"Relationship\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient\",\n \"text\": \"patient\",\n \"item\": [\n {\n \"linkId\": \"patient_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9736898202\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name\",\n \"text\": \"patient_name\",\n \"item\": [\n {\n \"linkId\": \"patient_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"URIEL\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"ROTH\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"1988-11-10\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess\",\n \"text\": \"requestedAccess\",\n \"item\": [\n {\n \"linkId\": \"requestedAccess_accessLevel\",\n \"text\": \"Requested access level\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"APPT\",\n \"display\": \"Appointment Booking\"\n }\n },\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"VACC\",\n \"display\": \"Vaccination Records\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccess\",\n \"text\": \"Reason for access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess\",\n \"code\": \"COMB\",\n \"display\": \"Communication Barriers\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccessMoreinfo\",\n \"text\": \"Reason for access - further information\",\n \"answer\": [\n {\n \"valueString\": \"No internet connection\"\n }\n ]\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/QuestionnaireResponse", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "QuestionnaireResponse" + ] + }, + "description": "## Example scenario\n\n**Given** no proxy role exists between two adults \n**When** a valid access request is sent with the proxy as the applicant \n**Then** a 201 response is returned" + }, + "response": [ + { + "name": "A2A proxy applicant access request created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "5ef96245-493a-468c-9936-06fb46e387af", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "15ace5c8-dc43-435f-baf8-3437b76ffdbf", + "type": "text" + }, + { + "key": "X-Use-National-Proxy-Store", + "value": "False", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"QuestionnaireResponse\",\n \"status\": \"completed\",\n \"authored\": \"2026-01-12T15:09:45.790Z\",\n \"source\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"subject\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898202\"\n }\n },\n \"questionnaire\": \"Questionnaire/2e61ba16-f2ee-4e16-8526-194873d63f24\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson\",\n \"text\": \"relatedPerson\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9730675929\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name\",\n \"text\": \"relatedPerson_name\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Betty\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"MORLEY\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2005-01-20\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_basisForAccess\",\n \"text\": \"Basis For Access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_relationship\",\n \"text\": \"Relationship\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient\",\n \"text\": \"patient\",\n \"item\": [\n {\n \"linkId\": \"patient_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9736898202\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name\",\n \"text\": \"patient_name\",\n \"item\": [\n {\n \"linkId\": \"patient_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"URIEL\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"ROTH\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"1988-11-10\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess\",\n \"text\": \"requestedAccess\",\n \"item\": [\n {\n \"linkId\": \"requestedAccess_accessLevel\",\n \"text\": \"Requested access level\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"APPT\",\n \"display\": \"Appointment Booking\"\n }\n },\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"VACC\",\n \"display\": \"Vaccination Records\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccess\",\n \"text\": \"Reason for access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess\",\n \"code\": \"COMB\",\n \"display\": \"Communication Barriers\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccessMoreinfo\",\n \"text\": \"Reason for access - further information\",\n \"answer\": [\n {\n \"valueString\": \"No internet connection\"\n }\n ]\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "QuestionnaireResponse" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Mon, 01 Dec 2025 16:09:01 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "186" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "720499ae-68fe-495a-8485-862105f276a9" + }, + { + "key": "x-amz-apigw-id", + "value": "U6qQkGxVrPEFeoA=" + }, + { + "key": "location", + "value": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse/e185e5e3-901e-4b6a-bfe2-f9adb0b311a4" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-692dbd9c-999e6478f9613be345a68c77" + }, + { + "key": "X-Request-ID", + "value": "687bfc1b-b7a7-4681-a7bf-01ac6e7dd97a" + }, + { + "key": "X-Correlation-ID", + "value": "6adda3bb-aacf-4e4f-a459-a2a0fe6d34be" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"19C01XB6WC\",\n \"display\": \"19C01XB6WC\"\n }\n ]\n }\n }\n ]\n}" + } + ] + }, + { + "name": "Valid request - Patient applicant - New adult to adult access request", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Use-National-Proxy-Store", + "value": "False", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"QuestionnaireResponse\",\n \"status\": \"completed\",\n \"authored\": \"{{$isoTimestamp}}\",\n \"source\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"subject\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"questionnaire\": \"Questionnaire/{{$randomUUID}}\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson\",\n \"text\": \"relatedPerson\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9736898164\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name\",\n \"text\": \"relatedPerson_name\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Heidi\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"LAW\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"1997-09-15\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_basisForAccess\",\n \"text\": \"Basis For Access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_relationship\",\n \"text\": \"Relationship\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient\",\n \"text\": \"patient\",\n \"item\": [\n {\n \"linkId\": \"patient_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9730675929\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name\",\n \"text\": \"patient_name\",\n \"item\": [\n {\n \"linkId\": \"patient_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Betty\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"MORLEY\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2005-01-20\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess\",\n \"text\": \"requestedAccess\",\n \"item\": [\n {\n \"linkId\": \"requestedAccess_accessLevel\",\n \"text\": \"Requested access level\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"APPT\",\n \"display\": \"Appointment Booking\"\n }\n },\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"VACC\",\n \"display\": \"Vaccination Records\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccess\",\n \"text\": \"Reason for access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess\",\n \"code\": \"COMB\",\n \"display\": \"Communication Barriers\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccessMoreinfo\",\n \"text\": \"Reason for access - further information\",\n \"answer\": [\n {\n \"valueString\": \"No internet connection\"\n }\n ]\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/QuestionnaireResponse", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "QuestionnaireResponse" + ] + }, + "description": "## Example scenario\n\n**Given** no proxy role exists between two adults \n**When** a valid access request is sent with the patient as the applicant \n**Then** a 201 response is returned" + }, + "response": [ + { + "name": "A2A patient applicant access request created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "8af428cd-7e1e-4ed3-b127-0b751d6ae98d", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "e5cc0a6d-ea0d-433b-9307-30c988926969", + "type": "text" + }, + { + "key": "X-Use-National-Proxy-Store", + "value": "False", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"QuestionnaireResponse\",\n \"status\": \"completed\",\n \"authored\": \"2026-01-12T15:09:46.233Z\",\n \"source\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"subject\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"questionnaire\": \"Questionnaire/aa952e3f-3657-4ec3-bec0-25d881ed2e20\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson\",\n \"text\": \"relatedPerson\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9736898164\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name\",\n \"text\": \"relatedPerson_name\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Heidi\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"LAW\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"1997-09-15\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_basisForAccess\",\n \"text\": \"Basis For Access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_relationship\",\n \"text\": \"Relationship\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient\",\n \"text\": \"patient\",\n \"item\": [\n {\n \"linkId\": \"patient_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9730675929\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name\",\n \"text\": \"patient_name\",\n \"item\": [\n {\n \"linkId\": \"patient_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Betty\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"MORLEY\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2005-01-20\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess\",\n \"text\": \"requestedAccess\",\n \"item\": [\n {\n \"linkId\": \"requestedAccess_accessLevel\",\n \"text\": \"Requested access level\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"APPT\",\n \"display\": \"Appointment Booking\"\n }\n },\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"VACC\",\n \"display\": \"Vaccination Records\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccess\",\n \"text\": \"Reason for access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess\",\n \"code\": \"COMB\",\n \"display\": \"Communication Barriers\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccessMoreinfo\",\n \"text\": \"Reason for access - further information\",\n \"answer\": [\n {\n \"valueString\": \"No internet connection\"\n }\n ]\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/QuestionnaireResponse", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "QuestionnaireResponse" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Mon, 01 Dec 2025 16:10:22 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "186" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "d15e2ba0-3698-4fcf-80fe-d73279dd89a8" + }, + { + "key": "x-amz-apigw-id", + "value": "U6qdWHFfLPEFoUA=" + }, + { + "key": "location", + "value": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse/bdbba534-6e11-4491-aa3a-1631b0009628" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-692dbdee-08b18875f6f85ab2a7353bd4" + }, + { + "key": "X-Request-ID", + "value": "82cb14a5-09d0-41d4-8f73-2936794c32de" + }, + { + "key": "X-Correlation-ID", + "value": "73873b5d-1e2e-4a42-9dc3-83f1292f944b" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"19C0177GRI\",\n \"display\": \"19C0177GRI\"\n }\n ]\n }\n }\n ]\n}" + } + ] + }, + { + "name": "Valid request - New adult to child access request", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Use-National-Proxy-Store", + "value": "False", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"QuestionnaireResponse\",\n \"status\": \"completed\",\n \"authored\": \"{{$isoTimestamp}}\",\n \"source\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"subject\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898245\"\n }\n },\n \"questionnaire\": \"Questionnaire/01dc6813-3421-4d14-948d-a4888241add1\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson\",\n \"text\": \"relatedPerson\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9730675929\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name\",\n \"text\": \"relatedPerson_name\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Betty\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"MORLEY\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2005-01-20\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_basisForAccess\",\n \"text\": \"Basis For Access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_relationship\",\n \"text\": \"Relationship\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails\",\n \"text\": \"parentalApplicationSupplementaryDetails\",\n \"item\": [\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_evidenceOfResponsibility\",\n \"text\": \"Evidence of parental responsibility\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-EvidenceOfResponsibility\",\n \"code\": \"BRTH\",\n \"display\": \"Birth certificate\"\n }\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_evidenceOfResponsibilityMoreinfo\",\n \"text\": \"Evidence of responsibility - Further Information\",\n \"answer\": [\n {\n \"valueString\": \"Birth Certificate is original\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_isCurrentAddressConfirmed\",\n \"text\": \"Is current address confirmed?\",\n \"answer\": [\n {\n \"valueString\": \"Yes\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_newAddress\",\n \"text\": \"parentalApplicationSupplementaryDetails_newAddress\",\n \"item\": [\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line1\",\n \"text\": \"Address Line 1\",\n \"answer\": [\n {\n \"valueString\": \"101 MESSINGHAM ROAD\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line2\",\n \"text\": \"Address Line 2\",\n \"answer\": [\n {\n \"valueString\": \"\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line3\",\n \"text\": \"Address Line 3\",\n \"answer\": [\n {\n \"valueString\": \"\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_city\",\n \"text\": \"Town / City\",\n \"answer\": [\n {\n \"valueString\": \"SCUNTHORPE\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_district\",\n \"text\": \"County\",\n \"answer\": [\n {\n \"valueString\": \"S HUMBERSIDE\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_postalCode\",\n \"text\": \"Postcode\",\n \"answer\": [\n {\n \"valueString\": \"DN17 2LN\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_liveAtSameAddress\",\n \"text\": \"Do the adult and child live at the same address?\",\n \"answer\": [\n {\n \"valueString\": \"Yes\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_canChildConsent\",\n \"text\": \"Can the child consent?\",\n \"answer\": [\n {\n \"valueString\": \"No\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_reasonNoChildConsent\",\n \"text\": \"Reason the child cannot consent\",\n \"answer\": [\n {\n \"valueString\": \"Child is too young\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient\",\n \"text\": \"patient\",\n \"item\": [\n {\n \"linkId\": \"patient_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9736898245\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name\",\n \"text\": \"patient_name\",\n \"item\": [\n {\n \"linkId\": \"patient_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Amber\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"TUCKER\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2017-06-09\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess\",\n \"text\": \"requestedAccess\",\n \"item\": [\n {\n \"linkId\": \"requestedAccess_accessLevel\",\n \"text\": \"Requested access level\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"APPT\",\n \"display\": \"Appointment Booking\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccess\",\n \"text\": \"Reason for access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess\",\n \"code\": \"COMB\",\n \"display\": \"Communication Barriers\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccessMoreinfo\",\n \"text\": \"Reason for access - further information\",\n \"answer\": [\n {\n \"valueString\": \"No internet connection\"\n }\n ]\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/QuestionnaireResponse", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "QuestionnaireResponse" + ] + }, + "description": "## Example scenario\n\n**Given** no proxy role exists between an adult and child \n**When** a valid access request is sent with the proxy as the applicant \n**Then** a 201 response is returned" + }, + "response": [ + { + "name": "A2C access request created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "d6f3b8fe-0041-4c34-aeb4-eac71020170d", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "46efa85e-d5c4-403b-a38a-1945f33bac2c", + "type": "text" + }, + { + "key": "X-Use-National-Proxy-Store", + "value": "False", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"QuestionnaireResponse\",\n \"status\": \"completed\",\n \"authored\": \"2026-01-12T15:09:46.453Z\",\n \"source\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"subject\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898245\"\n }\n },\n \"questionnaire\": \"Questionnaire/01dc6813-3421-4d14-948d-a4888241add1\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson\",\n \"text\": \"relatedPerson\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9730675929\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name\",\n \"text\": \"relatedPerson_name\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Betty\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"MORLEY\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2005-01-20\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_basisForAccess\",\n \"text\": \"Basis For Access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_relationship\",\n \"text\": \"Relationship\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails\",\n \"text\": \"parentalApplicationSupplementaryDetails\",\n \"item\": [\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_evidenceOfResponsibility\",\n \"text\": \"Evidence of parental responsibility\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-EvidenceOfResponsibility\",\n \"code\": \"BRTH\",\n \"display\": \"Birth certificate\"\n }\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_evidenceOfResponsibilityMoreinfo\",\n \"text\": \"Evidence of responsibility - Further Information\",\n \"answer\": [\n {\n \"valueString\": \"Birth Certificate is original\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_isCurrentAddressConfirmed\",\n \"text\": \"Is current address confirmed?\",\n \"answer\": [\n {\n \"valueString\": \"Yes\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_newAddress\",\n \"text\": \"parentalApplicationSupplementaryDetails_newAddress\",\n \"item\": [\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line1\",\n \"text\": \"Address Line 1\",\n \"answer\": [\n {\n \"valueString\": \"101 MESSINGHAM ROAD\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line2\",\n \"text\": \"Address Line 2\",\n \"answer\": [\n {\n \"valueString\": \"\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line3\",\n \"text\": \"Address Line 3\",\n \"answer\": [\n {\n \"valueString\": \"\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_city\",\n \"text\": \"Town / City\",\n \"answer\": [\n {\n \"valueString\": \"SCUNTHORPE\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_district\",\n \"text\": \"County\",\n \"answer\": [\n {\n \"valueString\": \"S HUMBERSIDE\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_postalCode\",\n \"text\": \"Postcode\",\n \"answer\": [\n {\n \"valueString\": \"DN17 2LN\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_liveAtSameAddress\",\n \"text\": \"Do the adult and child live at the same address?\",\n \"answer\": [\n {\n \"valueString\": \"Yes\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_canChildConsent\",\n \"text\": \"Can the child consent?\",\n \"answer\": [\n {\n \"valueString\": \"No\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_reasonNoChildConsent\",\n \"text\": \"Reason the child cannot consent\",\n \"answer\": [\n {\n \"valueString\": \"Child is too young\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient\",\n \"text\": \"patient\",\n \"item\": [\n {\n \"linkId\": \"patient_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9736898245\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name\",\n \"text\": \"patient_name\",\n \"item\": [\n {\n \"linkId\": \"patient_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Amber\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"TUCKER\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2017-06-09\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess\",\n \"text\": \"requestedAccess\",\n \"item\": [\n {\n \"linkId\": \"requestedAccess_accessLevel\",\n \"text\": \"Requested access level\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"APPT\",\n \"display\": \"Appointment Booking\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccess\",\n \"text\": \"Reason for access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess\",\n \"code\": \"COMB\",\n \"display\": \"Communication Barriers\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccessMoreinfo\",\n \"text\": \"Reason for access - further information\",\n \"answer\": [\n {\n \"valueString\": \"No internet connection\"\n }\n ]\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/QuestionnaireResponse", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "QuestionnaireResponse" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Mon, 01 Dec 2025 16:11:33 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "186" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "4eba2237-3c13-4bab-afb1-1261b5ac6a19" + }, + { + "key": "x-amz-apigw-id", + "value": "U6qoVF-JLPEFXqQ=" + }, + { + "key": "location", + "value": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse/29a7f71a-2554-4e53-87de-07553d40d5ec" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-692dbe34-f306ba0e1a55aba127add964" + }, + { + "key": "X-Request-ID", + "value": "848e592d-a42e-4fee-b529-8ac484fd459c" + }, + { + "key": "X-Correlation-ID", + "value": "73de9aa5-5951-4d30-8f2d-e64482fb1990" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"19C01N8Q37\",\n \"display\": \"19C01N8Q37\"\n }\n ]\n }\n }\n ]\n}" + }, + { + "name": "A2C access request created - Verified relationship", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Use-National-Proxy-Store", + "value": "False", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"QuestionnaireResponse\",\n \"status\": \"completed\",\n \"authored\": \"{{$isoTimestamp}}\",\n \"source\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675929\"\n }\n },\n \"subject\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9730675422\"\n }\n },\n \"questionnaire\": \"Questionnaire/01dc6813-3421-4d14-948d-a4888241add1\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson\",\n \"text\": \"relatedPerson\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9730675929\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name\",\n \"text\": \"relatedPerson_name\",\n \"item\": [\n {\n \"linkId\": \"relatedPerson_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Betty\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"MORLEY\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2005-01-20\"\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_basisForAccess\",\n \"text\": \"Basis For Access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n },\n {\n \"linkId\": \"relatedPerson_relationship\",\n \"text\": \"Relationship\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"PRN\",\n \"display\": \"Parent\"\n }\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails\",\n \"text\": \"parentalApplicationSupplementaryDetails\",\n \"item\": [\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_evidenceOfResponsibility\",\n \"text\": \"Evidence of parental responsibility\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-EvidenceOfResponsibility\",\n \"code\": \"BRTH\",\n \"display\": \"Birth certificate\"\n }\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_evidenceOfResponsibilityMoreinfo\",\n \"text\": \"Evidence of responsibility - Further Information\",\n \"answer\": [\n {\n \"valueString\": \"Birth Certificate is original\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_isCurrentAddressConfirmed\",\n \"text\": \"Is current address confirmed?\",\n \"answer\": [\n {\n \"valueString\": \"Yes\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_newAddress\",\n \"text\": \"parentalApplicationSupplementaryDetails_newAddress\",\n \"item\": [\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line1\",\n \"text\": \"Address Line 1\",\n \"answer\": [\n {\n \"valueString\": \"101 MESSINGHAM ROAD\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line2\",\n \"text\": \"Address Line 2\",\n \"answer\": [\n {\n \"valueString\": \"\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_line3\",\n \"text\": \"Address Line 3\",\n \"answer\": [\n {\n \"valueString\": \"\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_city\",\n \"text\": \"Town / City\",\n \"answer\": [\n {\n \"valueString\": \"SCUNTHORPE\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_district\",\n \"text\": \"County\",\n \"answer\": [\n {\n \"valueString\": \"S HUMBERSIDE\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_postalCode\",\n \"text\": \"Postcode\",\n \"answer\": [\n {\n \"valueString\": \"DN17 2LN\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_liveAtSameAddress\",\n \"text\": \"Do the adult and child live at the same address?\",\n \"answer\": [\n {\n \"valueString\": \"Yes\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_canChildConsent\",\n \"text\": \"Can the child consent?\",\n \"answer\": [\n {\n \"valueString\": \"No\"\n }\n ]\n },\n {\n \"linkId\": \"parentalApplicationSupplementaryDetails_reasonNoChildConsent\",\n \"text\": \"Reason the child cannot consent\",\n \"answer\": [\n {\n \"valueString\": \"Child is too young\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient\",\n \"text\": \"patient\",\n \"item\": [\n {\n \"linkId\": \"patient_identifier\",\n \"text\": \"NHS Number\",\n \"answer\": [\n {\n \"valueString\": \"9730675422\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name\",\n \"text\": \"patient_name\",\n \"item\": [\n {\n \"linkId\": \"patient_name_first\",\n \"text\": \"First name.\",\n \"answer\": [\n {\n \"valueString\": \"Rowena\"\n }\n ]\n },\n {\n \"linkId\": \"patient_name_family\",\n \"text\": \"Family name (often called Surname).\",\n \"answer\": [\n {\n \"valueString\": \"HIRST\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"patient_birthDate\",\n \"text\": \"Date of Birth\",\n \"answer\": [\n {\n \"valueDate\": \"2015-08-09\"\n }\n ]\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess\",\n \"text\": \"requestedAccess\",\n \"item\": [\n {\n \"linkId\": \"requestedAccess_accessLevel\",\n \"text\": \"Requested access level\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess\",\n \"code\": \"APPT\",\n \"display\": \"Appointment Booking\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccess\",\n \"text\": \"Reason for access\",\n \"answer\": [\n {\n \"valueCoding\": {\n \"system\": \"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess\",\n \"code\": \"COMB\",\n \"display\": \"Communication Barriers\"\n }\n }\n ]\n },\n {\n \"linkId\": \"requestedAccess_reasonsForAccessMoreinfo\",\n \"text\": \"Reason for access - further information\",\n \"answer\": [\n {\n \"valueString\": \"No internet connection\"\n }\n ]\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/QuestionnaireResponse", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "QuestionnaireResponse" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Mon, 01 Dec 2025 16:11:33 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "186" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "4eba2237-3c13-4bab-afb1-1261b5ac6a19" + }, + { + "key": "x-amz-apigw-id", + "value": "U6qoVF-JLPEFXqQ=" + }, + { + "key": "location", + "value": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse/29a7f71a-2554-4e53-87de-07553d40d5ec" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-692dbe34-f306ba0e1a55aba127add964" + }, + { + "key": "X-Request-ID", + "value": "848e592d-a42e-4fee-b529-8ac484fd459c" + }, + { + "key": "X-Correlation-ID", + "value": "73de9aa5-5951-4d30-8f2d-e64482fb1990" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"19C01N8Q37\",\n \"display\": \"19C01N8Q37\"\n }\n ]\n }\n }\n ]\n}" + } + ] + }, + { + "name": "Invalid request body - New adult to adult access request", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Use-National-Proxy-Store", + "value": "False", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/QuestionnaireResponse", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "QuestionnaireResponse" + ] + }, + "description": "## Example scenario\n\n**Given** no proxy role exists between two adults \n**When** a access request is sent with invalid body \n**Then** a 400 error response is returned with code 'INVALID_VALUE'" + }, + "response": [ + { + "name": "Invalid request body error response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "94d7227f-f801-465f-b04c-8dd7494faf5f", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "7f829c8e-bec6-4cbe-8ed0-d71bf981095b", + "type": "text" + }, + { + "key": "X-Use-National-Proxy-Store", + "value": "False", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/QuestionnaireResponse", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "QuestionnaireResponse" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Mon, 01 Dec 2025 16:13:37 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "377" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "28073546-4513-47c5-9d2e-17caeb920a78" + }, + { + "key": "x-amz-apigw-id", + "value": "U6q7zHXFLPEF3Bg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-692dbeb1-7dd1e1125d0b5422386cffe9" + }, + { + "key": "X-Request-ID", + "value": "d82f5db5-1c08-4251-a94b-50684ea1a06b" + }, + { + "key": "X-Correlation-ID", + "value": "7eeca365-bf2b-4859-9e2c-b5c7731bbe1b" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"BAD_REQUEST\",\n \"display\": \"The request could not be processed.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"The supplied input is not a valid FHIR QuestionnaireResponse.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + } + ], + "description": "## Allowed auth methods\n\n- NHS Login token - Auth with test user `9730675929`\n \n\nSee collection level documentation for info about how to get authorization tokens.", + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{login_token}}", + "type": "string" + } + ] + }, + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "packages": {}, + "requests": {}, + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "packages": {}, + "requests": {}, + "exec": [ + "" + ] + } + } + ] + }, + { + "name": "Get access request (GET /QuestionnaireResponse/{id})", + "item": [ + { + "name": "Valid request - Get access request", + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/QuestionnaireResponse/:access_request_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "QuestionnaireResponse", + ":access_request_id" + ], + "variable": [ + { + "key": "access_request_id", + "value": "32a5cc78-eb64-4367-abea-cfdb6e9fa2e4" + } + ] + }, + "description": "## Example scenario\n\n**Given** a valid access request has been sent to VRS \n**When** a GET /QuestionnaireResponse/{id} request is sent with the access request UUID \n**Then** the access request is returned" + }, + "response": [] + }, + { + "name": "No access request found - Get access request", + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/QuestionnaireResponse/:access_request_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "QuestionnaireResponse", + ":access_request_id" + ], + "variable": [ + { + "key": "access_request_id", + "value": "32a5cc78-eb64-4367-abea-cfdb6e9fa2e4" + } + ] + }, + "description": "## Example scenario\n\n**Given** a valid access request has been sent to VRS \n**When** a GET /QuestionnaireResponse/{id} request is sent with a random UUID \n**Then** a 404 error is returned with message 'QUESTIONNAIRE_RESPONSE_NOT_FOUND'" + }, + "response": [ + { + "name": "No access request found error returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "074b07d8-104e-4574-abd7-bdc5181280da", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "f47a9a68-34a5-4a11-881b-8b45695f2e76", + "type": "text" + } + ], + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse/:access_request_id", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "QuestionnaireResponse", + ":access_request_id" + ], + "variable": [ + { + "key": "access_request_id", + "value": "32a5cc78-eb64-4367-abea-cfdb6e9fa2e4" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Mon, 01 Dec 2025 14:37:04 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "400" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "64959769-f136-4d27-9369-b4e01224c066" + }, + { + "key": "x-amz-apigw-id", + "value": "U6cyYE4brPEFXvw=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-692da80e-520fcf28565fe1ea77ceb7fc" + }, + { + "key": "X-Request-ID", + "value": "f6fe610a-d80b-4436-b727-67960c9687a1" + }, + { + "key": "X-Correlation-ID", + "value": "076421a4-1c56-43e4-95a9-6139434516a7" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"not-found\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"QUESTIONNAIRE_RESPONSE_NOT_FOUND\",\n \"display\": \"Questionnaire response not found\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\"\n }\n ]\n },\n \"diagnostics\": \"The Questionnaire response could not be found using the provided access request ID.\"\n }\n ]\n}" + } + ] + }, + { + "name": "No access request UUID - Get access request", + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/QuestionnaireResponse/", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "QuestionnaireResponse", + "" + ] + }, + "description": "## Example scenario\n\n**Given** a valid access request has been sent to VRS \n**When** a GET /QuestionnaireResponse/{id} request is sent without a UUID \n**Then** a 400 error is returned with message 'METHOD_NOT_ALLOWED'" + }, + "response": [ + { + "name": "No access request UUID invalid response", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "6e763c1c-b24b-4ffe-8598-e2983ae5e3cf", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "87ed4d25-05d6-4ab6-985e-a254cdd26339", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/QuestionnaireResponse/", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "QuestionnaireResponse", + "" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Mon, 01 Dec 2025 15:15:37 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "370" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "42e98c18-f152-4e8f-8cd2-fc0ba2bcc590" + }, + { + "key": "x-amz-apigw-id", + "value": "U6ibrGjDrPEFgRQ=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-692db117-2a87f1ac0c50e6702fcbc5ce" + }, + { + "key": "X-Request-ID", + "value": "4270ae5f-3cc9-418e-a6f8-aab43372486a" + }, + { + "key": "X-Correlation-ID", + "value": "a23d9c20-bcf2-4e03-ba6b-092a703947f3" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"not-supported\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"METHOD_NOT_ALLOWED\",\n \"display\": \"The method is not allowed.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"The method is not allowed for the requested resource.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Invalid access request UUID - Get access request", + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/QuestionnaireResponse/invalid", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "QuestionnaireResponse", + "invalid" + ] + }, + "description": "## Example scenario\n\n**Given** a valid access request has been sent to VRS \n**When** a GET /QuestionnaireResponse/{id} request is sent with an invalid UUID \n**Then** a 400 error is returned with message 'INVALID_IDENTIFIER_VALUE'" + }, + "response": [ + { + "name": "Invalid access request UUID invalid response", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "30e863b4-b90b-439e-a757-06eadf3cae48", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "79bc7284-1f65-407a-bc5e-1e5bd8d0496b", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/QuestionnaireResponse/invalid", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "QuestionnaireResponse", + "invalid" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Mon, 01 Dec 2025 15:15:37 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "370" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "42e98c18-f152-4e8f-8cd2-fc0ba2bcc590" + }, + { + "key": "x-amz-apigw-id", + "value": "U6ibrGjDrPEFgRQ=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-692db117-2a87f1ac0c50e6702fcbc5ce" + }, + { + "key": "X-Request-ID", + "value": "4270ae5f-3cc9-418e-a6f8-aab43372486a" + }, + { + "key": "X-Correlation-ID", + "value": "a23d9c20-bcf2-4e03-ba6b-092a703947f3" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1\",\n \"code\": \"INVALID_IDENTIFIER_VALUE\",\n \"display\": \"Invalid identifier value\"\n }\n ]\n },\n \"diagnostics\": \"The specified access request ID is invalid. Access request IDs must be a valid UUID.\"\n }\n ]\n}" + } + ] + } + ], + "description": "## Allowed auth methods\n\n- CIS2 token - Auth with test user `656005750108`\n \n- NHS Login token - Auth with test user `9730675929`\n \n\nSee collection level documentation for info about how to get authorization tokens.", + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "packages": {}, + "requests": {}, + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "packages": {}, + "requests": {}, + "exec": [ + "" + ] + } + } + ] + }, + { + "name": "Create a new proxy role (POST /Consent)", + "item": [ + { + "name": "Valid request - New proxy role", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ] + }, + "description": "## Important - duplicates\n\nWe cannot currently accept duplicate proxy role requests for testing purposes.\n\nThis may lead to you experiencing 409 errors on the 'valid request' scenarios if the same request has already been sent.\n\n## Example scenario\n\n**Given** no proxy role exists in NPS between a proxy and patient \n**When** I send a POST /Consent request for the proxy and patient \n**Then** a 201 success response is returned" + }, + "response": [ + { + "name": "Adult to child - New proxy role created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "df29a1cb-3861-4d7f-918d-3bcf6f5ef362", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "0b7ed233-3055-48ac-93ef-c71922ccc577", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n },\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent" + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 15:14:39 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "101" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "bf6bc3d8-1829-4a81-9433-c0b1c21376d6" + }, + { + "key": "x-amz-apigw-id", + "value": "Uwpe7FCjrPEF5aQ=" + }, + { + "key": "location", + "value": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4f15f399-d381-4949-a744-25f9cbfecfb3" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929bc5f-f6012c539553033b0859994a" + }, + { + "key": "X-Request-ID", + "value": "46baf4c8-5bb5-4a6e-9bd4-264452817dab" + }, + { + "key": "X-Correlation-ID", + "value": "65bdf903-1cb2-4722-a291-d5056c44e712" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\"\n }\n ]\n}" + }, + { + "name": "Adult to adult - New proxy role created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898202\"\n }\n },\n \"dateTime\": \"{{$isoTimestamp}}\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898164\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898164\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 15:14:39 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "101" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "bf6bc3d8-1829-4a81-9433-c0b1c21376d6" + }, + { + "key": "x-amz-apigw-id", + "value": "Uwpe7FCjrPEF5aQ=" + }, + { + "key": "location", + "value": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/4f15f399-d381-4949-a744-25f9cbfecfb3" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929bc5f-f6012c539553033b0859994a" + }, + { + "key": "X-Request-ID", + "value": "46baf4c8-5bb5-4a6e-9bd4-264452817dab" + }, + { + "key": "X-Correlation-ID", + "value": "65bdf903-1cb2-4722-a291-d5056c44e712" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\"\n }\n ]\n}" + } + ] + }, + { + "name": "Duplicate role - New proxy role", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"{{$isoTimestamp}}\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role already exists in NPS between a proxy and patient \n**When** I send a POST /Consent request for the same proxy and patient \n**Then** a 409 error is returned with code 'DUPLICATE_RELATIONSHIP'" + }, + "response": [ + { + "name": "Duplicate role error returned", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "8616edc0-f04b-4d56-ac54-4c5dd8930d87", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "42cf4c55-e180-4b8f-abe3-60acd1780311", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"{{$isoTimestamp}}\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent" + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 12:41:31 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "352" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "de65a534-5cee-45c1-845e-023e9ffab375" + }, + { + "key": "x-amz-apigw-id", + "value": "UwTC8H42LPEFggg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69299878-54ea0e3b7bd5d7e836eaea8f" + }, + { + "key": "X-Request-ID", + "value": "dd90c863-82e3-4ef8-9568-3e68a64de1e0" + }, + { + "key": "X-Correlation-ID", + "value": "b08cd6b6-96fc-410c-84a9-e52732fcbc09" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"DUPLICATE_RELATIONSHIP\",\n \"display\": \"Request must be for a new proxy role.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Proxy role already exists.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Missing scope - New proxy role", + "request": { + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"{{$isoTimestamp}}\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-11-23\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"MTH\",\n \"display\": \"Mother\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"TBC\",\n \"display\": \"TBC\"\n }\n ]\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"MTH\",\n \"display\": \"Mother\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ] + } + }, + "response": [ + { + "name": "Missing scope error returned", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "2aa3293e-ad0e-4389-a466-d3209ebbfa4e", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "425ca0da-e10c-4010-86b4-93ca9bf737eb", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-16T08:13:06.480Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-11-23\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"MTH\",\n \"display\": \"Mother\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"TBC\",\n \"display\": \"TBC\"\n }\n ]\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"MTH\",\n \"display\": \"Mother\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 15:18:49 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "353" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "75bfd563-8f97-4b8a-8d50-a08643917d89" + }, + { + "key": "x-amz-apigw-id", + "value": "UwqGBE7MLPEFySQ=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929bd59-918cef993de61bcebe339d3e" + }, + { + "key": "X-Request-ID", + "value": "2ca06d13-2568-4f70-b06c-077af0f57137" + }, + { + "key": "X-Correlation-ID", + "value": "8c8ffb79-cc4c-4cb0-a62e-31dc1310a387" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_SCOPE\",\n \"display\": \"Required values are missing.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Unable to find scope\",\n \"expression\": [\n \"scope\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Invalid status - New proxy role", + "request": { + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"invalid\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"{{$isoTimestamp}}\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-11-23\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"MTH\",\n \"display\": \"Mother\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"TBC\",\n \"display\": \"TBC\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"MTH\",\n \"display\": \"Mother\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ] + } + }, + "response": [ + { + "name": "Invalid status - New proxy role", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "1e0a0136-6025-4190-8450-5676ada97c3c", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "bc404ec3-52fa-465c-9401-2b70484989bc", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"invalid\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"{{$isoTimestamp}}\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-11-23\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"MTH\",\n \"display\": \"Mother\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"TBC\",\n \"display\": \"TBC\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"MTH\",\n \"display\": \"Mother\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent" + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 15:27:32 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "339" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "47dd1183-4b49-44f1-a524-79fe459589a9" + }, + { + "key": "x-amz-apigw-id", + "value": "UwrXkFOZrPEF1ZA=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929bf63-31132bda7b3f654ea3534f15" + }, + { + "key": "X-Request-ID", + "value": "e23fbdd1-027c-4281-b37d-094691df9fc7" + }, + { + "key": "X-Correlation-ID", + "value": "226277b1-9d7c-411a-b3fd-3a4a70a4d90e" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_STATUS\",\n \"display\": \"Invalid status.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Status is invalid\",\n \"expression\": [\n \"status\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Missing free text for Other", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ],\n \"text\": \"Patient Privacy Consent\"\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"Information Access\"\n }\n ],\n \"text\": \"Information Access Consent\"\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-01-12T15:09:49.458Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"OTHER\",\n \"display\": \"Other reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ] + }, + "description": "## Example scenario\n\n**Given** no proxy role exists in NPS between a proxy and patient \n**When** I send a POST /Consent request for the proxy and patient with an invalid performer id \n**Then** a 422 error response is returned with code 'INVALID_IDENTIFIER_VALUE'" + }, + "response": [ + { + "name": "Missing free text code error returned", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "22f85b02-35ff-475f-808f-e0fb2bc93393", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "860406c9-ef53-4fed-939c-b6efbe8106f7", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ],\n \"text\": \"Patient Privacy Consent\"\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"Information Access\"\n }\n ],\n \"text\": \"Information Access Consent\"\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-01-12T15:09:49.458Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"OTHER\",\n \"display\": \"Other reason\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent" + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 12:46:09 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "402" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "369c4598-e093-44d1-8d27-015c1e1f8a40" + }, + { + "key": "x-amz-apigw-id", + "value": "UwTu1FORLPEFh3Q=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69299991-27f38de5fa687e1e7d4659b3" + }, + { + "key": "X-Request-ID", + "value": "70591ef1-fbe0-442b-bd9a-545fb5713859" + }, + { + "key": "X-Correlation-ID", + "value": "037cf36b-1014-4177-bcc6-c1cd647aae42" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_FREE_TEXT_FOR_OTHER\",\n \"display\": \"Free text must be provided for OTHER reason codes.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Free text is required when reason code is OTHER.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Missing grantor", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ] + }, + "description": "## Example scenario\n\n**Given** no proxy role exists in NPS between a proxy and patient \n**When** I send a POST /Consent request for the proxy and patient with an invalid performer id \n**Then** a 422 error response is returned with code 'INVALID_IDENTIFIER_VALUE'" + }, + "response": [ + { + "name": "Missing grantor error", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 12:46:09 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "402" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "369c4598-e093-44d1-8d27-015c1e1f8a40" + }, + { + "key": "x-amz-apigw-id", + "value": "UwTu1FORLPEFh3Q=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69299991-27f38de5fa687e1e7d4659b3" + }, + { + "key": "X-Request-ID", + "value": "70591ef1-fbe0-442b-bd9a-545fb5713859" + }, + { + "key": "X-Correlation-ID", + "value": "037cf36b-1014-4177-bcc6-c1cd647aae42" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_GRANTOR\",\n \"display\": \"Grantor required for active status\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Grantor extension is required when creating/updating an active proxy role\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor')\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Missing grantor reference", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\"\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ] + }, + "description": "## Example scenario\n\n**Given** no proxy role exists in NPS between a proxy and patient \n**When** I send a POST /Consent request for the proxy and patient with an invalid performer id \n**Then** a 422 error response is returned with code 'INVALID_IDENTIFIER_VALUE'" + }, + "response": [ + { + "name": "Missing grantor reference error", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "f059df53-0d68-4551-8233-8dedb7de5ba0", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "2a759f36-a989-4392-b0ed-95b2425d92f9", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\"\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent" + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 12:46:09 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "402" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "369c4598-e093-44d1-8d27-015c1e1f8a40" + }, + { + "key": "x-amz-apigw-id", + "value": "UwTu1FORLPEFh3Q=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69299991-27f38de5fa687e1e7d4659b3" + }, + { + "key": "X-Request-ID", + "value": "70591ef1-fbe0-442b-bd9a-545fb5713859" + }, + { + "key": "X-Correlation-ID", + "value": "037cf36b-1014-4177-bcc6-c1cd647aae42" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_GRANTOR_REFERENCE\",\n \"display\": \"Missing grantor reference\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Grantor extension must contain a valueReference\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Missing grantor identifier", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {}\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ] + }, + "description": "## Example scenario\n\n**Given** no proxy role exists in NPS between a proxy and patient \n**When** I send a POST /Consent request for the proxy and patient with an invalid performer id \n**Then** a 422 error response is returned with code 'INVALID_IDENTIFIER_VALUE'" + }, + "response": [ + { + "name": "Missing grantor identifier error", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "f059df53-0d68-4551-8233-8dedb7de5ba0", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "2a759f36-a989-4392-b0ed-95b2425d92f9", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {}\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent" + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 12:46:09 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "402" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "369c4598-e093-44d1-8d27-015c1e1f8a40" + }, + { + "key": "x-amz-apigw-id", + "value": "UwTu1FORLPEFh3Q=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69299991-27f38de5fa687e1e7d4659b3" + }, + { + "key": "X-Request-ID", + "value": "70591ef1-fbe0-442b-bd9a-545fb5713859" + }, + { + "key": "X-Correlation-ID", + "value": "037cf36b-1014-4177-bcc6-c1cd647aae42" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_GRANTOR_IDENTIFIER\",\n \"display\": \"Missing grantor identifier\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Grantor extension must contain a valueIdentifier\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Invalid grantor identifier system", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"BAD\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ] + }, + "description": "## Example scenario\n\n**Given** no proxy role exists in NPS between a proxy and patient \n**When** I send a POST /Consent request for the proxy and patient with an invalid performer id \n**Then** a 422 error response is returned with code 'INVALID_IDENTIFIER_VALUE'" + }, + "response": [ + { + "name": "Invalid grantor identifier system error", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "2a747914-9044-4543-90b0-ef09b2efbb7a", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "fabc4a6e-83ed-49e9-a2dd-cf0024f12a56", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"BAD\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent" + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 12:46:09 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "402" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "369c4598-e093-44d1-8d27-015c1e1f8a40" + }, + { + "key": "x-amz-apigw-id", + "value": "UwTu1FORLPEFh3Q=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69299991-27f38de5fa687e1e7d4659b3" + }, + { + "key": "X-Request-ID", + "value": "70591ef1-fbe0-442b-bd9a-545fb5713859" + }, + { + "key": "X-Correlation-ID", + "value": "037cf36b-1014-4177-bcc6-c1cd647aae42" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_GRANTOR_SYSTEM\",\n \"display\": \"Invalid grantor identifier system\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Valid grantor extension identifier system is required when creating/updating a consent with status 'active'\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier.system\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Invalid grantor identifier value", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"\"\n }\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ] + }, + "description": "## Example scenario\n\n**Given** no proxy role exists in NPS between a proxy and patient \n**When** I send a POST /Consent request for the proxy and patient with an invalid performer id \n**Then** a 422 error response is returned with code 'INVALID_IDENTIFIER_VALUE'" + }, + "response": [ + { + "name": "Invalid grantor identifier error", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "961d83de-6b2c-4d5f-8aaf-d48a65bf94b3", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "5093a1e0-f616-4565-b4f1-24c93774e0a0", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-09T13:50:10.090Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-12-02\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"\"\n }\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent" + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 12:46:09 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "402" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "369c4598-e093-44d1-8d27-015c1e1f8a40" + }, + { + "key": "x-amz-apigw-id", + "value": "UwTu1FORLPEFh3Q=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-69299991-27f38de5fa687e1e7d4659b3" + }, + { + "key": "X-Request-ID", + "value": "70591ef1-fbe0-442b-bd9a-545fb5713859" + }, + { + "key": "X-Correlation-ID", + "value": "037cf36b-1014-4177-bcc6-c1cd647aae42" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_GRANTOR_VALUE\",\n \"display\": \"Invalid grantor identifier value\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Valid grantor extension identifier value is required when creating/updating a consent with status 'active'\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier.value\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Invalid identifer system - New proxy role", + "request": { + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number/invalid\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"{{$isoTimestamp}}\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-11-23\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"MTH\",\n \"display\": \"Mother\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"TBC\",\n \"display\": \"TBC\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"MTH\",\n \"display\": \"Mother\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent" + ] + } + }, + "response": [ + { + "name": "Invalid status error returned", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "X-Request-ID", + "value": "004491e4-b270-4882-99c8-af4e387a505f", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "5f51e084-afd4-442b-b229-5470a750de52", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/fhir+json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number/invalid\",\n \"value\": \"9736898717\"\n }\n },\n \"dateTime\": \"2026-02-16T08:22:13.462Z\",\n \"provision\": {\n \"period\": {\n \"start\": \"2025-11-23\",\n \"end\": \"2030-11-23\"\n },\n \"actor\": [\n {\n \"role\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\",\n \"code\": \"MTH\",\n \"display\": \"Mother\"\n }\n ]\n },\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"TBC\",\n \"display\": \"TBC\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ],\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"code\": \"MTH\",\n \"display\": \"Mother\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent" + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 15:29:32 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "399" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "9ca19fe7-0a06-4da0-9b72-9e6135da40f1" + }, + { + "key": "x-amz-apigw-id", + "value": "UwrqcGPaLPEFWkg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929bfdc-4e9f2ada8f5faf65f1630c1c" + }, + { + "key": "X-Request-ID", + "value": "21cc43ac-e531-477d-bc97-3e77e9657b52" + }, + { + "key": "X-Correlation-ID", + "value": "aeeaa71d-0a78-4e83-8c81-3b2884371ae9" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_IDENTIFIER_SYSTEM\",\n \"display\": \"Invalid identifier system.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Patient identifier system is invalid\",\n \"expression\": [\n \"patient.identifier.system\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + } + ], + "description": "## Allowed auth methods\n\n- CIS2 token - Auth with test user `656005750108`\n \n\nSee collection level documentation for info about how to get authorization tokens.", + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "packages": {}, + "requests": {}, + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "packages": {}, + "requests": {}, + "exec": [ + "" + ] + } + } + ] + }, + { + "name": "Update proxy role (PATCH /Consent/{id})", + "item": [ + { + "name": "Valid request - Single update - Update proxy role", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\"op\": \"replace\", \"path\": \"/status\", \"value\": \"inactive\"},\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_DEACTIVATED_PATIENT_REQUEST\",\n \"display\": \"At patient request\"\n }\n ]\n }\n }\n ]\n }\n]\n", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store (NPS) \n**When** I send a PATCH /Consent request to update the proxy role \n**Then** a 200 response is returned and the role is updated" + }, + "response": [ + { + "name": "Proxy role updated to 'inactive' status", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "37a39814-060e-4100-b2ea-7057679112ec", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "bc983fc5-8066-4373-a87b-30d8cc0f905a", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\"op\": \"replace\", \"path\": \"/status\", \"value\": \"inactive\"},\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_DEACTIVATED_PATIENT_REQUEST\",\n \"display\": \"At patient request\"\n }\n ]\n }\n }\n ]\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 16:23:31 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "101" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "5b03d759-c55a-462d-ba3c-e2dbf92d031a" + }, + { + "key": "x-amz-apigw-id", + "value": "UwzkUE0urPEFqHg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929cc81-0d146fcdbc79baf5a5279c3d" + }, + { + "key": "X-Request-ID", + "value": "4555113e-aa4d-409d-bac0-41b0ed91cfc2" + }, + { + "key": "X-Correlation-ID", + "value": "b8c69a60-667d-4b0f-89c7-9de6d4e289a4" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\"\n }\n ]\n}" + }, + { + "name": "Proxy role end date updated", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/provision/period/end\",\n \"value\": \"2026-12-31\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 15:48:46 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "101" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "eb0a2130-76e5-41a0-9916-e7c8aa25a4ea" + }, + { + "key": "x-amz-apigw-id", + "value": "VEgG2Hh6LPEFXRQ=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6931ad5e-d4506ade6d4f3410b20618b9" + }, + { + "key": "X-Request-ID", + "value": "90a9a964-db4c-4ec7-9498-76087f979bb5" + }, + { + "key": "X-Correlation-ID", + "value": "2aa6936b-c5ba-437d-898e-c58794601a01" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\"\n }\n ]\n}" + }, + { + "name": "Proxy role policy rule updated", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"add\",\n \"path\": \"/policyRule\",\n \"value\": [\n {\n \"coding\": [\n {\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\"\n }\n ]\n }\n ],\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 15:54:54 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "101" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "63072889-896c-43b1-aff1-0e4eceb2b4d4" + }, + { + "key": "x-amz-apigw-id", + "value": "VEg_9FQxLPEF1mA=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6931aecc-d571f76cb8f3900088a01c45" + }, + { + "key": "X-Request-ID", + "value": "e436ebda-5011-431a-9de3-1d0749c6f45e" + }, + { + "key": "X-Correlation-ID", + "value": "930a58a1-7ca9-4a89-ac33-a24f5277b1d9" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\"\n }\n ]\n}" + } + ] + }, + { + "name": "Missing grantor", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/status\",\n \"value\": \"active\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n }\n ]\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store (NPS) \n**When** I send a PATCH /Consent request to update the proxy role \n**Then** a 200 response is returned and the role is updated" + }, + "response": [ + { + "name": "Missing grantor error", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "91ffa031-c7d8-46c9-acd7-5c7c81c7ad3e", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "24af4521-3ca5-4123-92a7-b255daa5f561", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n\t{\n\t\t\"op\": \"replace\",\n\t\t\"path\": \"/status\",\n\t\t\"value\": \"active\"\n\t},\n\t{\n\t\t\"op\": \"add\",\n\t\t\"path\": \"/extension/-\",\n\t\t\"value\": [\n\t\t\t{\n\t\t\t\t\"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n\t\t\t\t\"valueCodeableConcept\": {\n\t\t\t\t\t\"coding\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n\t\t\t\t\t\t\t\"code\": \"ROLE_CREATED\",\n\t\t\t\t\t\t\t\"display\": \"Role created\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Mon, 09 Feb 2026 13:44:16 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "490" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "35c94f51-ceed-4544-973b-6666dce5a447" + }, + { + "key": "x-amz-apigw-id", + "value": "YhCroEoNLPEFfxg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6989e4b0-ed8360e8a73f108f4753cf19" + }, + { + "key": "X-Request-ID", + "value": "e210658f-9b3e-4b3f-a41a-706ef045619f" + }, + { + "key": "X-Correlation-ID", + "value": "5ad4f9a4-07bc-4e98-a3e0-552a3a990631" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_GRANTOR\",\n \"display\": \"Grantor required for active status\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Grantor extension is required when creating/updating an active proxy role\",\n \"severity\": \"error\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor')\"\n ]\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Missing grantor reference", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n\t{\n\t\t\"op\": \"replace\",\n\t\t\"path\": \"/status\",\n\t\t\"value\": \"active\"\n\t},\n\t{\n\t\t\"op\": \"add\",\n\t\t\"path\": \"/extension/-\",\n\t\t\"value\": [\n\t\t\t{\n\t\t\t\t\"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n\t\t\t\t\"valueCodeableConcept\": {\n\t\t\t\t\t\"coding\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n\t\t\t\t\t\t\t\"code\": \"ROLE_CREATED\",\n\t\t\t\t\t\t\t\"display\": \"Role created\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\"\n\t\t\t}\n\t\t]\n\t}\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store (NPS) \n**When** I send a PATCH /Consent request to update the proxy role \n**Then** a 200 response is returned and the role is updated" + }, + "response": [ + { + "name": "Missing grantor reference error", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "91ffa031-c7d8-46c9-acd7-5c7c81c7ad3e", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "24af4521-3ca5-4123-92a7-b255daa5f561", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/status\",\n \"value\": \"active\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\"\n }\n ]\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Mon, 09 Feb 2026 13:44:16 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "490" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "35c94f51-ceed-4544-973b-6666dce5a447" + }, + { + "key": "x-amz-apigw-id", + "value": "YhCroEoNLPEFfxg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6989e4b0-ed8360e8a73f108f4753cf19" + }, + { + "key": "X-Request-ID", + "value": "e210658f-9b3e-4b3f-a41a-706ef045619f" + }, + { + "key": "X-Correlation-ID", + "value": "5ad4f9a4-07bc-4e98-a3e0-552a3a990631" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_GRANTOR_REFERENCE\",\n \"display\": \"Missing grantor reference\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Grantor extension must contain a valueReference\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Missing grantor identifier", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/status\",\n \"value\": \"active\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store (NPS) \n**When** I send a PATCH /Consent request to update the proxy role \n**Then** a 200 response is returned and the role is updated" + }, + "response": [ + { + "name": "Missing grantor identifier error", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "91ffa031-c7d8-46c9-acd7-5c7c81c7ad3e", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "24af4521-3ca5-4123-92a7-b255daa5f561", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/status\",\n \"value\": \"active\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Mon, 09 Feb 2026 13:44:16 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "490" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "35c94f51-ceed-4544-973b-6666dce5a447" + }, + { + "key": "x-amz-apigw-id", + "value": "YhCroEoNLPEFfxg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6989e4b0-ed8360e8a73f108f4753cf19" + }, + { + "key": "X-Request-ID", + "value": "e210658f-9b3e-4b3f-a41a-706ef045619f" + }, + { + "key": "X-Correlation-ID", + "value": "5ad4f9a4-07bc-4e98-a3e0-552a3a990631" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_GRANTOR_IDENTIFIER\",\n \"display\": \"Missing grantor identifier\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Grantor extension must contain a valueIdentifier\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Invalid grantor system", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/status\",\n \"value\": \"active\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://wrong-system.com\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store (NPS) \n**When** I send a PATCH /Consent request to update the proxy role \n**Then** a 200 response is returned and the role is updated" + }, + "response": [ + { + "name": "Invalid grantor system error", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "91ffa031-c7d8-46c9-acd7-5c7c81c7ad3e", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "24af4521-3ca5-4123-92a7-b255daa5f561", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/status\",\n \"value\": \"active\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://wrong-system.com\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Mon, 09 Feb 2026 13:44:16 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "490" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "35c94f51-ceed-4544-973b-6666dce5a447" + }, + { + "key": "x-amz-apigw-id", + "value": "YhCroEoNLPEFfxg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6989e4b0-ed8360e8a73f108f4753cf19" + }, + { + "key": "X-Request-ID", + "value": "e210658f-9b3e-4b3f-a41a-706ef045619f" + }, + { + "key": "X-Correlation-ID", + "value": "5ad4f9a4-07bc-4e98-a3e0-552a3a990631" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_GRANTOR_SYSTEM\",\n \"display\": \"Invalid grantor identifier system\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Valid grantor extension identifier system is required when creating/updating a consent with status 'active'\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier.system\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Invalid grantor value", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n\t{\n\t\t\"op\": \"replace\",\n\t\t\"path\": \"/status\",\n\t\t\"value\": \"active\"\n\t},\n\t{\n\t\t\"op\": \"add\",\n\t\t\"path\": \"/extension/-\",\n\t\t\"value\": [\n\t\t\t{\n\t\t\t\t\"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n\t\t\t\t\"valueCodeableConcept\": {\n\t\t\t\t\t\"coding\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n\t\t\t\t\t\t\t\"code\": \"ROLE_ACTIVATED\",\n\t\t\t\t\t\t\t\"display\": \"Role activated\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n\t\t\t\t\"valueReference\": {\n\t\t\t\t\t\"identifier\": {\n\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store (NPS) \n**When** I send a PATCH /Consent request to update the proxy role \n**Then** a 200 response is returned and the role is updated" + }, + "response": [ + { + "name": "Invalid grantor value error", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "91ffa031-c7d8-46c9-acd7-5c7c81c7ad3e", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "24af4521-3ca5-4123-92a7-b255daa5f561", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n\t{\n\t\t\"op\": \"replace\",\n\t\t\"path\": \"/status\",\n\t\t\"value\": \"active\"\n\t},\n\t{\n\t\t\"op\": \"add\",\n\t\t\"path\": \"/extension/-\",\n\t\t\"value\": [\n\t\t\t{\n\t\t\t\t\"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n\t\t\t\t\"valueCodeableConcept\": {\n\t\t\t\t\t\"coding\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n\t\t\t\t\t\t\t\"code\": \"ROLE_ACTIVATED\",\n\t\t\t\t\t\t\t\"display\": \"Role activated\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n\t\t\t\t\"valueReference\": {\n\t\t\t\t\t\"identifier\": {\n\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n\t\t\t\t\t\t\"value\": \"\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Mon, 09 Feb 2026 13:44:16 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "490" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "35c94f51-ceed-4544-973b-6666dce5a447" + }, + { + "key": "x-amz-apigw-id", + "value": "YhCroEoNLPEFfxg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6989e4b0-ed8360e8a73f108f4753cf19" + }, + { + "key": "X-Request-ID", + "value": "e210658f-9b3e-4b3f-a41a-706ef045619f" + }, + { + "key": "X-Correlation-ID", + "value": "5ad4f9a4-07bc-4e98-a3e0-552a3a990631" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_GRANTOR_VALUE\",\n \"display\": \"Invalid grantor identifier value\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Valid grantor extension identifier value is required when creating/updating a consent with status 'active'\",\n \"expression\": [\n \"extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier.value\"\n ],\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Valid request - Multiple updates - Update proxy role", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\"op\": \"replace\", \"path\": \"/status\", \"value\": \"inactive\"},\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_DEACTIVATED_PATIENT_REQUEST\",\n \"display\": \"At patient request\"\n }\n ]\n }\n }\n ]\n },\n {\n \"op\": \"replace\",\n \"path\": \"/provision/period/end\",\n \"value\": \"2026-12-31\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store (NPS) \n**When** I send a PATCH /Consent request with multiple updates for the proxy role \n**Then** a 200 response is returned and the role is updated" + }, + "response": [ + { + "name": "Proxy role status updated with end date", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "30e9b272-a646-4868-a2ce-6950f65bd736", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "7b9ded57-0c7a-497e-85c8-f2f00a6e0104", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\"op\": \"replace\", \"path\": \"/status\", \"value\": \"inactive\"},\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_DEACTIVATED_PATIENT_REQUEST\",\n \"display\": \"At patient request\"\n }\n ]\n }\n }\n ]\n },\n {\n \"op\": \"replace\",\n \"path\": \"/provision/period/end\",\n \"value\": \"2026-12-31\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Thu, 04 Dec 2025 15:56:16 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "348" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "fbb23fc6-d143-4ad4-ab95-fef1276bf7d0" + }, + { + "key": "x-amz-apigw-id", + "value": "VEhNJE2VrPEFXkA=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6931af20-0cc7e03b708f8949fc05bdfa" + }, + { + "key": "X-Request-ID", + "value": "0aa389b6-9542-428f-9e1c-b5411ff0a531" + }, + { + "key": "X-Correlation-ID", + "value": "e3845975-3d6b-4185-81cb-22a80f7ed0da" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"resourceType\": \"OperationOutcome\",\n \"issue\": [\n {\n \"severity\": \"information\",\n \"code\": \"informational\"\n }\n ]\n}" + } + ] + }, + { + "name": "Resource not found - Update proxy role", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/status\",\n \"value\": \"inactive\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_DEACTIVATED_PATIENT_REQUEST\",\n \"display\": \"At patient request\"\n }\n ]\n }\n }\n ]\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "{{$randomUUID}}" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store for a given UUID \n**When** a PATCH /Consent request is sent using the UUID \n**Then** a 404 error is returned with code 'RESOURCE_NOT_FOUND'" + }, + "response": [ + { + "name": "Resource not found error response", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "eb4bff55-95ce-4943-bd54-4b69266c2bb3", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "5e38ba2b-57db-42b5-b20b-00ae83957239", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/status\",\n \"value\": \"inactive\"\n },\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_DEACTIVATED_PATIENT_REQUEST\",\n \"display\": \"At patient request\"\n }\n ]\n }\n }\n ]\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "127149ab-d560-4f76-a72a-0207a1d09a7f" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 16:51:31 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "348" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "5940dd45-0b04-4e71-8fce-6a69665b256e" + }, + { + "key": "x-amz-apigw-id", + "value": "Uw3q4HTZrPEFxLQ=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929d312-f383a46c595faa9361bb8326" + }, + { + "key": "X-Request-ID", + "value": "4cfc1e62-1d97-47b2-825e-2f72eed5e29e" + }, + { + "key": "X-Correlation-ID", + "value": "db86232d-68a5-492d-96e3-02613a3cf6bf" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"diagnostics\": \"Proxy role not found.\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"display\": \"Request must be for a existing proxy role.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Invalid status code - Update proxy role", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\"op\": \"replace\", \"path\": \"/status\", \"value\": \"invalid_status\"},\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"ROLE_DEACTIVATED_PATIENT_REQUEST\",\n \"display\": \"At patient request\"\n }\n ]\n }\n }\n ]\n }\n]\n", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store for a given UUID \n**When** a PATCH /Consent request is sent using the UUID \n**Then** a 404 error is returned with code 'RESOURCE_NOT_FOUND'" + }, + "response": [ + { + "name": "Invalid status code error returned", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "45daf0e4-81b4-49a2-94ec-6893977a394c", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "ac7cb80e-309a-4e40-b3dc-44ed631e1943", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\"op\": \"replace\", \"path\": \"/status\", \"value\": \"invalid_status\"},\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consent-reason\",\n \"code\": \"ROLE_DEACTIVATED_PATIENT_REQUEST\",\n \"display\": \"At patient request\"\n }\n ]\n }\n }\n ]\n }\n]\n", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "aa58f9b7-2a02-45a2-9cb4-0d6fefe07a02" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 16:56:26 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "329" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "557c0652-9a38-434c-99c1-f979920055bf" + }, + { + "key": "x-amz-apigw-id", + "value": "Uw4ZOEOOLPEFggg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929d43a-6c636f683c11b4ac83776aa6" + }, + { + "key": "X-Request-ID", + "value": "1a4ee8bf-0d2b-4398-950f-b3fd9332e7d3" + }, + { + "key": "X-Correlation-ID", + "value": "986fe591-c2f0-422d-9e1e-c99628e9a1df" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_STATUS_CODE\",\n \"display\": \"Status code is invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Invalid status code.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Invalid state transition - Update proxy role", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n\t{\n\t\t\"op\": \"replace\",\n\t\t\"path\": \"/status\",\n\t\t\"value\": \"proposed\"\n\t},\n\t{\n\t\t\"op\": \"add\",\n\t\t\"path\": \"/extension/-\",\n\t\t\"value\": [\n\t\t\t{\n\t\t\t\t\"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n\t\t\t\t\"valueCodeableConcept\": {\n\t\t\t\t\t\"coding\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n\t\t\t\t\t\t\t\"code\": \"APPLICATION_RESUBMITTED\",\n\t\t\t\t\t\t\t\"display\": \"Application re-submitted\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store for a given UUID \n**When** a PATCH /Consent request is sent using the UUID \n**Then** a 404 error is returned with code 'RESOURCE_NOT_FOUND'" + }, + "response": [ + { + "name": "Invalid state transition error returned", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n\t{\n\t\t\"op\": \"replace\",\n\t\t\"path\": \"/status\",\n\t\t\"value\": \"proposed\"\n\t},\n\t{\n\t\t\"op\": \"add\",\n\t\t\"path\": \"/extension/-\",\n\t\t\"value\": [\n\t\t\t{\n\t\t\t\t\"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n\t\t\t\t\"valueCodeableConcept\": {\n\t\t\t\t\t\"coding\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n\t\t\t\t\t\t\t\"code\": \"APPLICATION_RESUBMITTED\",\n\t\t\t\t\t\t\t\"display\": \"Application re-submitted\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 16:56:26 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "329" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "557c0652-9a38-434c-99c1-f979920055bf" + }, + { + "key": "x-amz-apigw-id", + "value": "Uw4ZOEOOLPEFggg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929d43a-6c636f683c11b4ac83776aa6" + }, + { + "key": "X-Request-ID", + "value": "1a4ee8bf-0d2b-4398-950f-b3fd9332e7d3" + }, + { + "key": "X-Correlation-ID", + "value": "986fe591-c2f0-422d-9e1e-c99628e9a1df" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"diagnostics\": \"Patch attempting invalid status change.\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_STATE_TRANSITION\",\n \"display\": \"Status change is invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Invalid path - Update proxy role", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/someotherpath\",\n \"value\": \"active\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store for a given UUID \n**When** a PATCH /Consent request with an invalid path is sent using the UUID \n**Then** a 400 error is returned with code 'INVALID_PATCH_PATH'" + }, + "response": [ + { + "name": "Invalid path error returned", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "75fdd97a-89c6-49b8-84ad-aa9a770cecf0", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "95b73d30-9701-4e35-a93f-09677cae5b34", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/someotherpath\",\n \"value\": \"active\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "aa58f9b7-2a02-45a2-9cb4-0d6fefe07a02" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 16:58:39 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "346" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "9c37f3a0-d1af-4a9d-8664-20edf45bd111" + }, + { + "key": "x-amz-apigw-id", + "value": "Uw4t7HzBrPEFTsw=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929d4bf-e038f4c128983e6e945b14ad" + }, + { + "key": "X-Request-ID", + "value": "3e5e943f-2647-4a09-b216-7d3551a637e7" + }, + { + "key": "X-Correlation-ID", + "value": "65dc6940-bcb3-466d-b25d-0a10ab98d7e6" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_PATCH_PATH\",\n \"display\": \"Patch target is invalid.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Patch targeting non-existent element.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Missing free text for Other", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\"op\": \"replace\", \"path\": \"/status\", \"value\": \"inactive\"},\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"OTHER\",\n \"display\": \"Other reason\"\n }\n ]\n }\n }\n ]\n }\n]\n", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{api_base_url}}/Consent/:consent_id", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy role exists in the National Proxy Store for a given UUID \n**When** a PATCH /Consent request with a missing free text and status reason of 'Other' is sent using the UUID \n**Then** a 400 error is returned with code 'MISSING_FREE_TEXT_FOR_OTHER'" + }, + "response": [ + { + "name": "Missing free text error", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json-patch+json", + "type": "text" + }, + { + "key": "X-Request-ID", + "value": "c8809963-1a8e-4df1-965e-64b2c3dfed0f", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "3070bc8d-baf4-4a66-a7ba-c6c4d092f805", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\"op\": \"replace\", \"path\": \"/status\", \"value\": \"inactive\"},\n {\n \"op\": \"add\",\n \"path\": \"/extension/-\",\n \"value\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"OTHER\",\n \"display\": \"Other reason\"\n }\n ]\n }\n }\n ]\n }\n]\n", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/:consent_id", + "protocol": "https", + "host": [ + "int", + "api", + "service", + "nhs", + "uk" + ], + "path": [ + "validated-relationships", + "FHIR", + "R4", + "Consent", + ":consent_id" + ], + "variable": [ + { + "key": "consent_id", + "value": "0e8d365d-2667-4426-ae66-7eb8302bc724" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 16:58:39 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "346" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "9c37f3a0-d1af-4a9d-8664-20edf45bd111" + }, + { + "key": "x-amz-apigw-id", + "value": "Uw4t7HzBrPEFTsw=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929d4bf-e038f4c128983e6e945b14ad" + }, + { + "key": "X-Request-ID", + "value": "3e5e943f-2647-4a09-b216-7d3551a637e7" + }, + { + "key": "X-Correlation-ID", + "value": "65dc6940-bcb3-466d-b25d-0a10ab98d7e6" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_FREE_TEXT_FOR_OTHER\",\n \"display\": \"Free text must be provided for OTHER reason codes.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"Free text is required when reason code is OTHER.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + } + ], + "description": "## Allowed auth methods\n\n- CIS2 token - Auth with test user `656005750108`\n \n- NHS Login token - Auth with test user `9730675929`\n \n\nSee collection level documentation for info about how to get authorization tokens." + }, + { + "name": "Get verified candidate relationships (GET /RelatedPerson)", + "item": [ + { + "name": "Valid request - Get verified candidate relationships", + "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/RelatedPerson?identifier=9736898121", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "RelatedPerson" + ], + "query": [ + { + "key": "identifier", + "value": "9736898121", + "description": "NHS number of the user to retrieve verified relationships for" + } + ] + }, + "description": "## Example scenario\n\n**Given** an NHS user has multiple related person relationships in PDS \n**When** a GET /RelatedPerson request is sent for the user \n**Then** the relationships are returned" + }, + "response": [ + { + "name": "Candidate relationship returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/RelatedPerson?identifier=9736898148", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "RelatedPerson" + ], + "query": [ + { + "key": "identifier", + "value": "9736898148", + "description": "NHS number of the user to retrieve verified relationships for" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 17:10:29 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "927" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "3c77c3f5-2f94-4718-b4df-a994b49a9c8d" + }, + { + "key": "x-amz-apigw-id", + "value": "Uw6coGWKLPEFyvQ=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929d783-8368a433a0eae3395c7136cb" + }, + { + "key": "X-Request-ID", + "value": "e464b1c8-ad9b-41a2-9de3-2dd0e34d0fce" + }, + { + "key": "X-Correlation-ID", + "value": "056c8f1f-9d95-44b2-a4f7-582554f53387" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/IyKYB\",\n \"resource\": {\n \"id\": \"IyKYB\",\n \"birthDate\": \"2015-09-26\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"MTH\",\n \"display\": \"mother\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ],\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?identifier=9736898148\"\n }\n ],\n \"timestamp\": \"2025-11-28T17:10:29.231159+00:00\",\n \"total\": 1,\n \"type\": \"searchset\",\n \"resourceType\": \"Bundle\"\n}" + }, + { + "name": "Candidate relationship returned with patient details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/RelatedPerson?identifier=9736898148&_include=RelatedPerson:patient", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "RelatedPerson" + ], + "query": [ + { + "key": "identifier", + "value": "9736898148", + "description": "NHS number of the user to retrieve verified relationships for" + }, + { + "key": "_include", + "value": "RelatedPerson:patient" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 17:13:27 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "1395" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "a34914f5-c757-4a7c-b8e6-2061793de970" + }, + { + "key": "x-amz-apigw-id", + "value": "Uw63LFuCLPEFtfA=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929d82d-7210a91047b09608692e6ff6" + }, + { + "key": "X-Request-ID", + "value": "c46487fa-a7a9-4adb-82ec-dc7702fa66d4" + }, + { + "key": "X-Correlation-ID", + "value": "755116de-f4ef-406b-8088-1af14dd85c8d" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9736898644\",\n \"resource\": {\n \"id\": \"9736898644\",\n \"birthDate\": \"2015-09-26\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"resourceType\": \"Patient\"\n },\n \"search\": {\n \"mode\": \"include\"\n }\n },\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/IyKYB\",\n \"resource\": {\n \"id\": \"IyKYB\",\n \"birthDate\": \"2015-09-26\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"MTH\",\n \"display\": \"mother\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ],\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?identifier=9736898148&_include=RelatedPerson%3Apatient\"\n }\n ],\n \"timestamp\": \"2025-11-28T17:13:27.630813+00:00\",\n \"total\": 1,\n \"type\": \"searchset\",\n \"resourceType\": \"Bundle\"\n}" + } + ] + }, + { + "name": "Valid request - No relationships returned - Get verified candidate relationships", + "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/RelatedPerson?identifier=9736898199", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "RelatedPerson" + ], + "query": [ + { + "key": "identifier", + "value": "9736898199", + "description": "NHS number of the user to retrieve verified relationships for" + } + ] + }, + "description": "## Example scenario\n\n**Given** an NHS user has no related person relationships in PDS \n**When** a GET /RelatedPerson request is sent for the user \n**Then** no relationships are returned" + }, + "response": [ + { + "name": "No relationships returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/RelatedPerson?identifier=9736898199", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "RelatedPerson" + ], + "query": [ + { + "key": "identifier", + "value": "9736898199", + "description": "NHS number of the user to retrieve verified relationships for" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 17:15:06 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "249" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "9305e61b-2b8b-4a0c-84dd-0be9c4e1ce72" + }, + { + "key": "x-amz-apigw-id", + "value": "Uw7IDHSxrPEF7gg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929d899-c345d4868005c5dc5999d598" + }, + { + "key": "X-Request-ID", + "value": "189b9dd8-722e-4e1b-b76b-75d2dd05fd00" + }, + { + "key": "X-Correlation-ID", + "value": "38045e59-8b2a-4f52-a1a5-834c91c25a9f" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?identifier=9736898199\"\n }\n ],\n \"timestamp\": \"2025-11-28T17:15:05.994606+00:00\",\n \"total\": 0,\n \"type\": \"searchset\",\n \"resourceType\": \"Bundle\"\n}" + } + ] + }, + { + "name": "Valid request - Verify relationship - Get verified candidate relationships", + "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/RelatedPerson?identifier=9736898148&patient:identifier=9736898644", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "RelatedPerson" + ], + "query": [ + { + "key": "identifier", + "value": "9736898148", + "description": "NHS number of the user to retrieve verified relationships for" + }, + { + "key": "patient:identifier", + "value": "9736898644" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy has a related person relationship in PDS \n**When** a GET /RelatedPerson request is sent for the proxy and the patient \n**Then** the relationship is returned" + }, + "response": [ + { + "name": "Verified relationship returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/RelatedPerson?identifier=9736898148&patient:identifier=9736898644", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "RelatedPerson" + ], + "query": [ + { + "key": "identifier", + "value": "9736898148", + "description": "NHS number of the user to retrieve verified relationships for" + }, + { + "key": "patient:identifier", + "value": "9736898644" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 17:19:37 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "959" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "2ac409be-e9ce-4d73-a4b4-3c8a791aa51e" + }, + { + "key": "x-amz-apigw-id", + "value": "Uw7x4HIMrPEF-Fg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929d9a5-d9df4059c3c602feabe873fc" + }, + { + "key": "X-Request-ID", + "value": "88367407-4953-4b64-9da0-6308c007b120" + }, + { + "key": "X-Correlation-ID", + "value": "8b55ca15-93fb-4ce9-be1b-eb0eb5e728fa" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/IyKYB\",\n \"resource\": {\n \"id\": \"IyKYB\",\n \"birthDate\": \"2015-09-26\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"MTH\",\n \"display\": \"mother\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ],\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?identifier=9736898148&patient%3Aidentifier=9736898644\"\n }\n ],\n \"timestamp\": \"2025-11-28T17:19:37.300736+00:00\",\n \"total\": 1,\n \"type\": \"searchset\",\n \"resourceType\": \"Bundle\"\n}" + }, + { + "name": "Verified relationship returned with patient details", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/RelatedPerson?identifier=9736898148&patient:identifier=9736898644&_include=RelatedPerson:patient", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "RelatedPerson" + ], + "query": [ + { + "key": "identifier", + "value": "9736898148", + "description": "NHS number of the user to retrieve verified relationships for" + }, + { + "key": "patient:identifier", + "value": "9736898644" + }, + { + "key": "_include", + "value": "RelatedPerson:patient" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 17:19:37 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "959" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "2ac409be-e9ce-4d73-a4b4-3c8a791aa51e" + }, + { + "key": "x-amz-apigw-id", + "value": "Uw7x4HIMrPEF-Fg=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929d9a5-d9df4059c3c602feabe873fc" + }, + { + "key": "X-Request-ID", + "value": "88367407-4953-4b64-9da0-6308c007b120" + }, + { + "key": "X-Correlation-ID", + "value": "8b55ca15-93fb-4ce9-be1b-eb0eb5e728fa" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"entry\": [\n {\n \"fullUrl\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/IyKYB\",\n \"resource\": {\n \"id\": \"IyKYB\",\n \"birthDate\": \"2015-09-26\",\n \"identifier\": [\n {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898148\"\n }\n ],\n \"name\": [\n {\n \"family\": \"SHEPP\",\n \"given\": [\n \"Ashley\",\n \"Ellen\"\n ],\n \"period\": {\n \"start\": \"2025-08-06\"\n },\n \"prefix\": [\n \"MS\"\n ],\n \"use\": \"usual\"\n }\n ],\n \"patient\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9736898644\"\n }\n },\n \"relationship\": [\n {\n \"coding\": [\n {\n \"code\": \"MTH\",\n \"display\": \"mother\",\n \"system\": \"http://terminology.hl7.org/CodeSystem/v3-RoleCode\"\n }\n ]\n }\n ],\n \"resourceType\": \"RelatedPerson\"\n },\n \"search\": {\n \"mode\": \"match\"\n }\n }\n ],\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?identifier=9736898148&patient%3Aidentifier=9736898644\"\n }\n ],\n \"timestamp\": \"2025-11-28T17:19:37.300736+00:00\",\n \"total\": 1,\n \"type\": \"searchset\",\n \"resourceType\": \"Bundle\"\n}" + } + ] + }, + { + "name": "Missing identifier value - Get verified candidate relationships", + "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/RelatedPerson", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "RelatedPerson" + ] + }, + "description": "## Example scenario\n\n**Given** a proxy has a related person relationship in PDS \n**When** a GET /RelatedPerson request is sent with no identifier \n**Then** a 400 error is returned with code 'MISSING_IDENTIFIER_VALUE'" + }, + "response": [ + { + "name": "Missing identifier value error returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/RelatedPerson", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "RelatedPerson" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 17:45:09 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "362" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "f524a29e-b0e9-45b0-af70-ad23fd87158c" + }, + { + "key": "x-amz-apigw-id", + "value": "Uw_h7GQFrPEF8xw=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929dfa5-ca879ed8f2a8b5c139182a8b" + }, + { + "key": "X-Request-ID", + "value": "28dbd904-517c-4e42-a3f6-37772b2da578" + }, + { + "key": "X-Correlation-ID", + "value": "e1229f7b-b14f-4858-b4fd-dcb3c9151a99" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"MISSING_IDENTIFIER_VALUE\",\n \"display\": \"Missing RelatedPerson NHS number.\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"The 'identifier' parameter is required\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Invalid identifier value - Get verified candidate relationships", + "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/RelatedPerson?identifier=invalid", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "RelatedPerson" + ], + "query": [ + { + "key": "identifier", + "value": "invalid" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy has a related person relationship in PDS \n**When** a GET /RelatedPerson request is sent with an invalid identifier \n**Then** a 400 error is returned with code 'INVALID_IDENTIFIER_VALUE'" + }, + "response": [ + { + "name": "Invalid identifier value error returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/RelatedPerson?identifier=invalid", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "RelatedPerson" + ], + "query": [ + { + "key": "identifier", + "value": "invalid" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 17:47:15 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "422" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "7a627dc1-8fe7-4a07-9a17-5e8a7c77963b" + }, + { + "key": "x-amz-apigw-id", + "value": "Uw_1hFJWLPEFbKQ=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929e022-4dc5c06769a0b866a6456227" + }, + { + "key": "X-Request-ID", + "value": "c695d77b-b94e-4e04-9e2b-f7e34ef2e414" + }, + { + "key": "X-Correlation-ID", + "value": "46db2d38-e52b-4fcc-a8cf-2617fec4557a" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"diagnostics\": \"Not a valid NHS Number provided for the 'identifier' parameter\",\n \"expression\": [\n \"RelatedPerson.identifier\"\n ],\n \"details\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\",\n \"code\": \"INVALID_IDENTIFIER_VALUE\",\n \"display\": \"Provided value is invalid\"\n }\n ]\n },\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + }, + { + "name": "Invalid identifier system - Get verified candidate relationships", + "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {}, + "requests": {} + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number/invalid|730675929", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "RelatedPerson" + ], + "query": [ + { + "key": "identifier", + "value": "https://fhir.nhs.uk/Id/nhs-number/invalid|730675929" + } + ] + }, + "description": "## Example scenario\n\n**Given** a proxy has a related person relationship in PDS \n**When** a GET /RelatedPerson request is sent with an invalid identifier \n**Then** a 400 error is returned with code 'INVALID_IDENTIFIER_VALUE'" + }, + "response": [ + { + "name": "Invalid identifier value error returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "X-Request-ID", + "value": "{{$guid}}", + "type": "text" + }, + { + "key": "X-Correlation-ID", + "value": "{{$guid}}", + "type": "text" + } + ], + "url": { + "raw": "{{api_base_url}}/RelatedPerson?identifier=https://fhir.nhs.uk/Id/nhs-number/invalid|730675929", + "host": [ + "{{api_base_url}}" + ], + "path": [ + "RelatedPerson" + ], + "query": [ + { + "key": "identifier", + "value": "https://fhir.nhs.uk/Id/nhs-number/invalid|730675929" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "Text", + "header": [ + { + "key": "Date", + "value": "Fri, 28 Nov 2025 17:48:42 GMT" + }, + { + "key": "Content-Type", + "value": "application/fhir+json" + }, + { + "key": "Content-Length", + "value": "352" + }, + { + "key": "Connection", + "value": "keep-alive" + }, + { + "key": "x-amzn-RequestId", + "value": "66e70023-f78b-48aa-a29f-3df08e3e895c" + }, + { + "key": "x-amz-apigw-id", + "value": "UxADKEqiLPEFbWw=" + }, + { + "key": "X-Amzn-Trace-Id", + "value": "Root=1-6929e07a-ade89162a2d0b573830554ca" + }, + { + "key": "X-Request-ID", + "value": "a6c275c6-3964-4d18-8860-fcf25e510f14" + }, + { + "key": "X-Correlation-ID", + "value": "1d7ecfb8-29fb-461a-9904-e28216b510f8" + }, + { + "key": "Strict-Transport-Security", + "value": "max-age=31536000; includeSubDomains" + } + ], + "cookie": [], + "body": "{\n \"issue\": [\n {\n \"code\": \"invalid\",\n \"details\": {\n \"coding\": [\n {\n \"code\": \"INVALID_IDENTIFIER_SYSTEM\",\n \"display\": \"Invalid identifier system\",\n \"system\": \"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode\",\n \"version\": \"1\"\n }\n ]\n },\n \"diagnostics\": \"The identifier system is not valid.\",\n \"severity\": \"error\"\n }\n ],\n \"resourceType\": \"OperationOutcome\"\n}" + } + ] + } + ], + "description": "## Allowed auth methods\n\n- NHS Login token - Auth with test user `9730675929`\n \n- CIS2 token - Auth with test user `656005750108`\n \n\nSee collection level documentation for info about how to get authorization tokens.", + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{cis2_token}}", + "type": "string" + } + ] + }, + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "packages": {}, + "requests": {}, + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "packages": {}, + "requests": {}, + "exec": [ + "" + ] + } + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{vault:authorization-secret}}", + "type": "string" + } + ] + }, + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "" + ] + } + } + ], + "variable": [ + { + "key": "nps_enabled", + "value": "" + }, + { + "key": "nam_cache_enabled", + "value": "" + }, + { + "key": "nam_enabled", + "value": "" + }, + { + "key": "use_nam_mock", + "value": "" + } + ] } diff --git a/postman/validated_relationship_service.sandbox.postman_collection.json b/postman/validated_relationship_service.sandbox.postman_collection.json index afc177d4..df2f4fb3 100644 --- a/postman/validated_relationship_service.sandbox.postman_collection.json +++ b/postman/validated_relationship_service.sandbox.postman_collection.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "88a9dda6-bdbb-46c0-b888-78c8f4d35995" + "postman_id": "3286622e-e0e8-481d-a81b-42f14fc2d60e" }, "item": [ { - "id": "8441cbba-8ba9-4b55-b8fa-78146d129bcf", + "id": "1c5e41b5-fa25-48e1-aa9d-bd1aa82fec4e", "name": "QuestionnaireResponse", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "412e86f5-ab8d-44de-9440-b9ee9d3a95b0", + "id": "5e250ec6-330e-4c97-b17b-98f8a31fb350", "name": "New Access request", "request": { "name": "New Access request", @@ -75,7 +75,7 @@ { "listen": "test", "script": { - "id": "368c1d60-821c-45b9-bb10-9692c28c3fee", + "id": "ffc42bc2-6d18-41c1-9536-cd45cf9ec1cc", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/QuestionnaireResponse - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -90,7 +90,7 @@ } }, { - "id": "d7714453-8e84-4c96-a8a2-ea5802156b61", + "id": "d3c0dfe5-f5c0-4ba8-b172-415822766745", "name": "{id}", "description": { "content": "", @@ -98,7 +98,7 @@ }, "item": [ { - "id": "5fcbb209-b9ba-41cb-864f-101ec5e38839", + "id": "e1242e40-20b2-41a5-b625-0342335603f1", "name": "Get a proxy access request", "request": { "name": "Get a proxy access request", @@ -160,7 +160,7 @@ { "listen": "test", "script": { - "id": "2d754eb4-7f1d-4de3-ad26-711a2a8fff44", + "id": "5eb2dd3c-81dd-4cf9-a77e-ad2e97910983", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/QuestionnaireResponse/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -181,7 +181,7 @@ "event": [] }, { - "id": "1216ab88-365a-4570-87a8-e9cfdcff9fd5", + "id": "26f23c7f-0821-48d3-9b67-a5c2fdda2b5b", "name": "RelatedPerson", "description": { "content": "", @@ -189,7 +189,7 @@ }, "item": [ { - "id": "95a24513-7db5-4ceb-86fe-ff4fe11f558d", + "id": "89bb037d-5bbe-4aac-9c2b-2c4ad4824b29", "name": "Get verified candidate relationships", "request": { "name": "Get verified candidate relationships", @@ -267,7 +267,7 @@ { "listen": "test", "script": { - "id": "3a2ee785-3f57-43c8-81e4-006a25d39636", + "id": "a8d54083-2e05-4079-ba93-d0d88149a674", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/RelatedPerson - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -285,7 +285,7 @@ "event": [] }, { - "id": "1fbfa513-0cff-4736-bc88-3f98695a90e2", + "id": "c4c8ecf4-4c2f-4add-b164-21a2da2d83ce", "name": "Consent", "description": { "content": "", @@ -293,12 +293,12 @@ }, "item": [ { - "id": "efb2a45e-e289-466c-8e81-2997d0746674", + "id": "9e9dd57d-5df5-4024-84e9-ea13ed3403ef", "name": "Get proxy roles", "request": { "name": "Get proxy roles", "description": { - "content": "## Overview\nUse this endpoint to get the details about proxy roles, including current status, based on a provided NHS Number.\n\nEither `performer:identifier` or `patient:identifier` request parameters must be provided. `performer:identifier` and `patient:identifier` can be used together.\n\nYou 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`.\n\nYou can (optionally) include the `_include=Consent:grantee` request parameter to include the proxy's details in the response.\n\nYou can (optionally) include the `_include=Consent:patient` request parameter to include the patient's details in the response.\n\n## Access modes\n\nThis endpoint supports the following access modes:\n- Patient access\n- Healthcare worker access\n- Application-restricted access\n\n## Sandbox test scenarios\n\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario | Request | Response |\n| --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |\n| Multiple proxy relationships filtered by 'active' status including details | `performer:identifier=9000000017&_include=Consent:patient&_include=Consent:grantee&status=active` | HTTP Status 200 Bundle containing a multiple active proxy relationships including grantee and patient details |\n| Multiple proxy relationships filtered by 'inactive' status | `performer:identifier=9000000017&status=inactive` | HTTP Status 200 Bundle containing a multiple inactive proxy relationships |\n| 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 |\n| Multiple proxy relationships without filtering and details | `performer:identifier=9000000022` | HTTP Status 200 Bundle containing a multiple proxy relationships without details |\n| Multiple proxy relationships including grantee details | `performer:identifier=9000000022&_include=Consent:grantee` | HTTP Status 200 Bundle containing a multiple proxy relationships including grantee details |\n| Multiple proxy relationships including patient details | `performer:identifier=9000000022&_include=Consent:patient` | HTTP Status 200 Bundle containing a multiple proxy relationships including patient details |\n| Multiple proxy relationships including grantee and patient details | `performer:identifier=9000000022&_include=Consent:patient&_include=Consent:grantee` | HTTP Status 200 Bundle containing a multiple proxy relationships including grantee and patient details |\n| Multiple proxy relationships, single patient | `patient:identifier=9000000100` | HTTP Status 200 Bundle containing a multiple proxy relationships including grantee and patient details |\n| Multiple proxy relationships, single patient, including proxy details | `patient:identifier=9000000100&_include=Consent:grantee` | HTTP Status 200 Bundle containing a multiple proxy relationships including proxy details |\n| 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 |\n| Multiple proxy relationships, single patient, including proxy and patient details | `patient:identifier=9000000100&_include=Consent:patient&_include=Consent:grantee` | HTTP Status 200 Bundle containing a multiple proxy relationships including proxy and patient details |\n| No proxy relationships | `performer:identifier=9000000025&_include=Consent:patient&_include=Consent:grantee&status=active` | HTTP Status 200 empty bundle |\n| A single proxy relationship between consenting adults | `performer:identifier=9000000010` and/or `patient:identifier=9000000005` | HTTP Status 200 Bundle containing a single proxy relationship |\n| A single proxy relationship between consenting adults including details | `performer:identifier=9000000010` and/or `patient:identifier=9000000005&_include=Consent:patient&_include=Consent:grantee` | HTTP Status 200 Bundle containing a single proxy relationship including grantee and patient details |\n| 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 |\n| A single proxy relationship between a mother and child including details | `performer:identifier=9000000019` and/or `patient:identifier=9000000009&_include=Consent:patient&_include=Consent:grantee` | HTTP Status 200 Bundle containing a single proxy relationship including grantee and patient details |\n| 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 |\n| Invalid status parameter | `performer:identifier=9000000019` and/or `patient:identifier=9000000009&status=test` | HTTP Status 422 and INVALID_PARAMETER error response |\n| Invalid include parameter | `performer:identifier=9000000019` and/or `patient:identifier=9000000009&_include=test` | HTTP Status 422 and INVALID_PARAMETER error response |\n| Missing identifier | `patient:identifier=9000000009` | HTTP Status 400 and MISSING_IDENTIFIER_VALUE error response |\n| 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 |\n| Invalid identifier system | `identifier=https://fhir.nhs.uk/Id/nhs-number/9730675929` | HTTP Status 422 and INVALID_IDENTIFIER_SYSTEM error response |\n| No performer record found | `identifier=9000000999` | HTTP Status 404 and INVALIDATED_RESOURCE error response |\n| GP Practice not found | `identifier=9000000012` | HTTP Status 404 and GP_PRACTICE_NOT_FOUND error response |\n\n### Sandbox constraints\n\nThe sandbox environment has the following constraints for this endpoint:\n\n - Request headers are not tested. `X-IM1-Connection-Params`, `X-Request-ID` and `X-Correlation-ID` are disregarded.\n", + "content": "## Overview\nUse this endpoint to get the details about proxy roles, including current status, based on a provided NHS Number.\n\nEither `performer:identifier` or `patient:identifier` request parameters must be provided. `performer:identifier` and `patient:identifier` can be used together.\n\nYou 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`.\n\nYou can (optionally) include the `_include=Consent:performer` request parameter to include the proxy's details in the response.\n\nYou can (optionally) include the `_include=Consent:patient` request parameter to include the patient's details in the response.\n\n## Access modes\n\nThis endpoint supports the following access modes:\n- Patient access\n- Healthcare worker access\n- Application-restricted access\n\n## Sandbox test scenarios\n\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario | Request | Response |\n| --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |\n| 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 |\n| Multiple proxy relationships filtered by 'inactive' status | `performer:identifier=9000000017&status=inactive` | HTTP Status 200 Bundle containing a multiple inactive proxy relationships |\n| 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 |\n| Multiple proxy relationships without filtering and details | `performer:identifier=9000000022` | HTTP Status 200 Bundle containing a multiple proxy relationships without details |\n| Multiple proxy relationships including performer details | `performer:identifier=9000000022&_include=Consent:performer` | HTTP Status 200 Bundle containing a multiple proxy relationships including performer details |\n| Multiple proxy relationships including patient details | `performer:identifier=9000000022&_include=Consent:patient` | HTTP Status 200 Bundle containing a multiple proxy relationships including patient details |\n| 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 |\n| Multiple proxy relationships, single patient | `patient:identifier=9000000100` | HTTP Status 200 Bundle containing a multiple proxy relationships including performer and patient details |\n| 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 |\n| 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 |\n| 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 |\n| No proxy relationships | `performer:identifier=9000000025&_include=Consent:patient&_include=Consent:performer&status=active` | HTTP Status 200 empty bundle |\n| A single proxy relationship between consenting adults | `performer:identifier=9000000010` and/or `patient:identifier=9000000005` | HTTP Status 200 Bundle containing a single proxy relationship |\n| 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 |\n| 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 |\n| 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 |\n| 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 |\n| Invalid status parameter | `performer:identifier=9000000019` and/or `patient:identifier=9000000009&status=test` | HTTP Status 422 and INVALID_PARAMETER error response |\n| Invalid include parameter | `performer:identifier=9000000019` and/or `patient:identifier=9000000009&_include=test` | HTTP Status 422 and INVALID_PARAMETER error response |\n| Missing identifier | `patient:identifier=9000000009` | HTTP Status 400 and MISSING_IDENTIFIER_VALUE error response |\n| 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 |\n| Invalid identifier system | `identifier=https://fhir.nhs.uk/Id/nhs-number/9730675929` | HTTP Status 422 and INVALID_IDENTIFIER_SYSTEM error response |\n| No performer record found | `identifier=9000000999` | HTTP Status 404 and INVALIDATED_RESOURCE error response |\n| GP Practice not found | `identifier=9000000012` | HTTP Status 404 and GP_PRACTICE_NOT_FOUND error response |\n\n### Sandbox constraints\n\nThe sandbox environment has the following constraints for this endpoint:\n\n - Request headers are not tested. `X-IM1-Connection-Params`, `X-Request-ID` and `X-Correlation-ID` are disregarded.\n", "type": "text/plain" }, "url": { @@ -343,7 +343,7 @@ "type": "text/plain" }, "key": "_include", - "value": "Consent:grantee" + "value": "Consent:performer" }, { "disabled": false, @@ -398,7 +398,7 @@ { "listen": "test", "script": { - "id": "a4fc385e-21c7-4de4-892f-482d74436914", + "id": "5fa3d9b0-8f87-4c69-aeae-6c547afe83f1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/Consent - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -413,7 +413,7 @@ } }, { - "id": "33298e76-4b7a-4a87-b69c-8838e0a611a6", + "id": "0442727f-b94c-47ae-bf24-322b32241270", "name": "Create a proxy role", "request": { "name": "Create a proxy role", @@ -462,7 +462,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9000000012\"\n }\n },\n \"dateTime\": \"2025-02-11T14:30:00Z\",\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n }\n ],\n \"provision\": {\n \"type\": \"permit\",\n \"period\": {\n \"start\": \"2025-02-11T14:30:00Z\",\n \"end\": \"2029-02-11T14:30:00Z\"\n },\n \"actor\": [\n {\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9000000009\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\"\n }\n ]\n }\n },\n {\n \"url\": \"http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9000000009\",\n \"display\": \"Role created\"\n }\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n}", + "raw": "{\n \"resourceType\": \"Consent\",\n \"status\": \"active\",\n \"scope\": {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/consentscope\",\n \"code\": \"patient-privacy\",\n \"display\": \"Privacy Consent\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"system\": \"https://terminology.hl7.org/CodeSystem/v3-ActCode\",\n \"code\": \"INFA\",\n \"display\": \"information access\"\n }\n ]\n }\n ],\n \"patient\": {\n \"type\": \"Patient\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9000000012\"\n }\n },\n \"dateTime\": \"2025-02-11T14:30:00Z\",\n \"performer\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9000000009\"\n }\n }\n ],\n \"policyRule\": [\n {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis\",\n \"code\": \"parental-responsibility\",\n \"display\": \"Parental responsibility\"\n }\n ]\n }\n ],\n \"provision\": {\n \"type\": \"permit\",\n \"period\": {\n \"start\": \"2025-02-11T14:30:00Z\",\n \"end\": \"2029-02-11T14:30:00Z\"\n },\n \"actor\": [\n {\n \"reference\": {\n \"type\": \"RelatedPerson\",\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\n \"value\": \"9000000009\"\n }\n }\n }\n ]\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason\",\n \"code\": \"ROLE_CREATED\",\n \"display\": \"Role created from scratch by GP\"\n }\n ]\n }\n },\n {\n \"url\": \"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor\",\n \"valueReference\": {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\n \"value\": \"G8101234\"\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -476,7 +476,7 @@ { "listen": "test", "script": { - "id": "5691a776-3a12-48b9-aa71-0b0b946b5ea3", + "id": "c15f8cad-efe9-48cb-a88a-b3a8b25f6eec", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/Consent - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -491,7 +491,7 @@ } }, { - "id": "10590cf0-9865-4096-a2ff-3cc85c8ee732", + "id": "800dca0d-d8ae-47c4-bb6c-22a30ba4691c", "name": "{id}", "description": { "content": "", @@ -499,12 +499,12 @@ }, "item": [ { - "id": "542b8b92-0ff3-46cf-9fb7-86a5b9e9d6f2", + "id": "70df3ba8-54c8-4ab2-bcc2-8af4fe0166ea", "name": "Get proxy role", "request": { "name": "Get proxy role", "description": { - "content": "## Overview\nUse this endpoint to get the details of a proxy role, including current status, based on a provided id.\n\nYou can (optionally) include the `_include=Consent:grantee` request parameter to include the proxy's details in the response.\n\nYou can (optionally) include the `_include=Consent:patient` request parameter to include the patient's details in the response.\n\n## Access modes\n\nThis endpoint supports the following access modes:\n- Healthcare worker access\n- Application-restricted access\n\n## Sandbox test scenarios\n\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario | Request | Response |\n| -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| Retrieve single consenting adult relationship | Valid request with ID `74eed847-ca25-4e76-8cf2-f2c2d7842a7a` | HTTP Status 200 Bundle containing a single active proxy relationship |\n| Retrieve single consenting adult relationship with patient details | Valid request with ID `74eed847-ca25-4e76-8cf2-f2c2d7842a7a?_include=Consent:patient` | HTTP Status 200 Bundle containing a single active proxy relationship with patient details |\n| Retrieve single consenting adult relationship with grantee details | Valid request with ID `74eed847-ca25-4e76-8cf2-f2c2d7842a7a?_include=Consent:grantee` | HTTP Status 200 Bundle containing a single active proxy relationship with grantee details |\n| Retrieve single consenting adult relationship with grantee and patient details | Valid request with ID `74eed847-ca25-4e76-8cf2-f2c2d7842a7a?_include=Consent:grantee&_include=Consent:patient` | HTTP Status 200 Bundle containing a single active proxy relationship with grantee and patient details |\n| Retrieve single mother-child relationship | Valid request with ID `39df03a2-1b14-4d19-b1dc-d5d8cbf96948` | HTTP Status 200 Bundle containing a single active proxy relationship |\n| Retrieve single mother-child relationship with patient details | Valid request with ID `39df03a2-1b14-4d19-b1dc-d5d8cbf96948?_include=Consent:patient` | HTTP Status 200 Bundle containing a single active proxy relationship with patient details |\n| Retrieve single mother-child relationship with grantee details | Valid request with ID `39df03a2-1b14-4d19-b1dc-d5d8cbf96948?_include=Consent:grantee` | HTTP Status 200 Bundle containing a single active proxy relationship with grantee details |\n| Retrieve single mother-child relationship with grantee and patient details | Valid request with ID `39df03a2-1b14-4d19-b1dc-d5d8cbf96948?_include=Consent:grantee&_include=Consent:patient` | HTTP Status 200 Bundle containing a single active proxy relationship with grantee and patient details |\n\n### Sandbox constraints\n\nThe sandbox environment has the following constraints for this endpoint:\n\n- Request headers are not tested. `X-Request-ID` and `X-Correlation-ID` are disregarded.\n", + "content": "## Overview\nUse this endpoint to get the details of a proxy role, including current status, based on a provided id.\n\nYou can (optionally) include the `_include=Consent:performer` request parameter to include the proxy's details in the response.\n\nYou can (optionally) include the `_include=Consent:patient` request parameter to include the patient's details in the response.\n\n## Access modes\n\nThis endpoint supports the following access modes:\n- Healthcare worker access\n- Application-restricted access\n\n## Sandbox test scenarios\n\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario | Request | Response |\n| -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| Retrieve single consenting adult relationship | Valid request with ID `74eed847-ca25-4e76-8cf2-f2c2d7842a7a` | HTTP Status 200 Bundle containing a single active proxy relationship |\n| Retrieve single consenting adult relationship with patient details | Valid request with ID `74eed847-ca25-4e76-8cf2-f2c2d7842a7a?_include=Consent:patient` | HTTP Status 200 Bundle containing a single active proxy relationship with patient details |\n| Retrieve single consenting adult relationship with performer details | Valid request with ID `74eed847-ca25-4e76-8cf2-f2c2d7842a7a?_include=Consent:performer` | HTTP Status 200 Bundle containing a single active proxy relationship with performer details |\n| Retrieve single consenting adult relationship with performer and patient details | Valid request with ID `74eed847-ca25-4e76-8cf2-f2c2d7842a7a?_include=Consent:performer&_include=Consent:patient` | HTTP Status 200 Bundle containing a single active proxy relationship with performer and patient details |\n| Retrieve single mother-child relationship | Valid request with ID `39df03a2-1b14-4d19-b1dc-d5d8cbf96948` | HTTP Status 200 Bundle containing a single active proxy relationship |\n| Retrieve single mother-child relationship with patient details | Valid request with ID `39df03a2-1b14-4d19-b1dc-d5d8cbf96948?_include=Consent:patient` | HTTP Status 200 Bundle containing a single active proxy relationship with patient details |\n| Retrieve single mother-child relationship with performer details | Valid request with ID `39df03a2-1b14-4d19-b1dc-d5d8cbf96948?_include=Consent:performer` | HTTP Status 200 Bundle containing a single active proxy relationship with performer details |\n| Retrieve single mother-child relationship with performer and patient details | Valid request with ID `39df03a2-1b14-4d19-b1dc-d5d8cbf96948?_include=Consent:performer&_include=Consent:patient` | HTTP Status 200 Bundle containing a single active proxy relationship with performer and patient details |\n\n### Sandbox constraints\n\nThe sandbox environment has the following constraints for this endpoint:\n\n- Request headers are not tested. `X-Request-ID` and `X-Correlation-ID` are disregarded.\n", "type": "text/plain" }, "url": { @@ -523,7 +523,7 @@ "type": "text/plain" }, "key": "_include", - "value": "Consent:grantee" + "value": "Consent:performer" }, { "disabled": false, @@ -580,7 +580,7 @@ { "listen": "test", "script": { - "id": "f3269a55-7a51-43b1-abe3-5fbc974410ab", + "id": "f294fdd1-70d3-4280-ae9f-3f22806de372", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/Consent/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -595,7 +595,7 @@ } }, { - "id": "ea177cf6-d5b7-4ecf-8ccc-10146e70c2a0", + "id": "bbcb0867-9cc4-42aa-a09f-1d4bf8930d6c", "name": "Update a proxy role", "request": { "name": "Update a proxy role", @@ -652,7 +652,7 @@ { "listen": "test", "script": { - "id": "3384add5-3b96-4318-9f1c-f9600940b155", + "id": "f8d2e86a-ab42-4c78-bbd4-0d18e034ba8a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/Consent/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -682,7 +682,7 @@ } ], "info": { - "_postman_id": "88a9dda6-bdbb-46c0-b888-78c8f4d35995", + "_postman_id": "3286622e-e0e8-481d-a81b-42f14fc2d60e", "name": "Validated Relationships Service API", "version": { "raw": "1.19.0", diff --git a/sandbox/api/constants.py b/sandbox/api/constants.py index f4d52b7f..31252eb0 100644 --- a/sandbox/api/constants.py +++ b/sandbox/api/constants.py @@ -3,7 +3,7 @@ PATIENT_IDENTIFIERS = ["9000000017", "9000000033", "9000000042"] RELATED_IDENTIFIERS = ["9000000009", "9000000025", "9000000042"] -CONSENT_GRANTEE = "Consent:grantee" +CONSENT_PERFORMER = "Consent:performer" CONSENT_PATIENT = "Consent:patient" # Example files @@ -29,47 +29,47 @@ ) GET_CONSENT__MULTIPLE_RELATIONSHIPS = f"{GET_CONSENT__DIRECTORY}multiple-relationships.yaml" GET_CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_BOTH = ( - f"{GET_CONSENT__DIRECTORY}multiple-relationships-include-grantee-patient.yaml" + f"{GET_CONSENT__DIRECTORY}multiple-relationships-include-performer-patient.yaml" ) GET_CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PATIENT = ( f"{GET_CONSENT__DIRECTORY}multiple-relationships-include-patient.yaml" ) -GET_CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_GRANTEE = ( - f"{GET_CONSENT__DIRECTORY}multiple-relationships-include-grantee.yaml" +GET_CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PERFORMER = ( + f"{GET_CONSENT__DIRECTORY}multiple-relationships-include-performer.yaml" ) GET_CONSENT__NO_RELATIONSHIPS = f"{GET_CONSENT__DIRECTORY}no-relationships.yaml" GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP = f"{GET_CONSENT__DIRECTORY}single-consenting-adult-relationship.yaml" GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_BOTH = ( - f"{GET_CONSENT__DIRECTORY}single-consenting-adult-relationship-include-grantee-patient.yaml" + f"{GET_CONSENT__DIRECTORY}single-consenting-adult-relationship-include-performer-patient.yaml" ) GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_PATIENT = ( f"{GET_CONSENT__DIRECTORY}single-consenting-adult-relationship-include-patient.yaml" ) -GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_GRANTEE = ( - f"{GET_CONSENT__DIRECTORY}single-consenting-adult-relationship-include-grantee.yaml" +GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_PERFORMER = ( + f"{GET_CONSENT__DIRECTORY}single-consenting-adult-relationship-include-performer.yaml" ) GET_CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP = f"{GET_CONSENT__DIRECTORY}single-mother-child-relationship.yaml" GET_CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_BOTH = ( - f"{GET_CONSENT__DIRECTORY}single-mother-child-relationship-include-grantee-patient.yaml" + f"{GET_CONSENT__DIRECTORY}single-mother-child-relationship-include-performer-patient.yaml" ) GET_CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_PATIENT = ( f"{GET_CONSENT__DIRECTORY}single-mother-child-relationship-include-patient.yaml" ) -GET_CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_GRANTEE = ( - f"{GET_CONSENT__DIRECTORY}single-mother-child-relationship-include-grantee.yaml" +GET_CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_PERFORMER = ( + f"{GET_CONSENT__DIRECTORY}single-mother-child-relationship-include-performer.yaml" ) GET_CONSENT__STATUS_PARAM_INVALID = f"{GET_CONSENT__DIRECTORY}errors/invalid-status-parameter.yaml" GET_CONSENT__MULTIPLE_RELATIONSHIPS_SINGLE_PATIENT = ( f"{GET_CONSENT__DIRECTORY}multiple-relationships-single-patient.yaml" ) -GET_CONSENT__MULTIPLE_RELATIONSHIPS_SINGLE_PATIENT_INCLUDE_GRANTEE = ( - f"{GET_CONSENT__DIRECTORY}multiple-relationships-single-patient-include-grantee.yaml" +GET_CONSENT__MULTIPLE_RELATIONSHIPS_SINGLE_PATIENT_INCLUDE_PERFORMER = ( + f"{GET_CONSENT__DIRECTORY}multiple-relationships-single-patient-include-performer.yaml" ) GET_CONSENT__MULTIPLE_RELATIONSHIPS_SINGLE_PATIENT_INCLUDE_PATIENT = ( f"{GET_CONSENT__DIRECTORY}multiple-relationships-single-patient-include-patient.yaml" ) GET_CONSENT__MULTIPLE_RELATIONSHIPS_SINGLE_PATIENT_INCLUDE_BOTH = ( - f"{GET_CONSENT__DIRECTORY}multiple-relationships-single-patient-include-grantee-patient.yaml" + f"{GET_CONSENT__DIRECTORY}multiple-relationships-single-patient-include-performer-patient.yaml" ) GET_CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_UNKNOWN_LEGAL_BASIS = ( f"{GET_CONSENT__DIRECTORY}single-mother-child-relationship-unknown-legal-basis.yaml" diff --git a/sandbox/api/get_consent.py b/sandbox/api/get_consent.py index 2a53f990..68cee8de 100644 --- a/sandbox/api/get_consent.py +++ b/sandbox/api/get_consent.py @@ -9,12 +9,12 @@ GET_CONSENT__FILTERED_RELATIONSHIPS_STATUS_PROPOSED_ACTIVE, GET_CONSENT__MULTIPLE_RELATIONSHIPS_SINGLE_PATIENT, GET_CONSENT__MULTIPLE_RELATIONSHIPS_SINGLE_PATIENT_INCLUDE_PATIENT, - GET_CONSENT__MULTIPLE_RELATIONSHIPS_SINGLE_PATIENT_INCLUDE_GRANTEE, + GET_CONSENT__MULTIPLE_RELATIONSHIPS_SINGLE_PATIENT_INCLUDE_PERFORMER, GET_CONSENT__MULTIPLE_RELATIONSHIPS_SINGLE_PATIENT_INCLUDE_BOTH, GET_CONSENT__MULTIPLE_RELATIONSHIPS, GET_CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_BOTH, GET_CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PATIENT, - GET_CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_GRANTEE, + GET_CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PERFORMER, GET_CONSENT__NO_RELATIONSHIPS, GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP, GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_BOTH, @@ -79,7 +79,7 @@ def get_consent_response() -> Union[dict, tuple]: GET_CONSENT__MULTIPLE_RELATIONSHIPS_SINGLE_PATIENT, GET_CONSENT__MULTIPLE_RELATIONSHIPS_SINGLE_PATIENT_INCLUDE_BOTH, GET_CONSENT__MULTIPLE_RELATIONSHIPS_SINGLE_PATIENT_INCLUDE_PATIENT, - GET_CONSENT__MULTIPLE_RELATIONSHIPS_SINGLE_PATIENT_INCLUDE_GRANTEE, + GET_CONSENT__MULTIPLE_RELATIONSHIPS_SINGLE_PATIENT_INCLUDE_PERFORMER, ) # Filtering elif performer_identifier == "9000000017": @@ -97,7 +97,7 @@ def get_consent_response() -> Union[dict, tuple]: GET_CONSENT__MULTIPLE_RELATIONSHIPS, GET_CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_BOTH, GET_CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PATIENT, - GET_CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_GRANTEE, + GET_CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PERFORMER, ) # No relationships elif performer_identifier == "9000000025": diff --git a/sandbox/api/get_consent_by_id.py b/sandbox/api/get_consent_by_id.py index 75c566b0..ae4e24c1 100644 --- a/sandbox/api/get_consent_by_id.py +++ b/sandbox/api/get_consent_by_id.py @@ -8,11 +8,11 @@ GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP, GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_BOTH, GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_PATIENT, - GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_GRANTEE, + GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_PERFORMER, GET_CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP, GET_CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_BOTH, GET_CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_PATIENT, - GET_CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_GRANTEE, + GET_CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_PERFORMER, GET_CONSENT_BY_ID__INVALID_ID_ERROR, BAD_REQUEST_INCLUDE_PARAM_INVALID, INVALIDATED_RESOURCE, @@ -41,7 +41,7 @@ def get_consent_by_id_response(identifier: str) -> Union[dict, tuple]: GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP, GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_BOTH, GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_PATIENT, - GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_GRANTEE, + GET_CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_PERFORMER, ) elif identifier == "39df03a2-1b14-4d19-b1dc-d5d8cbf96948": return check_for_consent_include_params( @@ -49,7 +49,7 @@ def get_consent_by_id_response(identifier: str) -> Union[dict, tuple]: GET_CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP, GET_CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_BOTH, GET_CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_PATIENT, - GET_CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_GRANTEE, + GET_CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_PERFORMER, ) elif identifier == "a0922245-1072-40c3-8f4e-a7490c10d365": return generate_response_from_example(INVALIDATED_RESOURCE, 404) diff --git a/sandbox/api/post_consent.py b/sandbox/api/post_consent.py index 8b1a3b32..a194ed80 100644 --- a/sandbox/api/post_consent.py +++ b/sandbox/api/post_consent.py @@ -31,8 +31,7 @@ def post_consent_response() -> Union[dict, tuple]: logger.debug("Received request to POST consent") # Validate body - beyond the scope of sandbox - assume body is valid for scenario json = request.get_json() - grantee_ext = next(ext for ext in json["extension"] if "grantee" in ext["url"]) - patient_identifier = grantee_ext["valueReference"]["identifier"]["value"] + patient_identifier = json["performer"][0]["identifier"]["value"] response = None # Successful parent-child proxy creation diff --git a/sandbox/api/tests/test_get_consent.py b/sandbox/api/tests/test_get_consent.py index 7ad52e56..940c8dbc 100644 --- a/sandbox/api/tests/test_get_consent.py +++ b/sandbox/api/tests/test_get_consent.py @@ -49,7 +49,7 @@ def test_get_consent_returns_expected_responses__mocked_get_consent( ("request_args", "response_file_name", "status_code"), [ ( - "performer:identifier=9000000017&status=active&_include=Consent:grantee&_include=Consent:patient", + "performer:identifier=9000000017&status=active&_include=Consent:performer&_include=Consent:patient", "./api/examples/GET_Consent/filtered-relationships-status-active-include-details.yaml", 200, ), @@ -86,13 +86,13 @@ def test_get_consent_returns_expected_responses__mocked_get_consent( 200, ), ( - "performer:identifier=9000000022&_include=Consent:grantee", - "./api/examples/GET_Consent/multiple-relationships-include-grantee.yaml", + "performer:identifier=9000000022&_include=Consent:performer", + "./api/examples/GET_Consent/multiple-relationships-include-performer.yaml", 200, ), ( - "performer:identifier=9000000022&_include=Consent:grantee&_include=Consent:patient", - "./api/examples/GET_Consent/multiple-relationships-include-grantee-patient.yaml", + "performer:identifier=9000000022&_include=Consent:performer&_include=Consent:patient", + "./api/examples/GET_Consent/multiple-relationships-include-performer-patient.yaml", 200, ), ( @@ -111,18 +111,18 @@ def test_get_consent_returns_expected_responses__mocked_get_consent( 200, ), ( - "performer:identifier=9000000010&_include=Consent:grantee&_include=Consent:patient", - "./api/examples/GET_Consent/single-consenting-adult-relationship-include-grantee-patient.yaml", + "performer:identifier=9000000010&_include=Consent:performer&_include=Consent:patient", + "./api/examples/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml", 200, ), ( - "patient:identifier=9000000005&_include=Consent:grantee&_include=Consent:patient", - "./api/examples/GET_Consent/single-consenting-adult-relationship-include-grantee-patient.yaml", + "patient:identifier=9000000005&_include=Consent:performer&_include=Consent:patient", + "./api/examples/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml", 200, ), ( - "performer:identifier=9000000010&patient:identifier=9000000005&_include=Consent:grantee&_include=Consent:patient", # noqa: E501 - "./api/examples/GET_Consent/single-consenting-adult-relationship-include-grantee-patient.yaml", + "performer:identifier=9000000010&patient:identifier=9000000005&_include=Consent:performer&_include=Consent:patient", # noqa: E501 + "./api/examples/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml", 200, ), ( @@ -141,18 +141,18 @@ def test_get_consent_returns_expected_responses__mocked_get_consent( 200, ), ( - "performer:identifier=9000000019&_include=Consent:grantee&_include=Consent:patient", - "./api/examples/GET_Consent/single-mother-child-relationship-include-grantee-patient.yaml", + "performer:identifier=9000000019&_include=Consent:performer&_include=Consent:patient", + "./api/examples/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml", 200, ), ( - "patient:identifier=9000000009&_include=Consent:grantee&_include=Consent:patient", - "./api/examples/GET_Consent/single-mother-child-relationship-include-grantee-patient.yaml", + "patient:identifier=9000000009&_include=Consent:performer&_include=Consent:patient", + "./api/examples/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml", 200, ), ( - "performer:identifier=9000000019&patient:identifier=9000000009&_include=Consent:grantee&_include=Consent:patient", # noqa: E501 - "./api/examples/GET_Consent/single-mother-child-relationship-include-grantee-patient.yaml", + "performer:identifier=9000000019&patient:identifier=9000000009&_include=Consent:performer&_include=Consent:patient", # noqa: E501 + "./api/examples/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml", 200, ), ( @@ -161,8 +161,8 @@ def test_get_consent_returns_expected_responses__mocked_get_consent( 200, ), ( - "patient:identifier=9000000100&_include=Consent:grantee", - "./api/examples/GET_Consent/multiple-relationships-single-patient-include-grantee.yaml", + "patient:identifier=9000000100&_include=Consent:performer", + "./api/examples/GET_Consent/multiple-relationships-single-patient-include-performer.yaml", 200, ), ( @@ -171,8 +171,8 @@ def test_get_consent_returns_expected_responses__mocked_get_consent( 200, ), ( - "patient:identifier=9000000100&_include=Consent:grantee&_include=Consent:patient", - "./api/examples/GET_Consent/multiple-relationships-single-patient-include-grantee-patient.yaml", + "patient:identifier=9000000100&_include=Consent:performer&_include=Consent:patient", + "./api/examples/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml", 200, ), ( @@ -239,6 +239,6 @@ def test_get_consent__500_internal_server_error( """Test Consent endpoint.""" mock_remove_system.side_effect = Exception("Test exception") # Act - client.get(f"{CONSENT_API_ENDPOINT}?performer:identifier=9000000015&status=active&_include=Consent:grantee") + client.get(f"{CONSENT_API_ENDPOINT}?performer:identifier=9000000015&status=active&_include=Consent:performer") # Assert mock_generate_response_from_example.assert_called_once_with("./api/examples/errors/internal-server-error.yaml", 500) diff --git a/sandbox/api/tests/test_get_consent_by_id.py b/sandbox/api/tests/test_get_consent_by_id.py index 069ec2b0..d7eb5907 100644 --- a/sandbox/api/tests/test_get_consent_by_id.py +++ b/sandbox/api/tests/test_get_consent_by_id.py @@ -72,8 +72,8 @@ def test_get_consent_by_id_returns_expected_responses__mocked_get_consent_by_id( ), ( "74eed847-ca25-4e76-8cf2-f2c2d7842a7a", # Single consenting adult relationship with include performer - "_include=Consent:grantee", - "./api/examples/GET_Consent/single-consenting-adult-relationship-include-grantee.yaml", + "_include=Consent:performer", + "./api/examples/GET_Consent/single-consenting-adult-relationship-include-performer.yaml", 200, ), ( @@ -84,8 +84,8 @@ def test_get_consent_by_id_returns_expected_responses__mocked_get_consent_by_id( ), ( "74eed847-ca25-4e76-8cf2-f2c2d7842a7a", # Single consenting adult relationship with include both - "_include=Consent:grantee&_include=Consent:patient", - "./api/examples/GET_Consent/single-consenting-adult-relationship-include-grantee-patient.yaml", + "_include=Consent:performer&_include=Consent:patient", + "./api/examples/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml", 200, ), ( @@ -96,8 +96,8 @@ def test_get_consent_by_id_returns_expected_responses__mocked_get_consent_by_id( ), ( "39df03a2-1b14-4d19-b1dc-d5d8cbf96948", # Single adult-child relationship with include performer - "_include=Consent:grantee", - "./api/examples/GET_Consent/single-mother-child-relationship-include-grantee.yaml", + "_include=Consent:performer", + "./api/examples/GET_Consent/single-mother-child-relationship-include-performer.yaml", 200, ), ( @@ -108,8 +108,8 @@ def test_get_consent_by_id_returns_expected_responses__mocked_get_consent_by_id( ), ( "39df03a2-1b14-4d19-b1dc-d5d8cbf96948", # Single adult-child relationship with include both - "_include=Consent:grantee&_include=Consent:patient", - "./api/examples/GET_Consent/single-mother-child-relationship-include-grantee-patient.yaml", + "_include=Consent:performer&_include=Consent:patient", + "./api/examples/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml", 200, ), ], diff --git a/sandbox/api/tests/test_post_consent.py b/sandbox/api/tests/test_post_consent.py index db0a9666..4e6b9e26 100644 --- a/sandbox/api/tests/test_post_consent.py +++ b/sandbox/api/tests/test_post_consent.py @@ -105,15 +105,8 @@ def test_post_consent_when_valid_returns_expected_response( status=status_code, content_type="application/json", ) + json = {"performer": [{"identifier": {"value": nhs_num}}]} # Act - json = { - "extension": [ - { - "url": "https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee", - "valueReference": {"identifier": {"value": nhs_num}}, - } - ] - } response = client.post(CONSENT_API_ENDPOINT, json=json) # Assert if id is not None: diff --git a/sandbox/api/utils.py b/sandbox/api/utils.py index 70e6b759..f05fa616 100644 --- a/sandbox/api/utils.py +++ b/sandbox/api/utils.py @@ -9,7 +9,7 @@ from .constants import ( BAD_REQUEST_INCLUDE_PARAM_INVALID, CONSENT_PATIENT, - CONSENT_GRANTEE, + CONSENT_PERFORMER, GET_CONSENT__STATUS_PARAM_INVALID, INCLUDE_FLAG, INTERNAL_SERVER_ERROR_EXAMPLE, @@ -267,7 +267,7 @@ def check_for_consent_include_params( include_none_response_yaml: str, include_both_response_yaml: str = None, include_patient_response_yaml: str = None, - include_grantee_response_yaml: str = None, + include_performer_response_yaml: str = None, ) -> Response: """Checks the GET consent request include params and provides the related response @@ -275,20 +275,20 @@ def check_for_consent_include_params( _include (List[str]): The include parameters supplied to the request include_none_response_yaml (str): Bundle to return when include params are empty include_both_response_yaml (str): (optional) Bundle to return when include param - is Consent:grantee,Consent:patient + is Consent:performer,Consent:patient include_patient_response_yaml (str): (optional) Bundle to return when include param is Consent:patient - include_grantee_response_yaml (str): (optional) Bundle to return when include param is Consent:grantee + include_performer_response_yaml (str): (optional) Bundle to return when include param is Consent:performer Returns: response: Resultant Response object based on input. """ if _include == [] or _include is None: return generate_response_from_example(include_none_response_yaml, 200) - elif _include == [CONSENT_GRANTEE]: - if include_grantee_response_yaml: - return generate_response_from_example(include_grantee_response_yaml, 200) + elif _include == [CONSENT_PERFORMER]: + if include_performer_response_yaml: + return generate_response_from_example(include_performer_response_yaml, 200) else: - logger.error("No consent grantee example provided") + logger.error("No consent performer example provided") return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500) elif _include == [CONSENT_PATIENT]: if include_patient_response_yaml: @@ -296,7 +296,7 @@ def check_for_consent_include_params( else: logger.error("No consent:patient example provided") return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500) - elif len(_include) == 2 and CONSENT_PATIENT in _include and CONSENT_GRANTEE in _include: + elif len(_include) == 2 and CONSENT_PATIENT in _include and CONSENT_PERFORMER in _include: return generate_response_from_example(include_both_response_yaml, 200) else: return generate_response_from_example(BAD_REQUEST_INCLUDE_PARAM_INVALID, 422) @@ -341,7 +341,7 @@ def check_for_consent_filtering( return generate_response_from_example(INVALIDATED_RESOURCE, 404) if effective_statuses == {"active"}: - if len(_include) == 2 and CONSENT_GRANTEE in _include and CONSENT_PATIENT in _include: + if len(_include) == 2 and CONSENT_PERFORMER in _include and CONSENT_PATIENT in _include: return generate_response_from_example(status_active_with_details_response_yaml, 200) else: return generate_response_from_example(INVALIDATED_RESOURCE, 404) diff --git a/specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml b/specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml index 3be476d3..611b4339 100644 --- a/specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml +++ b/specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml @@ -24,6 +24,10 @@ ConsentAdultToAdultGuardianRequest: code: "court-appointed-personal-welfare-deputy" display: "Court Appointed Personal Welfare Deputy" dateTime: "2025-02-11T14:30:00Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000017' provision: type: permit period: @@ -41,11 +45,6 @@ ConsentAdultToAdultGuardianRequest: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created from scratch by GP - - url: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000017' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml b/specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml index c73018bc..4d3069d3 100644 --- a/specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml +++ b/specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml @@ -19,6 +19,10 @@ ConsentParentChildProxyCreationRequest: system: https://fhir.nhs.uk/Id/nhs-number value: "9000000012" dateTime: "2025-02-11T14:30:00Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000009' policyRule: - coding: - system: "https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis" @@ -42,12 +46,6 @@ ConsentParentChildProxyCreationRequest: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created from scratch by GP - - url: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000009' - display: Role created - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml index 8a193d8f..3d5b723a 100644 --- a/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml +++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml @@ -1,8 +1,8 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle: - summary: Multiple active relationships including grantee and patient details + summary: Multiple active relationships including performer and patient details description: A Bundle containing multiple active proxy relationships with varying legal bases including the details - of the grantee and patient. + of the performer and patient. value: resourceType: Bundle timestamp: "2026-01-16T14:00:00+00:00" @@ -10,7 +10,7 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle: type: searchset link: - relation: self - url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=active&_include=Consent:grantee&_include=Consent:patient + url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=active&_include=Consent:performer&_include=Consent:patient entry: - fullUrl: "https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/PR974746" resource: @@ -115,6 +115,10 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000009" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000017' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -142,11 +146,6 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000017' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -221,6 +220,10 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000005" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000017' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -253,11 +256,6 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000017' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml index b2de2764..906c2d54 100644 --- a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml +++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml @@ -30,6 +30,10 @@ ConsentMultipleRelationshipsStatusInactiveBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000006' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000017' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -57,11 +61,6 @@ ConsentMultipleRelationshipsStatusInactiveBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_DEACTIVATED_END_DATE_REACHED display: End date reached - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000017' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -89,6 +88,10 @@ ConsentMultipleRelationshipsStatusInactiveBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000007' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000017' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -117,11 +120,6 @@ ConsentMultipleRelationshipsStatusInactiveBundle: code: OTHER display: Other reason text: Patient would not respond to phone calls - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000017' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml index 187eda11..98586774 100644 --- a/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml +++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml @@ -30,6 +30,10 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000009' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000017' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -57,11 +61,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000017' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -90,6 +89,10 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000005' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000017' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -117,11 +120,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000017' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -150,6 +148,10 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000020' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000017' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -177,11 +179,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: APPLICATION_SUBMITTED display: Application submitted online - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000017' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -210,6 +207,10 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000021' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000017' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -237,11 +238,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: APPLICATION_SUBMITTED display: Application submitted online - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000017' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml index f19fe78c..21caf4b8 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml @@ -62,6 +62,10 @@ ConsentMultipleRelationshipsIncludePatientBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000009" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000022' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -89,11 +93,6 @@ ConsentMultipleRelationshipsIncludePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000022' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -150,6 +149,10 @@ ConsentMultipleRelationshipsIncludePatientBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000005" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000022' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -177,11 +180,6 @@ ConsentMultipleRelationshipsIncludePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000022' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -238,6 +236,10 @@ ConsentMultipleRelationshipsIncludePatientBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000006" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000022' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -265,11 +267,6 @@ ConsentMultipleRelationshipsIncludePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_DEACTIVATED_END_DATE_REACHED display: End date reached - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000022' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-grantee-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml similarity index 95% rename from specification/examples/responses/GET_Consent/multiple-relationships-include-grantee-patient.yaml rename to specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml index 2ae76ea6..857104f0 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-include-grantee-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml @@ -1,7 +1,7 @@ -ConsentMultipleRelationshipsIncludeGranteePatientBundle: - summary: Multiple relationships with grantee and patient details +ConsentMultipleRelationshipsIncludePerformerPatientBundle: + summary: Multiple relationships with performer and patient details description: - A Bundle containing multiple proxy relationships with varying legal basis' including grantee + A Bundle containing multiple proxy relationships with varying legal basis' including performer and patient details. value: resourceType: Bundle @@ -10,7 +10,7 @@ ConsentMultipleRelationshipsIncludeGranteePatientBundle: type: searchset link: - relation: self - url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:grantee&_include=Consent:patient + url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:performer&_include=Consent:patient entry: - fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/PR974743 resource: @@ -115,6 +115,10 @@ ConsentMultipleRelationshipsIncludeGranteePatientBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000009" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000022' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -142,11 +146,6 @@ ConsentMultipleRelationshipsIncludeGranteePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000022' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -222,6 +221,10 @@ ConsentMultipleRelationshipsIncludeGranteePatientBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000005" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000022' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -249,11 +252,6 @@ ConsentMultipleRelationshipsIncludeGranteePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000022' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -329,6 +327,10 @@ ConsentMultipleRelationshipsIncludeGranteePatientBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000006" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000022' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -356,11 +358,6 @@ ConsentMultipleRelationshipsIncludeGranteePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_DEACTIVATED_END_DATE_REACHED display: End date reached - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000022' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-grantee.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml similarity index 94% rename from specification/examples/responses/GET_Consent/multiple-relationships-include-grantee.yaml rename to specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml index 68f68750..d24d0d99 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-include-grantee.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml @@ -1,7 +1,7 @@ -ConsentMultipleRelationshipsIncludeGranteeBundle: - summary: Multiple relationships with grantee details +ConsentMultipleRelationshipsIncludePerformerBundle: + summary: Multiple relationships with performer details description: - A Bundle containing multiple proxy relationships with varying legal basis' including grantee details + A Bundle containing multiple proxy relationships with varying legal basis' including performer details value: resourceType: Bundle timestamp: '2026-01-16T14:00:00+00:00' @@ -9,7 +9,7 @@ ConsentMultipleRelationshipsIncludeGranteeBundle: type: searchset link: - relation: self - url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:grantee + url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:performer entry: - fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/PR974743 resource: @@ -84,6 +84,10 @@ ConsentMultipleRelationshipsIncludeGranteeBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000009' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000022' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -111,11 +115,6 @@ ConsentMultipleRelationshipsIncludeGranteeBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000022' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -164,6 +163,10 @@ ConsentMultipleRelationshipsIncludeGranteeBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000005' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000022' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -191,11 +194,6 @@ ConsentMultipleRelationshipsIncludeGranteeBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000022' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -244,6 +242,10 @@ ConsentMultipleRelationshipsIncludeGranteeBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000006' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000022' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -271,11 +273,6 @@ ConsentMultipleRelationshipsIncludeGranteeBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_DEACTIVATED_END_DATE_REACHED display: End date reached - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000022' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml index 3bf66598..45bcfa8f 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml @@ -59,6 +59,10 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000100" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000020' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -86,11 +90,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000020' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -118,6 +117,10 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000100" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000021' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -145,11 +148,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000021' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -177,6 +175,10 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000100" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000022' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -204,11 +206,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_DEACTIVATED_END_DATE_REACHED display: End date reached - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000022' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-grantee-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml similarity index 95% rename from specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-grantee-patient.yaml rename to specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml index ae86d0cd..70abd504 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-grantee-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml @@ -1,6 +1,6 @@ -ConsentMultipleRelationshipsSinglePatientIncludeGranteePatientBundle: +ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: summary: Multiple relationships (multiple proxy relationships with single patient) - description: A Bundle containing multiple proxy relationships with single patient, including patient and grantee details. + description: A Bundle containing multiple proxy relationships with single patient, including patient and performer details. value: resourceType: Bundle timestamp: "2026-01-16T14:00:00+00:00" @@ -8,7 +8,7 @@ ConsentMultipleRelationshipsSinglePatientIncludeGranteePatientBundle: type: searchset link: - relation: self - url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:grantee&_include=Consent:patient + url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:performer&_include=Consent:patient entry: - fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2 resource: @@ -110,6 +110,10 @@ ConsentMultipleRelationshipsSinglePatientIncludeGranteePatientBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000100" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000020' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -137,11 +141,6 @@ ConsentMultipleRelationshipsSinglePatientIncludeGranteePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000020' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -216,6 +215,10 @@ ConsentMultipleRelationshipsSinglePatientIncludeGranteePatientBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000100" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000021' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -243,11 +246,6 @@ ConsentMultipleRelationshipsSinglePatientIncludeGranteePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000021' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -322,6 +320,10 @@ ConsentMultipleRelationshipsSinglePatientIncludeGranteePatientBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000100" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000022' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -349,11 +351,6 @@ ConsentMultipleRelationshipsSinglePatientIncludeGranteePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_DEACTIVATED_END_DATE_REACHED display: End date reached - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000022' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-grantee.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml similarity index 95% rename from specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-grantee.yaml rename to specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml index d5ebb6ee..854fce6e 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-grantee.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml @@ -1,6 +1,6 @@ -ConsentMultipleRelationshipsSinglePatientIncludeGranteeBundle: +ConsentMultipleRelationshipsSinglePatientIncludePerformerBundle: summary: Multiple relationships (multiple proxy relationships with single patient) - description: A Bundle containing multiple proxy relationships with single patient, including grantee details. + description: A Bundle containing multiple proxy relationships with single patient, including performer details. value: resourceType: Bundle timestamp: '2026-01-16T14:00:00+00:00' @@ -8,7 +8,7 @@ ConsentMultipleRelationshipsSinglePatientIncludeGranteeBundle: type: searchset link: - relation: self - url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:grantee + url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:performer entry: - fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/PR974744 resource: @@ -81,6 +81,10 @@ ConsentMultipleRelationshipsSinglePatientIncludeGranteeBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000100' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000020' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -108,11 +112,6 @@ ConsentMultipleRelationshipsSinglePatientIncludeGranteeBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000020' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -187,6 +186,10 @@ ConsentMultipleRelationshipsSinglePatientIncludeGranteeBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000100' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000021' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -214,11 +217,6 @@ ConsentMultipleRelationshipsSinglePatientIncludeGranteeBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000021' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -293,6 +291,10 @@ ConsentMultipleRelationshipsSinglePatientIncludeGranteeBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000100' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000022' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -320,11 +322,6 @@ ConsentMultipleRelationshipsSinglePatientIncludeGranteeBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_DEACTIVATED_END_DATE_REACHED display: End date reached - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000022' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml index 69b4d9d7..423b8ec9 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml @@ -30,6 +30,10 @@ ConsentMultipleRelationshipsSinglePatientBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000100' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000020' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -57,11 +61,6 @@ ConsentMultipleRelationshipsSinglePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000020' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -89,6 +88,10 @@ ConsentMultipleRelationshipsSinglePatientBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000100' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000021' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -116,12 +119,6 @@ ConsentMultipleRelationshipsSinglePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000021' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -149,6 +146,10 @@ ConsentMultipleRelationshipsSinglePatientBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000100' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000022' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -176,11 +177,6 @@ ConsentMultipleRelationshipsSinglePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_DEACTIVATED_END_DATE_REACHED display: End date reached - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000022' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/multiple-relationships.yaml b/specification/examples/responses/GET_Consent/multiple-relationships.yaml index 2fa772e2..7f1a7bbf 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships.yaml @@ -30,6 +30,10 @@ ConsentMultipleRelationshipsBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000009' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000022' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -57,11 +61,6 @@ ConsentMultipleRelationshipsBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000022' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -89,6 +88,10 @@ ConsentMultipleRelationshipsBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000005' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000022' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -116,11 +119,6 @@ ConsentMultipleRelationshipsBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000022' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: @@ -148,6 +146,10 @@ ConsentMultipleRelationshipsBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000006' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000022' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -175,11 +177,6 @@ ConsentMultipleRelationshipsBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_DEACTIVATED_END_DATE_REACHED display: End date reached - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000022' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/no-relationships.yaml b/specification/examples/responses/GET_Consent/no-relationships.yaml index a315c639..0eaf7df2 100644 --- a/specification/examples/responses/GET_Consent/no-relationships.yaml +++ b/specification/examples/responses/GET_Consent/no-relationships.yaml @@ -8,5 +8,5 @@ ConsentNoRelationshipsEmptyBundle: type: searchset link: - relation: self - url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000025&_include=Consent:grantee&_include=Consent:patient + url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000025&_include=Consent:performer&_include=Consent:patient entry: [] diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml index 254c65b6..753be60d 100644 --- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml +++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml @@ -59,6 +59,10 @@ ConsentSingleConsentingAdultRelationshipIncludePatientBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000005" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000010' policy: - authority: 'https://www.england.nhs.uk' uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -86,11 +90,6 @@ ConsentSingleConsentingAdultRelationshipIncludePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000010' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-grantee-patient.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml similarity index 93% rename from specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-grantee-patient.yaml rename to specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml index 978650a7..bf0ce9fb 100644 --- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-grantee-patient.yaml +++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml @@ -1,7 +1,7 @@ -ConsentSingleConsentingAdultRelationshipIncludeGranteePatientBundle: - summary: Single consenting adult proxy relationship with grantee and patient details +ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle: + summary: Single consenting adult proxy relationship with performer and patient details description: - A Bundle containing a single proxy relationship between consenting adults including the grantee and + A Bundle containing a single proxy relationship between consenting adults including the performer and patient details. value: resourceType: Bundle @@ -10,7 +10,7 @@ ConsentSingleConsentingAdultRelationshipIncludeGranteePatientBundle: type: searchset link: - relation: self - url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:grantee&_include=Consent:patient + url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer&_include=Consent:patient entry: - fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/PR974720 resource: @@ -109,6 +109,10 @@ ConsentSingleConsentingAdultRelationshipIncludeGranteePatientBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000005" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000010' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -136,11 +140,6 @@ ConsentSingleConsentingAdultRelationshipIncludeGranteePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000010' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-grantee.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml similarity index 92% rename from specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-grantee.yaml rename to specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml index d798185f..a5d6a85b 100644 --- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-grantee.yaml +++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml @@ -1,7 +1,7 @@ -ConsentSingleConsentingAdultRelationshipIncludeGranteeBundle: - summary: Single consenting adult proxy relationship with grantee details +ConsentSingleConsentingAdultRelationshipIncludePerformerBundle: + summary: Single consenting adult proxy relationship with performer details description: - A Bundle containing a single proxy relationship between consenting adults including the grantee details. + A Bundle containing a single proxy relationship between consenting adults including the performer details. value: resourceType: Bundle timestamp: '2026-01-16T14:00:00+00:00' @@ -9,7 +9,7 @@ ConsentSingleConsentingAdultRelationshipIncludeGranteeBundle: type: searchset link: - relation: self - url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:grantee + url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer entry: - fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/PR974720 resource: @@ -79,6 +79,10 @@ ConsentSingleConsentingAdultRelationshipIncludeGranteeBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000005' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000010' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -106,11 +110,6 @@ ConsentSingleConsentingAdultRelationshipIncludeGranteeBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000010' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml index 7490ea96..5af306e5 100644 --- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml +++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml @@ -30,6 +30,10 @@ ConsentSingleConsentingAdultRelationshipBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000005' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000010' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -57,11 +61,6 @@ ConsentSingleConsentingAdultRelationshipBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000010' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml index f4a5b06f..6dde7fc0 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml @@ -59,6 +59,10 @@ ConsentSingleAdultChildRelationshipIncludePatientBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000009" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000019' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -83,11 +87,6 @@ ConsentSingleAdultChildRelationshipIncludePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000019' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-grantee-patient.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml similarity index 93% rename from specification/examples/responses/GET_Consent/single-mother-child-relationship-include-grantee-patient.yaml rename to specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml index a9004900..adcf3b05 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-grantee-patient.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml @@ -1,7 +1,7 @@ -ConsentSingleAdultChildRelationshipIncludeGranteePatientBundle: - summary: Single adult child proxy relationship with grantee and patient details +ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle: + summary: Single adult child proxy relationship with performer and patient details description: - A Bundle containing a single proxy relationship between an adult and child including the grantee + A Bundle containing a single proxy relationship between an adult and child including the performer and patient details. value: resourceType: Bundle @@ -10,7 +10,7 @@ ConsentSingleAdultChildRelationshipIncludeGranteePatientBundle: type: searchset link: - relation: self - url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:grantee&_include=Consent:patient + url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer&_include=Consent:patient entry: - fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/PR974742 resource: @@ -113,6 +113,10 @@ ConsentSingleAdultChildRelationshipIncludeGranteePatientBundle: system: "https://fhir.nhs.uk/Id/nhs-number" value: "9000000009" dateTime: "2024-07-21T17:32:28Z" + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000019' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -140,11 +144,6 @@ ConsentSingleAdultChildRelationshipIncludeGranteePatientBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000019' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-grantee.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml similarity index 93% rename from specification/examples/responses/GET_Consent/single-mother-child-relationship-include-grantee.yaml rename to specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml index 49a2b430..a42b2624 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-grantee.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml @@ -1,7 +1,7 @@ -ConsentSingleAdultChildRelationshipIncludeGranteeBundle: - summary: Single adult child proxy relationship with grantee details +ConsentSingleAdultChildRelationshipIncludePerformerBundle: + summary: Single adult child proxy relationship with performer details description: - A Bundle containing a single proxy relationship between an adult and child including the grantee details. + A Bundle containing a single proxy relationship between an adult and child including the performer details. value: resourceType: Bundle timestamp: '2026-01-16T14:00:00+00:00' @@ -9,7 +9,7 @@ ConsentSingleAdultChildRelationshipIncludeGranteeBundle: type: searchset link: - relation: self - url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:grantee + url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer entry: - fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/PR974742 resource: @@ -82,6 +82,10 @@ ConsentSingleAdultChildRelationshipIncludeGranteeBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000009' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000019' policy: - authority: "https://www.england.nhs.uk" uri: "https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services" @@ -109,11 +113,6 @@ ConsentSingleAdultChildRelationshipIncludeGranteeBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000019' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-unknown-legal-basis.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-unknown-legal-basis.yaml index 2d80bc74..e78be4d7 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-unknown-legal-basis.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-unknown-legal-basis.yaml @@ -30,6 +30,10 @@ ConsentSingleAdultChildRelationshipUnknownLegalBasisBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000119' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000111' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -60,11 +64,6 @@ ConsentSingleAdultChildRelationshipUnknownLegalBasisBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000111' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml index facfdbc3..130a8c23 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml @@ -30,6 +30,10 @@ ConsentSingleAdultChildRelationshipBundle: system: 'https://fhir.nhs.uk/Id/nhs-number' value: '9000000009' dateTime: '2024-07-21T17:32:28Z' + performer: + - identifier: + system: https://fhir.nhs.uk/Id/nhs-number + value: '9000000019' policy: - authority: 'https://www.england.nhs.uk' uri: 'https://digital.nhs.uk/data-and-information/information-standards/governance/latest-activity/standards-and-collections/dapb3051-identity-verification-and-authentication-standard-for-digital-health-and-care-services' @@ -57,11 +61,6 @@ ConsentSingleAdultChildRelationshipBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: ROLE_CREATED display: Role created - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000019' - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor valueReference: identifier: diff --git a/specification/examples/responses/POST_Consent/errors/invalid_identifier_value.yaml b/specification/examples/responses/POST_Consent/errors/invalid_identifier_value.yaml index 2c8aa423..5d84e212 100644 --- a/specification/examples/responses/POST_Consent/errors/invalid_identifier_value.yaml +++ b/specification/examples/responses/POST_Consent/errors/invalid_identifier_value.yaml @@ -10,8 +10,8 @@ PostConsentInvalidIdentifierValueError: display: Invalid identifier value. system: https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode version: "1" - diagnostics: Grantee identifier value is invalid + diagnostics: Performer identifier value is invalid expression: - - "extension.grantee.valueReference.identifier.value" + - "performer.identifier.value" severity: error resourceType: OperationOutcome diff --git a/specification/validated-relationships-service-api.yaml b/specification/validated-relationships-service-api.yaml index c082cba1..a5aa628a 100644 --- a/specification/validated-relationships-service-api.yaml +++ b/specification/validated-relationships-service-api.yaml @@ -545,7 +545,7 @@ paths: 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:grantee` request parameter to include the proxy's details in the response. + 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. @@ -562,22 +562,22 @@ paths: | Scenario | Request | Response | | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- | - | Multiple proxy relationships filtered by 'active' status including details | `performer:identifier=9000000017&_include=Consent:patient&_include=Consent:grantee&status=active` | HTTP Status 200 Bundle containing a multiple active proxy relationships including grantee and patient details | + | 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 grantee details | `performer:identifier=9000000022&_include=Consent:grantee` | HTTP Status 200 Bundle containing a multiple proxy relationships including grantee 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 grantee and patient details | `performer:identifier=9000000022&_include=Consent:patient&_include=Consent:grantee` | HTTP Status 200 Bundle containing a multiple proxy relationships including grantee and patient details | - | Multiple proxy relationships, single patient | `patient:identifier=9000000100` | HTTP Status 200 Bundle containing a multiple proxy relationships including grantee and patient details | - | Multiple proxy relationships, single patient, including proxy details | `patient:identifier=9000000100&_include=Consent:grantee` | HTTP Status 200 Bundle containing a multiple proxy relationships including proxy 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:grantee` | 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:grantee&status=active` | HTTP Status 200 empty bundle | + | 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:grantee` | HTTP Status 200 Bundle containing a single proxy relationship including grantee and patient details | + | 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:grantee` | HTTP Status 200 Bundle containing a single proxy relationship including grantee and patient details | + | 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 | @@ -621,20 +621,20 @@ paths: $ref: "./examples/responses/GET_Consent/multiple-relationships.yaml#/ConsentMultipleRelationshipsBundle" ConsentMultipleRelationshipsIncludePatientBundle: $ref: "./examples/responses/GET_Consent/multiple-relationships-include-patient.yaml#/ConsentMultipleRelationshipsIncludePatientBundle" - ConsentMultipleRelationshipsIncludeGranteeBundle: - $ref: "./examples/responses/GET_Consent/multiple-relationships-include-grantee.yaml#/ConsentMultipleRelationshipsIncludeGranteeBundle" - ConsentMultipleRelationshipsIncludeGranteePatientBundle: - $ref: "./examples/responses/GET_Consent/multiple-relationships-include-grantee-patient.yaml#/ConsentMultipleRelationshipsIncludeGranteePatientBundle" + ConsentMultipleRelationshipsIncludePerformerBundle: + $ref: "./examples/responses/GET_Consent/multiple-relationships-include-performer.yaml#/ConsentMultipleRelationshipsIncludePerformerBundle" + ConsentMultipleRelationshipsIncludePerformerPatientBundle: + $ref: "./examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml#/ConsentMultipleRelationshipsIncludePerformerPatientBundle" ConsentNoRelationshipsEmptyBundle: $ref: "./examples/responses/GET_Consent/no-relationships.yaml#/ConsentNoRelationshipsEmptyBundle" ConsentSingleConsentingAdultRelationshipBundle: $ref: "./examples/responses/GET_Consent/single-consenting-adult-relationship.yaml#/ConsentSingleConsentingAdultRelationshipBundle" - ConsentSingleConsentingAdultRelationshipIncludeGranteePatientBundle: - $ref: "./examples/responses/GET_Consent/single-consenting-adult-relationship-include-grantee-patient.yaml#/ConsentSingleConsentingAdultRelationshipIncludeGranteePatientBundle" + ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle: + $ref: "./examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml#/ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle" ConsentSingleAdultChildRelationshipBundle: $ref: "./examples/responses/GET_Consent/single-mother-child-relationship.yaml#/ConsentSingleAdultChildRelationshipBundle" - ConsentSingleAdultChildRelationshipIncludeGranteePatientBundle: - $ref: "./examples/responses/GET_Consent/single-mother-child-relationship-include-grantee-patient.yaml#/ConsentSingleAdultChildRelationshipIncludeGranteePatientBundle" + ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle: + $ref: "./examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml#/ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle" ConsentMultipleRelationshipsSinglePatientBundle: $ref: "./examples/responses/GET_Consent/multiple-relationships-single-patient.yaml#/ConsentMultipleRelationshipsSinglePatientBundle" @@ -770,10 +770,10 @@ paths: | HTTP status | Error code | Description | | ----------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | - | 400 | `MISSING_IDENTIFIER_VALUE` | Missing grantee or patient identifier. | - | 400 | `MISSING_IDENTIFIER_SYSTEM` | Missing grantee or patient identifier system. | + | 400 | `MISSING_IDENTIFIER_VALUE` | Missing performer or patient identifier. | + | 400 | `MISSING_IDENTIFIER_SYSTEM` | Missing performer or patient identifier system. | | 400 | `MISSING_PATIENT` | Missing patient. | - | 400 | `MISSING_GRANTEE` | Missing grantee. | + | 400 | `MISSING_PERFORMER` | Missing performer. | | 400 | `MISSING_GRANTOR` | Grantor extension is required when creating or activating an active proxy role. | | 400 | `MISSING_GRANTOR_REFERENCE` | Grantor extension is present but missing valueReference. | | 400 | `MISSING_GRANTOR_IDENTIFIER`| Grantor extension is present but missing valueIdentifier. | @@ -788,10 +788,10 @@ paths: | 405 | `METHOD_NOT_ALLOWED` | The method is not allowed. | | 408 | `TIMEOUT` | Request timed out. | | 409 | `DUPLICATE_RELATIONSHIP` | Conflict with requested proxy role. | - | 422 | `INVALID_IDENTIFIER_VALUE` | Invalid grantee or patient identifier value. | - | 422 | `INVALID_IDENTIFIER_SYSTEM` | Invalid grantee or patient identifier system. | + | 422 | `INVALID_IDENTIFIER_VALUE` | Invalid performer or patient identifier value. | + | 422 | `INVALID_IDENTIFIER_SYSTEM` | Invalid performer or patient identifier system. | | 422 | `INVALID_PATIENT` | Invalid patient. | - | 422 | `INVALID_GRANTEE` | Invalid grantee. | + | 422 | `INVALID_PERFORMER` | Invalid performer. | | 422 | `INVALID_STATUS` | Invalid status. | | 422 | `INVALID_SCOPE` | Invalid scope. | | 422 | `INVALID_CATEGORY` | Invalid category. | @@ -863,7 +863,7 @@ paths: ## 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:grantee` request parameter to include the proxy's details in the response. + 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. @@ -881,12 +881,12 @@ paths: | -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | Retrieve single consenting adult relationship | Valid request with ID `74eed847-ca25-4e76-8cf2-f2c2d7842a7a` | HTTP Status 200 Bundle containing a single active proxy relationship | | Retrieve single consenting adult relationship with patient details | Valid request with ID `74eed847-ca25-4e76-8cf2-f2c2d7842a7a?_include=Consent:patient` | HTTP Status 200 Bundle containing a single active proxy relationship with patient details | - | Retrieve single consenting adult relationship with grantee details | Valid request with ID `74eed847-ca25-4e76-8cf2-f2c2d7842a7a?_include=Consent:grantee` | HTTP Status 200 Bundle containing a single active proxy relationship with grantee details | - | Retrieve single consenting adult relationship with grantee and patient details | Valid request with ID `74eed847-ca25-4e76-8cf2-f2c2d7842a7a?_include=Consent:grantee&_include=Consent:patient` | HTTP Status 200 Bundle containing a single active proxy relationship with grantee and patient details | + | Retrieve single consenting adult relationship with performer details | Valid request with ID `74eed847-ca25-4e76-8cf2-f2c2d7842a7a?_include=Consent:performer` | HTTP Status 200 Bundle containing a single active proxy relationship with performer details | + | Retrieve single consenting adult relationship with performer and patient details | Valid request with ID `74eed847-ca25-4e76-8cf2-f2c2d7842a7a?_include=Consent:performer&_include=Consent:patient` | HTTP Status 200 Bundle containing a single active proxy relationship with performer and patient details | | Retrieve single mother-child relationship | Valid request with ID `39df03a2-1b14-4d19-b1dc-d5d8cbf96948` | HTTP Status 200 Bundle containing a single active proxy relationship | | Retrieve single mother-child relationship with patient details | Valid request with ID `39df03a2-1b14-4d19-b1dc-d5d8cbf96948?_include=Consent:patient` | HTTP Status 200 Bundle containing a single active proxy relationship with patient details | - | Retrieve single mother-child relationship with grantee details | Valid request with ID `39df03a2-1b14-4d19-b1dc-d5d8cbf96948?_include=Consent:grantee` | HTTP Status 200 Bundle containing a single active proxy relationship with grantee details | - | Retrieve single mother-child relationship with grantee and patient details | Valid request with ID `39df03a2-1b14-4d19-b1dc-d5d8cbf96948?_include=Consent:grantee&_include=Consent:patient` | HTTP Status 200 Bundle containing a single active proxy relationship with grantee and patient details | + | Retrieve single mother-child relationship with performer details | Valid request with ID `39df03a2-1b14-4d19-b1dc-d5d8cbf96948?_include=Consent:performer` | HTTP Status 200 Bundle containing a single active proxy relationship with performer details | + | Retrieve single mother-child relationship with performer and patient details | Valid request with ID `39df03a2-1b14-4d19-b1dc-d5d8cbf96948?_include=Consent:performer&_include=Consent:patient` | HTTP Status 200 Bundle containing a single active proxy relationship with performer and patient details | ### Sandbox constraints @@ -913,18 +913,18 @@ paths: $ref: "./examples/responses/GET_Consent/single-consenting-adult-relationship.yaml#/ConsentSingleConsentingAdultRelationshipBundle" ConsentSingleConsentingAdultRelationshipIncludePatientBundle: $ref: "./examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml#/ConsentSingleConsentingAdultRelationshipIncludePatientBundle" - ConsentSingleConsentingAdultRelationshipIncludeGranteeBundle: - $ref: "./examples/responses/GET_Consent/single-consenting-adult-relationship-include-grantee.yaml#/ConsentSingleConsentingAdultRelationshipIncludeGranteeBundle" - ConsentSingleConsentingAdultRelationshipIncludeGranteePatientBundle: - $ref: "./examples/responses/GET_Consent/single-consenting-adult-relationship-include-grantee-patient.yaml#/ConsentSingleConsentingAdultRelationshipIncludeGranteePatientBundle" + ConsentSingleConsentingAdultRelationshipIncludePerformerBundle: + $ref: "./examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml#/ConsentSingleConsentingAdultRelationshipIncludePerformerBundle" + ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle: + $ref: "./examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml#/ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle" ConsentSingleAdultChildRelationshipBundle: $ref: "./examples/responses/GET_Consent/single-mother-child-relationship.yaml#/ConsentSingleAdultChildRelationshipBundle" ConsentSingleAdultChildRelationshipIncludePatientBundle: $ref: "./examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml#/ConsentSingleAdultChildRelationshipIncludePatientBundle" - ConsentSingleAdultChildRelationshipIncludeGranteeBundle: - $ref: "./examples/responses/GET_Consent/single-mother-child-relationship-include-grantee.yaml#/ConsentSingleAdultChildRelationshipIncludeGranteeBundle" - ConsentSingleAdultChildRelationshipIncludeGranteePatientBundle: - $ref: "./examples/responses/GET_Consent/single-mother-child-relationship-include-grantee-patient.yaml#/ConsentSingleAdultChildRelationshipIncludeGranteePatientBundle" + ConsentSingleAdultChildRelationshipIncludePerformerBundle: + $ref: "./examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml#/ConsentSingleAdultChildRelationshipIncludePerformerBundle" + ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle: + $ref: "./examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml#/ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle" "4XX": description: | @@ -2342,8 +2342,7 @@ components: maxItems: 1 items: $ref: "#/components/schemas/Reference" - description: "Deprecated. Instead use the Grantee Extension." - deprecated: true + description: "Individuals or organizations that agreed to the consent." policy: type: array items: @@ -2359,7 +2358,6 @@ components: items: anyOf: - $ref: "#/components/schemas/StatusReasonExtension" - - $ref: "#/components/schemas/GranteeExtension" - $ref: "#/components/schemas/GrantorExtension" description: "Additional content. For active proxy roles, grantor is required." @@ -2435,18 +2433,6 @@ components: valueCodeableConcept: $ref: "#/components/schemas/CodeableConcept" description: Classification of the status. - GranteeExtension: - type: object - properties: - url: - type: string - enum: - - "https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee" - valueReference: - properties: - identifier: - $ref: "#/components/schemas/Identifier" - description: Details for proxy. GrantorExtension: type: object @@ -2778,20 +2764,20 @@ components: items: type: string enum: - - "Consent:grantee" + - "Consent:performer" - "Consent:patient" default: - - "Consent:grantee" + - "Consent:performer" - "Consent:patient" examples: FullInclude: - summary: Include the grantee (proxy) and patient in the bundle + summary: Include the performer (proxy) and patient in the bundle value: - - "Consent:grantee" + - "Consent:performer" - "Consent:patient" - IncludeGrantee: - summary: Include the grantee (proxy) in the bundle - value: Consent:grantee + IncludePerformer: + summary: Include the performer (proxy) in the bundle + value: Consent:performer IncludePatient: summary: Include the patient in the bundle value: Consent:patient