Skip to content

Commit a73a56f

Browse files
Merge pull request #240 from NHSDigital/bug/NPA-5395/ensure-fhir-compatibility-for-consent-resource
NPA-5395: Ensure FHIR Compatibility for Consent Resource
2 parents 3bf5643 + 00231e4 commit a73a56f

22 files changed

+640
-903
lines changed

postman/Validate Relationship Service Sandbox.postman_collection.json

Lines changed: 424 additions & 608 deletions
Large diffs are not rendered by default.

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

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
88
timestamp: "2020-08-26T14:00:00+00:00"
99
total: 2
1010
type: searchset
11+
link:
12+
- relation: self
13+
url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=active&_include=Consent:performer&_include=Consent:patient
1114
entry:
1215
- fullUrl: "https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742"
1316
resource:
@@ -90,6 +93,9 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
9093
- identifier:
9194
system: "https://fhir.nhs.uk/Id/nhs-number"
9295
value: "9000000017"
96+
policy:
97+
- authority: "https://www.england.nhs.uk"
98+
uri: "REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD"
9399
provision:
94100
actor:
95101
- reference:
@@ -105,14 +111,6 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
105111
period:
106112
end: "2026-02-11"
107113
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
115-
text: "To be confirmed"
116114
search:
117115
mode: match
118116
- fullUrl: "https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720"
@@ -190,6 +188,9 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
190188
- identifier:
191189
system: "https://fhir.nhs.uk/Id/nhs-number"
192190
value: "9000000017"
191+
policy:
192+
- authority: "https://www.england.nhs.uk"
193+
uri: "REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD"
193194
provision:
194195
actor:
195196
- reference:
@@ -205,13 +206,5 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
205206
period:
206207
end: "2026-02-11"
207208
start: "2025-02-11"
208-
extension:
209-
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
210-
valueCodeableConcept:
211-
coding:
212-
- code: TBC
213-
display: TBC
214-
system: http://terminology.hl7.org/CodeSystem/consent-reason
215-
text: "To be confirmed"
216209
search:
217210
mode: match

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

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
66
timestamp: '2020-08-26T14:00:00+00:00'
77
total: 2
88
type: searchset
9+
link:
10+
- relation: self
11+
url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=inactive
912
entry:
1013
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/AATD11A1
1114
resource:
@@ -33,6 +36,9 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
3336
- identifier:
3437
system: 'https://fhir.nhs.uk/Id/nhs-number'
3538
value: '9000000017'
39+
policy:
40+
- authority: https://www.england.nhs.uk
41+
uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
3642
provision:
3743
actor:
3844
- reference:
@@ -48,14 +54,6 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
4854
period:
4955
end: '2026-02-11'
5056
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
58-
text: "To be confirmed"
5957
search:
6058
mode: match
6159
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/ABCD12B3
@@ -84,6 +82,9 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
8482
- identifier:
8583
system: 'https://fhir.nhs.uk/Id/nhs-number'
8684
value: '9000000017'
85+
policy:
86+
- authority: https://www.england.nhs.uk
87+
uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
8788
provision:
8889
actor:
8990
- reference:
@@ -99,13 +100,5 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
99100
period:
100101
end: '2026-02-11'
101102
start: '2025-02-11'
102-
extension:
103-
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
104-
valueCodeableConcept:
105-
coding:
106-
- code: TBC
107-
display: TBC
108-
system: http://terminology.hl7.org/CodeSystem/consent-reason
109-
text: "To be confirmed"
110103
search:
111104
mode: match

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

Lines changed: 15 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
66
timestamp: '2020-08-26T14:00:00+00:00'
77
total: 4
88
type: searchset
9+
link:
10+
- relation: self
11+
url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=proposed&status=active&_include=Consent:patient
912
entry:
1013
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9
1114
resource:
@@ -33,6 +36,9 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
3336
- identifier:
3437
system: 'https://fhir.nhs.uk/Id/nhs-number'
3538
value: '9000000017'
39+
policy:
40+
- authority: https://www.england.nhs.uk
41+
uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
3642
provision:
3743
actor:
3844
- reference:
@@ -48,14 +54,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
4854
period:
4955
end: '2026-02-11'
5056
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
58-
text: "To be confirmed"
5957
search:
6058
mode: match
6159

@@ -85,7 +83,9 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
8583
- identifier:
8684
system: 'https://fhir.nhs.uk/Id/nhs-number'
8785
value: '9000000017'
88-
86+
policy:
87+
- authority: https://www.england.nhs.uk
88+
uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
8989
provision:
9090
actor:
9191
- reference:
@@ -101,14 +101,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
101101
period:
102102
end: '2026-02-11'
103103
start: '2025-02-11'
104-
extension:
105-
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
106-
valueCodeableConcept:
107-
coding:
108-
- code: TBC
109-
display: TBC
110-
system: http://terminology.hl7.org/CodeSystem/consent-reason
111-
text: "To be confirmed"
112104
search:
113105
mode: match
114106

@@ -138,6 +130,9 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
138130
- identifier:
139131
system: 'https://fhir.nhs.uk/Id/nhs-number'
140132
value: '9000000017'
133+
policy:
134+
- authority: https://www.england.nhs.uk
135+
uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
141136
provision:
142137
actor:
143138
- reference:
@@ -153,14 +148,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
153148
period:
154149
end: '2026-02-11'
155150
start: '2025-02-11'
156-
extension:
157-
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
158-
valueCodeableConcept:
159-
coding:
160-
- code: TBC
161-
display: TBC
162-
system: http://terminology.hl7.org/CodeSystem/consent-reason
163-
text: "To be confirmed"
164151
search:
165152
mode: match
166153

@@ -190,6 +177,9 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
190177
- identifier:
191178
system: 'https://fhir.nhs.uk/Id/nhs-number'
192179
value: '9000000017'
180+
policy:
181+
- authority: https://www.england.nhs.uk
182+
uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
193183
provision:
194184
actor:
195185
- reference:
@@ -205,13 +195,5 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
205195
period:
206196
end: '2026-02-11'
207197
start: '2025-02-11'
208-
extension:
209-
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
210-
valueCodeableConcept:
211-
coding:
212-
- code: TBC
213-
display: TBC
214-
system: http://terminology.hl7.org/CodeSystem/consent-reason
215-
text: "To be confirmed"
216198
search:
217199
mode: match

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

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ ConsentMultipleRelationshipsIncludePatientBundle:
77
timestamp: '2020-08-26T14:00:00+00:00'
88
total: 3
99
type: searchset
10+
link:
11+
- relation: self
12+
url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:patient
1013
entry:
1114
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2
1215
resource:
@@ -65,6 +68,9 @@ ConsentMultipleRelationshipsIncludePatientBundle:
6568
- identifier:
6669
system: 'https://fhir.nhs.uk/Id/nhs-number'
6770
value: '9000000022'
71+
policy:
72+
- authority: https://www.england.nhs.uk
73+
uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
6874
provision:
6975
actor:
7076
- reference:
@@ -80,14 +86,6 @@ ConsentMultipleRelationshipsIncludePatientBundle:
8086
period:
8187
end: '2026-02-11'
8288
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
90-
text: "To be confirmed"
9189
search:
9290
mode: match
9391
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/DFCC67F5
@@ -144,6 +142,9 @@ ConsentMultipleRelationshipsIncludePatientBundle:
144142
- identifier:
145143
system: 'https://fhir.nhs.uk/Id/nhs-number'
146144
value: '9000000022'
145+
policy:
146+
- authority: https://www.england.nhs.uk
147+
uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
147148
provision:
148149
actor:
149150
- reference:
@@ -159,14 +160,6 @@ ConsentMultipleRelationshipsIncludePatientBundle:
159160
period:
160161
end: '2026-02-11'
161162
start: '2025-02-11'
162-
extension:
163-
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
164-
valueCodeableConcept:
165-
coding:
166-
- code: TBC
167-
display: TBC
168-
system: http://terminology.hl7.org/CodeSystem/consent-reason
169-
text: "To be confirmed"
170163
search:
171164
mode: match
172165
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/ZPTT32T3
@@ -223,6 +216,9 @@ ConsentMultipleRelationshipsIncludePatientBundle:
223216
- identifier:
224217
system: 'https://fhir.nhs.uk/Id/nhs-number'
225218
value: '9000000022'
219+
policy:
220+
- authority: https://www.england.nhs.uk
221+
uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
226222
provision:
227223
actor:
228224
- reference:
@@ -238,14 +234,6 @@ ConsentMultipleRelationshipsIncludePatientBundle:
238234
period:
239235
end: '2026-02-11'
240236
start: '2025-02-11'
241-
extension:
242-
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
243-
valueCodeableConcept:
244-
coding:
245-
- code: TBC
246-
display: TBC
247-
system: http://terminology.hl7.org/CodeSystem/consent-reason
248-
text: "To be confirmed"
249237
search:
250238
mode: match
251239

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

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
88
timestamp: '2020-08-26T14:00:00+00:00'
99
total: 3
1010
type: searchset
11+
link:
12+
- relation: self
13+
url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:performer&_include=Consent:patient
1114
entry:
1215
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
1316
resource:
@@ -90,6 +93,9 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
9093
- identifier:
9194
system: 'https://fhir.nhs.uk/Id/nhs-number'
9295
value: '9000000022'
96+
policy:
97+
- authority: https://www.england.nhs.uk
98+
uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
9399
provision:
94100
actor:
95101
- reference:
@@ -105,14 +111,6 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
105111
period:
106112
end: '2026-02-11'
107113
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
115-
text: "To be confirmed"
116114
search:
117115
mode: match
118116
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720
@@ -191,6 +189,9 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
191189
- identifier:
192190
system: 'https://fhir.nhs.uk/Id/nhs-number'
193191
value: '9000000022'
192+
policy:
193+
- authority: https://www.england.nhs.uk
194+
uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
194195
provision:
195196
actor:
196197
- reference:
@@ -206,14 +207,6 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
206207
period:
207208
end: '2026-02-11'
208209
start: '2025-02-11'
209-
extension:
210-
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
211-
valueCodeableConcept:
212-
coding:
213-
- code: TBC
214-
display: TBC
215-
system: http://terminology.hl7.org/CodeSystem/consent-reason
216-
text: "To be confirmed"
217210
search:
218211
mode: match
219212
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/AATD11A1
@@ -292,6 +285,9 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
292285
- identifier:
293286
system: 'https://fhir.nhs.uk/Id/nhs-number'
294287
value: '9000000022'
288+
policy:
289+
- authority: https://www.england.nhs.uk
290+
uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
295291
provision:
296292
actor:
297293
- reference:
@@ -307,13 +303,5 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
307303
period:
308304
end: '2026-02-11'
309305
start: '2025-02-11'
310-
extension:
311-
- url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
312-
valueCodeableConcept:
313-
coding:
314-
- code: TBC
315-
display: TBC
316-
system: http://terminology.hl7.org/CodeSystem/consent-reason
317-
text: "To be confirmed"
318306
search:
319307
mode: match

0 commit comments

Comments
 (0)