Skip to content

Commit 8b44c81

Browse files
ellie-bound1-NHSDellie-bound1-NHSD
authored
NPA-7384: Update examples and spec to ensure provision.actor is depre… (#389)
…cated and not to be used # Pull Request ## 🧾 Ticket Link <!-- Add the Jira ticket link here --> https://nhsd-jira.digital.nhs.uk/browse/NPA-7384 --- ## 📄 Description/Summary of Changes <!-- Describe the changes made in this PR. Include the purpose/scope/impact of the changes --> - Make sure provision.actor is labeled as deprecated and remove it from examples. --- ## 🧪 Developer Testing Carried Out <!-- Describe what tests (automated/unit/manual etc.) have been done for the ticket. Include: --> <!-- - Any tests added/updated --> <!-- - Evidence that each acceptance criterion from the Jira ticket is met --> <!-- - Evidence of tests running eg. link to github workflow with tests passing or screenshot of tests running locally --> - <!-- Briefly describe the testing carried out in this PR --> --- ## 📋 PR Principles <!-- Principles we as a team follow when conducting a PR --> - Keep PRs Small and Focused: Ensure the PR addresses a single task or feature to make it easier to review. - Multiple PRs for one Ticket: When splitting work into multiple PRs, clearly describe what this PR addresses and outline the remaining work to complete the ticket. - Ensure Tests Are Included: Add or update unit, integration, or end-to-end tests to cover the changes made. - Follow Coding Standards: Ensure the code adheres to the team's coding guidelines and best practices. - Resolve Comments Promptly: If you raise a comment, ensure you follow up and resolve it before approving the PR to maintain clarity and ensure comments are addressed. - Foster Learning: PR reviews are an opportunity to share knowledge, provide constructive feedback, and encourage a collaborative environment. ## 🏷️ Naming Conventions Reminder Please ensure the following naming conventions are followed: - PR title follows the format: `NPA-XXXX: <short-description>` - Branch name follows the convention: `<type>/NPA-XXXX/<short-description>` - Commit messages follow the template: `NPA-XXXX: <short-description>`
1 parent e64e47b commit 8b44c81

26 files changed

Lines changed: 15 additions & 246 deletions

‎specification/examples/requests/PATCH_Consent/multiple_updates.yaml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,10 @@ MultipleUpdates:
2020
- op: add
2121
path: /provision/period/end
2222
value: "2026-12-31T23:59:59Z"
23+
- op: add
24+
path: /policyRule
25+
value:
26+
coding:
27+
- system: "https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis"
28+
code: parental-responsibility
29+
display: Parental responsibility

‎specification/examples/requests/PATCH_Consent/replace_policy_rule.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
ReplacePolicyRuleRequest:
22
summary: Replace policy rule
3-
description: payload used to add a new policy rule to the consent provision
3+
description: payload used to add a new legal basis to the proxy role
44
value:
55
- op: add
66
path: /policyRule

‎specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,6 @@ ConsentAdultToAdultGuardianRequest:
3232
type: permit
3333
period:
3434
start: "2026-02-11T14:30:00Z"
35-
actor:
36-
- reference:
37-
type: RelatedPerson
38-
identifier:
39-
system: https://fhir.nhs.uk/Id/nhs-number
40-
value: "9000000017"
4135
extension:
4236
- url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason
4337
valueCodeableConcept:

‎specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,6 @@ ConsentParentChildProxyCreationRequest:
3333
period:
3434
start: "2025-02-11T14:30:00Z"
3535
end: "2029-02-11T14:30:00Z"
36-
actor:
37-
- reference:
38-
type: RelatedPerson
39-
identifier:
40-
system: https://fhir.nhs.uk/Id/nhs-number
41-
value: "9000000009"
4236
extension:
4337
- url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason
4438
valueCodeableConcept:

‎specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -129,11 +129,6 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
129129
display: Parental responsibility
130130
provision:
131131
type: permit
132-
actor:
133-
- reference:
134-
identifier:
135-
system: "https://fhir.nhs.uk/Id/nhs-number"
136-
value: "9000000017"
137132
period:
138133
end: "2026-02-11"
139134
start: "2025-02-11"
@@ -234,16 +229,6 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
234229
display: Parental responsibility
235230
provision:
236231
type: permit
237-
actor:
238-
- role:
239-
coding:
240-
- code: parental-responsibility
241-
display: "Parental responsibility"
242-
system: "https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis"
243-
reference:
244-
identifier:
245-
system: https://fhir.nhs.uk/Id/nhs-number
246-
value: "9000000017"
247232
period:
248233
end: "2026-02-11"
249234
start: "2025-02-11"

‎specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,6 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
4444
display: Parental responsibility
4545
provision:
4646
type: permit
47-
actor:
48-
- reference:
49-
identifier:
50-
system: https://fhir.nhs.uk/Id/nhs-number
51-
value: '9000000017'
5247
period:
5348
end: '2026-02-11'
5449
start: '2025-02-11'
@@ -102,11 +97,6 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
10297
display: Parental responsibility
10398
provision:
10499
type: permit
105-
actor:
106-
- reference:
107-
identifier:
108-
system: https://fhir.nhs.uk/Id/nhs-number
109-
value: '9000000017'
110100
period:
111101
end: '2026-02-11'
112102
start: '2025-02-11'

‎specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml‎

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
4444
display: Parental responsibility
4545
provision:
4646
type: permit
47-
actor:
48-
- reference:
49-
identifier:
50-
system: https://fhir.nhs.uk/Id/nhs-number
51-
value: '9000000017'
5247
period:
5348
end: '2026-02-11'
5449
start: '2025-02-11'
@@ -103,11 +98,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
10398
display: Parental responsibility
10499
provision:
105100
type: permit
106-
actor:
107-
- reference:
108-
identifier:
109-
system: 'https://fhir.nhs.uk/Id/nhs-number'
110-
value: '9000000017'
111101
period:
112102
end: '2026-02-11'
113103
start: '2025-02-11'
@@ -155,18 +145,8 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
155145
policy:
156146
- authority: 'https://www.england.nhs.uk'
157147
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'
158-
policyRule:
159-
coding:
160-
- system: "https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis"
161-
code: parental-responsibility
162-
display: Parental responsibility
163148
provision:
164149
type: permit
165-
actor:
166-
- reference:
167-
identifier:
168-
system: https://fhir.nhs.uk/Id/nhs-number
169-
value: '9000000017'
170150
period:
171151
end: '2026-02-11'
172152
start: '2025-02-11'
@@ -179,11 +159,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
179159
- system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason
180160
code: APPLICATION_SUBMITTED
181161
display: Application submitted online
182-
- url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor
183-
valueReference:
184-
identifier:
185-
system: https://fhir.nhs.uk/Id/ods-organization-code
186-
value: "G8101234"
187162
search:
188163
mode: match
189164

@@ -214,18 +189,8 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
214189
policy:
215190
- authority: 'https://www.england.nhs.uk'
216191
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'
217-
policyRule:
218-
coding:
219-
- system: "https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis"
220-
code: parental-responsibility
221-
display: Parental responsibility
222192
provision:
223193
type: permit
224-
actor:
225-
- reference:
226-
identifier:
227-
system: https://fhir.nhs.uk/Id/nhs-number
228-
value: '9000000017'
229194
period:
230195
end: '2026-02-11'
231196
start: '2025-02-11'
@@ -238,10 +203,5 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
238203
- system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason
239204
code: APPLICATION_SUBMITTED
240205
display: Application submitted online
241-
- url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor
242-
valueReference:
243-
identifier:
244-
system: https://fhir.nhs.uk/Id/ods-organization-code
245-
value: "G8101234"
246206
search:
247207
mode: match

‎specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,6 @@ ConsentMultipleRelationshipsIncludePatientBundle:
7676
display: Parental responsibility
7777
provision:
7878
type: permit
79-
actor:
80-
- reference:
81-
identifier:
82-
system: https://fhir.nhs.uk/Id/nhs-number
83-
value: '9000000022'
8479
period:
8580
end: "2026-02-11"
8681
start: "2025-02-11"
@@ -163,11 +158,6 @@ ConsentMultipleRelationshipsIncludePatientBundle:
163158
display: Parental responsibility
164159
provision:
165160
type: permit
166-
actor:
167-
- reference:
168-
identifier:
169-
system: https://fhir.nhs.uk/Id/nhs-number
170-
value: '9000000022'
171161
period:
172162
end: "2026-02-11"
173163
start: "2025-02-11"
@@ -250,11 +240,6 @@ ConsentMultipleRelationshipsIncludePatientBundle:
250240
display: Parental responsibility
251241
provision:
252242
type: permit
253-
actor:
254-
- reference:
255-
identifier:
256-
system: https://fhir.nhs.uk/Id/nhs-number
257-
value: '9000000022'
258243
period:
259244
end: "2026-02-11"
260245
start: "2025-02-11"

‎specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -129,11 +129,6 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
129129
display: Parental responsibility
130130
provision:
131131
type: permit
132-
actor:
133-
- reference:
134-
identifier:
135-
system: https://fhir.nhs.uk/Id/nhs-number
136-
value: '9000000022'
137132
period:
138133
end: "2026-02-11"
139134
start: "2025-02-11"
@@ -235,11 +230,6 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
235230
display: "Best Interest"
236231
provision:
237232
type: permit
238-
actor:
239-
- reference:
240-
identifier:
241-
system: https://fhir.nhs.uk/Id/nhs-number
242-
value: '9000000022'
243233
period:
244234
end: "2026-02-11"
245235
start: "2025-02-11"
@@ -341,11 +331,6 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
341331
display: "Best Interest"
342332
provision:
343333
type: permit
344-
actor:
345-
- reference:
346-
identifier:
347-
system: https://fhir.nhs.uk/Id/nhs-number
348-
value: '9000000022'
349334
period:
350335
end: "2026-02-11"
351336
start: "2025-02-11"

‎specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -98,11 +98,6 @@ ConsentMultipleRelationshipsIncludePerformerBundle:
9898
display: Parental responsibility
9999
provision:
100100
type: permit
101-
actor:
102-
- reference:
103-
identifier:
104-
system: https://fhir.nhs.uk/Id/nhs-number
105-
value: '9000000022'
106101
period:
107102
end: '2026-02-11'
108103
start: '2025-02-11'
@@ -177,11 +172,6 @@ ConsentMultipleRelationshipsIncludePerformerBundle:
177172
display: 'Best interest'
178173
provision:
179174
type: permit
180-
actor:
181-
- reference:
182-
identifier:
183-
system: https://fhir.nhs.uk/Id/nhs-number
184-
value: '9000000022'
185175
period:
186176
end: '2026-02-11'
187177
start: '2025-02-11'
@@ -256,11 +246,6 @@ ConsentMultipleRelationshipsIncludePerformerBundle:
256246
display: "Best interest"
257247
provision:
258248
type: permit
259-
actor:
260-
- reference:
261-
identifier:
262-
system: https://fhir.nhs.uk/Id/nhs-number
263-
value: '9000000022'
264249
period:
265250
end: '2026-02-11'
266251
start: '2025-02-11'

0 commit comments

Comments
 (0)