Skip to content

Commit 682e850

Browse files
ChristopherBaconCopilotellie-bound1-NHSD
authored
NPA-5608: IOPS amendments for get consent and get consent ID (#259)
# Pull Request ## 🧾 Ticket Link <!-- Add the Jira ticket link here --> https://nhsd-jira.digital.nhs.uk/browse/NPA-5608 --- ## 📄 Description/Summary of Changes <!-- Describe the changes made in this PR. Include the purpose/scope/impact of the changes --> - Updated specification with postman and schema changes for get constent and get consent ID - Updated examples for get consent and get consent ID --- ## 🧪 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 --> - Ran Postman testing to check that responses were correct --- ## 🧪 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 --> - [x] PR title follows the format: `NPA-XXXX: <short-description>` - [x] Branch name follows the convention: `<type>/NPA-XXXX/<short-description>` - [x] 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 - [x] 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]> Co-authored-by: ellie-bound1-NHSD <[email protected]>
1 parent cab6ad1 commit 682e850

21 files changed

+311
-449
lines changed

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

Lines changed: 84 additions & 144 deletions
Large diffs are not rendered by default.

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

Lines changed: 29 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,18 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
2222
- system: "https://placeholder.fhir.nhs.uk/Id/local-gp-patient-identifier"
2323
value: "ABC0000003"
2424
patient:
25-
type: Patient
2625
identifier:
2726
system: "https://fhir.nhs.uk/Id/nhs-number"
2827
value: "9000000017"
2928
relationship:
3029
- coding:
31-
- system: "http://terminology.hl7.org/CodeSystem/v3-RoleCode"
32-
code: PRN
33-
display: parent
34-
- system: "http://terminology.hl7.org/CodeSystem/v3-RoleCode"
35-
code: MTH
36-
display: mother
30+
- system: "http://terminology.hl7.org/CodeSystem/v3-RoleCode"
31+
code: PRN
32+
display: parent
33+
- coding:
34+
- system: "http://terminology.hl7.org/CodeSystem/v3-RoleCode"
35+
code: MTH
36+
display: mother
3737
search:
3838
mode: include
3939
- fullUrl: "https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2"
@@ -51,8 +51,7 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
5151
- system: "https://placeholder.fhir.nhs.uk/Id/local-gp-patient-identifier"
5252
value: "ABC1234567"
5353
name:
54-
- id: "123456"
55-
use: usual
54+
- use: usual
5655
period:
5756
start: "2020-01-01"
5857
end: "2021-12-31"
@@ -66,8 +65,7 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
6665
- PhD
6766
birthDate: "2022-10-22"
6867
generalPractitioner:
69-
- type: "Organization"
70-
identifier:
68+
- identifier:
7169
value: "ODS12345"
7270
system: "https://fhir.nhs.uk/Id/ods-organization-code"
7371
search:
@@ -103,16 +101,15 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
103101
uri: "REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD"
104102
provision:
105103
actor:
106-
- reference:
107-
identifier:
108-
system: https://fhir.nhs.uk/Id/nhs-number
109-
value: "9000000017"
110-
type: RelatedPerson
111-
role:
112-
coding:
113-
- code: PRN
114-
display: Parent
115-
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
104+
- reference:
105+
identifier:
106+
system: https://fhir.nhs.uk/Id/nhs-number
107+
value: "9000000017"
108+
role:
109+
coding:
110+
- code: PRN
111+
display: Parent
112+
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
116113
period:
117114
end: "2026-02-11"
118115
start: "2025-02-11"
@@ -128,7 +125,6 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
128125
- system: "https://placeholder.fhir.nhs.uk/Id/local-gp-patient-identifier"
129126
value: "ABC0000003"
130127
patient:
131-
type: Patient
132128
identifier:
133129
system: "https://fhir.nhs.uk/Id/nhs-number"
134130
value: "9000000005"
@@ -154,8 +150,7 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
154150
- system: "https://placeholder.fhir.nhs.uk/Id/local-gp-patient-identifier"
155151
value: "ABC9999999"
156152
name:
157-
- id: "123456"
158-
use: usual
153+
- use: usual
159154
period:
160155
start: "2020-01-01"
161156
end: "2021-12-31"
@@ -166,8 +161,7 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
166161
- Mrs
167162
birthDate: "1995-10-22"
168163
generalPractitioner:
169-
- type: "Organization"
170-
identifier:
164+
- identifier:
171165
value: "ODS12345"
172166
system: "https://fhir.nhs.uk/Id/ods-organization-code"
173167
search:
@@ -203,16 +197,15 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
203197
uri: "REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD"
204198
provision:
205199
actor:
206-
- reference:
207-
identifier:
208-
system: https://fhir.nhs.uk/Id/nhs-number
209-
value: "9000000017"
210-
type: RelatedPerson
211-
role:
212-
coding:
213-
- code: PRN
214-
display: Parent
215-
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
200+
- reference:
201+
identifier:
202+
system: https://fhir.nhs.uk/Id/nhs-number
203+
value: "9000000017"
204+
role:
205+
coding:
206+
- code: PRN
207+
display: Parent
208+
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
216209
period:
217210
end: "2026-02-11"
218211
start: "2025-02-11"

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
4545
identifier:
4646
system: https://fhir.nhs.uk/Id/nhs-number
4747
value: '9000000017'
48-
type: RelatedPerson
4948
role:
5049
coding:
5150
- code: PRN
@@ -91,7 +90,6 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
9190
identifier:
9291
system: https://fhir.nhs.uk/Id/nhs-number
9392
value: '9000000017'
94-
type: RelatedPerson
9593
role:
9694
coding:
9795
- code: PRN

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
4545
identifier:
4646
system: https://fhir.nhs.uk/Id/nhs-number
4747
value: '9000000017'
48-
type: RelatedPerson
4948
role:
5049
coding:
5150
- code: PRN
@@ -92,7 +91,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
9291
identifier:
9392
system: https://fhir.nhs.uk/Id/nhs-number
9493
value: '9000000017'
95-
type: RelatedPerson
9694
role:
9795
coding:
9896
- code: PRN
@@ -139,7 +137,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
139137
identifier:
140138
system: https://fhir.nhs.uk/Id/nhs-number
141139
value: '9000000017'
142-
type: RelatedPerson
143140
role:
144141
coding:
145142
- code: PRN
@@ -186,7 +183,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
186183
identifier:
187184
system: https://fhir.nhs.uk/Id/nhs-number
188185
value: '9000000017'
189-
type: RelatedPerson
190186
role:
191187
coding:
192188
- code: PRN

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

Lines changed: 33 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ ConsentMultipleRelationshipsIncludePatientBundle:
2525
- system: "https://placeholder.fhir.nhs.uk/Id/local-gp-patient-identifier"
2626
value: ABC1234567
2727
name:
28-
- id: "123456"
29-
use: usual
28+
- use: usual
3029
period:
3130
start: "2020-01-01"
3231
end: "2021-12-31"
@@ -40,8 +39,7 @@ ConsentMultipleRelationshipsIncludePatientBundle:
4039
- PhD
4140
birthDate: "2022-10-22"
4241
generalPractitioner:
43-
- type: Organization
44-
identifier:
42+
- identifier:
4543
value: ODS12345
4644
system: "https://fhir.nhs.uk/Id/ods-organization-code"
4745
search:
@@ -77,16 +75,15 @@ ConsentMultipleRelationshipsIncludePatientBundle:
7775
uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
7876
provision:
7977
actor:
80-
- reference:
81-
identifier:
82-
system: https://fhir.nhs.uk/Id/nhs-number
83-
value: "9000000022"
84-
type: RelatedPerson
85-
role:
86-
coding:
87-
- code: PRN
88-
display: Parent
89-
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
78+
- reference:
79+
identifier:
80+
system: https://fhir.nhs.uk/Id/nhs-number
81+
value: '9000000022'
82+
role:
83+
coding:
84+
- code: PRN
85+
display: Parent
86+
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
9087
period:
9188
end: "2026-02-11"
9289
start: "2025-02-11"
@@ -107,8 +104,7 @@ ConsentMultipleRelationshipsIncludePatientBundle:
107104
- system: "https://placeholder.fhir.nhs.uk/Id/local-gp-patient-identifier"
108105
value: ABC9999999
109106
name:
110-
- id: "123456"
111-
use: usual
107+
- use: usual
112108
period:
113109
start: "2020-01-01"
114110
end: "2021-12-31"
@@ -119,8 +115,7 @@ ConsentMultipleRelationshipsIncludePatientBundle:
119115
- Mrs
120116
birthDate: "1995-10-22"
121117
generalPractitioner:
122-
- type: Organization
123-
identifier:
118+
- identifier:
124119
value: ODS12345
125120
system: "https://fhir.nhs.uk/Id/ods-organization-code"
126121
search:
@@ -156,16 +151,15 @@ ConsentMultipleRelationshipsIncludePatientBundle:
156151
uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
157152
provision:
158153
actor:
159-
- reference:
160-
identifier:
161-
system: https://fhir.nhs.uk/Id/nhs-number
162-
value: "9000000022"
163-
type: RelatedPerson
164-
role:
165-
coding:
166-
- code: PRN
167-
display: Parent
168-
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
154+
- reference:
155+
identifier:
156+
system: https://fhir.nhs.uk/Id/nhs-number
157+
value: '9000000022'
158+
role:
159+
coding:
160+
- code: PRN
161+
display: Parent
162+
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
169163
period:
170164
end: "2026-02-11"
171165
start: "2025-02-11"
@@ -186,8 +180,7 @@ ConsentMultipleRelationshipsIncludePatientBundle:
186180
- system: "https://placeholder.fhir.nhs.uk/Id/local-gp-patient-identifier"
187181
value: ABC9999999
188182
name:
189-
- id: "123456"
190-
use: usual
183+
- use: usual
191184
period:
192185
start: "2020-01-01"
193186
end: "2021-12-31"
@@ -198,8 +191,7 @@ ConsentMultipleRelationshipsIncludePatientBundle:
198191
- Mr
199192
birthDate: 1991-1-13
200193
generalPractitioner:
201-
- type: Organization
202-
identifier:
194+
- identifier:
203195
value: ODS12345
204196
system: "https://fhir.nhs.uk/Id/ods-organization-code"
205197
search:
@@ -235,16 +227,15 @@ ConsentMultipleRelationshipsIncludePatientBundle:
235227
uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
236228
provision:
237229
actor:
238-
- reference:
239-
identifier:
240-
system: https://fhir.nhs.uk/Id/nhs-number
241-
value: "9000000022"
242-
type: RelatedPerson
243-
role:
244-
coding:
245-
- code: PRN
246-
display: Parent
247-
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
230+
- reference:
231+
identifier:
232+
system: https://fhir.nhs.uk/Id/nhs-number
233+
value: '9000000022'
234+
role:
235+
coding:
236+
- code: PRN
237+
display: Parent
238+
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
248239
period:
249240
end: "2026-02-11"
250241
start: "2025-02-11"

0 commit comments

Comments
 (0)