Skip to content

Commit 1b1190a

Browse files
lelliott-hippolelliott-hippo
authored
Merge pull request #217 from NHSDigital/dev/NPA-4531-update-consent-examples
NPA-4531: Update GET/Consent examples & Postman collection
2 parents b36b927 + c744b37 commit 1b1190a

19 files changed

+5837
-3856
lines changed

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

Lines changed: 5071 additions & 3701 deletions
Large diffs are not rendered by default.

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

Lines changed: 44 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
22
summary: Multiple active relationships including performer and patient details
33
description:
4-
A Bundle containing multiple active proxy relationships with varying legal basis' including the details
4+
A Bundle containing multiple active proxy relationships with varying legal bases including the details
55
of the performer and patient.
66
value:
77
resourceType: Bundle
@@ -90,6 +90,28 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
9090
- identifier:
9191
system: "https://fhir.nhs.uk/Id/nhs-number"
9292
value: "9000000017"
93+
provision:
94+
actor:
95+
- reference:
96+
identifier:
97+
system: https://fhir.nhs.uk/Id/nhs-number
98+
value: "9000000017"
99+
type: RelatedPerson
100+
role:
101+
coding:
102+
- code: PRN
103+
display: Parent
104+
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
105+
period:
106+
end: "2026-02-11"
107+
start: "2025-02-11"
108+
extension:
109+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
110+
valueCodeableConcept:
111+
- coding:
112+
- code: TBC
113+
display: TBC
114+
system: http://terminology.hl7.org/CodeSystem/consent-reason
93115
search:
94116
mode: match
95117
- fullUrl: "https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720"
@@ -167,12 +189,27 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
167189
- identifier:
168190
system: "https://fhir.nhs.uk/Id/nhs-number"
169191
value: "9000000017"
170-
verification:
171-
- verified: true
172-
verifiedWith:
192+
provision:
193+
actor:
194+
- reference:
173195
identifier:
174-
system: "https://fhir.nhs.uk/Id/nhs-number"
175-
value: "9000000005"
176-
verificationDate: "2024-07-21T17:32:28Z"
196+
system: https://fhir.nhs.uk/Id/nhs-number
197+
value: "9000000017"
198+
type: RelatedPerson
199+
role:
200+
coding:
201+
- code: PRN
202+
display: Parent
203+
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
204+
period:
205+
end: "2026-02-11"
206+
start: "2025-02-11"
207+
extension:
208+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
209+
valueCodeableConcept:
210+
- coding:
211+
- code: TBC
212+
display: TBC
213+
system: http://terminology.hl7.org/CodeSystem/consent-reason
177214
search:
178215
mode: match

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

Lines changed: 43 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
ConsentMultipleRelationshipsStatusInactiveBundle:
22
summary: Multiple inactive relationships
3-
description: A Bundle containing multiple inactive proxy relationships with varying legal basis'
3+
description: A Bundle containing multiple inactive proxy relationships with varying legal basis
44
value:
55
resourceType: Bundle
66
timestamp: '2020-08-26T14:00:00+00:00'
@@ -33,13 +33,28 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
3333
- identifier:
3434
system: 'https://fhir.nhs.uk/Id/nhs-number'
3535
value: '9000000017'
36-
verification:
37-
- verified: true
38-
verifiedWith:
36+
provision:
37+
actor:
38+
- reference:
3939
identifier:
40-
system: 'https://fhir.nhs.uk/Id/nhs-number'
41-
value: '9000000006'
42-
verificationDate: '2024-07-21T17:32:28Z'
40+
system: https://fhir.nhs.uk/Id/nhs-number
41+
value: '9000000017'
42+
type: RelatedPerson
43+
role:
44+
coding:
45+
- code: PRN
46+
display: Parent
47+
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
48+
period:
49+
end: '2026-02-11'
50+
start: '2025-02-11'
51+
extension:
52+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
53+
valueCodeableConcept:
54+
- coding:
55+
- code: TBC
56+
display: TBC
57+
system: http://terminology.hl7.org/CodeSystem/consent-reason
4358
search:
4459
mode: match
4560
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/ABCD12B3
@@ -68,12 +83,27 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
6883
- identifier:
6984
system: 'https://fhir.nhs.uk/Id/nhs-number'
7085
value: '9000000017'
71-
verification:
72-
- verified: true
73-
verifiedWith:
86+
provision:
87+
actor:
88+
- reference:
7489
identifier:
75-
system: 'https://fhir.nhs.uk/Id/nhs-number'
76-
value: '9000000007'
77-
verificationDate: '2024-07-21T17:32:28Z'
90+
system: https://fhir.nhs.uk/Id/nhs-number
91+
value: '9000000017'
92+
type: RelatedPerson
93+
role:
94+
coding:
95+
- code: PRN
96+
display: Parent
97+
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
98+
period:
99+
end: '2026-02-11'
100+
start: '2025-02-11'
101+
extension:
102+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
103+
valueCodeableConcept:
104+
- coding:
105+
- code: TBC
106+
display: TBC
107+
system: http://terminology.hl7.org/CodeSystem/consent-reason
78108
search:
79109
mode: match

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

Lines changed: 86 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,28 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
3333
- identifier:
3434
system: 'https://fhir.nhs.uk/Id/nhs-number'
3535
value: '9000000017'
36+
provision:
37+
actor:
38+
- reference:
39+
identifier:
40+
system: https://fhir.nhs.uk/Id/nhs-number
41+
value: '9000000017'
42+
type: RelatedPerson
43+
role:
44+
coding:
45+
- code: PRN
46+
display: Parent
47+
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
48+
period:
49+
end: '2026-02-11'
50+
start: '2025-02-11'
51+
extension:
52+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
53+
valueCodeableConcept:
54+
- coding:
55+
- code: TBC
56+
display: TBC
57+
system: http://terminology.hl7.org/CodeSystem/consent-reason
3658
search:
3759
mode: match
3860

@@ -62,13 +84,29 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
6284
- identifier:
6385
system: 'https://fhir.nhs.uk/Id/nhs-number'
6486
value: '9000000017'
65-
verification:
66-
- verified: true
67-
verifiedWith:
87+
88+
provision:
89+
actor:
90+
- reference:
6891
identifier:
69-
system: 'https://fhir.nhs.uk/Id/nhs-number'
70-
value: '9000000005'
71-
verificationDate: '2024-07-21T17:32:28Z'
92+
system: https://fhir.nhs.uk/Id/nhs-number
93+
value: '9000000017'
94+
type: RelatedPerson
95+
role:
96+
coding:
97+
- code: PRN
98+
display: Parent
99+
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
100+
period:
101+
end: '2026-02-11'
102+
start: '2025-02-11'
103+
extension:
104+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
105+
valueCodeableConcept:
106+
- coding:
107+
- code: TBC
108+
display: TBC
109+
system: http://terminology.hl7.org/CodeSystem/consent-reason
72110
search:
73111
mode: match
74112

@@ -98,13 +136,28 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
98136
- identifier:
99137
system: 'https://fhir.nhs.uk/Id/nhs-number'
100138
value: '9000000017'
101-
verification:
102-
- verified: true
103-
verifiedWith:
139+
provision:
140+
actor:
141+
- reference:
104142
identifier:
105-
system: 'https://fhir.nhs.uk/Id/nhs-number'
106-
value: '9000000020'
107-
verificationDate: '2024-07-21T17:32:28Z'
143+
system: https://fhir.nhs.uk/Id/nhs-number
144+
value: '9000000017'
145+
type: RelatedPerson
146+
role:
147+
coding:
148+
- code: PRN
149+
display: Parent
150+
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
151+
period:
152+
end: '2026-02-11'
153+
start: '2025-02-11'
154+
extension:
155+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
156+
valueCodeableConcept:
157+
- coding:
158+
- code: TBC
159+
display: TBC
160+
system: http://terminology.hl7.org/CodeSystem/consent-reason
108161
search:
109162
mode: match
110163

@@ -134,12 +187,27 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
134187
- identifier:
135188
system: 'https://fhir.nhs.uk/Id/nhs-number'
136189
value: '9000000017'
137-
verification:
138-
- verified: true
139-
verifiedWith:
190+
provision:
191+
actor:
192+
- reference:
140193
identifier:
141-
system: 'https://fhir.nhs.uk/Id/nhs-number'
142-
value: '9000000021'
143-
verificationDate: '2024-07-21T17:32:28Z'
194+
system: https://fhir.nhs.uk/Id/nhs-number
195+
value: '9000000017'
196+
type: RelatedPerson
197+
role:
198+
coding:
199+
- code: PRN
200+
display: Parent
201+
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
202+
period:
203+
end: '2026-02-11'
204+
start: '2025-02-11'
205+
extension:
206+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
207+
valueCodeableConcept:
208+
- coding:
209+
- code: TBC
210+
display: TBC
211+
system: http://terminology.hl7.org/CodeSystem/consent-reason
144212
search:
145213
mode: match

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

Lines changed: 64 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,28 @@ ConsentMultipleRelationshipsIncludePatientBundle:
6565
- identifier:
6666
system: 'https://fhir.nhs.uk/Id/nhs-number'
6767
value: '9000000022'
68+
provision:
69+
actor:
70+
- reference:
71+
identifier:
72+
system: https://fhir.nhs.uk/Id/nhs-number
73+
value: '9000000022'
74+
type: RelatedPerson
75+
role:
76+
coding:
77+
- code: PRN
78+
display: Parent
79+
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
80+
period:
81+
end: '2026-02-11'
82+
start: '2025-02-11'
83+
extension:
84+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
85+
valueCodeableConcept:
86+
- coding:
87+
- code: TBC
88+
display: TBC
89+
system: http://terminology.hl7.org/CodeSystem/consent-reason
6890
search:
6991
mode: match
7092
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/DFCC67F5
@@ -121,13 +143,28 @@ ConsentMultipleRelationshipsIncludePatientBundle:
121143
- identifier:
122144
system: 'https://fhir.nhs.uk/Id/nhs-number'
123145
value: '9000000022'
124-
verification:
125-
- verified: true
126-
verifiedWith:
146+
provision:
147+
actor:
148+
- reference:
127149
identifier:
128-
system: 'https://fhir.nhs.uk/Id/nhs-number'
129-
value: '9000000005'
130-
verificationDate: '2024-07-21T17:32:28Z'
150+
system: https://fhir.nhs.uk/Id/nhs-number
151+
value: '9000000022'
152+
type: RelatedPerson
153+
role:
154+
coding:
155+
- code: PRN
156+
display: Parent
157+
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
158+
period:
159+
end: '2026-02-11'
160+
start: '2025-02-11'
161+
extension:
162+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
163+
valueCodeableConcept:
164+
- coding:
165+
- code: TBC
166+
display: TBC
167+
system: http://terminology.hl7.org/CodeSystem/consent-reason
131168
search:
132169
mode: match
133170
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/ZPTT32T3
@@ -184,13 +221,28 @@ ConsentMultipleRelationshipsIncludePatientBundle:
184221
- identifier:
185222
system: 'https://fhir.nhs.uk/Id/nhs-number'
186223
value: '9000000022'
187-
verification:
188-
- verified: true
189-
verifiedWith:
224+
provision:
225+
actor:
226+
- reference:
190227
identifier:
191-
system: 'https://fhir.nhs.uk/Id/nhs-number'
192-
value: '9000000006'
193-
verificationDate: '2024-07-21T17:32:28Z'
228+
system: https://fhir.nhs.uk/Id/nhs-number
229+
value: '9000000022'
230+
type: RelatedPerson
231+
role:
232+
coding:
233+
- code: PRN
234+
display: Parent
235+
system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
236+
period:
237+
end: '2026-02-11'
238+
start: '2025-02-11'
239+
extension:
240+
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
241+
valueCodeableConcept:
242+
- coding:
243+
- code: TBC
244+
display: TBC
245+
system: http://terminology.hl7.org/CodeSystem/consent-reason
194246
search:
195247
mode: match
196248

0 commit comments

Comments
 (0)