From 34132da21fb540ebcbf3ae6d046defda4291ab25 Mon Sep 17 00:00:00 2001 From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com> Date: Thu, 27 Aug 2026 11:25:56 +0100 Subject: [PATCH 1/6] NPA-7384: Update examples and spec to ensure provision.actor is deprecated and not to be used --- .../PATCH_Consent/replace_policy_rule.yaml | 2 +- .../adult_to_adult_proxy_creation.yaml | 6 ------ .../parent_child_proxy_creation.yaml | 6 ------ ...onships-status-active-include-details.yaml | 15 -------------- ...iltered-relationships-status-inactive.yaml | 5 ----- ...-relationships-status-proposed-active.yaml | 20 ------------------- ...ultiple-relationships-include-patient.yaml | 15 -------------- ...lationships-include-performer-patient.yaml | 17 ++-------------- ...tiple-relationships-include-performer.yaml | 15 -------------- ...nships-single-patient-include-patient.yaml | 5 ----- ...gle-patient-include-performer-patient.yaml | 15 -------------- ...hips-single-patient-include-performer.yaml | 15 -------------- ...multiple-relationships-single-patient.yaml | 15 -------------- .../GET_Consent/multiple-relationships.yaml | 15 -------------- ...ng-adult-relationship-include-patient.yaml | 5 ----- ...elationship-include-performer-patient.yaml | 5 ----- ...-adult-relationship-include-performer.yaml | 5 ----- .../single-consenting-adult-relationship.yaml | 5 ----- ...er-child-relationship-include-patient.yaml | 5 ----- ...elationship-include-performer-patient.yaml | 5 ----- ...-child-relationship-include-performer.yaml | 5 ----- ...hild-relationship-unknown-legal-basis.yaml | 6 ------ .../single-mother-child-relationship.yaml | 5 ----- .../validated-relationships-service-api.yaml | 3 ++- 24 files changed, 5 insertions(+), 210 deletions(-) diff --git a/specification/examples/requests/PATCH_Consent/replace_policy_rule.yaml b/specification/examples/requests/PATCH_Consent/replace_policy_rule.yaml index fb136181..42195c68 100644 --- a/specification/examples/requests/PATCH_Consent/replace_policy_rule.yaml +++ b/specification/examples/requests/PATCH_Consent/replace_policy_rule.yaml @@ -1,6 +1,6 @@ ReplacePolicyRuleRequest: summary: Replace policy rule - description: payload used to add a new policy rule to the consent provision + description: payload used to add a new legal basis to the proxy role value: - op: add path: /policyRule diff --git a/specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml b/specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml index 447c904b..349e106d 100644 --- a/specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml +++ b/specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml @@ -32,12 +32,6 @@ ConsentAdultToAdultGuardianRequest: 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: diff --git a/specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml b/specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml index 03ff021b..36ddc45d 100644 --- a/specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml +++ b/specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml @@ -33,12 +33,6 @@ ConsentParentChildProxyCreationRequest: 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: diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml index e120785a..10ea68c0 100644 --- a/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml +++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml @@ -129,11 +129,6 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle: 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" @@ -234,16 +229,6 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle: 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" diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml index ae87feca..1c9c939e 100644 --- a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml +++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml @@ -44,11 +44,6 @@ ConsentMultipleRelationshipsStatusInactiveBundle: 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' diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml index 8c7c9375..b4fe24b7 100644 --- a/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml +++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml @@ -44,11 +44,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: 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' @@ -103,11 +98,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: 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' @@ -162,11 +152,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: 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' @@ -221,11 +206,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: 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' diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml index b6a4156b..a89ff331 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml @@ -76,11 +76,6 @@ ConsentMultipleRelationshipsIncludePatientBundle: 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" @@ -163,11 +158,6 @@ ConsentMultipleRelationshipsIncludePatientBundle: 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" @@ -250,11 +240,6 @@ ConsentMultipleRelationshipsIncludePatientBundle: 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" diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml index 5fbafe34..28074c04 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml @@ -129,11 +129,7 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle: 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" @@ -235,11 +231,7 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle: 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" @@ -341,11 +333,6 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle: 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" diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml index 994dfc3a..2fb983d4 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml @@ -98,11 +98,6 @@ ConsentMultipleRelationshipsIncludePerformerBundle: 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' @@ -177,11 +172,6 @@ ConsentMultipleRelationshipsIncludePerformerBundle: 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' @@ -256,11 +246,6 @@ ConsentMultipleRelationshipsIncludePerformerBundle: 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' diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml index 57abc645..1e341f2a 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml @@ -73,11 +73,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: display: "Court appointed personal welfare deputy" 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" diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml index 291ac927..3c10932b 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml @@ -124,11 +124,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: display: "Court Appointed Personal Welfare Deputy" 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" @@ -229,11 +224,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: 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" @@ -334,11 +324,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle: 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" diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml index e14b2741..21428101 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml @@ -95,11 +95,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerBundle: display: "Court Appointed Personal Welfare Deputy" 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' @@ -200,11 +195,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerBundle: 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' @@ -305,11 +295,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerBundle: 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' diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml index fee14b55..2ed8cf75 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml @@ -44,11 +44,6 @@ ConsentMultipleRelationshipsSinglePatientBundle: 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' @@ -102,11 +97,6 @@ ConsentMultipleRelationshipsSinglePatientBundle: 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' @@ -160,11 +150,6 @@ ConsentMultipleRelationshipsSinglePatientBundle: 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' diff --git a/specification/examples/responses/GET_Consent/multiple-relationships.yaml b/specification/examples/responses/GET_Consent/multiple-relationships.yaml index f2d6d78e..7c7b4aba 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships.yaml @@ -44,11 +44,6 @@ ConsentMultipleRelationshipsBundle: 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' @@ -102,11 +97,6 @@ ConsentMultipleRelationshipsBundle: 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' @@ -160,11 +150,6 @@ ConsentMultipleRelationshipsBundle: 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' diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml index 5278aa51..2f769857 100644 --- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml +++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml @@ -73,11 +73,6 @@ ConsentSingleConsentingAdultRelationshipIncludePatientBundle: 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" diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml index c1fb1f50..4d5a5232 100644 --- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml +++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml @@ -123,11 +123,6 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle: 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" diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml index 9abc21ad..d508b2e3 100644 --- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml +++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml @@ -93,11 +93,6 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerBundle: 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" diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml index d3e2dd98..61b3e712 100644 --- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml +++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml @@ -44,11 +44,6 @@ ConsentSingleConsentingAdultRelationshipBundle: 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' diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml index bc416dbe..5230b840 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml @@ -73,11 +73,6 @@ ConsentSingleAdultChildRelationshipIncludePatientBundle: 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: diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml index f67eb397..1509b55c 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml @@ -127,11 +127,6 @@ ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle: 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" diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml index 03f7ba72..023fa9a5 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml @@ -96,11 +96,6 @@ ConsentSingleAdultChildRelationshipIncludePerformerBundle: 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" diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-unknown-legal-basis.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-unknown-legal-basis.yaml index c76bdeb0..d992c55d 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-unknown-legal-basis.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-unknown-legal-basis.yaml @@ -46,12 +46,6 @@ ConsentSingleAdultChildRelationshipUnknownLegalBasisBundle: display: Unknown provision: type: permit - actor: - - reference: - identifier: - system: https://fhir.nhs.uk/Id/nhs-number - value: '9000000111' - type: RelatedPerson period: start: '2025-02-11' end: '2026-02-11' diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml index 4a60af91..8110b597 100644 --- a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml +++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml @@ -44,11 +44,6 @@ ConsentSingleAdultChildRelationshipBundle: 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' diff --git a/specification/validated-relationships-service-api.yaml b/specification/validated-relationships-service-api.yaml index 6c19641a..97aed00d 100644 --- a/specification/validated-relationships-service-api.yaml +++ b/specification/validated-relationships-service-api.yaml @@ -2451,7 +2451,8 @@ components: format: date-time actor: type: array - description: "Individuals or organisations involved in the provision" + description: "Individuals or organisations involved in the provision. Deprecated - use policyRule instead." + deprecated: true items: type: object properties: From b64de503f47efb612095c41b6adbc3694930d6c4 Mon Sep 17 00:00:00 2001 From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com> Date: Fri, 28 Aug 2026 13:23:24 +0100 Subject: [PATCH 2/6] NPA-7384: Make policyRule required --- specification/validated-relationships-service-api.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/validated-relationships-service-api.yaml b/specification/validated-relationships-service-api.yaml index 97aed00d..5fd5db27 100644 --- a/specification/validated-relationships-service-api.yaml +++ b/specification/validated-relationships-service-api.yaml @@ -2306,6 +2306,7 @@ components: - patient - dateTime - extension + - policyRule 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: From fd42b4bc770e9c83762c1d3427db9c16444348e3 Mon Sep 17 00:00:00 2001 From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com> Date: Fri, 28 Aug 2026 13:45:01 +0100 Subject: [PATCH 3/6] NPA-7384: Resolve example comments --- .../filtered-relationships-status-inactive.yaml | 5 ----- ...ltiple-relationships-include-performer-patient.yaml | 2 -- ...e-relationships-single-patient-include-patient.yaml | 10 ---------- 3 files changed, 17 deletions(-) diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml index 1c9c939e..98abee1d 100644 --- a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml +++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml @@ -97,11 +97,6 @@ ConsentMultipleRelationshipsStatusInactiveBundle: 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' diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml index 28074c04..99f6af14 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml @@ -129,7 +129,6 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle: display: Parental responsibility provision: type: permit - period: end: "2026-02-11" start: "2025-02-11" @@ -231,7 +230,6 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle: display: "Best Interest" provision: type: permit - period: end: "2026-02-11" start: "2025-02-11" diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml index 1e341f2a..0242d6a4 100644 --- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml +++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml @@ -126,11 +126,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: 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" @@ -184,11 +179,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle: 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" From af1ad999622eeedd2e1cd9c90a612e43e25f0146 Mon Sep 17 00:00:00 2001 From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com> Date: Fri, 28 Aug 2026 13:46:31 +0100 Subject: [PATCH 4/6] NPA-7384: Update access denied example to match implementation --- specification/examples/responses/errors/access-denied.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/examples/responses/errors/access-denied.yaml b/specification/examples/responses/errors/access-denied.yaml index ba32883a..a6f26d95 100644 --- a/specification/examples/responses/errors/access-denied.yaml +++ b/specification/examples/responses/errors/access-denied.yaml @@ -10,6 +10,6 @@ AccessDeniedError: 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" + diagnostics: "Invalid access token - Access Denied." severity: error resourceType: "OperationOutcome" From 05a2118cba562a378607244c4332ac362f197b7c Mon Sep 17 00:00:00 2001 From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com> Date: Fri, 28 Aug 2026 13:49:24 +0100 Subject: [PATCH 5/6] NPA-7384: policy rule is not required --- specification/validated-relationships-service-api.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/validated-relationships-service-api.yaml b/specification/validated-relationships-service-api.yaml index 5fd5db27..97aed00d 100644 --- a/specification/validated-relationships-service-api.yaml +++ b/specification/validated-relationships-service-api.yaml @@ -2306,7 +2306,6 @@ components: - patient - dateTime - extension - - policyRule 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: From 89efb9c2d0cedeb0499ecea978db1a954a41a02d Mon Sep 17 00:00:00 2001 From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com> Date: Fri, 28 Aug 2026 16:01:24 +0100 Subject: [PATCH 6/6] NPA-7384: Add new error codes --- .../PATCH_Consent/multiple_updates.yaml | 7 +++++++ ...-relationships-status-proposed-active.yaml | 20 ------------------- .../validated-relationships-service-api.yaml | 4 ++++ 3 files changed, 11 insertions(+), 20 deletions(-) diff --git a/specification/examples/requests/PATCH_Consent/multiple_updates.yaml b/specification/examples/requests/PATCH_Consent/multiple_updates.yaml index a9689985..a30141ff 100644 --- a/specification/examples/requests/PATCH_Consent/multiple_updates.yaml +++ b/specification/examples/requests/PATCH_Consent/multiple_updates.yaml @@ -20,3 +20,10 @@ MultipleUpdates: - op: add path: /provision/period/end value: "2026-12-31T23:59:59Z" + - op: add + path: /policyRule + value: + coding: + - system: "https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis" + code: parental-responsibility + display: Parental responsibility diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml index b4fe24b7..92a50392 100644 --- a/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml +++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml @@ -145,11 +145,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: 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 period: @@ -164,11 +159,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: APPLICATION_SUBMITTED display: Application submitted online - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/ods-organization-code - value: "G8101234" search: mode: match @@ -199,11 +189,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: 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 period: @@ -218,10 +203,5 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle: - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason code: APPLICATION_SUBMITTED display: Application submitted online - - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor - valueReference: - identifier: - system: https://fhir.nhs.uk/Id/ods-organization-code - value: "G8101234" search: mode: match diff --git a/specification/validated-relationships-service-api.yaml b/specification/validated-relationships-service-api.yaml index 97aed00d..34d65602 100644 --- a/specification/validated-relationships-service-api.yaml +++ b/specification/validated-relationships-service-api.yaml @@ -783,6 +783,7 @@ paths: | 400 | `MISSING_SCOPE` | Missing scope. | | 400 | `MISSING_CATEGORY` | Missing category. | | 400 | `MISSING_DATETIME` | Missing datetime. | + | 400 | `MISSING_POLICY_RULE` | Policy Rule is required when creating or activating an active proxy role. | | 400 | `BAD_REQUEST` | Invalid request. For details, see the `diagnostics` field. | | 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. | | 403 | `FORBIDDEN` | Access denied to resource. | @@ -798,6 +799,7 @@ paths: | 422 | `INVALID_CATEGORY` | Invalid category. | | 422 | `INVALID_DATETIME` | Invalid datetime. | | 422 | `INVALID_PROVISION` | Invalid provision. | + | 422 | `INVALID_POLICY_RULE` | Invalid policy rule. | | 422 | `INVALID_EXTENSION` | Invalid extension. | | 422 | `INVALID_GRANTOR_VALUE` | Grantor ODS code is missing, empty, whitespace-only or invalid format. | | 422 | `INVALID_PERFORMER` | Invalid performer. | @@ -1075,6 +1077,7 @@ paths: | ----------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | 400 | `MISSING_VALUE` | Missing header or parameter. For details, see the `diagnostics` field. | | 400 | `MISSING_GRANTOR` | Grantor extension is required when creating or activating a consent with status "active". For details, see the `diagnostics` field. | + | 400 | `MISSING_POLICY_RULE` | Policy Rule is required when creating or activating a consent with status "active". For details, see the `diagnostics` field. | | 400 | `MISSING_GRANTOR_REFERENCE` | Grantor extension reference is required when creating or activating a consent with status "active". For details, see the `diagnostics` field. | | 400 | `MISSING_GRANTOR_IDENTIFIER`| Grantor extension identifier is required when creating or activating a consent with status "active". For details, see the `diagnostics` field. | | 400 | `INVALID_PATCH` | Invalid patch. | @@ -1094,6 +1097,7 @@ paths: | 422 | `INVALID_END_DATE` | End date is invalid. | | 422 | `INVALID_GRANTOR_VALUE` | Invalid grantor identifier value. For details, see the `diagnostics` field. | | 422 | `INVALID_GRANTOR_SYSTEM` | Invalid grantor system value. For details, see the `diagnostics` field. | + | 422 | `INVALID_POLICY_RULE` | Invalid policy rule value. For details, see the `diagnostics` field. | | 429 | `THROTTLED` | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). | content: