{"openapi":"3.0.0","info":{"contact":{"email":"api.management@nhs.net","name":"Validated Relationships Service API Support","url":"https://digital.nhs.uk/developer/help-and-support"},"description":"## Overview\nThis service underpins the National Proxy Programme whose core objective is to allow Patients to be supported with\ntheir healthcare by someone they trust (a Proxy) as part of a digitally-enabled journey. The service has two core\nuses. Firstly, it surfaces verified candidate relationships (i.e. indicates suitable Proxies for a Patient such as\nBirth Mothers) to support GPâs decision-making when granting Proxy access. Secondly, it supports the subsequent\ncreation, use and management of Proxy roles which are stored in a central, national database. The Proxy roles held\nby the database are strictly for the purpose of enabling access to healthcare services, initially in Primary Care.\n\nWith this service you can:\n\n- Create a new Proxy access request (Submit an online application via NHS App)\n- View Pending Proxy access requests\n- Get verified candidate relationships (to support decision making when granting proxy access)\n- Create a Proxy role\n- Get Proxy roles\n- Get a Proxy role by ID\n- Update (or revoke) a Proxy role\n\n## Who can use this API\nThis API can only be used where there is a legal basis to do so. Make sure you have this and a valid use case before\nyou go too far with your development by [contacting us](https://digital.nhs.uk/developer/help-and-support).\n\nYou must do this before you can go live (see the 'Onboarding' section below).\n\n## Related APIs\nThe following APIs are related to this API:\n\n- [Personal Demographics Service - FHIR API](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir) - we use the data held in PDS as a source of data to verify relationships.\n\n## API status and roadmap\nThis API is [in production, beta](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses), meaning:\n- we might make breaking changes, but only if we cannot avoid it, and we will give advance notice\n\n## Service level\nThis API is a bronze service, meaning it is operational and supported only during business hours (8am to 6pm), Monday to Friday excluding bank holidays.\n\nFor more details, see [service levels](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#service-levels).\n\n## Technology\nThis API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest).\n\nIt conforms to the [FHIR](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#fhir) global standard for health care data exchange, specifically to [FHIR R4 (v4.0.1)](https://hl7.org/fhir/r4/), except that it does not support the [capabilities](http://hl7.org/fhir/R4/http.html#capabilities) interaction.\n\nIt includes some country-specific FHIR extensions, which are built against [FHIR UK Core](https://digital.nhs.uk/services/fhir-uk-core), specifically [UK.core.r4 1.0.0](https://simplifier.net/packages/uk.core.r4/1.0.0).\n\nYou do not need to know much about FHIR to use this API - FHIR APIs are just RESTful APIs that follow specific rules.\nIn particular:\n- resource names are capitalised and singular, for example `/RelatedPerson` not `/relatedpersons`\n- array names are singular, for example `name` not `names` for the recorded names of a patient\n\nThere are [libraries and SDKs available](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) to help with FHIR API integration.\n\n## Guidance for developers\n\nSupplementary documentation and guidance for developers:\n\n- National Proxy Service developer documentation (link to be added)\n\n## Network access\nThis API is available on the internet.\n\nFor more details see [Network access for APIs](https://digital.nhs.uk/developer/guides-and-documentation/network-access-for-apis).\n\n## Security and authorisation\n\nThis API supports both [user-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis) and [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis) access types with the following access modes:\n\n| Access mode | Access type |\n|-------------------------------|------------------------|\n| Patient access | User-restricted |\n| Healthcare worker access | User-restricted |\n| Application-restricted access | Application-restricted |\n\nFor more information on access modes and how to use them, see the developer [security and authorisation guide](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation).\n\nEach API operation section of this documentation indicates the access modes that the endpoint supports.\n\n### User-restricted access\n\nUser-restricted access meaning an end user must be present, authenticated and authorised.\n\n#### Patient access mode\nIf the end user is a patient then you must use this access mode.\n\n[Review all patient access modes](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#patient-access-mode)\n\nAll API endpoints that support this access mode require that the user has proven their identity to a high level\nand authenticated using strong authentication credentials. The combination of these forms a [Vector of Trust](https://nhsconnect.github.io/nhslogin/vectors-of-trust/) profile.\n\nAllowed vectors of trust are:\n- `P9.Cp.Cd`\n- `P9.Cp.Ck`\n- `P9.Cm`\n\n#### Healthcare worker access mode\nIf the end user is a healthcare worker then you must use this access mode. All API endpoints that support this\naccess mode require that the user has been authenticated with a \"very high confidence\" authenticator ([AAL3](https://digital.nhs.uk/services/care-identity-service/applications-and-services/cis2-authentication/integrate/design-and-build/authenticator-guidance-for-developers)).\n\n[Review all CIS2 healthcare worker access modes](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#healthcare-worker-access-mode)\n\n### Application-restricted access\n\nThis API is application-restricted, meaning we authenticate the calling application but not the end user. This\nshould only be utilised where user-restrcited access modes are not feasible or practical.\n\n[Review all application-restricted access modes](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis)\n\n## Headers\nThis API is case-insensitive when processing request headers, meaning it will accept headers regardless of the letter casing used. (e.g. X-Request-Id, x-request-id are treated the same). When sending headers back in the response, we preserve the exact casing as received in the original request.\n\n## Errors\nWe use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:\n\n* 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action\n* 400 to 499 if it failed because of a client error by your application\n* 500 to 599 if it failed because of an error on our server\n\nErrors specific to each API are shown in the Operations section. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more information on errors.\n\n## Open source\nYou might find the following [open source](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#open-source) resources useful:\n\n| Resource | Description | Links |\n| -------------------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Validated Relationships FHIR API | Source code for the API proxy, sandbox and specification. | [GitHub repo](https://github.com/NHSDigital/validated-relationships-service-api) |\n| FHIR libraries and SDKs | Various open source libraries for integrating with FHIR APIs. | [FHIR libraries and SDKs](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) |\n| nhs-number | Python package containing utilities for NHS numbers including validity checks, normalisation and generation. | [GitHub repo](https://github.com/uk-fci/nhs-number) \\| [Python Package index](https://pypi.org/project/nhs-number/) \\| [Docs](https://nhs-number.uk-fci.tech/) |\n\nWe currently don't have any open source client libraries or sample code for this API and the source code for the Validated Relationship Service FHIR application is not currently in the open. If you think this would be useful, [contact us](https://digital.nhs.uk/developer/help-and-support).\n\n## Environments and testing\n| Environment | Base URL |\n| ----------------- | ------------------------------------------------------------------------------------ |\n| Sandbox | `https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/` |\n| Integration test | `https://int.api.service.nhs.uk/validated-relationships/FHIR/R4/` |\n| Production | `https://api.service.nhs.uk/validated-relationships/FHIR/R4/` |\n\n### Sandbox testing\nOur [sandbox environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing)\n\n* is for early developer testing\n* only covers a limited set of scenarios\n* is open access, so does not allow you to test authorisation\n\n[](https://raw.githubusercontent.com/NHSDigital/validated-relationships-service-api/master/postman/validated_relationship_service.sandbox.postman_collection.json)\n\nImport the postman collection to run requests against sandbox.\n\n### Integration testing\n\nOur [integration test environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing)\n\n* is for formal integration testing\n* requires authorisation using a supported access mode\n\n[![\"Run](\"https://run.pstmn.io/button.svg\")
](https://app.getpostman.com/run-collection/50544839-b6783b4e-de59-42c6-a80e-72cf64fa5ec9?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D50544839-b6783b4e-de59-42c6-a80e-72cf64fa5ec9%26entityType%3Dcollection%26workspaceId%3D082e43b8-9a51-4a16-af66-0d2b233cd69c#?env%5BINT%5D=[{"key":"cis2_token","value":"","enabled":true,"type":"secret","sessionValue":"qMBvg5UHwI1sy7QlxYKPsUqzFhAr","completeSessionValue":"qMBvg5UHwI1sy7QlxYKPsUqzFhAr","sessionIndex":0},{"key":"login_token","value":"","enabled":true,"type":"secret","sessionValue":"j9w15LLkUcmks9MysAGljfMoK0gF","completeSessionValue":"j9w15LLkUcmks9MysAGljfMoK0gF","sessionIndex":1},{"key":"api_base_url","value":"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4","enabled":true,"type":"default","sessionValue":"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4","completeSessionValue":"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4","sessionIndex":2},{"key":"vrs_api_private_key","value":"","enabled":true,"type":"secret","sessionValue":"-----BEGIN PRIVATE...","completeSessionValue":"-----BEGIN PRIVATE KEY-----\\nMIIJQQIBADANBgkqhkiG9w0BAQEFAASCCSswggknAgEAAoICAQDU08aPbVrLQGDw\\nLa66SXySssXSgEVkuyqoWTbFmeeWFUilywLK0jui4ir29WUZujj6kt5h90WZ0DyJ\\niwIOe9bPuYgmtvjoQciVgRvQBxRVXc8IRyoyEgWJXeX1QuOTUUXFpOeseAr9rWyx\\nbU50zMMLZ7DKHwYePiMdmshLhPb6mgRpGPizlxRCQqzDbqW8tDC5ahZaCyPmqahJ\\naqiK82AcimnO/Qge1cwRJ0kLSgtdnmKxFTZonnV9bIsl05Hks37GOzKpzdKtpPYv\\naBhhYUFscn2Gx+Rlhpj6QgRKep5JCQsuS11mBJ3a6eVCEyYkuNtytYXxiPvarXVN\\nUdZHCKMozcqJMLzWfUJAoTXkp1RwEDdl5sLyO9lnfXNtvJbLv8hAjSIOO/cEB8bK\\nVerWb9npK19xqxRF3Du2b8WpynG0EigmM+IUnEXB6LUCqYjbV9tz33T0R3Pdhx4X\\nF8vKsXv6WCXUyUZKMJ/AU02svobYmWrp91DtGbw/XgJEf0aIU2K3ZLdT75yEdOXz\\n++aY5m7V23lJAB83Sz8OTuAmb2Gdcr/WlXEHz4nqvk4mPRSzsqaUzpW8JrKWAGBL\\nSRtmU8uaHgY0yahFzH5kM7/hkSSA6hyDih1qy90J2Q7K4CW+lOKndNa6ZA8teSAc\\nnwtpyh0VI/rwp7MDneVy/LuCWQSGNwIDAQABAoICAE77HIfjnDsrdA4N1fb6CInk\\nYDeDNL1yHB2HpiTkvaXb1i74zNt583m6Fxm47cEDc9vBn1eZzTGMrrqYZLX9TTWf\\nc6BybKK8rvSUij7EMc6QVqGKz2TvfTCCMTG4lf34vjzfur4tel6z+k9J8kC0MHnO\\nDDSmGL4mbx+wbj5gZMuRVquuAbWcDn+cgMKyED2cXSyh6xOVaMhUE8jTFSMjuHo+\\n/486JcZTrzx6aMgQvXELszJmXd+rVoyqOGVcQ5ss5ZIpK98KK/IW8uma5tlUn1Pg\\nlSbsjZ0Du0e8Mh11rcIK4iRXAZ03f2FbRaIkuxYLqBzEsqV1IYoArzR3d167HNj9\\nbBbaxIWOp4ARjsSPr3rC2eMItvo8x8ecTnigieKebIrUs/q1/A4abeYzbONoRYXd\\npYG8A0yESGXjCyGvmvC/Y+CHiJbU5pvJCCQO/TseGmDwCz6MINWN+sJZZGiNbu2z\\nz2F3FTVRxU9S8WQWsbflE282ZbyT3X75uMS3dnYN3mkp56k/FBdYvfS8S7Em/3NZ\\nNdmKn2/7BpydEZJOQb+HHuRmankOXTEfQOZPNRmxESSVPrDifLiXK8S2+YooAvDD\\n/jwo8mkqNeUcD99aYkaNNv4rKh6iF+RfhoJo9hqH9QBGk0PfzMnr7L4AaMptdKWn\\n+CK/2nGUWqfmeHYjavNhAoIBAQDsBAHSOhWCByEAOY4gnoxOgorx2B9GFORtNjQ+\\nxm1uxgpyjk5DaT+4ACWZES/uskbHSWCnU+e1yMZ1StQ9fZGpcrVjngFI9tLTmwVg\\nsrlpPjVCiGKT3Gs2CChv6pzybtcwSDBV5XlEdMrvfEADPDiDBgd5rNPUFaB3IT2c\\niRG2SzT1FEcf0MT4x72d/1QHmhhTZ0OkLDI2sHN89Wr4kCS+QxNXf6XzsQyCZpj+\\nOwdIg3uyiRDhx/GmwP0UtbsurRgwKqUZf+iktwZtGbjzC+YZjaMOsX7dY3aHU247\\nvCoFg9mdmggWt37twRY0lcJzszb0/W6n03MpjyruHNtl+HKRAoIBAQDm2SAHDslp\\nJvLHByhH/zKfpf50RRLQBYlo3cFpflwPhoIr+npn3hFghcly1My7mxSt4RXvb6ZU\\noH3c2Wl+ocFQll5+gphriMbl/QrRxm/0+if3pQ+Dc+S5emNH7Z7xfH09LglDQd2j\\nVSUyINz9P6wW0noo9fgkCns/mAZ5BtrZIGdOvB8Az7Y2mhYiR8FM11jdlKDyo1fU\\ndW4/CWv8KNlgSVEziL1PMptORZ2aArm6Y19wfupkG+GZ8TK0CAS0NP5AQ8l2eEZ0\\nfaPAo5NQ1FsIf1jgIVOpcM1wVPTMqHI8CAQFnnTHE/CueoJIaRkWksKBKFHNNc8N\\n0q8oJCVAMMBHAoIBAHRwgamDKItPExP2UU18i0JMm1o3wy4jLpNG872ozeKh6BOe\\na7RMX7hasjHzTc+YutylMf87oQyJcof5k/6GTe/ofN8Z3A5wX5EwYRXU9y6aF1Ks\\n0N2cGHS+z5xvhmEBGD9kzhwCq7J/YIOIrFgsRME3n0aDYrq2tMUxbCEnasqiDg1/\\npJtot1T5zm39wypA9xFm1/NOLrPWmBOlTNI24znPA+LeQjSZO8+16HM9EhnPbJ6n\\niuGpcGpRukqWYjPkCBPzZiLPfSqOdagr0ZhvXWVsAG9GWI3G/XpEShVEfwLbiuh7\\nTtROUVvhMCBfZmEIoOt7gTVhV+bAEHELYZ7MVVECggEAfH/jLwtBgs13p/FrPxEa\\nK1Hp3qkWEUy7I+xdEFkOq2zerXtEItp4QrdEwwKTfCaSS4iWPPDZItD/sGks5Re1\\n25GNWutx6qT0qDsFZ8d+v/9eKMhDiqCpXYLtInC8BP8fyCwY4MYYE6urCNMCfC6n\\n0BMpwQePEVj5yX1jGEijJPC95o+8pMJhQiduAoTyck+95JrxBosjpjjDAYpCS9d4\\nDN7dxU5c0ua3LcqLyfDoW+aWJWS9YspKrKyRrNiaONpPuTcV4yfQz6im9REDNVeh\\n1P5hX1d5+GsW0RtwfyPloAyupp0j2+4cIu19cDIGTs9NyTyGiYcYqRrUTnDYCjuA\\npwKCAQAWxQxWBzNvx/ZMdYP+J7y7wT9ScRXdty2TilRtulSLjFfluntBqAue5eY6\\n5cHMDjw7Oej8fhQWt3vb/qPpDywh9tSKHBGBqYtI+sBEv7nKj5G/NuVYHX8En8po\\nsZSRza/qqxwRL6mhzi49F8J9dgYXrKS9z9JCi1YEIBW05cLiTY9dVb8fEm0r2YM8\\nBNf454Le4mSZrRN4h0nDL7Lg7LLZyyo9KVcsYCHnkCaFU3MKCeNzydF8azrgadSo\\nqC32nLbH1Y0SyRhE3Q39YCUeFzNYo9wwynzefjFupsrrCqhAOe1gC+Q1124tFMZu\\nKEHw2ABBEOW+MN2vFWpFyZpeTx9N\\n-----END PRIVATE KEY-----","sessionIndex":3},{"key":"nhs_developer_account_api_key","value":"","enabled":true,"type":"secret","sessionValue":"4hwivpJAZIqvpJlAWOctRXCSgUMlwZuK","completeSessionValue":"4hwivpJAZIqvpJlAWOctRXCSgUMlwZuK","sessionIndex":4},{"key":"consent_app_auth_header_value","value":"","enabled":true,"type":"secret","sessionValue":"CSVcbotAQGbhLqGZn1VTFGcQntAE","completeSessionValue":"CSVcbotAQGbhLqGZn1VTFGcQntAE","sessionIndex":5},{"key":"tpp_9674998535_access_token","value":"","enabled":true,"type":"secret","sessionValue":"{\"AccountId\":\"552869834\",\"Passphrase\":\"vRJqu139d7dverZg+8eW7vWFSCaSnwAWFR6Y4tYXjP7/uFSgtv7k2IOwA478OWp7ZDq4MBYC6hcTITErnNwgbxVm7VZ8f3QUnL...","completeSessionValue":"{\"AccountId\":\"552869834\",\"Passphrase\":\"vRJqu139d7dverZg+8eW7vWFSCaSnwAWFR6Y4tYXjP7/uFSgtv7k2IOwA478OWp7ZDq4MBYC6hcTITErnNwgbxVm7VZ8f3QUnLPWh+4K7EP5i/4K0AdGZ0IK0Uw7+C7XZc7FHg8RScIjh+2MqF7vuZ44umePvg8eSM48WR8K4XE=\",\"ProviderId\":\"b891fc3b51d5e7c1\",\"Im1CacheKey\":\"z8ElCDI3e1slWLbZsIRUwihy8WZFscr2dPmTfUui+gAqQ7Zh0WPVIXo/M9DuEVzO3XaFOpbB3wc9yhAUhAZhUg==\"}","sessionIndex":6},{"key":"tpp_9674998454_access_token","value":"","enabled":true,"type":"secret","sessionValue":"{\"AccountId\":\"858803203\",\"Passphrase\":\"JW4HsrWMl4HHMjlx9BIUnsS5uBJfqAlZy4/eYmKwku9UFQ/LACmOGmmXbd8oyUFb0v74MxnEf+9zQWOA44AKOIt7lKEvRIo5Mc...","completeSessionValue":"{\"AccountId\":\"858803203\",\"Passphrase\":\"JW4HsrWMl4HHMjlx9BIUnsS5uBJfqAlZy4/eYmKwku9UFQ/LACmOGmmXbd8oyUFb0v74MxnEf+9zQWOA44AKOIt7lKEvRIo5McB5NjvZNBBihLLO67Oq6oJcLylzCG1ZeHjLIx12kRt0nVDsvjCb216nFnDbOf5i1AaXmpStUHc\\u003d\",\"ProviderId\":\"b891fc3b51d5e7c1\",\"Im1CacheKey\":\"k0YOYWsTtmxgkVZSYp5ay+hGzyF2YHSpA6bzqA6G87b9kqn+GO/WCq4DTbCdHHhdRfBEXae8TShGkii8KuBwwA\\u003d\\u003d\"}","sessionIndex":7},{"key":"emis_9692113698_access_token","value":"","enabled":true,"type":"secret","sessionValue":"{\"Im1CacheKey\":\"WujPlHL3F+JxIJQx7FPDwico+6VjeDazwf7vyoukS4og6FyeeqqIIUJEUu/3DvYFIcAEAzqDvNa1y6Pf7FX9Cw==\",\"AccessIdentityGuid\":\"79e83929-...","completeSessionValue":"{\"Im1CacheKey\":\"WujPlHL3F+JxIJQx7FPDwico+6VjeDazwf7vyoukS4og6FyeeqqIIUJEUu/3DvYFIcAEAzqDvNa1y6Pf7FX9Cw==\",\"AccessIdentityGuid\":\"79e83929-ab77-4266-b1b9-fc7b823c1525\"}","sessionIndex":8},{"key":"emis_9692113612_access_token","value":"","enabled":true,"type":"secret","sessionValue":"{\"Im1CacheKey\":\"C8AvaxJtb6Z2QezcRzQ3YJklTeIUmSczcAz2z5kkCk9O644vUjWm/yBsEazsHmflOOEu00esr/llCOh8G43mcA==\",\"AccessIdentityGuid\":\"217ef6f1-...","completeSessionValue":"{\"Im1CacheKey\":\"C8AvaxJtb6Z2QezcRzQ3YJklTeIUmSczcAz2z5kkCk9O644vUjWm/yBsEazsHmflOOEu00esr/llCOh8G43mcA==\",\"AccessIdentityGuid\":\"217ef6f1-1d70-4a8e-b728-664316c75654\"}","sessionIndex":9}])\n## Onboarding\n\nYou need to get your software approved by us before it can go live with this API. We call this onboarding. The onboarding process can sometimes be quite long, so it's worth planning well ahead.\n\nAs part of this process, you need to demonstrate your technical conformance to the requirements for this API.\n\nYou also need to demonstrate that you can manage risks. This might impact the design of your software.\n\nTo understand how our online digital onboarding process works, see [digital onboarding](https://digital.nhs.uk/developer/guides-and-documentation/digital-onboarding).\n\n## Contact us\n\nFor help and support connecting to our APIs and to join our developer community, see [Help and support building healthcare software](https://digital.nhs.uk/developer/help-and-support).\n","title":"Validated Relationships Service API","version":"1.22.0"},"servers":[{"description":"Sandbox environment.","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4"},{"description":"Integration test environment.","url":"https://int.api.service.nhs.uk/validated-relationships/FHIR/R4"},{"description":"Production environment.","url":"https://api.service.nhs.uk/validated-relationships/FHIR/R4"}],"paths":{"/QuestionnaireResponse":{"post":{"description":"## Overview\nFor any new access request, the necessary details should be collected from a user facing service e.g.\nProxy Access Service and submitted as a QuestionnaireResponse.\n\n## Access modes\n\nThis endpoint supports the following access modes:\n\n- Patient access\n\n## Sandbox test scenarios:\n\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario | Request | Response |\n| ---------------------- | ------------------------------------------------------------------------------------------- | -----------------------------------------------|\n| Successful request | Valid request with performer identifier value of `9000000009` or `9000000017` | HTTP Status 200 Success response |\n| Duplicate proxy role | Request for proxy role that already exists, with performer identifier value of `9000000049` | HTTP Status 409 and DUPLICATE error response |\n\n\n### Sandbox constraints\n\nThe sandbox environment has the following constraints for this endpoint:\n\n- QuestionnaireResponse is not validated.\n- Request headers are not tested. `X-Request-ID` and `X-Correlation-ID` are disregarded.\n- No access request is created.\n","operationId":"new-access-request","parameters":[{"description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis).\n","explode":false,"in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM","format":"^Bearer\\ [[:ascii:]]+$","type":"string"},"style":"simple"},{"description":"A globally unique identifier (GUID) for the request, which we use to correlate logs through different components.\nMust be a universally unique identifier (UUID) (ideally version 4).\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Request-ID","required":true,"schema":{"example":"60e0b220-8136-4ca5-ae46-1d97ef59d068","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"},{"description":"An optional ID which you can use to track transactions across multiple systems.\nMust be a universally unique identifier (UUID) (ideally version 4).\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Correlation-ID","required":false,"schema":{"example":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/fhir+json":{"examples":{"questionnaireResponseMotherChildRequest":{"$ref":"#/components/examples/QuestionnaireResponseMotherChildRequest"},"questionnaireResponseAdultToAdultWithoutCapacityRequest":{"$ref":"#/components/examples/QuestionnaireResponseAdultToAdultWithoutCapacityRequest"},"questionnaireResponseAdultToAdultWithCapacityRequest":{"$ref":"#/components/examples/QuestionnaireResponseAdultToAdultWithCapacityRequest"},"questionnaireResponseAdultNominatesAdultRequest":{"$ref":"#/components/examples/QuestionnaireResponseAdultNominatesAdultRequest"},"questionnaireResponseDuplicateRelationship":{"$ref":"#/components/examples/QuestionnaireResponseDuplicateRelationship"}},"schema":{"$ref":"#/components/schemas/QuestionnaireResponse"}},"application/fhir+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/QuestionnaireResponse"}}},"required":true},"responses":{"200":{"content":{"application/fhir+json":{"examples":{"postQuestionnaireResponseSuccess":{"$ref":"#/components/examples/PostQuestionnaireResponseSuccess"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Request was received successfully for processing","headers":{"location":{"description":"URL for the newly created access request","explode":false,"schema":{"example":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse/156e1560-e532-4e2a-85ad-5aeff03dc43e","type":"string"},"style":"simple"}}},"4XX":{"content":{"application/fhir+json":{"examples":{"accessDeniedError":{"$ref":"#/components/examples/AccessDeniedError"},"postQuestionnaireResponseDuplicateRelationshipError":{"$ref":"#/components/examples/PostQuestionnaireResponseDuplicateRelationshipError"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Errors will be returned for the first error encountered in the request. An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| 400 | `MISSING_VALUE` | Missing header or parameter. For details, see the `diagnostics` field. |\n| 400 | `INVALID_VALUE` | Invalid Parameter or Invalid operation. |\n| 400 | `BAD_REQUEST` | Failed questionnaire response validation |\n| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |\n| 403 | `FORBIDDEN` | Access denied to resource. |\n| 405 | `METHOD_NOT_ALLOWED` | The method is not allowed. |\n| 408 | `TIMEOUT` | Request timed out. |\n| 409 | `DUPLICATE_RELATIONSHIP` | A proposed proxy role already exists for this proxy/patient relationship. |\n| 415 | `UNSUPPORTED_MEDIA` | Unsupported media type. |\n| 429 | `THROTTLED` | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |\n"},"5XX":{"content":{"application/fhir+json":{"examples":{"internalServerError":{"$ref":"#/components/examples/InternalServerError"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Errors will be returned for the first error encountered in the request. An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------- | ------------------------------------------------------------ |\n| 500 | `SERVER_ERROR` | An unexpected internal server error has occurred. |\n| 502 | `BAD_GATEWAY` | Connection to the backend service failed. |\n"}},"summary":"New Access request"}},"/QuestionnaireResponse/{id}":{"get":{"description":"## Overview\nRetrieve a QuestionnaireResponse using its unique access request ID. This endpoint returns the full\nQuestionnaireResponse document that was previously submitted.\n\n## Request Requirements\nA valid access request ID must be provided as a path parameter.\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| Valid access request ID | ID value: `156e1560-e532-4e2a-85ad-5aeff03dc43e` | HTTP Status 200 with QuestionnaireResponse |\n| Invalid access request ID | ID value: `INVALID` | HTTP Status 400 with INVALID_IDENTIFIER_VALUE message |\n| Missing access request ID | No ID path parameter | HTTP Status 405 with METHOD_NOT_ALLOWED message |\n| Non-existent access request ID | ID value: `60d09b82-f4bb-41f9-b41e-767999b4ac9b` | HTTP Status 404 with QUESTIONNAIRE_RESPONSE_NOT_FOUND message |\n\n### Sandbox constraints\n\nThe sandbox environment has the following constraints for this endpoint:\n\n - Request headers are not tested. For example, `X-Request-ID` and `X-Correlation-ID` are disregarded.\n","operationId":"get-questionnaire-response","parameters":[{"description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis).\n","explode":false,"in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM","format":"^Bearer\\ [[:ascii:]]+$","type":"string"},"style":"simple"},{"description":"A globally unique identifier (GUID) for the request, which we use to correlate logs through different components.\nMust be a universally unique identifier (UUID) (ideally version 4).\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Request-ID","required":true,"schema":{"example":"60e0b220-8136-4ca5-ae46-1d97ef59d068","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"},{"description":"An optional ID which you can use to track transactions across multiple systems.\nMust be a universally unique identifier (UUID) (ideally version 4).\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Correlation-ID","required":false,"schema":{"example":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"},{"description":"The unique access request ID of the QuestionnaireResponse to retrieve","explode":false,"in":"path","name":"id","required":true,"schema":{"example":"156e1560-e532-4e2a-85ad-5aeff03dc43e","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/fhir+json":{"examples":{"getQuestionnaireResponseSuccess":{"$ref":"#/components/examples/GetQuestionnaireResponseSuccess"}},"schema":{"$ref":"#/components/schemas/QuestionnaireResponse"}}},"description":"QuestionnaireResponse successfully retrieved."},"4XX":{"content":{"application/fhir+json":{"examples":{"invalidAccessRequestID":{"$ref":"#/components/examples/InvalidAccessRequestID"},"missingAccessRequestID":{"$ref":"#/components/examples/MethodNotAllowedError"},"questionnaireResponseNotFound":{"$ref":"#/components/examples/QuestionnaireResponseNotFound"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Errors will be returned for the first error encountered in the request. An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| 400 | `INVALID_IDENTIFIER_VALUE` | The access request ID must be a valid uuid. |\n| 400 | `INVALID_VALUE` | Invalid Parameter or Invalid operation. |\n| 400 | `BAD_REQUEST` | The access request ID is required but was not provided in the request. |\n| 400 | `MISSING_VALUE` | Missing header or parameter. For details, see the `diagnostics` field. |\n| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |\n| 403 | `FORBIDDEN` | Access denied to resource. |\n| 404 | `QUESTIONNAIRE_RESPONSE_NOT_FOUND` | No questionnaire response was found for the provided access request ID. |\n| 405 | `METHOD_NOT_ALLOWED` | The method is not allowed. |\n| 408 | `TIMEOUT` | Request timed out. |\n| 429 | `THROTTLED` | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |\n"},"5XX":{"content":{"application/fhir+json":{"examples":{"internalServerError":{"$ref":"#/components/examples/InternalServerError"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Errors will be returned for the first error encountered in the request. An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------- | ------------------------------------------------------------ |\n| 500 | `SERVER_ERROR` | An unexpected internal server error has occurred. |\n| 501 | `NOT_IMPLEMENTED` | API Endpoint not implemented. |\n| 502 | `BAD_GATEWAY` | Connection to the backend service failed. |\n| 503 | `DOWNSTREAM_SERVICE_ERROR` | Failed to generate response |\n"}},"summary":"Get a proxy access request"}},"/RelatedPerson":{"get":{"description":"## Overview\nUse this endpoint to get verified relationship information for a user with a given NHS Number. This endpoint should NOT be used to retrieve established proxy roles; these should be queried from the GET /Consent endpoints.\n\nYou can query for RelatedPerson's in the following ways:\n\n| Outcome | Query string value |\n| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |\n| Search for patient relationships for a candidate proxy | `identifier={proxy identifier}` |\n| Search for candidate proxy relationships for a patient | `patient:identifier={patient identifier}` |\n| Search for a specific verified candidate relationship for a given proxy and patient | `identifier={proxy identifier}&patient:identifier={patient identifier}` |\n\nYou must provide either the `identifier={identifier}` or `patient:identifier={identifier}` query string, or both, in your request.\n\n## Access modes\n\nThis endpoint supports the following access modes:\n- Patient access\n- Healthcare worker access\n\n## Sandbox test scenarios\n\nYou can test the following scenarios in our sandbox environment:\n\n| Scenario | Request | Response |\n| --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |\n| List Relationship | `identifier=9000000017` | HTTP Status 200 List of relationships for the proxy |\n| List Relationship and include patient's details | `identifier=9000000017&_include=RelatedPerson:patient` | HTTP Status 200 List of relationships for the proxy and includes patient data |\n| List Patient Relationship | `patient:identifier=9000000042` | HTTP Status 200 List of relationships for the patient |\n| List Patient Relationship and include patient's details | `patient:identifier=9000000042&_include=RelatedPerson:patient` | HTTP Status 200 List of relationships for the patient and includes patient data |\n| List Relationship and no relationships returned | `identifier=9000000033` | HTTP Status 200 Empty bundle |\n| Verify Relationship between proxy and patient | `identifier=9000000017&patient:identifier=9000000009` | HTTP Status 200 Verified relationship between patient and proxy |\n| Verify Relationship between proxy and patient and include patient's details | `identifier=9000000017&patient:identifier=9000000009&_include=RelatedPerson:patient` | HTTP Status 200 Verified relationship between patient and proxy and includes patient's details |\n| Missing identifier | `` | 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 400 and INVALID_IDENTIFIER_VALUE error response |\n| Malformed identifier & system | `identifier=https://fhir.nhs.uk/Id/nhs-number/9730675929` | HTTP Status 400 and INVALID_IDENTIFIER_SYSTEM error response |\n\n### Sandbox constraints\n\nThe sandbox environment has the following constraints for this endpoint:\n\n - Request headers are not tested. For example, `X-Request-ID` and `X-Correlation-ID` are disregarded.\n","operationId":"get-validated-relationships","parameters":[{"description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis).\n","explode":false,"in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM","format":"^Bearer\\ [[:ascii:]]+$","type":"string"},"style":"simple"},{"description":"The proxy's NHS number. For more information on FHIR tokens in general, [see here](https://build.fhir.org/search.html#token).\n","examples":{"withoutSystem":{"summary":"NHS number specified without system.","value":9000000017},"withSystem":{"summary":"System and NHS number specified","value":"https://fhir.nhs.uk/Id/nhs-number|9000000017"}},"explode":true,"in":"query","name":"identifier","required":false,"schema":{"format":"token","type":"string"},"style":"form"},{"description":"The patient's NHS number. For more information on FHIR tokens in general, [see here](https://build.fhir.org/search.html#token).\n","examples":{"withoutSystem":{"summary":"NHS number specified without system","value":9000000009},"withSystem":{"summary":"System and NHS number specified","value":"https://fhir.nhs.uk/Id/nhs-number|9000000009"}},"explode":true,"in":"query","name":"patient:identifier","required":false,"schema":{"format":"token","type":"string"},"style":"form"},{"description":"Include referenced resources in the bundle response by specifying one or more `_include` parameters. Further info [here](https://www.hl7.org/fhir/search.html#_include).\n","examples":{"IncludePatient":{"summary":"Include the patient in the bundle","value":["RelatedPerson:patient"]}},"explode":true,"in":"query","name":"_include","required":false,"schema":{"items":{"enum":["RelatedPerson:patient"],"type":"string"},"type":"array"},"style":"form"},{"description":"A globally unique identifier (GUID) for the request, which we use to correlate logs through different components.\nMust be a universally unique identifier (UUID) (ideally version 4).\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Request-ID","required":true,"schema":{"example":"60e0b220-8136-4ca5-ae46-1d97ef59d068","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"},{"description":"An optional ID which you can use to track transactions across multiple systems.\nMust be a universally unique identifier (UUID) (ideally version 4).\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Correlation-ID","required":false,"schema":{"example":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/fhir+json":{"examples":{"listRelationship":{"$ref":"#/components/examples/ListRelationship9000000017"},"listRelationshipIncludePatient":{"$ref":"#/components/examples/ListRelationship9000000017Include"},"listChildRelationship":{"$ref":"#/components/examples/ListRelationship9000000042"},"listChildRelationshipIncludePatient":{"$ref":"#/components/examples/ListRelationship9000000042Include"},"verifyRelationshipExample1":{"$ref":"#/components/examples/VerifyRelationship9000000009"},"verifyRelationshipExample1Include":{"$ref":"#/components/examples/VerifyRelationship9000000009Include"},"verifyRelationshipExample2":{"$ref":"#/components/examples/VerifyRelationship9000000025"},"verifyRelationshipExample2Include":{"$ref":"#/components/examples/VerifyRelationship9000000025Include"},"relatedEmptyResponse":{"$ref":"#/components/examples/RelatedEmptyResponse"}},"schema":{"$ref":"#/components/schemas/RelatedPersonBundle"}}},"description":"Information successfully returned."},"4XX":{"content":{"application/fhir+json":{"examples":{"AccessDeniedError":{"$ref":"#/components/examples/AccessDeniedError"},"RelatedPersonInvalidIdentifierMissing":{"$ref":"#/components/examples/RelatedPersonInvalidIdentifierMissing"},"RelatedPersonInvalidIdentifierError":{"$ref":"#/components/examples/RelatedPersonInvalidIdentifierError"},"InvalidIdentifierPatientError":{"$ref":"#/components/examples/InvalidIdentifierPatientError"},"RelatedPersonInvalidIdentifierSystem":{"$ref":"#/components/examples/RelatedPersonInvalidIdentifierSystem"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Errors will be returned for the first error encountered in the request. An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| 400 | `MISSING_IDENTIFIER_VALUE` | Missing RelatedPerson NHS number. |\n| 400 | `INVALID_IDENTIFIER_SYSTEM` | Invalid identifier system. |\n| 400 | `INVALID_VALUE` | Invalid Parameter or Invalid operation. |\n| 400 | `INVALID_PATIENT_IDENTIFIER_VALUE` | Malformed Patient NHS number. |\n| 400 | `INVALID_IDENTIFIER_VALUE` | Malformed RelatedPerson NHS number. |\n| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |\n| 403 | `FORBIDDEN` | Access denied to resource. |\n| 404 | `INVALIDATED_RESOURCE` | Resource that has been marked as invalid was requested - invalid resources cannot be retrieved |\n| 405 | `METHOD_NOT_ALLOWED` | The method is not allowed. |\n| 408 | `TIMEOUT` | Request timed out. |\n| 429 | `THROTTLED` | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |\n"},"5XX":{"content":{"application/fhir+json":{"examples":{"InternalServerError":{"$ref":"#/components/examples/InternalServerError"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Errors will be returned for the first error encountered in the request. An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------- | ------------------------------------------------------------ |\n| 500 | `SERVER_ERROR` | An unexpected internal server error has occurred. |\n| 501 | `NOT_IMPLEMENTED` | API Endpoint not implemented. |\n| 502 | `BAD_GATEWAY` | Connection to the backend service failed. |\n"}},"summary":"Get verified candidate relationships"}},"/Consent":{"get":{"description":"## 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","operationId":"get-consent","parameters":[{"description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis).\n","explode":false,"in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM","format":"^Bearer\\ [[:ascii:]]+$","type":"string"},"style":"simple"},{"description":"The performer's (Proxy) NHS number. For more information on FHIR tokens in general, [see here](https://build.fhir.org/search.html#token).\n","examples":{"withoutSystem":{"summary":"NHS number specified without system","value":9000000017},"withSystem":{"summary":"System and NHS number specified","value":"https://fhir.nhs.uk/Id/nhs-number|9000000017"}},"explode":true,"in":"query","name":"performer:identifier","required":false,"schema":{"format":"token","type":"string"},"style":"form"},{"description":"The patient's NHS number. For more information on FHIR tokens in general, [see here](https://build.fhir.org/search.html#token).\n","examples":{"withoutSystem":{"summary":"NHS number specified without system","value":9000000017},"withSystem":{"summary":"System and NHS number specified","value":"https://fhir.nhs.uk/Id/nhs-number|9000000017"}},"explode":true,"in":"query","name":"patient:identifier","required":false,"schema":{"format":"token","type":"string"},"style":"form"},{"description":"Specify one or more `status` values to filter the records returned in the bundle.\n\nSupports FHIR search conventions:\n- **OR** â comma-separated values within a single parameter, e.g. `status=active,proposed` returns records with status `active` _or_ `proposed`.\n- **AND** â repeated parameters, e.g. `status=active&status=proposed`. For a single-valued field like `status`, AND groups are intersected; disjoint groups will return no results.\n- **AND of ORs** â e.g. `status=active,proposed&status=inactive`.\n\nValid status values are bound to the http://hl7.org/fhir/consent-state-codes CodeSystem: `proposed`, `active`, `rejected`, `inactive`, `entered-in-error`.\n","examples":{"Active":{"summary":"Only active authorised proxy relationships","value":"active"},"Revoked":{"summary":"Only revoked proxy relationships","value":"inactive"},"ActiveOrProposed":{"summary":"Active OR proposed (but not yet authorised) proxy relationships","value":["proposed,active"]}},"explode":true,"in":"query","name":"status","required":false,"schema":{"items":{"description":"A single status value, or a comma-separated list of status values representing an OR group. Valid values are: `proposed`, `active`, `rejected`, `inactive`, `entered-in-error`.\n","type":"string"},"type":"array"},"style":"form"},{"description":"Include referenced resources in the bundle response by specifying one or more `_include` parameters. Further info [here](https://www.hl7.org/fhir/search.html#_include).","examples":{"FullInclude":{"summary":"Include the performer (proxy) and patient in the bundle","value":["Consent:performer","Consent:patient"]},"IncludePerformer":{"summary":"Include the performer (proxy) in the bundle","value":"Consent:performer"},"IncludePatient":{"summary":"Include the patient in the bundle","value":"Consent:patient"}},"explode":true,"in":"query","name":"_include","required":false,"schema":{"default":["Consent:performer","Consent:patient"],"items":{"enum":["Consent:performer","Consent:patient"],"type":"string"},"type":"array"},"style":"form"},{"description":"A globally unique identifier (GUID) for the request, which we use to correlate logs through different components.\nMust be a universally unique identifier (UUID) (ideally version 4).\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Request-ID","required":true,"schema":{"example":"60e0b220-8136-4ca5-ae46-1d97ef59d068","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"},{"description":"An optional ID which you can use to track transactions across multiple systems.\nMust be a universally unique identifier (UUID) (ideally version 4).\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Correlation-ID","required":false,"schema":{"example":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"},{"description":"An optional `;` delimited string containing parameters required to refresh proxy relationships from GPIT supplier systems. Parameters that comprise this string are:\n\n- IM1 User Connection token\n- ODS Code\n","explode":false,"in":"header","name":"X-IM1-Connection-Params","required":false,"schema":{"example":"NiV3CyMJH3xYV26ghlVpbbjT7pDVEA8HpFczAjRLTs1VezC4CYzupZ3XxXAWM7ELuseqrV8r0Ill7EL7G2tXUaVHCPWgg4q10+MxFjnRPrjDvckBRSZazqZcp0K2VBdUV0rZ7RUYJNJsjVAeefWhiK/Y4R+GFO86QDpt41JS9xA=;G123456","pattern":"^[^;]+;[^;]+$","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/fhir+json":{"examples":{"ConsentMultipleRelationshipsStatusActiveBundle":{"$ref":"#/components/examples/ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle"},"ConsentMultipleRelationshipsStatusInactiveBundle":{"$ref":"#/components/examples/ConsentMultipleRelationshipsStatusInactiveBundle"},"ConsentMultipleRelationshipsStatusProposedActiveBundle":{"$ref":"#/components/examples/ConsentMultipleRelationshipsStatusProposedActiveBundle"},"ConsentMultipleRelationshipsBundle":{"$ref":"#/components/examples/ConsentMultipleRelationshipsBundle"},"ConsentMultipleRelationshipsIncludePatientBundle":{"$ref":"#/components/examples/ConsentMultipleRelationshipsIncludePatientBundle"},"ConsentMultipleRelationshipsIncludePerformerBundle":{"$ref":"#/components/examples/ConsentMultipleRelationshipsIncludePerformerBundle"},"ConsentMultipleRelationshipsIncludePerformerPatientBundle":{"$ref":"#/components/examples/ConsentMultipleRelationshipsIncludePerformerPatientBundle"},"ConsentNoRelationshipsEmptyBundle":{"$ref":"#/components/examples/ConsentNoRelationshipsEmptyBundle"},"ConsentSingleConsentingAdultRelationshipBundle":{"$ref":"#/components/examples/ConsentSingleConsentingAdultRelationshipBundle"},"ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle":{"$ref":"#/components/examples/ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle"},"ConsentSingleAdultChildRelationshipBundle":{"$ref":"#/components/examples/ConsentSingleAdultChildRelationshipBundle"},"ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle":{"$ref":"#/components/examples/ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle"},"ConsentMultipleRelationshipsSinglePatientBundle":{"$ref":"#/components/examples/ConsentMultipleRelationshipsSinglePatientBundle"}},"schema":{"$ref":"#/components/schemas/ConsentBundle"}}},"description":"Information successfully returned."},"4XX":{"content":{"application/fhir+json":{"examples":{"AccessDeniedError":{"$ref":"#/components/examples/AccessDeniedError"},"ConsentInvalidIdentifierError":{"$ref":"#/components/examples/ConsentInvalidIdentifierError"},"ConsentInvalidIdentifierSystemError":{"$ref":"#/components/examples/ConsentInvalidIdentifierSystemError"},"ConsentIdentifierMissingError":{"$ref":"#/components/examples/ConsentIdentifierMissingError"},"InvalidatedResourceError":{"$ref":"#/components/examples/InvalidatedResourceError"},"ConsentInvalidStatusParameterError":{"$ref":"#/components/examples/ConsentInvalidStatusParameterError"},"GPPracticeNotFoundError":{"$ref":"#/components/examples/GPPracticeNotFoundError"},"InvalidIncludeParameterError":{"$ref":"#/components/examples/InvalidIncludeParameterError"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Errors will be returned for the first error encountered in the request. An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |\n| 404 | `INVALIDATED_RESOURCE` | Resource that has been marked as invalid was requested - invalid resources cannot be retrieved |\n| 404 | `GP_PRACTICE_NOT_FOUND` | GP Practice not found. |\n| 405 | `METHOD_NOT_ALLOWED` | The method is not allowed. |\n| 408 | `TIMEOUT` | Request timed out. |\n| 422 | `INVALID_PARAMETER` | Invalid parameter. For details, see the `diagnostics` field. |\n| 429 | `THROTTLED` | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |\n"},"5XX":{"content":{"application/fhir+json":{"examples":{"InternalServerError":{"$ref":"#/components/examples/InternalServerError"},"DownstreamServiceError":{"$ref":"#/components/examples/DownstreamServiceError"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Errors will be returned for the first error encountered in the request. An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------- | ------------------------------------------------------------- |\n| 500 | `SERVER_ERROR` | An unexpected internal server error has occurred. |\n| 502 | `BAD_GATEWAY` | Connection to the backend service failed. |\n| 503 | `DOWNSTREAM_SERVICE_ERROR` | A downstream service has failed, request cannot be completed. |\n"}},"summary":"Get proxy roles"},"post":{"description":"## Overview\nUse this endpoint to create a new proxy role between a patient and a related person (proxy).\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| Successful parent-child proxy creation | Valid request with a legal basis of parental responsibility, with performer identifier value of `9000000009`| HTTP Status 201 and OperationOutcome response |\n| Successful adult-adult proxy creation | Valid request with legal basis of consent, with performer identifier value of `9000000017` | HTTP Status 201 and OperationOutcome response |\n| Valid OTHER reason code with free text | Request with reason code 'OTHER' and free text provided, performer identifier `9000000051` | HTTP Status 201 and OperationOutcome response |\n| Non-OTHER reason code without free text | Request with a reason code other than 'OTHER', no free text, performer identifier `9000000052` | HTTP Status 201 and OperationOutcome response |\n| Non-OTHER reason code with free text | Request with a reason code other than 'OTHER', with free text, performer identifier `9000000053` | HTTP Status 201 and OperationOutcome response |\n| Missing free text for OTHER reason code | Request with reason code 'OTHER' but missing free text, performer identifier `9000000050` | HTTP Status 400 and MISSING_FREE_TEXT_FOR_OTHER error response |\n| Missing grantor | Valid request with status 'active' but no grantor extension, performer identifier `9000000054` | HTTP Status 400 and MISSING_GRANTOR error response |\n| Missing grantor valueReference | Request with grantor extension but missing valueReference, performer identifier `9000000057` | HTTP Status 400 and MISSING_GRANTOR_REFERENCE error response |\n| Missing grantor valueIdentifier | Request with grantor extension but missing valueIdentifier, performer identifier `9000000058` | HTTP Status 400 and MISSING_GRANTOR_IDENTIFIER error response |\n| Invalid grantor ODS code value | Request with grantor extension but missing/empty/invalid ODS code, performer identifier `9000000055` | HTTP Status 422 and INVALID_GRANTOR_VALUE error response |\n| Invalid grantor identifier system | Request with grantor extension but wrong/missing identifier system, performer identifier `9000000056` | HTTP Status 422 and INVALID_GRANTOR_SYSTEM error response |\n| Duplicate relationship | Request for relationship that already exists, with performer identifier value of `9000000049` | HTTP Status 409 and DUPLICATE_RELATIONSHIP error response |\n\n### Sandbox constraints\n\nThe sandbox environment has the following constraints for this endpoint:\n\n- `patient.identifier.value` is disregarded. The returned response is based on the `performer.identifier.value` only.\n- Request body is not validated.\n- Request headers are not tested. `X-Request-ID` and `X-Correlation-ID` are disregarded.\n- No proxy role is created.\n","operationId":"create-proxy-role","parameters":[{"description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis).\n","explode":false,"in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM","format":"^Bearer\\ [[:ascii:]]+$","type":"string"},"style":"simple"},{"description":"A globally unique identifier (GUID) for the request, which we use to correlate logs through different components.\nMust be a universally unique identifier (UUID) (ideally version 4).\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Request-ID","required":true,"schema":{"example":"60e0b220-8136-4ca5-ae46-1d97ef59d068","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"},{"description":"An optional ID which you can use to track transactions across multiple systems.\nMust be a universally unique identifier (UUID) (ideally version 4).\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Correlation-ID","required":false,"schema":{"example":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/fhir+json":{"examples":{"parentConsentRequest":{"$ref":"#/components/examples/ConsentParentChildProxyCreationRequest"},"guardianConsentRequest":{"$ref":"#/components/examples/ConsentAdultToAdultGuardianRequest"}},"schema":{"$ref":"#/components/schemas/Consent"}}},"required":true},"responses":{"201":{"content":{"application/fhir+json":{"examples":{"postConsentSuccess":{"$ref":"#/components/examples/PostConsentSuccess"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Consent resource successfully created","headers":{"location":{"description":"URL for the newly created proxy role","explode":false,"schema":{"example":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/90b9863e-e33c-4895-a333-fd0ea0e23205","type":"string"},"style":"simple"}}},"4XX":{"content":{"application/fhir+json":{"examples":{"postConsentDuplicateRelationship":{"$ref":"#/components/examples/PostConsentDuplicateRelationshipError"},"postConsentInvalidIdentifierValue":{"$ref":"#/components/examples/PostConsentInvalidIdentifierValueError"},"postConsentInvalidStatus":{"$ref":"#/components/examples/PostConsentInvalidStatusError"},"postConsentMissingIdentifierSystem":{"$ref":"#/components/examples/PostConsentMissingIdentifierSystemError"},"postConsentMissingScope":{"$ref":"#/components/examples/PostConsentMissingScopeError"},"postConsentInvalidRequest":{"$ref":"#/components/examples/PostConsentInvalidRequestError"},"postConsentInvalidFHIRRequest":{"$ref":"#/components/examples/PostConsentInvalidFHIRRequestError"},"postConsentMissingFreeTextForOther":{"$ref":"#/components/examples/PostConsentMissingFreeTextForOtherError"},"postConsentMissingGrantorError":{"$ref":"#/components/examples/PostConsentMissingGrantorError"},"postConsentMissingGrantorReferenceError":{"$ref":"#/components/examples/PostConsentMissingGrantorReferenceError"},"postConsentMissingGrantorIdentifierError":{"$ref":"#/components/examples/PostConsentMissingGrantorIdentifierError"},"postConsentInvalidGrantorIdentifierSystemError":{"$ref":"#/components/examples/PostConsentInvalidGrantorIdentifierSystemError"},"postConsentInvalidGrantorIdentifierValueError":{"$ref":"#/components/examples/PostConsentInvalidGrantorIdentifierValueError"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Errors will be returned for the first error encountered in the request. For details, see the `diagnostics` field of error. An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| 400 | `MISSING_IDENTIFIER_VALUE` | Missing performer or patient identifier. |\n| 400 | `MISSING_IDENTIFIER_SYSTEM` | Missing performer or patient identifier system. |\n| 400 | `MISSING_PATIENT` | Missing patient. |\n| 400 | `MISSING_PERFORMER` | Missing performer. |\n| 400 | `MISSING_GRANTOR` | Grantor extension is required when creating or activating an active proxy role. |\n| 400 | `MISSING_GRANTOR_REFERENCE` | Grantor extension is present but missing valueReference. |\n| 400 | `MISSING_GRANTOR_IDENTIFIER`| Grantor extension is present but missing valueIdentifier. |\n| 400 | `MISSING_VALUE` | Missing header or parameter. For details, see the `diagnostics` field. |\n| 400 | `MISSING_STATUS` | Missing status. |\n| 400 | `MISSING_SCOPE` | Missing scope. |\n| 400 | `MISSING_CATEGORY` | Missing category. |\n| 400 | `MISSING_DATETIME` | Missing datetime. |\n| 400 | `BAD_REQUEST` | Invalid request. For details, see the `diagnostics` field. |\n| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |\n| 403 | `FORBIDDEN` | Access denied to resource. |\n| 405 | `METHOD_NOT_ALLOWED` | The method is not allowed. |\n| 408 | `TIMEOUT` | Request timed out. |\n| 409 | `DUPLICATE_RELATIONSHIP` | Conflict with requested proxy role. |\n| 422 | `INVALID_IDENTIFIER_VALUE` | Invalid performer or patient identifier value. |\n| 422 | `INVALID_IDENTIFIER_SYSTEM` | Invalid performer or patient identifier system. |\n| 422 | `INVALID_PATIENT` | Invalid patient. |\n| 422 | `INVALID_PERFORMER` | Invalid performer. |\n| 422 | `INVALID_STATUS` | Invalid status. |\n| 422 | `INVALID_SCOPE` | Invalid scope. |\n| 422 | `INVALID_CATEGORY` | Invalid category. |\n| 422 | `INVALID_DATETIME` | Invalid datetime. |\n| 422 | `INVALID_PROVISION` | Invalid provision. |\n| 422 | `INVALID_EXTENSION` | Invalid extension. |\n| 422 | `INVALID_GRANTOR_VALUE` | Grantor ODS code is missing, empty, whitespace-only or invalid format. |\n| 422 | `INVALID_PERFORMER` | Invalid performer. |\n| 422 | `INVALID_GRANTOR_SYSTEM` | Grantor identifier system is invalid (must be 'https://fhir.nhs.uk/Id/ods-organization-code'). |\n| 429 | `THROTTLED` | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |\n"},"5XX":{"content":{"application/fhir+json":{"examples":{"InternalServerError":{"$ref":"#/components/examples/InternalServerError"},"DownstreamServiceError":{"$ref":"#/components/examples/DownstreamServiceError"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Errors will be returned for the first error encountered in the request. An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------- | ------------------------------------------------------------- |\n| 500 | `SERVER_ERROR` | An unexpected internal server error has occurred. |\n| 501 | `NOT_IMPLEMENTED` | API Endpoint not implemented. |\n| 502 | `BAD_GATEWAY` | Connection to the backend service failed. |\n| 503 | `DOWNSTREAM_SERVICE_ERROR` | A downstream service has failed, request cannot be completed. |\n"}},"summary":"Create a proxy role"}},"/Consent/{id}":{"get":{"description":"## 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","operationId":"get-consent-by-id","parameters":[{"description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis).\n","explode":false,"in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM","format":"^Bearer\\ [[:ascii:]]+$","type":"string"},"style":"simple"},{"description":"The logical id of the Consent resource","explode":false,"in":"path","name":"id","required":true,"schema":{"example":"74eed847-ca25-4e76-8cf2-f2c2d7842a7a","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"},{"description":"Include referenced resources in the bundle response by specifying one or more `_include` parameters. Further info [here](https://www.hl7.org/fhir/search.html#_include).","examples":{"FullInclude":{"summary":"Include the performer (proxy) and patient in the bundle","value":["Consent:performer","Consent:patient"]},"IncludePerformer":{"summary":"Include the performer (proxy) in the bundle","value":"Consent:performer"},"IncludePatient":{"summary":"Include the patient in the bundle","value":"Consent:patient"}},"explode":true,"in":"query","name":"_include","required":false,"schema":{"default":["Consent:performer","Consent:patient"],"items":{"enum":["Consent:performer","Consent:patient"],"type":"string"},"type":"array"},"style":"form"},{"description":"A globally unique identifier (GUID) for the request, which we use to correlate logs through different components.\nMust be a universally unique identifier (UUID) (ideally version 4).\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Request-ID","required":true,"schema":{"example":"60e0b220-8136-4ca5-ae46-1d97ef59d068","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"},{"description":"An optional ID which you can use to track transactions across multiple systems.\nMust be a universally unique identifier (UUID) (ideally version 4).\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Correlation-ID","required":false,"schema":{"example":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/fhir+json":{"examples":{"ConsentSingleConsentingAdultRelationshipBundle":{"$ref":"#/components/examples/ConsentSingleConsentingAdultRelationshipBundle"},"ConsentSingleConsentingAdultRelationshipIncludePatientBundle":{"$ref":"#/components/examples/ConsentSingleConsentingAdultRelationshipIncludePatientBundle"},"ConsentSingleConsentingAdultRelationshipIncludePerformerBundle":{"$ref":"#/components/examples/ConsentSingleConsentingAdultRelationshipIncludePerformerBundle"},"ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle":{"$ref":"#/components/examples/ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle"},"ConsentSingleAdultChildRelationshipBundle":{"$ref":"#/components/examples/ConsentSingleAdultChildRelationshipBundle"},"ConsentSingleAdultChildRelationshipIncludePatientBundle":{"$ref":"#/components/examples/ConsentSingleAdultChildRelationshipIncludePatientBundle"},"ConsentSingleAdultChildRelationshipIncludePerformerBundle":{"$ref":"#/components/examples/ConsentSingleAdultChildRelationshipIncludePerformerBundle"},"ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle":{"$ref":"#/components/examples/ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle"}},"schema":{"$ref":"#/components/schemas/ConsentBundle"}}},"description":"Information successfully returned."},"4XX":{"content":{"application/fhir+json":{"examples":{"AccessDeniedError":{"$ref":"#/components/examples/AccessDeniedError"},"InvalidatedResourceError":{"$ref":"#/components/examples/InvalidatedResourceError"},"InvalidIdError":{"$ref":"#/components/examples/ConsentInvalidIDError"},"InvalidIncludeParameterError":{"$ref":"#/components/examples/InvalidIncludeParameterError"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Errors will be returned for the first error encountered in the request. An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |\n| 404 | `INVALIDATED_RESOURCE` | Resource that has been marked as invalid was requested - invalid resources cannot be retrieved |\n| 405 | `METHOD_NOT_ALLOWED` | The method is not allowed. |\n| 408 | `TIMEOUT` | Request timed out. |\n| 429 | `THROTTLED` | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |\n"},"5XX":{"content":{"application/fhir+json":{"examples":{"InternalServerError":{"$ref":"#/components/examples/InternalServerError"},"DownstreamServiceError":{"$ref":"#/components/examples/DownstreamServiceError"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Errors will be returned for the first error encountered in the request. An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------- | ------------------------------------------------------------- |\n| 500 | `SERVER_ERROR` | An unexpected internal server error has occurred. |\n| 501 | `NOT_IMPLEMENTED` | API Endpoint not implemented. |\n| 502 | `BAD_GATEWAY` | Connection to the backend service failed. |\n"}},"summary":"Get proxy role"},"patch":{"description":"## Overview\nUse this endpoint to update an existing proxy role.\n\nSupported update scenarios include:\n\n* Update the status and status reason, (optionally) providing an additional free text description\n* Update the policy rule\n* Update the end date, for time-bound access\n\n## Request Requirements\n* The proxy role must exist and be identified by a valid ID\n* JSON Patch operations must be valid according to RFC 6902\n* Status changes must use valid status codes from \n\n### IMPORTANT: Business Rule Enforcement for `/status` updates\n\nIf you update the `/status` of a role, you **MUST** also provide a corresponding update to the `/extension` path in the same patch array to provide the `statusReason`. An error will be returned if a request for a change of `/status` does not include a status reason.\n\nThe values for `/status` and `statusReason` are validated against a proxy role lifecycle to ensure that the transition between the existing and requested status is valid. An error will be returned if the requested transition is not valid.\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| Successful status update | Valid patch changing status to 'active', request with id '74eed847-ca25-4e76-8cf2-f2c2d7842a7a' | HTTP Status 200 and OperationOutcome |\n| Successful access level update | Valid patch modifying the role end date, request with id '6b71ac92-baa3-4b76-b0f5-a601257e2722' | HTTP Status 200 and OperationOutcome |\n| Multiple valid changes | Valid patch with multiple operations, request with id '43003db8-ffcd-4bd6-ab2f-b49b9656f9e5' | HTTP Status 200 and OperationOutcome |\n| Valid OTHER reason code with free text | Patch with reason code 'OTHER' and free text, id='a1b2c3d4-e5f6-4789-a0b1-c2d3e4f5a6b7'| HTTP Status 200 and OperationOutcome |\n| Non-OTHER reason code without free text | Patch with a reason code other than 'OTHER', no free text, id='b2c3d4e5-f6a7-4890-b1c2-d3e4f5a6b7c8' | HTTP Status 200 and OperationOutcome |\n| Non-OTHER reason code with free text | Patch with a reason code other than 'OTHER', with free text, id='c3d4e5f6-a7b8-4901-c2d3-e4f5a6b7c8d9' | HTTP Status 200 and OperationOutcome |\n| Invalid patch format | Malformed JSON patch document, request with id '849ea584-2318-471b-a24c-cee1b5ad0137' | HTTP Status 400 and INVALID_PATCH_FORMAT error response |\n| Invalid path | Patch targeting non-existent element, request with id '01abb0c5-b1ac-499d-9655-9cd0b8d3588f' | HTTP Status 400 and INVALID_PATCH_PATH error response |\n| Invalid status code | Patch with invalid status value, request with id '78c35330-fa2f-4934-a5dd-fff847f38de5' | HTTP Status 422 and INVALID_STATUS_CODE error response |\n| Invalid status reason | Patch with invalid status reason value, request with id '51fb4df5-815a-45cd-8427-04d6558336b7' | HTTP Status 422 and INVALID_STATUS_REASON error response |\n| Resource not found | Patch for non-existent Consent, request with an id not listed here | HTTP Status 404 and RESOURCE_NOT_FOUND error response |\n| Invalid state transition | Patch attempting invalid status change, request with id '7b7f47b8-96e5-43eb-b733-283bf1449f2c' | HTTP Status 422 and INVALID_STATE_TRANSITION error response |\n| Missing free text for OTHER reason code | Patch with reason code 'OTHER' but missing free text, id='d4e8a6f2-1c3b-4a7e-9d2f-8b5c7e9f1a3d' | HTTP Status 400 and MISSING_FREE_TEXT_FOR_OTHER error response |\n| Missing grantor | Patch attempting to set status to 'active' without grantor extension, id='90957744-b971-496e-b7c3-ab971868ce14' | HTTP Status 400 and MISSING_GRANTOR error response |\n| Missing grantor valueReference | Request with grantor extension but missing valueReference, id='7e764160-38b6-41eb-9012-a3e476cbc517' | HTTP Status 400 and MISSING_GRANTOR_REFERENCE error response |\n| Missing grantor valueIdentifier | Request with grantor extension but missing valueIdentifier, id='faefd8c5-5e24-4415-8252-96e9241c7e78' | HTTP Status 400 and MISSING_GRANTOR_IDENTIFIER error response |\n| Invalid grantor ODS code value | Request with grantor extension but missing/empty/invalid ODS code, id='b68cbfc8-ccc2-48ad-b97b-b7410d773dc1' | HTTP Status 422 and INVALID_GRANTOR_VALUE error response |\n| Invalid grantor identifier system | Request with grantor extension but wrong/missing identifier system, id='fd189522-68e5-42dc-b44c-989be0eaa2bf' | HTTP Status 422 and INVALID_GRANTOR_SYSTEM error response |\n\n### Sandbox constraints\n\nThe sandbox environment has the following constraints for this endpoint:\n\n- Request body is not validated.\n- Request headers are not tested.\n- No proxy role is updated.\n","parameters":[{"description":"The logical id of the Consent resource","explode":false,"in":"path","name":"id","required":true,"schema":{"example":"74eed847-ca25-4e76-8cf2-f2c2d7842a7a","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json-patch+json":{"examples":{"statusUpdate":{"$ref":"#/components/examples/StatusUpdate"},"updateProvisionEndDate":{"$ref":"#/components/examples/UpdateProvisionEndDate"},"multipleUpdates":{"$ref":"#/components/examples/MultipleUpdates"},"policyRule":{"$ref":"#/components/examples/ReplacePolicyRuleRequest"}},"schema":{"items":{"$ref":"#/components/schemas/PatchOperation"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/fhir+json":{"examples":{"patchConsentSuccess":{"$ref":"#/components/examples/PatchConsentSuccess"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Consent resource successfully updated"},"4XX":{"content":{"application/fhir+json":{"examples":{"patchConsentInvalidPatchFormatError":{"$ref":"#/components/examples/PatchConsentInvalidPatchFormatError"},"patchConsentInvalidPathError":{"$ref":"#/components/examples/PatchConsentInvalidPathError"},"patchConsentInvalidStatusCodeError":{"$ref":"#/components/examples/PatchConsentInvalidStatusCodeError"},"PatchConsentInvalidStatusReasonError":{"$ref":"#/components/examples/PatchConsentInvalidStatusReasonError"},"patchConsentInvalidStateTransitionError":{"$ref":"#/components/examples/PatchConsentInvalidStateTransitionError"},"patchConsentMissingFreeTextForOther":{"$ref":"#/components/examples/PatchConsentMissingFreeTextForOtherError"},"patchConsentMissingGrantorError":{"$ref":"#/components/examples/PatchConsentMissingGrantorError"},"patchConsentMissingGrantorReferenceError":{"$ref":"#/components/examples/PatchConsentMissingGrantorReferenceError"},"patchConsentMissingGrantorIdentifierError":{"$ref":"#/components/examples/PatchConsentMissingGrantorIdentifierError"},"patchConsentInvalidGrantorIdentifierSystemError":{"$ref":"#/components/examples/PatchConsentInvalidGrantorIdentifierSystemError"},"patchConsentInvalidGrantorIdentifierValueError":{"$ref":"#/components/examples/PatchConsentInvalidGrantorIdentifierValueError"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Errors will be returned for the first error encountered in the request. For details, see the `diagnostics` field of error. An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |\n| 400 | `MISSING_VALUE` | Missing header or parameter. For details, see the `diagnostics` field. |\n| 400 | `MISSING_GRANTOR` | Grantor extension is required when creating or activating a consent with status \"active\". For details, see the `diagnostics` field. |\n| 400 | `MISSING_GRANTOR_REFERENCE` | Grantor extension reference is required when creating or activating a consent with status \"active\". For details, see the `diagnostics` field. |\n| 400 | `MISSING_GRANTOR_IDENTIFIER`| Grantor extension identifier is required when creating or activating a consent with status \"active\". For details, see the `diagnostics` field. |\n| 400 | `INVALID_PATCH` | Invalid patch. |\n| 400 | `INVALID_VALUE` | Invalid Parameter or Invalid operation. |\n| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |\n| 403 | `FORBIDDEN` | Access denied to resource. |\n| 405 | `METHOD_NOT_ALLOWED` | The method is not allowed. |\n| 408 | `TIMEOUT` | Request timed out. |\n| 409 | `DUPLICATE_PATCHES` | Two or more patches use same path. |\n| 415 | `UNSUPPORTED_MEDIA` | Unsupported media type. |\n| 422 | `INVALID_EXTENSION` | Invalid extension. |\n| 422 | `INVALID_PATCH_PATH` | Invalid patch path. |\n| 422 | `INVALID_STATUS_CODE` | Invalid status code. |\n| 422 | `INVALID_STATUS_REASON` | Invalid status reason. |\n| 422 | `INVALID_STATE_TRANSITION` | Invalid state transition. |\n| 422 | `INVALID_LEGAL_BASIS_CODE` | Invalid legal basis code. |\n| 422 | `INVALID_END_DATE` | End date is invalid. |\n| 422 | `INVALID_GRANTOR_VALUE` | Invalid grantor identifier value. For details, see the `diagnostics` field. |\n| 422 | `INVALID_GRANTOR_SYSTEM` | Invalid grantor system value. For details, see the `diagnostics` field. |\n| 429 | `THROTTLED` | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |\n"},"5XX":{"content":{"application/fhir+json":{"examples":{"InternalServerError":{"$ref":"#/components/examples/InternalServerError"},"DownstreamServiceError":{"$ref":"#/components/examples/DownstreamServiceError"}},"schema":{"$ref":"#/components/schemas/OperationOutcome"}}},"description":"Errors will be returned for the first error encountered in the request. An error occurred as follows:\n\n| HTTP status | Error code | Description |\n| ----------- | -------------------------- | ------------------------------------------------------------- |\n| 500 | `SERVER_ERROR` | An unexpected internal server error has occurred. |\n| 501 | `NOT_IMPLEMENTED` | API Endpoint not implemented. |\n| 502 | `BAD_GATEWAY` | Connection to the backend service failed. |\n"}},"summary":"Update a proxy role"}}},"components":{"examples":{"QuestionnaireResponseMotherChildRequest":{"description":"Example proxy access request from a mother (Martha) with NHS number `9000000017` requesting access to act on behalf of their child (Timmy) with NHS number `9000000002`.\n\nSignificant details to point out:\n\n- `source.type` should be `RelatedPerson` when a proxy is applying\n- `source.identifier.value` should be the NHS number of the user completing the form - this should correlate with the Identity token in the request\n- `subject.type` should be `Patient` since it is the patient that is the subject of the application\n- `subject.identifier.value` should be the NHS Number of the patient to which the application relates\n- `patient` demographics are present in the request as a result of being provided by the applicant\n","summary":"Mother > Child access request","value":{"resourceType":"QuestionnaireResponse","status":"completed","authored":"2024-07-15T09:43:03.280Z","source":{"type":"RelatedPerson","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}},"subject":{"type":"Patient","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000002"}},"questionnaire":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Questionnaire/01dc6813-3421-4d14-948d-a4888241add1","item":[{"linkId":"relatedPerson","text":"Proxy details","item":[{"linkId":"relatedPerson_identifier","text":"NHS number","answer":[{"valueString":"9000000017"}]},{"linkId":"relatedPerson_basisForAccess","text":"Basis for Access","answer":[{"valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"PRN","display":"Parent"}}]},{"linkId":"relatedPerson_relationship","text":"Relationship","answer":[{"valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"PRN","display":"Parent"}}]}]},{"linkId":"parentalApplicationSupplementaryDetails","text":"Parental Application Supplementary Details","item":[{"linkId":"parentalApplicationSupplementaryDetails_evidenceOfResponsibility","text":"Evidence of parental responsibility","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-EvidenceOfResponsibility","code":"BRTH","display":"Birth certificate"}}]},{"linkId":"parentalApplicationSupplementaryDetails_isCurrentAddressConfirmed","text":"Is current address confirmed?","answer":[{"valueBoolean":true}]},{"linkId":"parentalApplicationSupplementaryDetails_liveAtSameAddress","text":"Do adult and child live at the same address?","answer":[{"valueBoolean":true}]}]},{"linkId":"patient","text":"Patient details","item":[{"linkId":"patient_identifier","text":"NHS number","answer":[{"valueString":"9000000002"}]},{"linkId":"patient_name","text":"Name","item":[{"linkId":"patient_name_first","text":"First name","answer":[{"valueString":"Timothy"}]},{"linkId":"patient_name_family","text":"Last name","answer":[{"valueString":"Tenenbaum"}]}]},{"linkId":"patient_birthDate","text":"Date of birth","answer":[{"valueDate":"2020-10-22"}]}]},{"linkId":"requestedAccess","text":"Requested access","item":[{"linkId":"requestedAccess_accessLevel","text":"Requested access level","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"PRESCR","display":"Request and manage repeat prescriptions"}},{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"APPT","display":"Appointment Booking"}},{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"RECRD","display":"GP Health Records Access"}},{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"TEST","display":"Test Results"}},{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"VACC","display":"Vaccination Records"}},{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"COND","display":"Health Conditions"}},{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"CONSULT","display":"Consultations and Events"}},{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"DOCS","display":"Documents"}}]},{"linkId":"requestedAccess_accessLevelMoreinfo","text":"Requested access level - further information","answer":[{"valueString":"My child cannot access their own record"}]},{"linkId":"requestedAccess_reasonsForAccess","text":"Reason for access","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess","code":"PRAC","display":"Practical Reasons"}}]}]}]}},"QuestionnaireResponseAdultToAdultWithoutCapacityRequest":{"description":"Example proxy access request from an adult (Danny) with NHS number `9876543210` requesting access to act on behalf of an elderly parent (Florence) without capacity wth NHS number `9000000008`.\n\nSignificant details to point out:\n\n- `source.type` should be `RelatedPerson` when a proxy is applying\n- `source.identifier.value` should be the NHS number of the user completing the form - this should correlate with the Identity token in the request\n- `subject.type` should be `Patient` since it is the patient that is the subject of the application\n- `subject.identifier.value` should be the NHS Number of the patient to which the application relates\n- `patient` demographics are present in the request as a result of being provided by the applicant\n","summary":"Adult > Adult (without capacity) access request","value":{"resourceType":"QuestionnaireResponse","status":"completed","authored":"2024-07-15T09:43:03.280Z","source":{"type":"RelatedPerson","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9876543210"}},"subject":{"type":"Patient","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000008"}},"questionnaire":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Questionnaire/01dc6813-3421-4d14-948d-a4888241add1","item":[{"linkId":"relatedPerson","text":"Proxy details","item":[{"linkId":"relatedPerson_identifier","text":"NHS number","answer":[{"valueString":"9876543210"}]},{"linkId":"relatedPerson_basisForAccess","text":"Basis for Access","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/STU3/CodeSystem/RARecord-ProxyRole-1","code":"002","display":"Best interest decision made on behalf of the patient (Mental Capacity Act 2005)"}}]},{"linkId":"relatedPerson_relationship","text":"Relationship","answer":[{"valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"CHILD","display":"Child"}}]}]},{"linkId":"patient","text":"Patient details","item":[{"linkId":"patient_identifier","text":"NHS number","answer":[{"valueString":"9000000008"}]},{"linkId":"patient_name","text":"Name","item":[{"linkId":"patient_name_first","text":"First name","answer":[{"valueString":"Florence"}]},{"linkId":"patient_name_family","text":"Last name","answer":[{"valueString":"Smith"}]}]},{"linkId":"patient_birthDate","text":"Date of birth","answer":[{"valueDate":"1935-01-02"}]}]},{"linkId":"requestedAccess","text":"Requested access","item":[{"linkId":"requestedAccess_accessLevel","text":"Requested access level","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"APPT","display":"Appointment Booking"}},{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"VACC","display":"Vaccination Records"}}]},{"linkId":"requestedAccess_reasonsForAccess","text":"Reason for access","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess","code":"TECH","display":"Technical Barriers"}}]}]}]}},"QuestionnaireResponseAdultToAdultWithCapacityRequest":{"description":"Example proxy access request from an adult (Tom) with NHS number `9000000005` requesting access to act on behalf of his wife (Jill) with NHS number `9000000006`.\n\nSignificant details to point out:\n\n- `source.type` should be `RelatedPerson` when a proxy is applying\n- `source.identifier.value` should be the NHS number of the user completing the form - this should correlate with the Identity token in the request\n- `subject.type` should be `Patient` since it is the patient that is the subject of the application\n- `subject.identifier.value` should be the NHS Number of the patient to which the application relates\n- `patient` demographics are present in the request as a result of being provided by the applicant\n","summary":"Adult > Adult (with capacity) access request","value":{"resourceType":"QuestionnaireResponse","status":"completed","authored":"2024-07-15T09:43:03.280Z","source":{"type":"RelatedPerson","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000005"}},"subject":{"type":"Patient","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000006"}},"questionnaire":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Questionnaire/01dc6813-3421-4d14-948d-a4888241add1","item":[{"linkId":"relatedPerson","text":"Proxy details","item":[{"linkId":"relatedPerson_identifier","text":"NHS number","answer":[{"valueString":"9000000005"}]},{"linkId":"relatedPerson_basisForAccess","text":"Basis for Access","answer":[{"valueCoding":{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole","code":"Personal","display":"Personal relationship with the patient"}}]},{"linkId":"relatedPerson_relationship","text":"Relationship","answer":[{"valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"SPS","display":"Spouse"}}]}]},{"linkId":"patient","text":"Patient details","item":[{"linkId":"patient_identifier","text":"NHS number","answer":[{"valueString":"9000000006"}]},{"linkId":"patient_name","text":"Name","item":[{"linkId":"patient_name_first","text":"First name","answer":[{"valueString":"Jill"}]},{"linkId":"patient_name_family","text":"Last name","answer":[{"valueString":"Jones"}]}]},{"linkId":"patient_birthDate","text":"Date of birth","answer":[{"valueDate":"1965-01-01"}]}]},{"linkId":"requestedAccess","text":"Requested access","item":[{"linkId":"requestedAccess_accessLevel","text":"Requested access level","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"APPT","display":"Appointment Booking"}},{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"VACC","display":"Vaccination Records"}}]},{"linkId":"requestedAccess_reasonsForAccess","text":"Reason for access","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess","code":"PRAC","display":"Practical Reasons"}}]}]}]}},"QuestionnaireResponseAdultNominatesAdultRequest":{"description":"Example proxy access request from an adult (Jill) with NHS number `9000000006` nominating her husband (Tom) with NHS number `9000000005` to act on her behalf.\n\nSignificant things to point out:\n\n- `source.type` should be `Patient` when a patient is nominating a proxy\n- `source.identifier.value` should be the NHS number of the user completing the form - this should correlate with the Identity token in the request\n- `subject.type` should be `Patient` since it is the patient that is the subject of the application\n- `subject.identifier.value` should be the NHS Number of the patient to which the application relates\n- `relatedPerson` demographics are present in the request as a result of being provided by the applicant\n","summary":"Adult nominates Adult access request","value":{"resourceType":"QuestionnaireResponse","status":"completed","authored":"2024-07-15T09:43:03.280Z","source":{"type":"Patient","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000006"}},"subject":{"type":"Patient","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000006"}},"questionnaire":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Questionnaire/01dc6813-3421-4d14-948d-a4888241add1","item":[{"linkId":"relatedPerson","text":"Proxy details","item":[{"linkId":"relatedPerson_identifier","text":"NHS number","answer":[{"valueString":"9000000005"}]},{"linkId":"relatedPerson_name","text":"Name","item":[{"linkId":"relatedPerson_name_first","text":"First name","answer":[{"valueString":"Tom"}]},{"linkId":"relatedPerson_name_family","text":"Last name","answer":[{"valueString":"Jones"}]}]},{"linkId":"relatedPerson_birthDate","text":"Date of birth","answer":[{"valueDate":"1970-07-12"}]},{"linkId":"relatedPerson_basisForAccess","text":"Basis for Access","answer":[{"valueCoding":{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole","code":"Personal","display":"Personal relationship with the patient"}}]},{"linkId":"relatedPerson_relationship","text":"Relationship","answer":[{"valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"SPS","display":"Spouse"}}]}]},{"linkId":"patient","text":"Patient details","item":[{"linkId":"patient_identifier","text":"NHS number","answer":[{"valueString":"9000000006"}]}]},{"linkId":"requestedAccess","text":"Requested access","item":[{"linkId":"requestedAccess_accessLevel","text":"Requested access level","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"APPT","display":"Appointment Booking"}},{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"VACC","display":"Vaccination Records"}}]},{"linkId":"requestedAccess_reasonsForAccess","text":"Reason for access","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess","code":"PRAC","display":"Practical Reasons"}}]}]}]}},"QuestionnaireResponseDuplicateRelationship":{"description":"Example proxy access request that triggers a 409 DUPLICATE_RELATIONSHIP error due to an existing proxy role with NHS number `9000000049` requesting access to act on behalf of a patient (Jill Jones) with NHS number `9000000006`.\n\nSignificant details to point out:\n\n- `source.type` should be `RelatedPerson` when a proxy is applying\n- `source.identifier.value` should be the NHS number of the user completing the form - this should correlate with the Identity token in the request\n- `subject.type` should be `Patient` since it is the patient that is the subject of the application\n- `subject.identifier.value` should be the NHS Number of the patient to which the application relates\n- `patient` demographics are present in the request as a result of being provided by the applicant\n","summary":"Duplicate relationship request","value":{"resourceType":"QuestionnaireResponse","status":"completed","authored":"2024-07-15T09:43:03.280Z","source":{"type":"RelatedPerson","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000049"}},"subject":{"type":"Patient","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000006"}},"questionnaire":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Questionnaire/01dc6813-3421-4d14-948d-a4888241add1","item":[{"linkId":"relatedPerson","text":"Proxy details","item":[{"linkId":"relatedPerson_identifier","text":"NHS number","answer":[{"valueString":"9000000049"}]},{"linkId":"relatedPerson_basisForAccess","text":"Basis for Access","answer":[{"valueCoding":{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole","code":"Personal","display":"Personal relationship with the patient"}}]},{"linkId":"relatedPerson_relationship","text":"Relationship","answer":[{"valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"SPS","display":"Spouse"}}]}]},{"linkId":"patient","text":"Patient details","item":[{"linkId":"patient_identifier","text":"NHS number","answer":[{"valueString":"9000000006"}]},{"linkId":"patient_name","text":"Name","item":[{"linkId":"patient_name_first","text":"First name","answer":[{"valueString":"Jill"}]},{"linkId":"patient_name_family","text":"Last name","answer":[{"valueString":"Jones"}]}]},{"linkId":"patient_birthDate","text":"Date of birth","answer":[{"valueDate":"1965-01-01"}]}]},{"linkId":"requestedAccess","text":"Requested access","item":[{"linkId":"requestedAccess_accessLevel","text":"Requested access level","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"APPT","display":"Appointment Booking"}},{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"VACC","display":"Vaccination Records"}}]},{"linkId":"requestedAccess_reasonsForAccess","text":"Reason for access","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess","code":"PRAC","display":"Practical Reasons"}}]}]}]}},"PostQuestionnaireResponseSuccess":{"description":"A sample of the payload returned when a QuestionnaireResponse (proxy access request) has been successfully submitted. It contains a unique alpha-numeric reference code to identify the request by.","summary":"Success","value":{"resourceType":"OperationOutcome","issue":[{"severity":"information","code":"informational","details":{"coding":[{"code":"19318ZGLAB","display":"19318ZGLAB"}]}}]}},"AccessDeniedError":{"description":"The request was unsuccessful due to invalid authentication credentials being provided.","summary":"Access Denied","value":{"issue":[{"code":"forbidden","details":{"coding":[{"code":"ACCESS_DENIED","display":"Missing or invalid OAuth 2.0 bearer token in request.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Missing or invalid OAuth 2.0 bearer token in request","severity":"error"}],"resourceType":"OperationOutcome"}},"PostQuestionnaireResponseDuplicateRelationshipError":{"description":"Error response for a duplicate proxy role","summary":"Duplicate request for proxy role that already exists","value":{"issue":[{"code":"invalid","diagnostics":"Proxy role already exists.","details":{"coding":[{"code":"DUPLICATE_RELATIONSHIP","display":"Request must be for a new proxy role.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"severity":"error"}],"resourceType":"OperationOutcome"}},"InternalServerError":{"description":"An unexpected condition was encountered preventing the server from fulfilling the request.","summary":"Internal Server Error","value":{"issue":[{"code":"exception","details":{"coding":[{"code":"SERVER_ERROR","display":"Failed to generate response","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Internal Server Error - Failed to generate response is present in the response","severity":"error"}],"resourceType":"OperationOutcome"}},"GetQuestionnaireResponseSuccess":{"description":"A sample of the QuestionnaireResponse retrieved using a valid reference code.","summary":"Successfully retrieved QuestionnaireResponse","value":{"resourceType":"QuestionnaireResponse","status":"completed","authored":"2024-07-15T09:43:03.280Z","id":"156e1560-e532-4e2a-85ad-5aeff03dc43e","identifier":{"value":"19318ZGLAB"},"source":{"type":"RelatedPerson","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000005"}},"subject":{"type":"Patient","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000006"}},"questionnaire":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Questionnaire/01dc6813-3421-4d14-948d-a4888241add1","item":[{"linkId":"relatedPerson","text":"Proxy details","item":[{"linkId":"relatedPerson_identifier","text":"NHS number","answer":[{"valueString":"9000000005"}]},{"linkId":"relatedPerson_name","text":"Name","item":[{"linkId":"relatedPerson_name_first","text":"First name","answer":[{"valueString":"Jack"}]},{"linkId":"relatedPerson_name_family","text":"Last name","answer":[{"valueString":"Jones"}]}]},{"linkId":"relatedPerson_birthDate","text":"Date of birth","answer":[{"valueDate":"1970-02-15"}]},{"linkId":"relatedPerson_basisForAccess","text":"Basis for Access","answer":[{"valueCoding":{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole","code":"PRN","display":"Parent"}}]},{"linkId":"relatedPerson_relationship","text":"Relationship","answer":[{"valueCoding":{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"PRN","display":"Parent"}}]}]},{"linkId":"patient","text":"Patient details","item":[{"linkId":"patient_identifier","text":"NHS number","answer":[{"valueString":"9000000006"}]},{"linkId":"patient_name","text":"Name","item":[{"linkId":"patient_name_first","text":"First name","answer":[{"valueString":"Jill"}]},{"linkId":"patient_name_family","text":"Last name","answer":[{"valueString":"Jones"}]}]},{"linkId":"patient_birthDate","text":"Date of birth","answer":[{"valueDate":"1965-01-01"}]}]},{"linkId":"requestedAccess","text":"Requested access","item":[{"linkId":"requestedAccess_accessLevel","text":"Requested access level","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"APPT","display":"Appointment Booking"}},{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess","code":"VACC","display":"Vaccination Records"}}]},{"linkId":"requestedAccess_reasonsForAccess","text":"Reason for access","answer":[{"valueCoding":{"system":"https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess","code":"PRAC","display":"Practical Reasons"}}]}]}]}},"InvalidAccessRequestID":{"description":"The provided access request ID is invalid in format.","summary":"Invalid access request ID","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1","code":"INVALID_IDENTIFIER_VALUE","display":"Invalid identifier value"}]},"diagnostics":"The specified access request ID is invalid. Access request IDs must be a valid UUID."}]}},"MethodNotAllowedError":{"description":"405 error response bundle as HTTP method is not allowed","summary":"Method is not allowed","value":{"resourceType":"OperationOutcome","issue":[{"code":"not-supported","details":{"coding":[{"system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1","code":"METHOD_NOT_ALLOWED","display":"The method is not allowed."}]},"diagnostics":"The method is not allowed for the requested resource.","severity":"error"}]}},"QuestionnaireResponseNotFound":{"description":"The Questionnaire response could not be found using the provided access request ID.","summary":"Questionnaire response not found","value":{"resourceType":"OperationOutcome","issue":[{"severity":"error","code":"not-found","details":{"coding":[{"system":"https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1","code":"QUESTIONNAIRE_RESPONSE_NOT_FOUND","display":"Questionnaire response not found"}]},"diagnostics":"The Questionnaire response could not be found using the provided access request ID."}]}},"ListRelationship9000000017":{"description":"Example response containing the details of a list of matched candidate proxy relationship between a birth mother and her children.\n\nThe FHIR Bundle contains a `RelatedPerson` resource for each of the relationships verified against authoritative sources.\n","summary":"List relationship response for 9000000017","value":{"entry":[{"fullUrl":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742","resource":{"id":"BE974742","birthDate":"2017-09-23","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}},"name":[{"family":"MOGAJI","given":["GADIL"],"period":{"start":"2021-07-08"},"prefix":["MR"],"use":"usual"}],"relationship":[{"coding":[{"code":"MTH","display":"mother","system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode"}]}],"resourceType":"RelatedPerson"},"search":{"mode":"match"}},{"fullUrl":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/A3CC67E2","resource":{"id":"A3CC67E2","birthDate":"2018-04-27","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000025"}},"name":[{"family":"FEARON","given":["Daren"],"period":{"start":"2018-09-21"},"prefix":["MR"],"use":"usual"}],"relationship":[{"coding":[{"code":"MTH","display":"mother","system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode"}]}],"resourceType":"RelatedPerson"},"search":{"mode":"match"}}],"link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?identifier=9000000017"}],"resourceType":"Bundle","timestamp":"2024-01-01T00:00:00+00:00","total":2,"type":"searchset"}},"ListRelationship9000000017Include":{"description":"Example response containing the details of a list of matched candidate proxy relationship between a birth mother and her children.\n\nThe FHIR Bundle contains a `RelatedPerson` resource for each of the relationships verified against authoritative sources.\n\n`Patient` resources are included in the bundle when the `_include=RelatedPerson:patient` query parameter is specified.\n","summary":"List relationship response for 9000000017 with include","value":{"entry":[{"fullUrl":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9000000009","resource":{"birthDate":"2017-09-23","id":"9000000009","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}],"name":[{"family":"MOGAJI","given":["GADIL"],"period":{"start":"2021-07-08"},"prefix":["MR"],"use":"usual"}],"resourceType":"Patient"},"search":{"mode":"include"}},{"fullUrl":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742","resource":{"id":"BE974742","birthDate":"2017-09-23","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}},"name":[{"family":"MOGAJI","given":["GADIL"],"period":{"start":"2021-07-08"},"prefix":["MR"],"use":"usual"}],"relationship":[{"coding":[{"code":"MTH","display":"mother","system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode"}]}],"resourceType":"RelatedPerson"},"search":{"mode":"match"}},{"fullUrl":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9000000025","resource":{"birthDate":"2018-04-27","id":"9000000025","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000025"}],"name":[{"family":"FEARON","given":["Daren"],"period":{"start":"2018-09-21"},"prefix":["MR"],"use":"usual"}],"resourceType":"Patient"},"search":{"mode":"include"}},{"fullUrl":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/A3CC67E2","resource":{"id":"A3CC67E2","birthDate":"2018-04-27","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000025"}},"name":[{"family":"FEARON","given":["Daren"],"period":{"start":"2018-09-21"},"prefix":["MR"],"use":"usual"}],"relationship":[{"coding":[{"code":"MTH","display":"mother","system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode"}]}],"resourceType":"RelatedPerson"},"search":{"mode":"match"}}],"link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?identifier=9000000017&_include=RelatedPerson:patient"}],"resourceType":"Bundle","timestamp":"2024-01-01T00:00:00+00:00","total":2,"type":"searchset"}},"ListRelationship9000000042":{"description":"Example response containing the details of a list of matched relationship between a child and their birth mother.\n\nThe FHIR Bundle contains a `RelatedPerson` resource for each of the relationships verified against authoritative sources.\n","summary":"List relationship response for 9000000042","value":{"entry":[{"fullUrl":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742","resource":{"birthDate":"2017-09-23","id":"BE974742","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}],"name":[{"family":"MOGAJI","given":["GADIL"],"period":{"start":"2021-07-08"},"prefix":["MR"],"use":"usual"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000042"}},"relationship":[{"coding":[{"code":"CHILD","display":"child","system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode"}]}],"resourceType":"RelatedPerson"},"search":{"mode":"match"}}],"link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?patient:identifier=9000000042"}],"resourceType":"Bundle","timestamp":"2024-01-01T00:00:00+00:00","total":1,"type":"searchset"}},"ListRelationship9000000042Include":{"description":"Example response containing the details of a list of matched relationship between a child and their birth mother.\n\nThe FHIR Bundle contains a `RelatedPerson` resource for each of the relationships verified against authoritative sources.\n\n`Patient` resources are included in the bundle when the `_include=RelatedPerson:patient` query parameter is specified.\n","summary":"List relationship response for 9000000042 with include","value":{"entry":[{"fullUrl":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742","resource":{"birthDate":"2017-09-23","id":"BE974742","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}],"name":[{"family":"MOGAJI","given":["GADIL"],"period":{"start":"2021-07-08"},"prefix":["MR"],"use":"usual"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000042"}},"relationship":[{"coding":[{"code":"CHILD","display":"child","system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode"}]}],"resourceType":"RelatedPerson"},"search":{"mode":"match"}},{"fullUrl":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9000000042","resource":{"birthDate":"2017-09-23","id":"9000000042","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000042"}],"name":[{"family":"MOGAJI","given":["GADIL"],"period":{"start":"2021-07-08"},"prefix":["MR"],"use":"usual"}],"resourceType":"Patient"},"search":{"mode":"include"}}],"link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?patient:identifier=9000000042"}],"resourceType":"Bundle","timestamp":"2024-01-01T00:00:00+00:00","total":1,"type":"searchset"}},"VerifyRelationship9000000009":{"description":"Example response containing the details of a single matched candidate proxy relationship between a birth mother and her child.\n\nThe FHIR Bundle contains a `RelatedPerson` resource for the relationship verified against authoritative sources.\n","summary":"Verify relationship response for 9000000009","value":{"resourceType":"Bundle","timestamp":"2024-01-01T00:00:00+00:00","total":1,"type":"searchset","entry":[{"fullUrl":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742","resource":{"id":"BE974742","birthDate":"2017-09-23","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}},"name":[{"family":"MOGAJI","given":["GADIL"],"period":{"start":"2021-07-08"},"prefix":["MR"],"use":"usual"}],"relationship":[{"coding":[{"code":"MTH","display":"mother","system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode"}]}],"resourceType":"RelatedPerson"},"search":{"mode":"match"}}],"link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?patient:identifier=9000000009&identifier=9000000017"}]}},"VerifyRelationship9000000009Include":{"description":"Example response containing the details of a single matched candidate proxy relationship between a birth mother and her child.\n\nThe FHIR Bundle contains a `RelatedPerson` resource for the relationship verified against authoritative sources.\n\n`Patient` resources are included in the bundle when the `_include=RelatedPerson:patient` query parameter is specified.\n","summary":"Verify relationship response for 9000000009 with include","value":{"resourceType":"Bundle","timestamp":"2024-01-01T00:00:00+00:00","total":1,"type":"searchset","link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?patient:identifier=9000000009&identifier=9000000017&_include=RelatedPerson:patient"}],"entry":[{"fullUrl":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9000000009","resource":{"birthDate":"2017-09-23","id":"9000000009","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}],"name":[{"family":"MOGAJI","given":["GADIL"],"period":{"start":"2021-07-08"},"prefix":["MR"],"use":"usual"}],"resourceType":"Patient"},"search":{"mode":"include"}},{"fullUrl":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742","resource":{"id":"BE974742","birthDate":"2017-09-23","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}},"name":[{"family":"MOGAJI","given":["GADIL"],"period":{"start":"2021-07-08"},"prefix":["MR"],"use":"usual"}],"relationship":[{"coding":[{"code":"MTH","display":"mother","system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode"}]}],"resourceType":"RelatedPerson"},"search":{"mode":"match"}}]}},"VerifyRelationship9000000025":{"description":"Example response containing the details of a single matched candidate proxy relationship between a birth mother and her child.\n\nThe FHIR Bundle contains a `RelatedPerson` resource for the relationship verified against authoritative sources.\n","summary":"Verify relationship response for 9000000025","value":{"entry":[{"fullUrl":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/A3CC67E2","resource":{"id":"A3CC67E2","birthDate":"2018-04-27","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000025"}},"name":[{"family":"FEARON","given":["Daren"],"period":{"start":"2018-09-21"},"prefix":["MR"],"use":"usual"}],"relationship":[{"coding":[{"code":"MTH","display":"mother","system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode"}]}],"resourceType":"RelatedPerson"},"search":{"mode":"match"}}],"link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?patient:identifier=9000000025&identifier=9000000017"}],"resourceType":"Bundle","timestamp":"2024-01-01T00:00:00+00:00","total":1,"type":"searchset"}},"VerifyRelationship9000000025Include":{"description":"Example response containing the details of a single matched candidate proxy relationship between a birth mother and her child.\n\nThe FHIR Bundle contains a `RelatedPerson` resource for the relationship verified against authoritative sources.\n\n`Patient` resources are included in the bundle when the `_include=RelatedPerson:patient` query parameter is specified.\n","summary":"Verify relationship response for 9000000025 with include","value":{"entry":[{"fullUrl":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/9000000025","resource":{"birthDate":"2018-04-27","id":"9000000025","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000025"}],"name":[{"family":"FEARON","given":["Daren"],"period":{"start":"2018-09-21"},"prefix":["MR"],"use":"usual"}],"resourceType":"Patient"},"search":{"mode":"include"}},{"fullUrl":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/A3CC67E2","resource":{"id":"A3CC67E2","birthDate":"2018-04-27","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000025"}},"name":[{"family":"FEARON","given":["Daren"],"period":{"start":"2018-09-21"},"prefix":["MR"],"use":"usual"}],"relationship":[{"coding":[{"code":"MTH","display":"mother","system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode"}]}],"resourceType":"RelatedPerson"},"search":{"mode":"match"}}],"link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson?patient:identifier=9000000025&identifier=9000000017&_include=RelatedPerson:patient"}],"resourceType":"Bundle","timestamp":"2024-01-01T00:00:00+00:00","total":1,"type":"searchset"}},"RelatedEmptyResponse":{"description":"Example response containing no details of any matched candidate proxy relationships.\n","summary":"Without additional records.","value":{"resourceType":"Bundle","timestamp":"2024-01-01T00:00:00+00:00","total":0,"type":"searchset","link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships-service-api/FHIR/R4/RelatedPerson?identifier=9000000033"}]}},"RelatedPersonInvalidIdentifierMissing":{"description":"The request was unsuccessful due to missing system identifier.","summary":"Invalid Identifier Missing","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"MISSING_IDENTIFIER_VALUE","display":"Missing RelatedPerson NHS number.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"The 'identifier' parameter is required","severity":"error"}],"resourceType":"OperationOutcome"}},"RelatedPersonInvalidIdentifierError":{"description":"Error raised due to an invalid RelatedPerson identifier request parameter being specified.","summary":"Invalid RelatedPerson identifier","value":{"issue":[{"code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1","code":"INVALID_IDENTIFIER_VALUE","display":"Provided value is invalid"}]},"diagnostics":"Not a valid NHS Number provided for the 'identifier' parameter","expression":["RelatedPerson.identifier"],"severity":"error"}],"resourceType":"OperationOutcome"}},"InvalidIdentifierPatientError":{"description":"Error raised due to an invalid Patient identifier request parameter being specified.","summary":"Invalid Patient identifier","value":{"issue":[{"code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1","code":"INVALID_PATIENT_IDENTIFIER_VALUE","display":"Provided value is invalid"}]},"diagnostics":"Not a valid NHS Number provided for the 'patient:identifier' parameter","severity":"error"}],"resourceType":"OperationOutcome"}},"RelatedPersonInvalidIdentifierSystem":{"description":"The request was unsuccessful due to incorrect system identifier.","summary":"Invalid Identifier System","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"INVALID_IDENTIFIER_SYSTEM","display":"Invalid identifier system.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"The identifier system is not valid.","severity":"error"}],"resourceType":"OperationOutcome"}},"ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle":{"description":"A Bundle containing multiple active proxy relationships with varying legal bases including the details of the performer and patient.","summary":"Multiple active relationships including performer and patient details","value":{"resourceType":"Bundle","timestamp":"2026-01-16T14:00:00+00:00","total":2,"type":"searchset","link":[{"relation":"self","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":{"resourceType":"Patient","id":"PR974746","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}],"name":[{"use":"usual","period":{"start":"2020-01-01","end":"2029-12-31"},"given":["Lisa"],"family":"Thompson","prefix":["Mrs"]}],"birthDate":"1990-07-18","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742","resource":{"resourceType":"RelatedPerson","id":"BE974742","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}},"relationship":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"PRN","display":"parent"}]},{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"MTH","display":"mother"}]}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2","resource":{"resourceType":"Patient","id":"A3CC67E2","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}],"name":[{"use":"usual","period":{"start":"2020-01-01","end":"2021-12-31"},"given":["Jane Marie Anne"],"family":"Smith","prefix":["Mrs"],"suffix":["MBE","PhD"]}],"birthDate":"2022-10-22","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9","resource":{"resourceType":"Consent","id":"BBCC67E9","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720","resource":{"resourceType":"RelatedPerson","id":"RP974720","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000005"}},"relationship":[{"coding":[{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole","code":"Personal","display":"Personal relationship with the patient"}]}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/DFCC67F5","resource":{"resourceType":"Patient","id":"DFCC67F5","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000005"}],"name":[{"use":"usual","period":{"start":"2020-01-01","end":"2021-12-31"},"given":["Sally"],"family":"Evans","prefix":["Mrs"]}],"birthDate":"1995-10-22","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1","resource":{"resourceType":"Consent","id":"WWCC67T1","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"role":{"coding":[{"code":"parental-responsibility","display":"Parental responsibility","system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis"}]},"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}}]}},"ConsentMultipleRelationshipsStatusInactiveBundle":{"description":"A Bundle containing multiple inactive proxy relationships with varying legal basis","summary":"Multiple inactive relationships","value":{"resourceType":"Bundle","timestamp":"2026-01-16T14:00:00+00:00","total":2,"type":"searchset","link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=inactive"}],"entry":[{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/AATD11A1","resource":{"resourceType":"Consent","id":"AATD11A1","status":"inactive","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/ABCD12B3","resource":{"resourceType":"Consent","id":"ABCD12B3","status":"inactive","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/consent-reason","code":"OTHER","display":"Other reason"}],"text":"Patient would not respond to phone calls"}},{"url":"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}}]}},"ConsentMultipleRelationshipsStatusProposedActiveBundle":{"description":"A Bundle containing multiple active and proposed proxy relationships with varying legal basis'","summary":"Multiple active and proposed relationships","value":{"resourceType":"Bundle","timestamp":"2026-01-16T14:00:00+00:00","total":4,"type":"searchset","link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=proposed&status=active&_include=Consent:patient"}],"entry":[{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9","resource":{"resourceType":"Consent","id":"BBCC67E9","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1","resource":{"resourceType":"Consent","id":"WWCC67T1","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBGY55L2","resource":{"resourceType":"Consent","id":"BBGY55L2","status":"proposed","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/EFGH12C5","resource":{"resourceType":"Consent","id":"EFGH12C5","status":"proposed","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}}]}},"ConsentMultipleRelationshipsBundle":{"description":"A Bundle containing multiple proxy relationships with varying legal basis'.","summary":"Multiple relationships","value":{"resourceType":"Bundle","timestamp":"2026-01-16T14:00:00+00:00","total":3,"type":"searchset","link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022"}],"entry":[{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9","resource":{"resourceType":"Consent","id":"BBCC67E9","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1","resource":{"resourceType":"Consent","id":"WWCC67T1","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/AATD11A1","resource":{"resourceType":"Consent","id":"AATD11A1","status":"inactive","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}}]}},"ConsentMultipleRelationshipsIncludePatientBundle":{"description":"A Bundle containing multiple proxy relationships with varying legal basis' including patient details","summary":"Multiple relationships with patient details","value":{"resourceType":"Bundle","timestamp":"2026-01-16T14:00:00+00:00","total":3,"type":"searchset","link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:patient"}],"entry":[{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2","resource":{"resourceType":"Patient","id":"A3CC67E2","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}],"name":[{"use":"usual","period":{"start":"2020-01-01","end":"2021-12-31"},"given":["Jane Marie Anne"],"family":"Smith","prefix":["Mrs"],"suffix":["MBE","PhD"]}],"birthDate":"2022-10-22","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9","resource":{"resourceType":"Consent","id":"BBCC67E9","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibilitydssds","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/DFCC67F5","resource":{"resourceType":"Patient","id":"DFCC67F5","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000005"}],"name":[{"use":"usual","period":{"start":"2020-01-01","end":"2021-12-31"},"given":["Sally"],"family":"Evans","prefix":["Mrs"]}],"birthDate":"1995-10-22","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1","resource":{"resourceType":"Consent","id":"WWCC67T1","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/ZPTT32T3","resource":{"resourceType":"Patient","id":"ZPTT32T3","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000006"}],"name":[{"use":"usual","period":{"start":"2020-01-01","end":"2021-12-31"},"given":["Michael"],"family":"Percy","prefix":["Mr"]}],"birthDate":"1991-1-13","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/AATD11A1","resource":{"resourceType":"Consent","id":"AATD11A1","status":"inactive","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}}]}},"ConsentMultipleRelationshipsIncludePerformerBundle":{"description":"A Bundle containing multiple proxy relationships with varying legal basis' including performer details","summary":"Multiple relationships with performer details","value":{"resourceType":"Bundle","timestamp":"2026-01-16T14:00:00+00:00","total":3,"type":"searchset","link":[{"relation":"self","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":{"resourceType":"Patient","id":"PR974743","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}],"name":[{"use":"usual","period":{"start":"2020-01-01","end":"2029-12-31"},"given":["David"],"family":"Brown","prefix":["Mr"]}],"birthDate":"1975-06-10","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742","resource":{"resourceType":"RelatedPerson","id":"BE974742","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}},"relationship":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"PRN","display":"parent"}]},{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"MTH","display":"mother"}]}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9","resource":{"resourceType":"Consent","id":"BBCC67E9","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720","resource":{"resourceType":"RelatedPerson","id":"RP974720","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000005"}},"relationship":[{"coding":[{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole","code":"Personal","display":"Personal relationship with the patient"}]}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1","resource":{"resourceType":"Consent","id":"WWCC67T1","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"best-interest","display":"Best interest"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/AATD11A1","resource":{"resourceType":"RelatedPerson","id":"AATD11A1","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000006"}},"relationship":[{"coding":[{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole","code":"Personal","display":"Personal relationship with the patient"}]}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/AATD11A1","resource":{"resourceType":"Consent","id":"AATD11A1","status":"inactive","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"best-interest","display":"Best interest"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}}]}},"ConsentMultipleRelationshipsIncludePerformerPatientBundle":{"description":"A Bundle containing multiple proxy relationships with varying legal basis' including performer and patient details.","summary":"Multiple relationships with performer and patient details","value":{"resourceType":"Bundle","timestamp":"2026-01-18T14:00:00+00:00","total":3,"type":"searchset","link":[{"relation":"self","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":{"resourceType":"Patient","id":"PR974743","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}],"name":[{"use":"usual","period":{"start":"2020-01-01","end":"2029-12-31"},"given":["David"],"family":"Brown","prefix":["Mr"]}],"birthDate":"1975-06-10","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742","resource":{"resourceType":"RelatedPerson","id":"BE974742","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}},"relationship":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"PRN","display":"parent"}]},{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"MTH","display":"mother"}]}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2","resource":{"resourceType":"Patient","id":"A3CC67E2","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}],"name":[{"use":"usual","period":{"start":"2020-01-01","end":"2021-12-31"},"given":["Jane Marie Anne"],"family":"Smith","prefix":["Mrs"],"suffix":["MBE","PhD"]}],"birthDate":"2022-10-22","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9","resource":{"resourceType":"Consent","id":"BBCC67E9","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720","resource":{"resourceType":"RelatedPerson","id":"RP974720","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000005"}},"relationship":[{"coding":[{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole","code":"Personal","display":"Personal relationship with the patient"}]}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/DFCC67F5","resource":{"resourceType":"Patient","id":"DFCC67F5","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000005"}],"name":[{"use":"usual","period":{"start":"2020-01-01","end":"2021-12-31"},"given":["Sally"],"family":"Evans","prefix":["Mrs"]}],"birthDate":"1995-10-22","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1","resource":{"resourceType":"Consent","id":"WWCC67T1","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"best-interest","display":"Best Interest"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/AATD11A1","resource":{"resourceType":"RelatedPerson","id":"AATD11A1","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000006"}},"relationship":[{"coding":[{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole","code":"Personal","display":"Personal relationship with the patient"}]}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/ZPTT32T3","resource":{"resourceType":"Patient","id":"ZPTT32T3","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000006"}],"name":[{"use":"usual","period":{"start":"2020-01-01","end":"2021-12-31"},"given":["Michael"],"family":"Percy","prefix":["Mr"]}],"birthDate":"1991-1-13","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/AATD11A1","resource":{"resourceType":"Consent","id":"AATD11A1","status":"inactive","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"best-interest","display":"Best Interest"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}}]}},"ConsentNoRelationshipsEmptyBundle":{"description":"An empty bundle resulting from the performer having no proxy relationships","summary":"No relationships","value":{"resourceType":"Bundle","timestamp":"2026-01-16T14:00:00+00:00","total":0,"type":"searchset","link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000025&_include=Consent:performer&_include=Consent:patient"}],"entry":[]}},"ConsentSingleConsentingAdultRelationshipBundle":{"description":"A Bundle containing a single proxy relationship between consenting adults.","summary":"Single consenting adult proxy relationship","value":{"resourceType":"Bundle","timestamp":"2026-01-16T14:00:00+00:00","total":1,"type":"searchset","link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010"}],"entry":[{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1","resource":{"resourceType":"Consent","id":"WWCC67T1","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"court-appointed-personal-welfare-deputy","display":"Court Appointed Personal Welfare Deputy"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000010"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}}]}},"ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle":{"description":"A Bundle containing a single proxy relationship between consenting adults including the performer and patient details.","summary":"Single consenting adult proxy relationship with performer and patient details","value":{"resourceType":"Bundle","timestamp":"2026-01-16T14:00:00+00:00","total":1,"type":"searchset","link":[{"relation":"self","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":{"resourceType":"Patient","id":"PR974720","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000010"}],"name":[{"use":"usual","period":{"start":"2020-01-01","end":"2029-12-31"},"given":["John"],"family":"Smith","prefix":["Mr"]}],"birthDate":"1980-01-15","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720","resource":{"resourceType":"RelatedPerson","id":"RP974720","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000010"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000005"}},"relationship":[{"coding":[{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole","code":"Personal","display":"Personal relationship with the patient"}]}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/DFCC67F5","resource":{"resourceType":"Patient","id":"DFCC67F5","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000005"}],"name":[{"use":"usual","period":{"start":"2025-01-01","end":"2029-12-31"},"given":["Sally"],"family":"Evans","prefix":["Mrs"]}],"birthDate":"1995-10-22","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1","resource":{"resourceType":"Consent","id":"WWCC67T1","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000010"}}}],"period":{"end":"2029-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}}]}},"ConsentSingleAdultChildRelationshipBundle":{"description":"A Bundle containing a single proxy relationship between an adult and child","summary":"Single adult child proxy relationship","value":{"resourceType":"Bundle","timestamp":"2026-01-16T14:00:00+00:00","total":1,"type":"searchset","link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019"}],"entry":[{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9","resource":{"resourceType":"Consent","id":"BBCC67E9","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000019"}}}],"period":{"end":"2029-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}}]}},"ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle":{"description":"A Bundle containing a single proxy relationship between an adult and child including the performer and patient details.","summary":"Single adult child proxy relationship with performer and patient details","value":{"resourceType":"Bundle","timestamp":"2026-01-16T14:00:00+00:00","total":1,"type":"searchset","link":[{"relation":"self","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":{"resourceType":"Patient","id":"PR974742","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000019"}],"name":[{"use":"usual","period":{"start":"2020-01-01","end":"2029-12-31"},"given":["Sarah"],"family":"Jones","prefix":["Mrs"]}],"birthDate":"1985-03-22","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742","resource":{"resourceType":"RelatedPerson","id":"BE974742","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000019"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}},"relationship":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"PRN","display":"parent"}]},{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"MTH","display":"mother"}]}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2","resource":{"resourceType":"Patient","id":"A3CC67E2","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}],"name":[{"use":"usual","period":{"start":"2025-01-01","end":"2029-12-31"},"given":["Jane Marie Anne"],"family":"Smith","prefix":["Miss"]}],"birthDate":"2022-10-22","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9","resource":{"resourceType":"Consent","id":"BBCC67E9","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000019"}}}],"period":{"end":"2029-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}}]}},"ConsentMultipleRelationshipsSinglePatientBundle":{"description":"A Bundle containing multiple proxy relationships with single patient.","summary":"Multiple relationships (multiple proxy relationships with single patient)","value":{"resourceType":"Bundle","timestamp":"2026-01-16T14:00:00+00:00","total":3,"type":"searchset","link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100"}],"entry":[{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9","resource":{"resourceType":"Consent","id":"BBCC67E9","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000020"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1","resource":{"resourceType":"Consent","id":"WWCC67T1","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"court-appointed-personal-welfare-deputy","display":"Court appointed personal welfare deputy"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000021"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/AATD11A1","resource":{"resourceType":"Consent","id":"AATD11A1","status":"inactive","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"court-appointed-personal-welfare-deputy","display":"Court Appointed Personal Welfare Deputy"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000022"}}}],"period":{"end":"2026-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}}]}},"ConsentInvalidIdentifierError":{"description":"Error raised due to an invalid identifier request parameter being specified.","summary":"Invalid identifier","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"INVALID_IDENTIFIER_VALUE","display":"Required parameter(s) are invalid.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Invalid request with error - performer:identifier or patient:identifier parameter is invalid.","severity":"error"}],"resourceType":"OperationOutcome"}},"ConsentInvalidIdentifierSystemError":{"description":"422 error response bundle for an invalid system of the identifier","summary":"Identifier system invalid","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"INVALID_IDENTIFIER_SYSTEM","display":"Required parameter(s) are invalid.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Invalid request with error - performer:identifier or patient:identifier system parameter is invalid.","severity":"error"}],"resourceType":"OperationOutcome"}},"ConsentIdentifierMissingError":{"description":"400 error response bundle for a missing identifier","summary":"Bad request identifier missing","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"MISSING_IDENTIFIER_VALUE","display":"Required parameter(s) are missing.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Invalid request with error - performer:identifier or patient:identifier parameter not found.","severity":"error"}],"resourceType":"OperationOutcome"}},"InvalidatedResourceError":{"description":"404 error response bundle for invalidated resource","summary":"Invalidated resource","value":{"issue":[{"code":"processing","details":{"coding":[{"system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1","code":"INVALIDATED_RESOURCE","display":"Resource that has been marked as invalid was requested - invalid resources cannot be retrieved"}]},"diagnostics":"Resource that has been marked as invalid was requested - invalid resources cannot be retrieved","severity":"error"}],"resourceType":"OperationOutcome"}},"ConsentInvalidStatusParameterError":{"description":"422 error response bundle for an invalid status parameter","summary":"status parameter invalid","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"INVALID_PARAMETER","display":"Required parameter(s) are invalid.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Invalid request with error - status parameter is invalid.","severity":"error"}],"resourceType":"OperationOutcome"}},"GPPracticeNotFoundError":{"description":"404 GP Practice not found error response bundle","summary":"GP Practice not found","value":{"issue":[{"code":"processing","details":{"coding":[{"system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1","code":"GP_PRACTICE_NOT_FOUND","display":"GP Practice could not be found - invalid resources cannot be retrieved"}]},"diagnostics":"GP Practice could not be found","severity":"error"}],"resourceType":"OperationOutcome"}},"InvalidIncludeParameterError":{"description":"400 error response bundle for an invalid include parameter","summary":"Bad request include param invalid","value":{"issue":[{"code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1","code":"INVALID_PARAMETER","display":"Required parameter(s) are invalid."}]},"diagnostics":"Invalid request with error - _include parameter is invalid.","severity":"error"}],"resourceType":"OperationOutcome"}},"DownstreamServiceError":{"description":"An unexpected condition was encountered in a downstream service preventing the server from fulfilling the request.","summary":"Downstream Service Error","value":{"issue":[{"code":"processing","details":{"coding":[{"code":"DOWNSTREAM_SERVICE_ERROR","display":"Failed to generate response","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Downstream Service Error - Failed to generate response is present in the response","severity":"error"}],"resourceType":"OperationOutcome"}},"ConsentParentChildProxyCreationRequest":{"summary":"Create a proxy role with parental responsibility basis","value":{"resourceType":"Consent","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"type":"Patient","identifier":{"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","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","period":{"start":"2025-02-11T14:30:00Z","end":"2029-02-11T14:30:00Z"},"actor":[{"reference":{"type":"RelatedPerson","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}}}]},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason","code":"ROLE_CREATED","display":"Role created from scratch by GP"}]}},{"url":"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]}},"ConsentAdultToAdultGuardianRequest":{"summary":"Create a proxy role with court appointed deputy basis","value":{"resourceType":"Consent","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"type":"Patient","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000012"}},"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","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":{"start":"2026-02-11T14:30:00Z"},"actor":[{"reference":{"type":"RelatedPerson","identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000017"}}}]},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason","code":"ROLE_CREATED","display":"Role created from scratch by GP"}]}},{"url":"https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]}},"PostConsentSuccess":{"description":"A sample of the payload returned when a proxy role has been successfully created","summary":"Success","value":{"resourceType":"OperationOutcome","issue":[{"severity":"information","code":"informational"}]}},"PostConsentDuplicateRelationshipError":{"description":"Error response for a duplicate proxy role","summary":"Duplicate request for proxy role that already exists","value":{"issue":[{"code":"invalid","diagnostics":"Proxy role already exists.","details":{"coding":[{"code":"DUPLICATE_RELATIONSHIP","display":"Request must be for a new proxy role.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"severity":"error"}],"resourceType":"OperationOutcome"}},"PostConsentInvalidIdentifierValueError":{"description":"Error response for invalid identifier value","summary":"Invalid Identifier Value Error","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"INVALID_IDENTIFIER_VALUE","display":"Invalid identifier value.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Performer identifier value is invalid","expression":["performer.identifier.value"],"severity":"error"}],"resourceType":"OperationOutcome"}},"PostConsentInvalidStatusError":{"description":"Error response for invalid status","summary":"Invalid Status Error","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"INVALID_STATUS","display":"Invalid status.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Status is invalid","expression":["status"],"severity":"error"}],"resourceType":"OperationOutcome"}},"PostConsentMissingIdentifierSystemError":{"description":"Error response for missing identifier system","summary":"Missing Identifier System Error","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"MISSING_IDENTIFIER_SYSTEM","display":"Required values are missing.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Unable to determine the patient identifier system","expression":["patient.identifier.system"],"severity":"error"}],"resourceType":"OperationOutcome"}},"PostConsentMissingScopeError":{"description":"Error response for missing scope","summary":"Missing Scope Error","value":{"issue":[{"code":"invalid","diagnostics":"Unable to find scope","details":{"coding":[{"code":"MISSING_SCOPE","display":"Required values are missing.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"expression":["scope"],"severity":"error"}],"resourceType":"OperationOutcome"}},"PostConsentInvalidRequestError":{"description":"Error raised due to a request not being able to be processed.","summary":"Invalid request. For example you cannot create a proxy role for status 'rejected'.","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"BAD_REQUEST","display":"The request could not be processed.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"The supplied input is not valid.","severity":"error"}],"resourceType":"OperationOutcome"}},"PostConsentInvalidFHIRRequestError":{"description":"Error raised due to a request not being a valid FHIR Consent Resource.","summary":"Request failed FHIR validation.","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"BAD_REQUEST","display":"The request could not be processed.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"The supplied input is not a valid FHIR Consent.","severity":"error"}],"resourceType":"OperationOutcome"}},"PostConsentMissingFreeTextForOtherError":{"description":"400 error response when free text is not provided for OTHER reason codes","summary":"Bad request when free text is missing for OTHER reason code","value":{"issue":[{"code":"invalid","diagnostics":"Free text is required when reason code is OTHER.","details":{"coding":[{"code":"MISSING_FREE_TEXT_FOR_OTHER","display":"Free text must be provided for OTHER reason codes.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"severity":"error"}],"resourceType":"OperationOutcome"}},"PostConsentMissingGrantorError":{"description":"Returned when creating a POST consent request with status 'active' but no grantor extension is included","summary":"Missing Grantor Extension for Active Consent","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"MISSING_GRANTOR","display":"Grantor required for active status","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Grantor extension is required when creating/updating an active proxy role","expression":["extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor')"],"severity":"error"}],"resourceType":"OperationOutcome"}},"PostConsentMissingGrantorReferenceError":{"description":"Returned when the grantor extension is missing reference","summary":"Missing Grantor Reference Structure","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"MISSING_GRANTOR_REFERENCE","display":"Missing grantor reference","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Grantor extension must contain a valueReference","expression":["extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference"],"severity":"error"}],"resourceType":"OperationOutcome"}},"PostConsentMissingGrantorIdentifierError":{"description":"Returned when the grantor extension is missing reference","summary":"Missing Grantor Identifier Structure","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"MISSING_GRANTOR_IDENTIFIER","display":"Missing grantor identifier","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Grantor extension must contain a valueIdentifier","expression":["extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier"],"severity":"error"}],"resourceType":"OperationOutcome"}},"PostConsentInvalidGrantorIdentifierSystemError":{"description":"Returned when the grantor identifier system is incorrect","summary":"Invalid Grantor Identifier System","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"INVALID_GRANTOR_SYSTEM","display":"Invalid grantor identifier system","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Valid grantor extension identifier system is required when creating/updating a consent with status 'active'","expression":["extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier.system"],"severity":"error"}],"resourceType":"OperationOutcome"}},"PostConsentInvalidGrantorIdentifierValueError":{"description":"Returned when the grantor ODS code value is invalid","summary":"Invalid Grantor ODS Code","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"INVALID_GRANTOR_VALUE","display":"Invalid grantor identifier value","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Valid grantor extension identifier value is required when creating/updating a consent with status 'active'","expression":["extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier.value"],"severity":"error"}],"resourceType":"OperationOutcome"}},"ConsentSingleConsentingAdultRelationshipIncludePatientBundle":{"description":"A Bundle containing a single proxy relationship between consenting adults including the patient details.","summary":"Single consenting adult proxy relationship with patient details","value":{"resourceType":"Bundle","timestamp":"2026-01-16T14:00:00+00:00","total":1,"type":"searchset","link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:patient"}],"entry":[{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/DFCC67F5","resource":{"resourceType":"Patient","id":"DFCC67F5","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000005"}],"name":[{"use":"usual","period":{"start":"2024-01-01","end":"2029-12-31"},"given":["Sally"],"family":"Evans","prefix":["Mrs"]}],"birthDate":"1995-10-22","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1","resource":{"resourceType":"Consent","id":"WWCC67T1","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000010"}}}],"period":{"end":"2029-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}}]}},"ConsentSingleConsentingAdultRelationshipIncludePerformerBundle":{"description":"A Bundle containing a single proxy relationship between consenting adults including the performer details.","summary":"Single consenting adult proxy relationship with performer details","value":{"resourceType":"Bundle","timestamp":"2026-01-16T14:00:00+00:00","total":1,"type":"searchset","link":[{"relation":"self","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":{"resourceType":"Patient","id":"PR974720","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000010"}],"name":[{"use":"usual","period":{"start":"2020-01-01","end":"2029-12-31"},"given":["John"],"family":"Smith","prefix":["Mr"]}],"birthDate":"1980-01-15","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720","resource":{"resourceType":"RelatedPerson","id":"RP974720","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000010"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000005"}},"relationship":[{"coding":[{"system":"https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole","code":"Personal","display":"Personal relationship with the patient"}]}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1","resource":{"resourceType":"Consent","id":"WWCC67T1","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000010"}}}],"period":{"end":"2029-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}}]}},"ConsentSingleAdultChildRelationshipIncludePatientBundle":{"description":"A Bundle containing a single proxy relationship between an adult and child including the patient details.","summary":"Single adult child proxy relationship with patient details","value":{"resourceType":"Bundle","timestamp":"2026-01-16T14:00:00+00:00","total":1,"type":"searchset","link":[{"relation":"self","url":"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:patient"}],"entry":[{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2","resource":{"resourceType":"Patient","id":"A3CC67E2","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}],"name":[{"use":"usual","period":{"start":"2025-01-01","end":"2029-12-31"},"given":["Jane Marie Anne"],"family":"Smith","prefix":["Miss"]}],"birthDate":"2022-10-22","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9","resource":{"resourceType":"Consent","id":"BBCC67E9","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000019"}}}]},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}}]}},"ConsentSingleAdultChildRelationshipIncludePerformerBundle":{"description":"A Bundle containing a single proxy relationship between an adult and child including the performer details.","summary":"Single adult child proxy relationship with performer details","value":{"resourceType":"Bundle","timestamp":"2026-01-16T14:00:00+00:00","total":1,"type":"searchset","link":[{"relation":"self","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":{"resourceType":"Patient","id":"PR974742","meta":{"security":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSIdentityProofingLevel","code":"P9","display":"High level verification (P9)"}]},"identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000019"}],"name":[{"use":"usual","period":{"start":"2020-01-01","end":"2029-12-31"},"given":["Sarah"],"family":"Jones","prefix":["Mrs"]}],"birthDate":"1985-03-22","generalPractitioner":[{"identifier":{"value":"ODS12345","system":"https://fhir.nhs.uk/Id/ods-organization-code"}}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742","resource":{"resourceType":"RelatedPerson","id":"BE974742","identifier":[{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000019"}],"patient":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000009"}},"relationship":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"PRN","display":"parent"}]},{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"MTH","display":"mother"}]}]},"search":{"mode":"include"}},{"fullUrl":"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9","resource":{"resourceType":"Consent","id":"BBCC67E9","status":"active","scope":{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy Consent"}]},"category":[{"coding":[{"system":"https://terminology.hl7.org/CodeSystem/v3-ActCode","code":"INFA","display":"information access"}]}],"patient":{"identifier":{"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"}],"policyRule":[{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}],"provision":{"type":"permit","actor":[{"reference":{"identifier":{"system":"https://fhir.nhs.uk/Id/nhs-number","value":"9000000019"}}}],"period":{"end":"2029-02-11","start":"2025-02-11"}},"meta":{"lastUpdated":"2025-02-17T14:30:00Z"},"extension":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"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.grantor","valueReference":{"identifier":{"system":"https://fhir.nhs.uk/Id/ods-organization-code","value":"G8101234"}}}]},"search":{"mode":"match"}}]}},"ConsentInvalidIDError":{"description":"Error raised due to an invalid ID request path being specified.","summary":"Invalid ID","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"INVALID_ID_VALUE","display":"Required parameter(s) are invalid.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Invalid request with error - ID must be a valid UUID.","severity":"error"}],"resourceType":"OperationOutcome"}},"StatusUpdate":{"description":"Example status change to inactive. Along with reason for the status change.","summary":"Update consent status","value":[{"op":"replace","path":"/status","value":"inactive"},{"op":"add","path":"/extension/-","value":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason","code":"ROLE_CREATED","display":"Role created"}]}}]}]},"UpdateProvisionEndDate":{"description":"Example apply end date to a relationship. The relationship will be considered as ended following this date.\n","summary":"Set provision end date","value":[{"op":"add","path":"/provision/period/end","value":"2026-12-31T23:59:59Z"}]},"MultipleUpdates":{"description":"Example of a combined update to a record.\nThe status will be changed to active.\nThe relationship will be considered as ended following this date.\n","summary":"Set status to active with an end date","value":[{"op":"replace","path":"/status","value":"active"},{"op":"add","path":"/extension/-","value":[{"url":"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason","valueCodeableConcept":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/consent-reason","code":"ROLE_ACTIVATED","display":"Role activated"}]}}]},{"op":"add","path":"/provision/period/end","value":"2026-12-31T23:59:59Z"}]},"ReplacePolicyRuleRequest":{"description":"payload used to add a new policy rule to the consent provision","summary":"Replace policy rule","value":[{"op":"add","path":"/policyRule","value":{"coding":[{"system":"https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis","code":"parental-responsibility","display":"Parental responsibility"}]}}]},"PatchConsentSuccess":{"description":"A sample of the payload returned when a proxy role has been successfully updated","summary":"Success","value":{"resourceType":"OperationOutcome","issue":[{"severity":"information","code":"informational"}]}},"PatchConsentInvalidPatchFormatError":{"description":"400 error response for a malformed JSON patch document","summary":"Bad request format is invalid","value":{"issue":[{"code":"invalid","diagnostics":"Malformed JSON patch document.","details":{"coding":[{"code":"INVALID_PATCH_FORMAT","display":"Request format is invalid.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"severity":"error"}],"resourceType":"OperationOutcome"}},"PatchConsentInvalidPathError":{"description":"400 error response for patch targeting non-existent element","summary":"Bad request path is invalid","value":{"issue":[{"code":"invalid","diagnostics":"Patch targeting non-existent element.","details":{"coding":[{"code":"INVALID_PATCH_PATH","display":"Patch target is invalid.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"severity":"error"}],"resourceType":"OperationOutcome"}},"PatchConsentInvalidStatusCodeError":{"description":"422 error response for a request with an invalid status code","summary":"Bad request invalid status code","value":{"issue":[{"code":"invalid","diagnostics":"Invalid status code.","details":{"coding":[{"code":"INVALID_STATUS_CODE","display":"Status code is invalid.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"severity":"error"}],"resourceType":"OperationOutcome"}},"PatchConsentInvalidStatusReasonError":{"description":"422 error response for a request with an invalid status reason","summary":"Bad request invalid status reason","value":{"issue":[{"code":"invalid","diagnostics":"Invalid status reason.","details":{"coding":[{"code":"INVALID_STATUS_REASON","display":"Status reason is invalid.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"severity":"error"}],"resourceType":"OperationOutcome"}},"PatchConsentInvalidStateTransitionError":{"description":"422 error response for a request with an invalid state transition","summary":"Bad request invalid state transition","value":{"issue":[{"code":"invalid","diagnostics":"Patch attempting invalid status change.","details":{"coding":[{"code":"INVALID_STATE_TRANSITION","display":"Status change is invalid.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"severity":"error"}],"resourceType":"OperationOutcome"}},"PatchConsentMissingFreeTextForOtherError":{"description":"400 error response when free text is not provided for OTHER reason codes","summary":"Bad request when free text is missing for OTHER reason code","value":{"issue":[{"code":"invalid","diagnostics":"Free text is required when reason code is OTHER.","details":{"coding":[{"code":"MISSING_FREE_TEXT_FOR_OTHER","display":"Free text must be provided for OTHER reason codes.","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"severity":"error"}],"resourceType":"OperationOutcome"}},"PatchConsentMissingGrantorError":{"description":"Returned when a PATCH request attempts to set status to 'active' without including a grantor extension in the same request","summary":"Missing Grantor Extension for Active Consent","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"MISSING_GRANTOR","display":"Grantor required for active status","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Grantor extension is required when creating/updating an active proxy role","expression":["extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor')"],"severity":"error"}],"resourceType":"OperationOutcome"}},"PatchConsentMissingGrantorReferenceError":{"description":"Returned when the grantor extension is missing reference","summary":"Missing Grantor Reference Structure","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"MISSING_GRANTOR_REFERENCE","display":"Missing grantor reference","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Grantor extension must contain a valueReference","expression":["extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference"],"severity":"error"}],"resourceType":"OperationOutcome"}},"PatchConsentMissingGrantorIdentifierError":{"description":"Returned when the grantor extension is missing identifier","summary":"Missing Grantor Identifier Structure","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"MISSING_GRANTOR_IDENTIFIER","display":"Missing grantor identifier","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Grantor extension must contain a valueIdentifier","expression":["extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier"],"severity":"error"}],"resourceType":"OperationOutcome"}},"PatchConsentInvalidGrantorIdentifierSystemError":{"description":"Returned when the grantor identifier system is incorrect","summary":"Invalid Grantor Identifier System","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"INVALID_GRANTOR_SYSTEM","display":"Invalid grantor identifier system","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Valid grantor extension identifier system is required when creating/updating a consent with status 'active'","expression":["extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier.system"],"severity":"error"}],"resourceType":"OperationOutcome"}},"PatchConsentInvalidGrantorIdentifierValueError":{"description":"Returned when the grantor ODS code value is invalid","summary":"Invalid Grantor ODS Code","value":{"issue":[{"code":"invalid","details":{"coding":[{"code":"INVALID_GRANTOR_VALUE","display":"Invalid grantor identifier value","system":"https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode","version":"1"}]},"diagnostics":"Valid grantor extension identifier value is required when creating/updating a consent with status 'active'","expression":["extension.where(url = 'https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor').valueReference.identifier.value"],"severity":"error"}],"resourceType":"OperationOutcome"}}},"parameters":{"RelatedPersonIdentifier":{"description":"The proxy's NHS number. For more information on FHIR tokens in general, [see here](https://build.fhir.org/search.html#token).\n","examples":{"withoutSystem":{"summary":"NHS number specified without system.","value":9000000017},"withSystem":{"summary":"System and NHS number specified","value":"https://fhir.nhs.uk/Id/nhs-number|9000000017"}},"explode":true,"in":"query","name":"identifier","required":false,"schema":{"format":"token","type":"string"},"style":"form"},"PatientIdentifier":{"description":"The patient's NHS number. For more information on FHIR tokens in general, [see here](https://build.fhir.org/search.html#token).\n","examples":{"withoutSystem":{"summary":"NHS number specified without system","value":9000000009},"withSystem":{"summary":"System and NHS number specified","value":"https://fhir.nhs.uk/Id/nhs-number|9000000009"}},"explode":true,"in":"query","name":"patient:identifier","required":false,"schema":{"format":"token","type":"string"},"style":"form"},"ConsentBundlePerformerIdentifier":{"description":"The performer's (Proxy) NHS number. For more information on FHIR tokens in general, [see here](https://build.fhir.org/search.html#token).\n","examples":{"withoutSystem":{"summary":"NHS number specified without system","value":9000000017},"withSystem":{"summary":"System and NHS number specified","value":"https://fhir.nhs.uk/Id/nhs-number|9000000017"}},"explode":true,"in":"query","name":"performer:identifier","required":false,"schema":{"format":"token","type":"string"},"style":"form"},"ConsentBundlePatientIdentifier":{"description":"The patient's NHS number. For more information on FHIR tokens in general, [see here](https://build.fhir.org/search.html#token).\n","examples":{"withoutSystem":{"summary":"NHS number specified without system","value":9000000017},"withSystem":{"summary":"System and NHS number specified","value":"https://fhir.nhs.uk/Id/nhs-number|9000000017"}},"explode":true,"in":"query","name":"patient:identifier","required":false,"schema":{"format":"token","type":"string"},"style":"form"},"RelatedPersonBundleIncludes":{"description":"Include referenced resources in the bundle response by specifying one or more `_include` parameters. Further info [here](https://www.hl7.org/fhir/search.html#_include).\n","examples":{"IncludePatient":{"summary":"Include the patient in the bundle","value":["RelatedPerson:patient"]}},"explode":true,"in":"query","name":"_include","required":false,"schema":{"items":{"enum":["RelatedPerson:patient"],"type":"string"},"type":"array"},"style":"form"},"ConsentBundleIncludes":{"description":"Include referenced resources in the bundle response by specifying one or more `_include` parameters. Further info [here](https://www.hl7.org/fhir/search.html#_include).","examples":{"FullInclude":{"summary":"Include the performer (proxy) and patient in the bundle","value":["Consent:performer","Consent:patient"]},"IncludePerformer":{"summary":"Include the performer (proxy) in the bundle","value":"Consent:performer"},"IncludePatient":{"summary":"Include the patient in the bundle","value":"Consent:patient"}},"explode":true,"in":"query","name":"_include","required":false,"schema":{"default":["Consent:performer","Consent:patient"],"items":{"enum":["Consent:performer","Consent:patient"],"type":"string"},"type":"array"},"style":"form"},"ConsentStatus":{"description":"Specify one or more `status` values to filter the records returned in the bundle.\n\nSupports FHIR search conventions:\n- **OR** â comma-separated values within a single parameter, e.g. `status=active,proposed` returns records with status `active` _or_ `proposed`.\n- **AND** â repeated parameters, e.g. `status=active&status=proposed`. For a single-valued field like `status`, AND groups are intersected; disjoint groups will return no results.\n- **AND of ORs** â e.g. `status=active,proposed&status=inactive`.\n\nValid status values are bound to the http://hl7.org/fhir/consent-state-codes CodeSystem: `proposed`, `active`, `rejected`, `inactive`, `entered-in-error`.\n","examples":{"Active":{"summary":"Only active authorised proxy relationships","value":"active"},"Revoked":{"summary":"Only revoked proxy relationships","value":"inactive"},"ActiveOrProposed":{"summary":"Active OR proposed (but not yet authorised) proxy relationships","value":["proposed,active"]}},"explode":true,"in":"query","name":"status","required":false,"schema":{"items":{"description":"A single status value, or a comma-separated list of status values representing an OR group. Valid values are: `proposed`, `active`, `rejected`, `inactive`, `entered-in-error`.\n","type":"string"},"type":"array"},"style":"form"},"BearerAuthorization":{"description":"An [OAuth 2.0 bearer token](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#user-restricted-apis).\n","explode":false,"in":"header","name":"Authorization","required":true,"schema":{"example":"Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM","format":"^Bearer\\ [[:ascii:]]+$","type":"string"},"style":"simple"},"RequestID":{"description":"A globally unique identifier (GUID) for the request, which we use to correlate logs through different components.\nMust be a universally unique identifier (UUID) (ideally version 4).\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Request-ID","required":true,"schema":{"example":"60e0b220-8136-4ca5-ae46-1d97ef59d068","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"},"CorrelationID":{"description":"An optional ID which you can use to track transactions across multiple systems.\nMust be a universally unique identifier (UUID) (ideally version 4).\nMirrored back in a response header.\n","explode":false,"in":"header","name":"X-Correlation-ID","required":false,"schema":{"example":"11c46f5f-cdef-4865-94b2-0ee0edcc26da","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"},"Im1ConnectionParams":{"description":"An optional `;` delimited string containing parameters required to refresh proxy relationships from GPIT supplier systems. Parameters that comprise this string are:\n\n- IM1 User Connection token\n- ODS Code\n","explode":false,"in":"header","name":"X-IM1-Connection-Params","required":false,"schema":{"example":"NiV3CyMJH3xYV26ghlVpbbjT7pDVEA8HpFczAjRLTs1VezC4CYzupZ3XxXAWM7ELuseqrV8r0Ill7EL7G2tXUaVHCPWgg4q10+MxFjnRPrjDvckBRSZazqZcp0K2VBdUV0rZ7RUYJNJsjVAeefWhiK/Y4R+GFO86QDpt41JS9xA=;G123456","pattern":"^[^;]+;[^;]+$","type":"string"},"style":"simple"},"ConsentID":{"description":"The logical id of the Consent resource","explode":false,"in":"path","name":"id","required":true,"schema":{"example":"74eed847-ca25-4e76-8cf2-f2c2d7842a7a","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"},"AccessRequestID":{"description":"The unique access request ID of the QuestionnaireResponse to retrieve","explode":false,"in":"path","name":"id","required":true,"schema":{"example":"156e1560-e532-4e2a-85ad-5aeff03dc43e","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},"style":"simple"}},"schemas":{"QuestionnaireResponse":{"description":"A FHIR QuestionnaireResponse","properties":{"resourceType":{"description":"The FHIR resource type","enum":["QuestionnaireResponse"],"type":"string"},"status":{"description":"The position of the questionnaire response within its overall lifecycle.","enum":["completed"],"type":"string"},"authored":{"description":"The date time that this set of answers were last changed.","format":"date-time","type":"string"},"source":{"$ref":"#/components/schemas/QuestionnaireResponse_source"},"subject":{"$ref":"#/components/schemas/QuestionnaireResponse_subject"},"questionnaire":{"description":"The Questionnaire that defines and organizes the questions for which answers are being provided.","type":"string"},"item":{"description":"A group or question item from the original questionnaire for which answers are provided.","items":{"$ref":"#/components/schemas/QuestionnaireResponse_item_inner"},"type":"array"}},"required":["authored","questionnaire","source","status","subject"],"type":"object"},"QuestionnaireResponseItem_RelatedPerson":{"properties":{"linkId":{"enum":["relatedPerson"],"type":"string"},"text":{"type":"string"},"item":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner"},"type":"array"}},"required":["item","linkId","text"],"type":"object"},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails":{"properties":{"linkId":{"enum":["parentalApplicationSupplementaryDetails"],"type":"string"},"text":{"type":"string"},"item":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner"},"type":"array"}},"type":"object"},"QuestionnaireResponseItem_Patient":{"properties":{"linkId":{"enum":["patient"],"type":"string"},"text":{"type":"string"},"item":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_Patient_item_inner"},"type":"array"}},"required":["item","linkId","text"],"type":"object"},"QuestionnaireResponseItem_RequestedAccess":{"properties":{"linkId":{"enum":["requestedAccess"],"type":"string"},"text":{"type":"string"},"item":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RequestedAccess_item_inner"},"type":"array"}},"required":["item","linkId","text"],"type":"object"},"BaseBundle":{"description":"A FHIR Bundle.","properties":{"resourceType":{"description":"FHIR resource type.","enum":["Bundle"],"type":"string"},"timestamp":{"description":"The UTC date and time the search results were returned.","format":"date-time","type":"string"},"total":{"description":"The number of resources contained within the Bundle.\n","type":"number"}},"type":"object"},"Searchset":{"allOf":[{"$ref":"#/components/schemas/BaseBundle"},{"properties":{"type":{"description":"Denotes that the Bundle is a collection of resources returned as a result of a search.","enum":["searchset"],"type":"string"}},"type":"object"}]},"Link":{"properties":{"link":{"description":"Links related to the entry","items":{"$ref":"#/components/schemas/Link_link_inner"},"type":"array"}},"type":"object"},"RelatedPersonBundle":{"allOf":[{"$ref":"#/components/schemas/Searchset"},{"properties":{"link":{"items":{"$ref":"#/components/schemas/RelatedPersonBundle_allOf_link"},"type":"array"},"entry":{"description":"A collection of resources contained within the Bundle.\n\nAn empty bundle suggests that no candidate proxy/patient links were identified.\n","items":{"$ref":"#/components/schemas/RelatedPersonBundle_allOf_entry"},"type":"array"}},"type":"object"}]},"ConsentBundle":{"allOf":[{"$ref":"#/components/schemas/Searchset"},{"$ref":"#/components/schemas/Link"},{"properties":{"entry":{"description":"A collection of resources contained within the Bundle.\n\nAn empty bundle suggests that the proxy has no proxy relationships.\n","items":{"$ref":"#/components/schemas/ConsentBundle_allOf_entry"},"type":"array"}},"type":"object"}]},"RelatedPersonWithDetailsBundleEntry":{"allOf":[{"$ref":"#/components/schemas/RelatedPersonBundleEntry"},{"description":"A RelatedPerson bundle entry with patient name and birthDate.","properties":{"resource":{"$ref":"#/components/schemas/RelatedPersonWithDetailsBundleEntry_allOf_resource"}},"type":"object"}],"type":"object"},"RelatedPersonBundleEntry":{"description":"A RelatedPerson bundle entry.","properties":{"fullUrl":{"description":"The canonical URL of the resource in the entry","type":"string"},"resource":{"$ref":"#/components/schemas/RelatedPerson"},"search":{"$ref":"#/components/schemas/RelatedPersonBundleEntry_search"}},"type":"object"},"PatientBundleEntry":{"description":"A Patient bundle entry.","properties":{"fullUrl":{"description":"The canonical URL of the resource in the entry","type":"string"},"resource":{"$ref":"#/components/schemas/Patient"},"search":{"$ref":"#/components/schemas/RelatedPersonBundleEntry_search"}},"type":"object"},"ConsentBundleEntry":{"description":"A Consent bundle entry.","properties":{"fullUrl":{"description":"The canonical URL of the resource in the entry","type":"string"},"resource":{"$ref":"#/components/schemas/ReadConsent"},"search":{"$ref":"#/components/schemas/RelatedPersonBundleEntry_search"}},"type":"object"},"RelatedPerson":{"description":"The proxy's details. This includes their relationship to the referenced patient.","properties":{"resourceType":{"default":"RelatedPerson","description":"FHIR resource type.","enum":["RelatedPerson"],"type":"string"},"id":{"description":"Unique identifier of the RelatedPerson resource.","type":"string"},"identifier":{"description":"The proxy's NHS number. The primary identifier of a patient, unique within NHS England and Wales. Always 10 digits and must be a [valid NHS number](https://www.datadictionary.nhs.uk/attributes/nhs_number.html).","items":{"$ref":"#/components/schemas/RelatedPerson_identifier_inner"},"type":"array"},"patient":{"$ref":"#/components/schemas/RelatedPerson_patient"},"relationship":{"description":"How the proxy is related to the patient.","items":{"$ref":"#/components/schemas/RelatedPerson_relationship_inner"},"type":"array"}},"type":"object"},"Patient":{"description":"The patient's details.","properties":{"resourceType":{"default":"Patient","description":"FHIR resource type.","enum":["Patient"],"type":"string"},"id":{"description":"Unique identifier of the Patient resource","type":"string"},"meta":{"$ref":"#/components/schemas/Patient_meta"},"identifier":{"description":"The primary identifier of a patient. Possible identifiers include the NHS number or local GP patient identifier. If it is an NHS number, it will always 10 digits and must be a [valid NHS number](https://www.datadictionary.nhs.uk/attributes/nhs_number.html).","items":{"$ref":"#/components/schemas/Patient_identifier_inner"},"type":"array"},"name":{"$ref":"#/components/schemas/PDSName"},"birthDate":{"$ref":"#/components/schemas/PDSBirthDate"},"generalPractitioner":{"description":"Patient's nominated primary care provider, each a Reference(Organization | Practitioner | PractitionerRole).","items":{"$ref":"#/components/schemas/Reference"},"type":"array"}},"type":"object"},"Consent":{"description":"The details of the consent including who the patient and care \"performer\" are, status of the relationship and whether consent was given by a patient with capacity.","properties":{"resourceType":{"default":"Consent","description":"FHIR resource type.","enum":["Consent"],"type":"string"},"id":{"description":"Unique identifier of the Consent resource","type":"string"},"status":{"description":"The status of the consent, following the ConsentStateCodes value set. See more information about this codesystem in the [FHIR specification](http://hl7.org/fhir/R4/codesystem-consent-state-codes.html).","enum":["proposed","active","rejected","inactive","entered-in-error"],"type":"string"},"scope":{"$ref":"#/components/schemas/CodeableConcept"},"category":{"description":"Classification of the type of consent, bound to http://terminology.hl7.org/CodeSystem/v3-ActCode.","items":{"$ref":"#/components/schemas/CodeableConcept"},"type":"array"},"patient":{"$ref":"#/components/schemas/Reference"},"dateTime":{"description":"Date and time when the consent was created.","format":"date-time","type":"string"},"performer":{"description":"Individuals or organizations that agreed to the consent.","items":{"$ref":"#/components/schemas/Reference"},"maxItems":1,"type":"array"},"policy":{"items":{"$ref":"#/components/schemas/Policy"},"type":"array"},"policyRule":{"items":{"$ref":"#/components/schemas/CodeableConcept"},"type":"array"},"provision":{"$ref":"#/components/schemas/Provision"},"extension":{"description":"Additional content. For active proxy roles, grantor is required.","items":{"$ref":"#/components/schemas/Consent_extension_inner"},"type":"array"}},"required":["category","dateTime","extension","id","patient","scope","status"],"type":"object"},"ReadConsent":{"allOf":[{"$ref":"#/components/schemas/Consent"},{"properties":{"meta":{"$ref":"#/components/schemas/ReadConsent_allOf_meta"}},"type":"object"}]},"Policy":{"properties":{"authority":{"description":"Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.","format":"uri","type":"string"},"uri":{"description":"The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.","format":"uri","type":"string"}},"type":"object"},"Provision":{"description":"Constraints to the base Consent policy rule, which may be enforced over time.","properties":{"type":{"description":"Action to take for this provision of the consent.","enum":["permit","deny"],"type":"string"},"period":{"$ref":"#/components/schemas/Provision_period"},"actor":{"description":"Individuals or organisations involved in the provision","items":{"$ref":"#/components/schemas/Provision_actor_inner"},"type":"array"}},"type":"object"},"StatusReasonExtension":{"properties":{"url":{"enum":["https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason"],"type":"string"},"valueCodeableConcept":{"$ref":"#/components/schemas/CodeableConcept"}},"type":"object"},"GrantorExtension":{"properties":{"url":{"enum":["https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor"],"type":"string"},"valueReference":{"$ref":"#/components/schemas/GrantorExtension_valueReference"}},"type":"object"},"OperationOutcome":{"description":"Outcome of an operation that does not result in a resource or bundle being returned, for example an error or an async/batch submission.\nThere are a number of possible error codes that can be returned along with a more detailed description in the `display` field.\n","properties":{"resourceType":{"default":"OperationOutcome","description":"FHIR Resource Type.","type":"string"},"issue":{"description":"List of issues that have occurred.","items":{"$ref":"#/components/schemas/OperationOutcome_issue_inner"},"minItems":1,"type":"array"}},"type":"object"},"Reference":{"properties":{"identifier":{"$ref":"#/components/schemas/Identifier"}},"required":["identifier"],"type":"object"},"Identifier":{"properties":{"system":{"description":"The namespace for the identifier.","type":"string"},"value":{"description":"The value that is unique.","type":"string"}},"required":["system","value"],"type":"object"},"CodeableConcept":{"properties":{"coding":{"items":{"$ref":"#/components/schemas/Coding"},"type":"array"},"text":{"description":"Plain text representation of the concept.","type":"string"}},"type":"object"},"Coding":{"properties":{"system":{"description":"The identification of the code system that defines the meaning of the code.","type":"string"},"code":{"description":"The actual code from the code system.","type":"string"},"display":{"description":"A human-readable representation of the code.","type":"string"}},"type":"object"},"PatchOperation":{"properties":{"op":{"enum":["add","remove","replace"],"type":"string"},"path":{"description":"Static paths that do not require an index.","enum":["/status","/extension/-","/provision/period/end","/provision/actor"],"type":"string"},"value":{"$ref":"#/components/schemas/PatchOperation_value"}},"required":["op","path"],"type":"object"},"PDSName":{"description":"List of names associated with the patient.","items":{"$ref":"#/components/schemas/PDSName_inner"},"type":"array"},"PDSBirthDate":{"description":"The date on which the patient was born or is officially deemed to have been born.\n\nIt is a date in the format `yyyy-mm-dd`. Due to data quality issues on a small number of patients `yyyy-mm` and `yyyy` format may also be returned.\n","format":"date","type":"string"},"QuestionnaireResponse_source_identifier":{"description":"The person who answered the questions about the subject NHS number. The primary identifier of a patient, unique within NHS England and Wales. Always 10 digits and must be a valid NHS number - see:\nhttps://www.datadictionary.nhs.uk/attributes/nhs_number.html\n","properties":{"system":{"description":"Codesystem URL for source's NHS number.","enum":["https://fhir.nhs.uk/Id/nhs-number"],"type":"string"},"value":{"description":"The source's NHS number.","type":"string"}}},"QuestionnaireResponse_source":{"description":"The person who answered the questions about the subject.","properties":{"type":{"enum":["Patient","RelatedPerson"],"type":"string"},"identifier":{"$ref":"#/components/schemas/QuestionnaireResponse_source_identifier"}},"type":"object"},"QuestionnaireResponse_subject_identifier":{"description":"The patient's NHS number. The primary identifier of a patient, unique within NHS England and Wales. Always 10 digits and must be a valid NHS number - see:\nhttps://www.datadictionary.nhs.uk/attributes/nhs_number.html\n","properties":{"system":{"description":"Codesystem URL for the subject's NHS number.","enum":["https://fhir.nhs.uk/Id/nhs-number"],"type":"string"},"value":{"description":"The subject's NHS number.","type":"string"}}},"QuestionnaireResponse_subject":{"description":"The person who is the subject.","properties":{"type":{"enum":["Patient"],"type":"string"},"identifier":{"$ref":"#/components/schemas/QuestionnaireResponse_subject_identifier"}},"type":"object"},"QuestionnaireResponse_item_inner":{"oneOf":[{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_Patient"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_RequestedAccess"}]},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner_oneOf":{"properties":{"valueString":{"type":"string"}},"type":"object"},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner":{"oneOf":[{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner_oneOf"}]},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf":{"properties":{"linkId":{"enum":["relatedPerson_identifier"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"maxItems":1,"minItems":1,"type":"array"}},"required":["answer","linkId","text"],"type":"object"},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_1_item_inner_oneOf":{"properties":{"linkId":{"enum":["relatedPerson_name_first"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"maxItems":1,"minItems":1,"type":"array"}},"required":["answer","linkId","text"],"type":"object"},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_1_item_inner_oneOf_1":{"properties":{"linkId":{"enum":["relatedPerson_name_family"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"maxItems":1,"minItems":1,"type":"array"}},"required":["answer","linkId","text"],"type":"object"},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_1_item_inner":{"oneOf":[{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_1_item_inner_oneOf"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_1_item_inner_oneOf_1"}]},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_1":{"properties":{"linkId":{"enum":["relatedPerson_name"],"type":"string"},"text":{"type":"string"},"item":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_1_item_inner"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_2_answer_inner_oneOf":{"properties":{"valueDate":{"format":"date","type":"string"}},"type":"object"},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_2_answer_inner":{"oneOf":[{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_2_answer_inner_oneOf"}]},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_2":{"properties":{"linkId":{"enum":["relatedPerson_birthDate"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_2_answer_inner"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_3_answer_inner_oneOf_valueCoding":{"properties":{"system":{"enum":["http://terminology.hl7.org/CodeSystem/v3-RoleCode","https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole","https://fhir.nhs.uk/STU3/CodeSystem/RARecord-ProxyRole-1"],"type":"string"},"code":{"enum":["PRN","Personal","002"],"type":"string"},"display":{"description":"FHIR relationship type.","enum":["Parent","Personal relationship with the patient","Best interest decision made on behalf of the patient (Mental Capacity Act 2005)"],"type":"string"}},"type":"object"},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_3_answer_inner_oneOf":{"properties":{"valueCoding":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_3_answer_inner_oneOf_valueCoding"}},"type":"object"},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_3_answer_inner":{"oneOf":[{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_3_answer_inner_oneOf"}]},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_3":{"properties":{"linkId":{"enum":["relatedPerson_basisForAccess"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_3_answer_inner"},"maxItems":1,"minItems":1,"type":"array"}},"required":["answer","linkId","text"],"type":"object"},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_4_answer_inner_oneOf_valueCoding":{"properties":{"system":{"enum":["http://terminology.hl7.org/CodeSystem/v3-RoleCode","http://terminology.hl7.org/CodeSystem/v3-RoleClass","https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole"],"type":"string"},"code":{"enum":["PRN","CHILD","SPS","FAMMEMB","FRND","CAREGIVER","SIGOTHR"],"type":"string"},"display":{"description":"FHIR relationship type.","enum":["Parent","Child","Partner, wife or husband","Other family member","Friend, neighbour or housemate","Paid carer or support worker","Other"],"type":"string"}},"type":"object"},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_4_answer_inner_oneOf":{"properties":{"valueCoding":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_4_answer_inner_oneOf_valueCoding"}},"type":"object"},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_4_answer_inner":{"oneOf":[{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_4_answer_inner_oneOf"}]},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_4":{"properties":{"linkId":{"enum":["relatedPerson_relationship"],"type":"string"},"text":{"type":"string"},"answer":{"description":"The directionality of the relationship is from the RelatedPerson (proxy) to the Patient. For example, if the Patient is a child, and the RelatedPerson is the mother, the relationship would be PRN (parent). Crucially, the relationship type is defined by the role that the proxy plays in the relationship.","items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_4_answer_inner"},"maxItems":1,"minItems":1,"type":"array"}},"required":["answer","linkId","text"],"type":"object"},"QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_5":{"properties":{"linkId":{"enum":["relatedPerson_relationshipMoreinfo"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"maxItems":1,"type":"array"}},"type":"object"},"QuestionnaireResponseItem_RelatedPerson_item_inner":{"oneOf":[{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_1"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_2"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_3"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_4"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_5"}]},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_answer_inner_oneOf_valueCoding":{"properties":{"system":{"enum":["https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-EvidenceOfResponsibility"],"type":"string"},"code":{"enum":["BRTH","ADPT","PRNA","SPRNA","PORD","SGORD","OTHCOURT","OTHR"],"type":"string"},"display":{"description":"Evidence of responsibility type.","enum":["Birth certificate","Adoption certificate","Court-witnessed parental responsibility agreement","Court-witnessed step-parent parental responsibility agreement","Parental order","Special guardianship order","Other court order","Other"],"type":"string"}},"type":"object"},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_answer_inner_oneOf":{"properties":{"valueCoding":{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_answer_inner_oneOf_valueCoding"}},"type":"object"},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_answer_inner":{"oneOf":[{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_answer_inner_oneOf"}]},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf":{"properties":{"linkId":{"enum":["parentalApplicationSupplementaryDetails_evidenceOfResponsibility"],"type":"string"},"text":{"type":"string"},"answer":{"description":"Evidence of responsibility","items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_answer_inner"},"maxItems":1,"type":"array"}},"required":["answer","linkId","text"],"type":"object"},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_1":{"properties":{"linkId":{"enum":["parentalApplicationSupplementaryDetails_evidenceOfResponsibilityMoreinfo"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"type":"array"}},"type":"object"},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_2":{"properties":{"linkId":{"enum":["parentalApplicationSupplementaryDetails_isCurrentAddressConfirmed"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"type":"array"}},"required":["answer","linkId","text"],"type":"object"},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_3_item_inner_oneOf":{"properties":{"linkId":{"enum":["parentalApplicationSupplementaryDetails_line1"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"type":"array"}},"type":"object"},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_3_item_inner_oneOf_1":{"properties":{"linkId":{"enum":["parentalApplicationSupplementaryDetails_line2"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"type":"array"}},"type":"object"},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_3_item_inner_oneOf_2":{"properties":{"linkId":{"enum":["parentalApplicationSupplementaryDetails_line3"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"type":"array"}},"type":"object"},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_3_item_inner_oneOf_3":{"properties":{"linkId":{"enum":["parentalApplicationSupplementaryDetails_city"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"type":"array"}},"type":"object"},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_3_item_inner_oneOf_4":{"properties":{"linkId":{"enum":["parentalApplicationSupplementaryDetails_district"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"type":"array"}},"type":"object"},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_3_item_inner_oneOf_5":{"properties":{"linkId":{"enum":["parentalApplicationSupplementaryDetails_postalCode"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"type":"array"}},"type":"object"},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_3_item_inner":{"oneOf":[{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_3_item_inner_oneOf"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_3_item_inner_oneOf_1"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_3_item_inner_oneOf_2"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_3_item_inner_oneOf_3"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_3_item_inner_oneOf_4"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_3_item_inner_oneOf_5"}]},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_3":{"properties":{"linkId":{"enum":["parentalApplicationSupplementaryDetails_newAddress"],"type":"string"},"text":{"type":"string"},"item":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_3_item_inner"},"type":"array"}},"type":"object"},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_4":{"properties":{"linkId":{"enum":["parentalApplicationSupplementaryDetails_liveAtSameAddress"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"type":"array"}},"required":["answer","linkId","text"],"type":"object"},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_5":{"properties":{"linkId":{"enum":["parentalApplicationSupplementaryDetails_canChildConsent"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"type":"array"}},"required":["answer","linkId","text"],"type":"object"},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_6":{"properties":{"linkId":{"enum":["parentalApplicationSupplementaryDetails_reasonNoChildConsent"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"type":"array"}},"type":"object"},"QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner":{"oneOf":[{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_1"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_2"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_3"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_4"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_5"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_ParentalApplicationSupplementaryDetails_item_inner_oneOf_6"}]},"QuestionnaireResponseItem_Patient_item_inner_oneOf":{"properties":{"linkId":{"enum":["patient_identifier"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"maxItems":1,"minItems":1,"type":"array"}},"required":["answer","linkId","text"],"type":"object"},"QuestionnaireResponseItem_Patient_item_inner_oneOf_1_item_inner_oneOf":{"properties":{"linkId":{"enum":["patient_name_first"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"maxItems":1,"minItems":1,"type":"array"}},"required":["answer","linkId","text"],"type":"object"},"QuestionnaireResponseItem_Patient_item_inner_oneOf_1_item_inner_oneOf_1":{"properties":{"linkId":{"enum":["patient_name_family"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"maxItems":1,"minItems":1,"type":"array"}},"required":["answer","linkId","text"],"type":"object"},"QuestionnaireResponseItem_Patient_item_inner_oneOf_1_item_inner":{"oneOf":[{"$ref":"#/components/schemas/QuestionnaireResponseItem_Patient_item_inner_oneOf_1_item_inner_oneOf"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_Patient_item_inner_oneOf_1_item_inner_oneOf_1"}]},"QuestionnaireResponseItem_Patient_item_inner_oneOf_1":{"properties":{"linkId":{"enum":["patient_name"],"type":"string"},"text":{"type":"string"},"item":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_Patient_item_inner_oneOf_1_item_inner"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"QuestionnaireResponseItem_Patient_item_inner_oneOf_2":{"properties":{"linkId":{"enum":["patient_birthDate"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_2_answer_inner"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"QuestionnaireResponseItem_Patient_item_inner":{"oneOf":[{"$ref":"#/components/schemas/QuestionnaireResponseItem_Patient_item_inner_oneOf"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_Patient_item_inner_oneOf_1"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_Patient_item_inner_oneOf_2"}]},"QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf_answer_inner_oneOf_valueCoding":{"properties":{"system":{"enum":["https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-RequestedAccess"],"type":"string"},"code":{"enum":["PRESCR","APPT","RECRD","TEST","VACC","COND","CONSULT","DOCS"],"type":"string"},"display":{"description":"FHIR Requested access level.","enum":["Request and manage repeat prescriptions","Appointment Booking","GP Health Records Access","Test Results","Vaccination Records","Health Conditions","Consultations and Events","Documents"],"type":"string"}},"type":"object"},"QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf_answer_inner_oneOf":{"properties":{"valueCoding":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf_answer_inner_oneOf_valueCoding"}},"type":"object"},"QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf_answer_inner":{"oneOf":[{"$ref":"#/components/schemas/QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf_answer_inner_oneOf"}]},"QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf":{"properties":{"linkId":{"enum":["requestedAccess_accessLevel"],"type":"string"},"text":{"type":"string"},"answer":{"description":"A multiple option selection where multiple access levels can be selected","items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf_answer_inner"},"minItems":1,"type":"array"}},"required":["answer","linkId","text"],"type":"object"},"QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf_1_answer_inner_oneOf_valueCoding":{"properties":{"system":{"enum":["https://fhir.nhs.uk/CodeSystem/Proxy-Placeholder-ReasonForAccess"],"type":"string"},"code":{"enum":["COMB","MHEA","PHYS","PRAC","TECH","NEUR","LRN","OTHR","NotSpecified"],"type":"string"},"display":{"description":"FHIR Reason for access.","enum":["Communication Barriers","Mental Health Condition","Physical Condition","Practical Reasons","Technical Barriers","Neurodiverse","Learning Disability","Other","Prefer not to say"],"type":"string"}},"type":"object"},"QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf_1_answer_inner_oneOf":{"properties":{"valueCoding":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf_1_answer_inner_oneOf_valueCoding"}},"type":"object"},"QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf_1_answer_inner":{"oneOf":[{"$ref":"#/components/schemas/QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf_1_answer_inner_oneOf"}]},"QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf_1":{"properties":{"linkId":{"enum":["requestedAccess_reasonsForAccess"],"type":"string"},"text":{"type":"string"},"answer":{"description":"A multiple option selection where multiple reasons can be selected","items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf_1_answer_inner"},"minItems":1,"type":"array"}},"required":["answer","linkId","text"],"type":"object"},"QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf_2":{"properties":{"linkId":{"enum":["requestedAccess_reasonsForAccessMoreinfo"],"type":"string"},"text":{"type":"string"},"answer":{"items":{"$ref":"#/components/schemas/QuestionnaireResponseItem_RelatedPerson_item_inner_oneOf_answer_inner"},"type":"array"}},"type":"object"},"QuestionnaireResponseItem_RequestedAccess_item_inner":{"oneOf":[{"$ref":"#/components/schemas/QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf_1"},{"$ref":"#/components/schemas/QuestionnaireResponseItem_RequestedAccess_item_inner_oneOf_2"}]},"Link_link_inner":{"properties":{"relation":{"description":"A name which details the functional use for this link - see:\nhttp://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1\n","type":"string"},"url":{"description":"The reference details for the link.","format":"uri","type":"string"}},"type":"object"},"RelatedPersonBundle_allOf_link":{"properties":{"relation":{"description":"Links related to this Bundle - see:\nhttp://www.iana.org/assignments/link-relations/link-relations.xhtml\n","type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"},"RelatedPersonBundle_allOf_entry":{"anyOf":[{"$ref":"#/components/schemas/RelatedPersonWithDetailsBundleEntry"},{"$ref":"#/components/schemas/PatientBundleEntry"}]},"ConsentBundle_allOf_entry":{"anyOf":[{"$ref":"#/components/schemas/RelatedPersonBundleEntry"},{"$ref":"#/components/schemas/PatientBundleEntry"},{"$ref":"#/components/schemas/ConsentBundleEntry"}]},"RelatedPersonWithDetailsBundleEntry_allOf_resource":{"allOf":[{"$ref":"#/components/schemas/RelatedPerson"},{"properties":{"name":{"$ref":"#/components/schemas/PDSName"},"birthDate":{"$ref":"#/components/schemas/PDSBirthDate"}},"type":"object"}]},"RelatedPersonBundleEntry_search":{"properties":{"mode":{"enum":["match","include"],"example":"match","type":"string"}},"type":"object"},"RelatedPerson_identifier_inner":{"properties":{"system":{"description":"Codesystem URL for the proxy's NHS number.","enum":["https://fhir.nhs.uk/Id/nhs-number"],"type":"string"},"value":{"description":"The proxy's NHS number.","type":"string"}},"type":"object"},"RelatedPerson_patient_identifier":{"description":"The patient's NHS number. The primary identifier of a patient, unique within NHS England and Wales. Always 10 digits and must be a [valid NHS number](https://www.datadictionary.nhs.uk/attributes/nhs_number.html).","properties":{"system":{"description":"Codesystem URL for the patient's NHS number.","enum":["https://fhir.nhs.uk/Id/nhs-number"],"type":"string"},"value":{"description":"The patient's NHS number.","type":"string"}},"type":"object"},"RelatedPerson_patient":{"description":"A reference to a patient the proxy is related to.","properties":{"type":{"description":"FHIR resource type.","enum":["Patient"],"type":"string"},"identifier":{"$ref":"#/components/schemas/RelatedPerson_patient_identifier"}},"type":"object"},"RelatedPerson_relationship_inner_coding_inner":{"properties":{"system":{"default":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","description":"FHIR codesystem.","enum":["http://terminology.hl7.org/CodeSystem/v3-RoleCode","https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole"],"type":"string"},"code":{"description":"FHIR relationship type code.","enum":["MTH","PRN","Personal","CHILD"],"type":"string"},"display":{"description":"FHIR relationship type.","enum":["mother","parent","Personal relationship with the patient","child"],"type":"string"}},"type":"object"},"RelatedPerson_relationship_inner":{"properties":{"coding":{"description":"FHIR coding array.","items":{"$ref":"#/components/schemas/RelatedPerson_relationship_inner_coding_inner"},"type":"array"}},"type":"object"},"Patient_meta":{"description":"Metadata about a resource","properties":{"security":{"description":"Security Labels applied to this resource","items":{"$ref":"#/components/schemas/Coding"},"type":"array"}},"type":"object"},"Patient_identifier_inner":{"properties":{"system":{"description":"Codesystem URL for the identifier.","enum":["https://fhir.nhs.uk/Id/nhs-number"],"type":"string"},"value":{"description":"The identifier value (e.g. NHS number).","type":"string"}},"type":"object"},"Consent_extension_inner":{"anyOf":[{"$ref":"#/components/schemas/StatusReasonExtension"},{"$ref":"#/components/schemas/GrantorExtension"}]},"ReadConsent_allOf_meta":{"description":"Metadata about a resource","properties":{"lastUpdated":{"description":"When the resource version last changed","format":"date-time","type":"string"}},"type":"object"},"Provision_period":{"description":"The start date on which the proxy role was granted, and (optionally) an end date for time-bound access.","properties":{"start":{"description":"Starting time with inclusive boundary","format":"date-time","type":"string"},"end":{"description":"End time with inclusive boundary, if not ongoing","format":"date-time","type":"string"}},"type":"object"},"Provision_actor_inner":{"properties":{"reference":{"$ref":"#/components/schemas/Reference"},"role":{"$ref":"#/components/schemas/CodeableConcept"}},"type":"object"},"GrantorExtension_valueReference":{"properties":{"identifier":{"$ref":"#/components/schemas/Identifier"}},"type":"object"},"OperationOutcome_issue_inner_details_coding_inner":{"properties":{"system":{"description":"URI of the coding system specification.","type":"string"},"version":{"description":"Version of the coding system in use.","type":"string"},"code":{"description":"Symbol in syntax defined by the system.","type":"string"},"display":{"description":"Representation defined by the system.","type":"string"}},"type":"object"},"OperationOutcome_issue_inner_details":{"description":"Internal error code.","properties":{"coding":{"items":{"$ref":"#/components/schemas/OperationOutcome_issue_inner_details_coding_inner"},"type":"array"}},"type":"object"},"OperationOutcome_issue_inner":{"properties":{"severity":{"description":"Severity of the error.","enum":["fatal","error","warning","information"],"type":"string"},"code":{"description":"FHIR error code.","enum":["exception","forbidden","informational","invalid","not-found","not-supported","processing","required"],"type":"string"},"details":{"$ref":"#/components/schemas/OperationOutcome_issue_inner_details"},"diagnostics":{"description":"Additional diagnostic information about the issue. This information is subject to change.","type":"string"},"expression":{"description":"FHIRPath of element(s) related to the error.","items":{"type":"string"},"type":"array"}},"required":["code","severity"],"type":"object"},"PatchOperation_value":{"oneOf":[{"type":"string"},{"items":{"type":"object"},"type":"array"}]},"PDSName_inner_period":{"description":"Business effective period when the name was, is, or will be in use.\n","properties":{"start":{"description":"Start date of time period, if known, in format `yyyy-mm-dd`. Can be a future date.","format":"date","type":"string"},"end":{"description":"End date of time period, if known and if not ongoing, in format `yyyy-mm-dd`. Can be a future date.","format":"date","type":"string"}},"required":["start"],"type":"object"},"PDSName_inner":{"additionalProperties":false,"properties":{"id":{"description":"Unique object identifier for this name.","type":"string"},"use":{"description":"How this name should be used.\n* usual - Known as, conventional or the one patient normally uses. A patient always has a usual name.\n* temp - An alias or temporary name. This may also be used for temporary names assigned at birth or in emergency situations.\n* nickname - A name that the patient prefers to be addressed by, but is not part of their usual name.\n* old - This name is no longer in use (or was never correct, but retained for records).\n* maiden - Name changed for Marriage. A name used prior to changing name because of marriage. This term is not gender specific. The use of this term does not imply any particular history for a person's name.\n\nThe following use codes are included in the [name-use](https://www.hl7.org/fhir/valueset-name-use.html) value set, but should not be used and is not be returned as part of a retrieval.\n* official - The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called \"legal name\".\n* anonymous - Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons).\n","enum":["usual","temp","nickname","old","maiden"],"type":"string"},"period":{"$ref":"#/components/schemas/PDSName_inner_period"},"given":{"description":"Given names, including any middle names.\n\nEach name(s) should be a separate item in the list. The first given name may include multiple names, separated by a space.\nSubsequent names must be broken down into list items. For example, the input `[Jane Marie Anne, Jo Adele]` returns `[Jane Marie Anne, Jo, Adele]`.\n","items":{"maxLength":35,"type":"string"},"maxItems":5,"type":"array"},"family":{"description":"Family name (often called Surname).","maxLength":35,"type":"string"},"prefix":{"description":"Name prefixes, titles, and prenominals.","items":{"type":"string"},"type":"array"},"suffix":{"description":"Name suffices and postnominals.","items":{"type":"string"},"type":"array"},"text":{"description":"Text representation of the full name","type":"string"}},"required":["use"],"type":"object"}}}}