Skip to content

Commit 89dd8a5

Browse files
ellie-bound1-NHSDCopilot
ellie-bound1-NHSD
and
Copilot
authored
NPA-5825: Updated examples and postman to align with Proxy Role Data … (#267)
…Model # Pull Request ## 🧾 Ticket Link <!-- Add the Jira ticket link here --> https://nhsd-jira.digital.nhs.uk/browse/NPA-5825 --- ## 📄 Description/Summary of Changes <!-- Describe the changes made in this PR. Include the purpose/scope/impact of the changes --> - For POST Consent created 2 new error response examples for when proxy role could not be created due to invalid request or invalid FHIR resource in request - Updated GET and POST Consent examples to align with the [Proxy Role Data](https://nhsd-confluence.digital.nhs.uk/spaces/NPA/pages/964545526/Proxy+Role+Data+model) Model - Updated postman collection to reflect these changes --- ## 🧪 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 --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> --- ## 🧪 Reviewer Testing Required <!-- Describe how to test the changes that have been made in the ticket. Include: --> <!-- - Testing environment details (e.g. sandbox/local setup) --> <!-- - Steps to verify the changes --> - [ ] <!-- Add bullet points for testing instructions --> - [ ] <!-- Add bullet points for testing instructions --> - [ ] <!-- Add bullet points for testing instructions --> --- ## ✅ Developer Checklist <!-- Complete before submitting the PR --> - [ ] 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>` - [ ] All acceptance criteria from the Jira ticket are addressed - [ ] Automated tests (unit/integration/API/infrastructure etc. tests) are added or updated - [ ] Assignees and appropriate labels (e.g. `terraform`, `documentation`) are added --- ## 👀 Reviewer Checklist <!-- To be completed by the reviewer --> - [ ] Changes meet the acceptance criteria of the Jira ticket - [ ] Code is able to be merged (no conflicts and adheres to coding standards) - [ ] Sufficient test evidence is provided (manual and/or automated) - [ ] Infrastructure/operational/build changes are validated (if applicable) --- ## 🚀 Post-merge <!-- Actions to complete after merging --> After merging and deploying changes to the sandbox, Postman collection or spec examples please run the Run Postman collection workflow. This will run the tests within the collection to check that the sandbox is working as expected once deployed. --------- Co-authored-by: Copilot <[email protected]>
1 parent 54055c4 commit 89dd8a5

25 files changed

+1553
-446
lines changed

‎postman/Validated Relationship Service Sandbox.postman_collection.json‎

Lines changed: 964 additions & 236 deletions
Large diffs are not rendered by default.

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ ConsentAdultToAdultGuardianRequest:
55
status: active
66
scope:
77
coding:
8-
- system: "http://terminology.hl7.org/CodeSystem/consentscope"
8+
- system: "https://terminology.hl7.org/CodeSystem/consentscope"
99
code: patient-privacy
1010
display: "Privacy Consent"
1111
text: "Patient Privacy Consent"
1212
category:
1313
- coding:
14-
- system: "http://terminology.hl7.org/CodeSystem/v3-ActCode"
14+
- system: "https://terminology.hl7.org/CodeSystem/v3-ActCode"
1515
code: INFA
1616
display: "Information Access"
1717
text: "Information Access Consent"
@@ -32,9 +32,9 @@ ConsentAdultToAdultGuardianRequest:
3232
actor:
3333
- role:
3434
coding:
35-
- system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
36-
code: GUARD
37-
display: Guardian
35+
- system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
36+
code: court-appointed-personal-welfare-deputy
37+
display: Court appointed personal welfare deputy
3838
reference:
3939
type: RelatedPerson
4040
identifier:
@@ -44,6 +44,6 @@ ConsentAdultToAdultGuardianRequest:
4444
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
4545
valueCodeableConcept:
4646
coding:
47-
- system: http://terminology.hl7.org/CodeSystem/consent-reason
48-
code: TBC
49-
display: TBC
47+
- system: https://terminology.hl7.org/CodeSystem/consent-reason
48+
code: ROLE_CREATED
49+
display: Role created from scratch by GP

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ ConsentParentChildProxyCreationRequest:
55
status: active
66
scope:
77
coding:
8-
- system: "http://terminology.hl7.org/CodeSystem/consentscope"
8+
- system: "https://terminology.hl7.org/CodeSystem/consentscope"
99
code: patient-privacy
1010
display: "Privacy Consent"
1111
text: "Patient Privacy Consent"
1212
category:
1313
- coding:
14-
- system: "http://terminology.hl7.org/CodeSystem/v3-ActCode"
14+
- system: "https://terminology.hl7.org/CodeSystem/v3-ActCode"
1515
code: INFA
1616
display: "Information Access"
1717
text: "Information Access Consent"
@@ -33,9 +33,9 @@ ConsentParentChildProxyCreationRequest:
3333
actor:
3434
- role:
3535
coding:
36-
- system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
37-
code: PRN
38-
display: Parent
36+
- system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
37+
code: parental-responsibility
38+
display: Parental responsibility
3939
reference:
4040
type: RelatedPerson
4141
identifier:
@@ -45,6 +45,6 @@ ConsentParentChildProxyCreationRequest:
4545
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
4646
valueCodeableConcept:
4747
coding:
48-
- system: http://terminology.hl7.org/CodeSystem/consent-reason
49-
code: TBC
50-
display: TBC
48+
- system: https://terminology.hl7.org/CodeSystem/consent-reason
49+
code: ROLE_CREATED
50+
display: Role created from scratch by GP

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

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,13 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
7777
status: active
7878
scope:
7979
coding:
80-
- system: "http://terminology.hl7.org/CodeSystem/consentscope"
80+
- system: "https://terminology.hl7.org/CodeSystem/consentscope"
8181
code: patient-privacy
8282
display: "Privacy Consent"
8383
text: "Patient Privacy Consent"
8484
category:
8585
- coding:
86-
- system: "http://terminology.hl7.org/CodeSystem/v3-ActCode"
86+
- system: "https://terminology.hl7.org/CodeSystem/v3-ActCode"
8787
code: INFA
8888
display: "Information Access"
8989
text: "Information Access Consent"
@@ -107,12 +107,19 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
107107
value: "9000000017"
108108
role:
109109
coding:
110-
- code: PRN
111-
display: Parent
112-
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
110+
- code: parental-responsibility
111+
display: Parental responsibility
112+
system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
113113
period:
114114
end: "2026-02-11"
115115
start: "2025-02-11"
116+
extension:
117+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
118+
valueCodeableConcept:
119+
coding:
120+
- system: https://terminology.hl7.org/CodeSystem/consent-reason
121+
code: ROLE_CREATED
122+
display: Role created from scratch by GP
116123
search:
117124
mode: match
118125
- fullUrl: "https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720"
@@ -173,13 +180,13 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
173180
status: active
174181
scope:
175182
coding:
176-
- system: "http://terminology.hl7.org/CodeSystem/consentscope"
183+
- system: "https://terminology.hl7.org/CodeSystem/consentscope"
177184
code: patient-privacy
178185
display: "Privacy Consent"
179186
text: "Patient Privacy Consent"
180187
category:
181188
- coding:
182-
- system: "http://terminology.hl7.org/CodeSystem/v3-ActCode"
189+
- system: "https://terminology.hl7.org/CodeSystem/v3-ActCode"
183190
code: INFA
184191
display: "Information Access"
185192
text: "Information Access Consent"
@@ -203,11 +210,18 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
203210
value: "9000000017"
204211
role:
205212
coding:
206-
- code: PRN
207-
display: Parent
208-
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
213+
- code: parental-responsibility
214+
display: Parental responsibility
215+
system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
209216
period:
210217
end: "2026-02-11"
211218
start: "2025-02-11"
219+
extension:
220+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
221+
valueCodeableConcept:
222+
coding:
223+
- system: https://terminology.hl7.org/CodeSystem/consent-reason
224+
code: ROLE_CREATED
225+
display: Role created from scratch by GP
212226
search:
213227
mode: match

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

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
1717
status: inactive
1818
scope:
1919
coding:
20-
- system: 'http://terminology.hl7.org/CodeSystem/consentscope'
20+
- system: 'https://terminology.hl7.org/CodeSystem/consentscope'
2121
code: patient-privacy
2222
display: Privacy Consent
2323
text: Patient Privacy Consent
2424
category:
2525
- coding:
26-
- system: 'http://terminology.hl7.org/CodeSystem/v3-ActCode'
26+
- system: 'https://terminology.hl7.org/CodeSystem/v3-ActCode'
2727
code: INFA
2828
display: Information Access
2929
text: Information Access Consent
@@ -47,12 +47,19 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
4747
value: '9000000017'
4848
role:
4949
coding:
50-
- code: PRN
51-
display: Parent
52-
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
50+
- code: parental-responsibility
51+
display: Parental responsibility
52+
system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
5353
period:
5454
end: '2026-02-11'
5555
start: '2025-02-11'
56+
extension:
57+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
58+
valueCodeableConcept:
59+
coding:
60+
- system: https://terminology.hl7.org/CodeSystem/consent-reason
61+
code: ROLE_DEACTIVATED_END_DATE_REACHED
62+
display: End-date reached
5663
search:
5764
mode: match
5865
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/ABCD12B3
@@ -62,13 +69,13 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
6269
status: inactive
6370
scope:
6471
coding:
65-
- system: 'http://terminology.hl7.org/CodeSystem/consentscope'
72+
- system: 'https://terminology.hl7.org/CodeSystem/consentscope'
6673
code: patient-privacy
6774
display: Privacy Consent
6875
text: Patient Privacy Consent
6976
category:
7077
- coding:
71-
- system: 'http://terminology.hl7.org/CodeSystem/v3-ActCode'
78+
- system: 'https://terminology.hl7.org/CodeSystem/v3-ActCode'
7279
code: INFA
7380
display: Information Access
7481
text: Information Access Consent
@@ -92,11 +99,18 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
9299
value: '9000000017'
93100
role:
94101
coding:
95-
- code: PRN
96-
display: Parent
97-
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
102+
- code: parental-responsibility
103+
display: Parental responsibility
104+
system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
98105
period:
99106
end: '2026-02-11'
100107
start: '2025-02-11'
108+
extension:
109+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
110+
valueCodeableConcept:
111+
coding:
112+
- system: https://terminology.hl7.org/CodeSystem/consent-reason
113+
code: ROLE_DEACTIVATED_END_DATE_REACHED
114+
display: End-date reached
101115
search:
102116
mode: match

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

Lines changed: 48 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
1717
status: active
1818
scope:
1919
coding:
20-
- system: 'http://terminology.hl7.org/CodeSystem/consentscope'
20+
- system: 'https://terminology.hl7.org/CodeSystem/consentscope'
2121
code: patient-privacy
2222
display: Privacy Consent
2323
text: Patient Privacy Consent
2424
category:
2525
- coding:
26-
- system: 'http://terminology.hl7.org/CodeSystem/v3-ActCode'
26+
- system: 'https://terminology.hl7.org/CodeSystem/v3-ActCode'
2727
code: INFA
2828
display: Information Access
2929
text: Information Access Consent
@@ -47,12 +47,19 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
4747
value: '9000000017'
4848
role:
4949
coding:
50-
- code: PRN
51-
display: Parent
52-
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
50+
- code: parental-responsibility
51+
display: Parental responsibility
52+
system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
5353
period:
5454
end: '2026-02-11'
5555
start: '2025-02-11'
56+
extension:
57+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
58+
valueCodeableConcept:
59+
coding:
60+
- system: https://terminology.hl7.org/CodeSystem/consent-reason
61+
code: ROLE_CREATED
62+
display: Role created from scratch by GP
5663
search:
5764
mode: match
5865

@@ -63,13 +70,13 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
6370
status: active
6471
scope:
6572
coding:
66-
- system: 'http://terminology.hl7.org/CodeSystem/consentscope'
73+
- system: 'https://terminology.hl7.org/CodeSystem/consentscope'
6774
code: patient-privacy
6875
display: Privacy Consent
6976
text: Patient Privacy Consent
7077
category:
7178
- coding:
72-
- system: 'http://terminology.hl7.org/CodeSystem/v3-ActCode'
79+
- system: 'https://terminology.hl7.org/CodeSystem/v3-ActCode'
7380
code: INFA
7481
display: Information Access
7582
text: Information Access Consent
@@ -93,12 +100,19 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
93100
value: '9000000017'
94101
role:
95102
coding:
96-
- code: PRN
97-
display: Parent
98-
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
103+
- code: parental-responsibility
104+
display: Parental responsibility
105+
system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
99106
period:
100107
end: '2026-02-11'
101108
start: '2025-02-11'
109+
extension:
110+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
111+
valueCodeableConcept:
112+
coding:
113+
- system: https://terminology.hl7.org/CodeSystem/consent-reason
114+
code: ROLE_CREATED
115+
display: Role created from scratch by GP
102116
search:
103117
mode: match
104118

@@ -109,13 +123,13 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
109123
status: proposed
110124
scope:
111125
coding:
112-
- system: 'http://terminology.hl7.org/CodeSystem/consentscope'
126+
- system: 'https://terminology.hl7.org/CodeSystem/consentscope'
113127
code: patient-privacy
114128
display: Privacy Consent
115129
text: Patient Privacy Consent
116130
category:
117131
- coding:
118-
- system: 'http://terminology.hl7.org/CodeSystem/v3-ActCode'
132+
- system: 'https://terminology.hl7.org/CodeSystem/v3-ActCode'
119133
code: INFA
120134
display: Information Access
121135
text: Information Access Consent
@@ -139,12 +153,19 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
139153
value: '9000000017'
140154
role:
141155
coding:
142-
- code: PRN
143-
display: Parent
144-
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
156+
- code: parental-responsibility
157+
display: Parental responsibility
158+
system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
145159
period:
146160
end: '2026-02-11'
147161
start: '2025-02-11'
162+
extension:
163+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
164+
valueCodeableConcept:
165+
coding:
166+
- system: https://terminology.hl7.org/CodeSystem/consent-reason
167+
code: APPLICATION_SUBMITTED
168+
display: Application submitted online
148169
search:
149170
mode: match
150171

@@ -155,13 +176,13 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
155176
status: proposed
156177
scope:
157178
coding:
158-
- system: 'http://terminology.hl7.org/CodeSystem/consentscope'
179+
- system: 'https://terminology.hl7.org/CodeSystem/consentscope'
159180
code: patient-privacy
160181
display: Privacy Consent
161182
text: Patient Privacy Consent
162183
category:
163184
- coding:
164-
- system: 'http://terminology.hl7.org/CodeSystem/v3-ActCode'
185+
- system: 'https://terminology.hl7.org/CodeSystem/v3-ActCode'
165186
code: INFA
166187
display: Information Access
167188
text: Information Access Consent
@@ -185,11 +206,18 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
185206
value: '9000000017'
186207
role:
187208
coding:
188-
- code: PRN
189-
display: Parent
190-
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
209+
- code: parental-responsibility
210+
display: Parental responsibility
211+
system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
191212
period:
192213
end: '2026-02-11'
193214
start: '2025-02-11'
215+
extension:
216+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
217+
valueCodeableConcept:
218+
coding:
219+
- system: https://terminology.hl7.org/CodeSystem/consent-reason
220+
code: APPLICATION_SUBMITTED
221+
display: Application submitted online
194222
search:
195223
mode: match

0 commit comments

Comments
 (0)