From d2dec5379b096937db2c5da811ee15ca53b81a21 Mon Sep 17 00:00:00 2001
From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com>
Date: Mon, 4 Aug 2025 10:00:54 +0100
Subject: [PATCH 1/8] NPA-5395: Remove Extension from Consent schema in spec
and examples
---
.../PATCH_Consent/replace_status.yaml | 12 +------
.../adult_to_adult_proxy_creation.yaml | 7 ----
.../parent_child_proxy_creation.yaml | 7 ----
...onships-status-active-include-details.yaml | 16 ----------
...iltered-relationships-status-inactive.yaml | 16 ----------
...-relationships-status-proposed-active.yaml | 32 -------------------
...ultiple-relationships-include-patient.yaml | 24 --------------
...lationships-include-performer-patient.yaml | 24 --------------
...tiple-relationships-include-performer.yaml | 24 --------------
...nships-single-patient-include-patient.yaml | 24 --------------
...gle-patient-include-performer-patient.yaml | 24 --------------
...hips-single-patient-include-performer.yaml | 24 --------------
...multiple-relationships-single-patient.yaml | 24 --------------
.../GET_Consent/multiple-relationships.yaml | 24 --------------
...elationship-include-performer-patient.yaml | 8 -----
.../single-consenting-adult-relationship.yaml | 8 -----
...elationship-include-performer-patient.yaml | 8 -----
.../single-mother-child-relationship.yaml | 8 -----
.../validated-relationships-service-api.yaml | 16 ----------
19 files changed, 1 insertion(+), 329 deletions(-)
diff --git a/specification/examples/requests/PATCH_Consent/replace_status.yaml b/specification/examples/requests/PATCH_Consent/replace_status.yaml
index 74766426..bb5d101f 100644
--- a/specification/examples/requests/PATCH_Consent/replace_status.yaml
+++ b/specification/examples/requests/PATCH_Consent/replace_status.yaml
@@ -1,17 +1,7 @@
StatusUpdate:
summary: Update consent status
- description: Example status change to inactive. Along with reason for the status change.
+ description: Example status change to inactive.
value:
- op: replace
path: /status
value: inactive
- - op: replace
- path: /extension
- value:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - system: http://terminology.hl7.org/CodeSystem/consent-reason
- code: TBC
- display: TBC
-
diff --git a/specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml b/specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml
index c26c343a..7f903a0b 100644
--- a/specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml
+++ b/specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml
@@ -40,10 +40,3 @@ ConsentAdultToAdultGuardianRequest:
identifier:
system: https://fhir.nhs.uk/Id/nhs-number
value: "9000000017"
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - system: http://terminology.hl7.org/CodeSystem/consent-reason
- code: TBC
- display: TBC
\ No newline at end of file
diff --git a/specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml b/specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml
index c7374722..6693583e 100644
--- a/specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml
+++ b/specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml
@@ -41,10 +41,3 @@ ConsentParentChildProxyCreationRequest:
identifier:
system: https://fhir.nhs.uk/Id/nhs-number
value: "9000000009"
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - system: http://terminology.hl7.org/CodeSystem/consent-reason
- code: TBC
- display: TBC
\ No newline at end of file
diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml
index fc0ac6e0..46f78023 100644
--- a/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml
+++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml
@@ -105,14 +105,6 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
period:
end: "2026-02-11"
start: "2025-02-11"
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: "https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720"
@@ -205,13 +197,5 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
period:
end: "2026-02-11"
start: "2025-02-11"
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml
index c5c0eec6..d82ec1ee 100644
--- a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml
+++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml
@@ -48,14 +48,6 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/ABCD12B3
@@ -99,13 +91,5 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml
index ffc118fc..d04ce938 100644
--- a/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml
+++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml
@@ -48,14 +48,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
@@ -101,14 +93,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
@@ -153,14 +137,6 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
@@ -205,13 +181,5 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml
index 92ad038e..cde27e85 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml
@@ -80,14 +80,6 @@ ConsentMultipleRelationshipsIncludePatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/DFCC67F5
@@ -159,14 +151,6 @@ ConsentMultipleRelationshipsIncludePatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/ZPTT32T3
@@ -238,14 +222,6 @@ ConsentMultipleRelationshipsIncludePatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml
index 5289326d..a185c5b2 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml
@@ -105,14 +105,6 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720
@@ -206,14 +198,6 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/AATD11A1
@@ -307,13 +291,5 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml
index 104cd9b5..f7f18490 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml
@@ -75,14 +75,6 @@ ConsentMultipleRelationshipsIncludePerformerBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: >-
@@ -150,14 +142,6 @@ ConsentMultipleRelationshipsIncludePerformerBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: >-
@@ -225,14 +209,6 @@ ConsentMultipleRelationshipsIncludePerformerBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml
index 75543ad4..6630adf5 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml
@@ -76,14 +76,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1
@@ -127,14 +119,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/AATD11A1
@@ -178,13 +162,5 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml
index 5301ff00..ca0f5894 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml
@@ -100,14 +100,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
@@ -172,14 +164,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
@@ -244,13 +228,5 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml
index d0592898..eb463312 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml
@@ -72,14 +72,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
@@ -144,14 +136,6 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
@@ -216,13 +200,5 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml
index 32cb284a..432a6bd1 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml
@@ -48,14 +48,6 @@ ConsentMultipleRelationshipsSinglePatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1
@@ -99,14 +91,6 @@ ConsentMultipleRelationshipsSinglePatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/AATD11A1
@@ -150,13 +134,5 @@ ConsentMultipleRelationshipsSinglePatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships.yaml b/specification/examples/responses/GET_Consent/multiple-relationships.yaml
index bbf018da..16fc01a4 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships.yaml
@@ -48,14 +48,6 @@ ConsentMultipleRelationshipsBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1
@@ -99,14 +91,6 @@ ConsentMultipleRelationshipsBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/AATD11A1
@@ -150,13 +134,5 @@ ConsentMultipleRelationshipsBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml
index 120e6b83..933b92cc 100644
--- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml
+++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml
@@ -100,13 +100,5 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml
index d597686a..e285fb55 100644
--- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml
+++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml
@@ -48,13 +48,5 @@ ConsentSingleConsentingAdultRelationshipBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml
index 57f1c8b4..8ed89266 100644
--- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml
+++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml
@@ -105,13 +105,5 @@ ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml
index 71bc9852..a9825dc1 100644
--- a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml
+++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml
@@ -48,13 +48,5 @@ ConsentSingleAdultChildRelationshipBundle:
period:
end: '2026-02-11'
start: '2025-02-11'
- extension:
- - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
- valueCodeableConcept:
- coding:
- - code: TBC
- display: TBC
- system: http://terminology.hl7.org/CodeSystem/consent-reason
- text: "To be confirmed"
search:
mode: match
diff --git a/specification/validated-relationships-service-api.yaml b/specification/validated-relationships-service-api.yaml
index 5b9f58ee..4f9578c4 100644
--- a/specification/validated-relationships-service-api.yaml
+++ b/specification/validated-relationships-service-api.yaml
@@ -751,7 +751,6 @@ paths:
| 422 | `INVALID_CATEGORY` | Invalid category. |
| 422 | `INVALID_DATETIME` | Invalid datetime. |
| 422 | `INVALID_PROVISION` | Invalid provision. |
- | 422 | `INVALID_EXTENSION` | Invalid extension. |
| 422 | `INVALID_PARAMETER` | Invalid request parameter. For details, see the diagnostics field. |
| 429 | `THROTTLED` | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |
@@ -2246,11 +2245,6 @@ components:
description: "Individuals or organizations that agreed to the consent."
provision:
$ref: "#/components/schemas/Provision"
- extension:
- type: array
- description: Model the status reason.
- items:
- $ref: "#/components/schemas/Extension"
Provision:
type: object
@@ -2280,15 +2274,6 @@ components:
$ref: "#/components/schemas/CodeableConcept"
description: "Classification of the role of consent, bound to http://terminology.hl7.org/CodeSystem/v3-RoleCode"
- Extension:
- type: object
- properties:
- url:
- type: string
- valueCodeableConcept:
- $ref: "#/components/schemas/CodeableConcept"
- description: Classification of the status of consent, bound to http://terminology.hl7.org/CodeSystem/consent-reason.
-
OperationOutcome:
type: object
description: |
@@ -2439,7 +2424,6 @@ components:
- /status
- /provision/period/end
- /provision/actor
- - /extension
value:
oneOf:
- type: string
From 98a4e0a4630b623aade705d94d16fa4aab00d04c Mon Sep 17 00:00:00 2001
From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com>
Date: Mon, 4 Aug 2025 10:42:00 +0100
Subject: [PATCH 2/8] NPA-5395: Update postman with removing extenstion from
Consent bundle
---
...ip Service Sandbox.postman_collection.json | 606 +-----------------
.../validated-relationships-service-api.yaml | 2 +-
2 files changed, 4 insertions(+), 604 deletions(-)
diff --git a/postman/Validate Relationship Service Sandbox.postman_collection.json b/postman/Validate Relationship Service Sandbox.postman_collection.json
index cb0d25a5..c0c7aa1d 100644
--- a/postman/Validate Relationship Service Sandbox.postman_collection.json
+++ b/postman/Validate Relationship Service Sandbox.postman_collection.json
@@ -1,10 +1,10 @@
{
"info": {
- "_postman_id": "a676026f-cba5-4d4e-a36b-7c78a9382f49",
- "name": "Validate Relationship Service Sandbox 10/07/25",
+ "_postman_id": "35ed5c9e-f0bb-49c9-841e-3dbfcc85ddc5",
+ "name": "Validate Relationship Service Sandbox 04/08/25",
"description": "This Postman collection includes example scenarios for each of the Validated Relationship Service (VRS) API endpoints, covering both valid and invalid request scenarios.\n\nThe collection is pointed towards the VRS sandbox environment, which will return a specific example response based on the request sent. All data shown in the requests or responses is test data.\n\nOur sandbox environment only covers the scenarios listed in the Postman collection and is open access. It does not allow you to test authorisation or any scenarios beyond the ones documented.\n\nFull specification is available at [https://digital.nhs.uk/developer/api-catalogue/validated-relationship-service](https://digital.nhs.uk/developer/api-catalogue/validated-relationship-service)",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
- "_exporter_id": "18067099"
+ "_exporter_id": "44536620"
},
"item": [
{
@@ -2215,21 +2215,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -2389,21 +2374,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -2553,21 +2523,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -2642,21 +2597,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -2793,21 +2733,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -2882,21 +2807,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -2971,21 +2881,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -3060,21 +2955,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -3212,21 +3092,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -3301,21 +3166,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -3390,21 +3240,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -3581,21 +3416,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -3717,21 +3537,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -3853,21 +3658,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -4040,21 +3830,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -4167,21 +3942,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -4294,21 +4054,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -4532,21 +4277,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -4706,21 +4436,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -4880,21 +4595,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -5028,21 +4728,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -5117,21 +4802,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -5206,21 +4876,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -5436,21 +5091,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -5563,21 +5203,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -5690,21 +5315,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -5881,21 +5491,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -6008,21 +5603,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -6135,21 +5715,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -6326,21 +5891,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -6415,21 +5965,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -6504,21 +6039,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -6697,21 +6217,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -6922,21 +6427,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -7070,21 +6560,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -7304,21 +6779,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -8187,21 +7647,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -8692,21 +8137,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -8837,21 +8267,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -9360,21 +8775,6 @@
" \"start\": \"2025-02-11\"",
" }",
" },",
- " \"extension\": [",
- " {",
- " \"url\": \"https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason\",",
- " \"valueCodeableConcept\": {",
- " \"coding\": [",
- " {",
- " \"code\": \"TBC\",",
- " \"display\": \"TBC\",",
- " \"system\": \"http://terminology.hl7.org/CodeSystem/consent-reason\"",
- " }",
- " ],",
- " \"text\": \"To be confirmed\"",
- " }",
- " }",
- " ]",
" },",
" \"search\": {",
" \"mode\": \"match\"",
diff --git a/specification/validated-relationships-service-api.yaml b/specification/validated-relationships-service-api.yaml
index 4f9578c4..aef0f65b 100644
--- a/specification/validated-relationships-service-api.yaml
+++ b/specification/validated-relationships-service-api.yaml
@@ -141,7 +141,7 @@ info:
* only covers a limited set of scenarios
* is open access, so does not allow you to test authorisation
- [
](https://god.gw.postman.com/run-collection/46399153-73a3846c-092a-44a1-940f-18736fb1f411?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D46399153-73a3846c-092a-44a1-940f-18736fb1f411%26entityType%3Dcollection%26workspaceId%3D34c06bc9-c5de-4206-b931-9ee51c810dbb))
+ [
](https://app.getpostman.com/run-collection/44536620-35ed5c9e-f0bb-49c9-841e-3dbfcc85ddc5?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D44536620-35ed5c9e-f0bb-49c9-841e-3dbfcc85ddc5%26entityType%3Dcollection%26workspaceId%3Dad27765c-6ca7-4f03-9ef4-fd61fe46e357)
### Integration testing
From ec6377fbfa797cb2a530d05b28489f05027b14c9 Mon Sep 17 00:00:00 2001
From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com>
Date: Mon, 4 Aug 2025 12:57:45 +0100
Subject: [PATCH 3/8] NPA-5395: Update OAS with policy in ConsentBundle
---
...ationships-status-active-include-details.yaml | 6 ++++++
.../filtered-relationships-status-inactive.yaml | 6 ++++++
...red-relationships-status-proposed-active.yaml | 13 ++++++++++++-
.../multiple-relationships-include-patient.yaml | 9 +++++++++
...-relationships-include-performer-patient.yaml | 9 +++++++++
...multiple-relationships-include-performer.yaml | 9 +++++++++
...tionships-single-patient-include-patient.yaml | 9 +++++++++
...single-patient-include-performer-patient.yaml | 9 +++++++++
...onships-single-patient-include-performer.yaml | 9 +++++++++
.../multiple-relationships-single-patient.yaml | 9 +++++++++
.../GET_Consent/multiple-relationships.yaml | 9 +++++++++
...nting-adult-relationship-include-patient.yaml | 3 +++
...t-relationship-include-performer-patient.yaml | 3 +++
...ing-adult-relationship-include-performer.yaml | 3 +++
.../single-consenting-adult-relationship.yaml | 3 +++
...other-child-relationship-include-patient.yaml | 3 +++
...d-relationship-include-performer-patient.yaml | 3 +++
.../single-mother-child-relationship.yaml | 3 +++
.../validated-relationships-service-api.yaml | 16 ++++++++++++++++
19 files changed, 133 insertions(+), 1 deletion(-)
diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml
index 46f78023..336c6e13 100644
--- a/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml
+++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml
@@ -90,6 +90,9 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
- identifier:
system: "https://fhir.nhs.uk/Id/nhs-number"
value: "9000000017"
+ policy:
+ - authority: "https://www.england.nhs.uk"
+ uri: "REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD"
provision:
actor:
- reference:
@@ -182,6 +185,9 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
- identifier:
system: "https://fhir.nhs.uk/Id/nhs-number"
value: "9000000017"
+ policy:
+ - authority: "https://www.england.nhs.uk"
+ uri: "REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD"
provision:
actor:
- reference:
diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml
index d82ec1ee..8c477baa 100644
--- a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml
+++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml
@@ -33,6 +33,9 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000017'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -76,6 +79,9 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000017'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml
index d04ce938..f5e6efcb 100644
--- a/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml
+++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml
@@ -33,6 +33,9 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000017'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -77,7 +80,9 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000017'
-
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -122,6 +127,9 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000017'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -166,6 +174,9 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000017'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml
index cde27e85..d60cba30 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml
@@ -65,6 +65,9 @@ ConsentMultipleRelationshipsIncludePatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -136,6 +139,9 @@ ConsentMultipleRelationshipsIncludePatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -207,6 +213,9 @@ ConsentMultipleRelationshipsIncludePatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml
index a185c5b2..5061bcdb 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml
@@ -90,6 +90,9 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -183,6 +186,9 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -276,6 +282,9 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml
index f7f18490..3d41ea25 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml
@@ -60,6 +60,9 @@ ConsentMultipleRelationshipsIncludePerformerBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -127,6 +130,9 @@ ConsentMultipleRelationshipsIncludePerformerBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -194,6 +200,9 @@ ConsentMultipleRelationshipsIncludePerformerBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml
index 6630adf5..2e588222 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml
@@ -61,6 +61,9 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000020'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -104,6 +107,9 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000021'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -147,6 +153,9 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml
index ca0f5894..76252c66 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml
@@ -85,6 +85,9 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000020'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -149,6 +152,9 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000021'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -213,6 +219,9 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml
index eb463312..ea174d7d 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml
@@ -57,6 +57,9 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000020'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -121,6 +124,9 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000021'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -185,6 +191,9 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml
index 432a6bd1..c32bace3 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml
@@ -33,6 +33,9 @@ ConsentMultipleRelationshipsSinglePatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000020'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -76,6 +79,9 @@ ConsentMultipleRelationshipsSinglePatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000021'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -119,6 +125,9 @@ ConsentMultipleRelationshipsSinglePatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships.yaml b/specification/examples/responses/GET_Consent/multiple-relationships.yaml
index 16fc01a4..04233841 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships.yaml
@@ -33,6 +33,9 @@ ConsentMultipleRelationshipsBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -76,6 +79,9 @@ ConsentMultipleRelationshipsBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
@@ -119,6 +125,9 @@ ConsentMultipleRelationshipsBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000022'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml
index dee9bed2..e3d2fd7d 100644
--- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml
+++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml
@@ -62,5 +62,8 @@ ConsentSingleConsentingAdultRelationshipIncludePatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000010'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml
index 933b92cc..859d5576 100644
--- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml
+++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml
@@ -85,6 +85,9 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000010'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml
index 607eb95d..38da7bad 100644
--- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml
+++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml
@@ -56,5 +56,8 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000010'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml
index e285fb55..bc94cdf5 100644
--- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml
+++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml
@@ -33,6 +33,9 @@ ConsentSingleConsentingAdultRelationshipBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000010'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml
index cf32f0de..92e2da3a 100644
--- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml
+++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml
@@ -65,5 +65,8 @@ ConsentSingleAdultChildRelationshipIncludePatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000019'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
search:
mode: match
diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml
index 8ed89266..3490b5fb 100644
--- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml
+++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml
@@ -90,6 +90,9 @@ ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000019'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml
index a9825dc1..536201b7 100644
--- a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml
+++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml
@@ -33,6 +33,9 @@ ConsentSingleAdultChildRelationshipBundle:
- identifier:
system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9000000019'
+ policy:
+ - authority: https://www.england.nhs.uk
+ uri: REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD
provision:
actor:
- reference:
diff --git a/specification/validated-relationships-service-api.yaml b/specification/validated-relationships-service-api.yaml
index aef0f65b..406eaa77 100644
--- a/specification/validated-relationships-service-api.yaml
+++ b/specification/validated-relationships-service-api.yaml
@@ -2243,8 +2243,24 @@ components:
items:
$ref: "#/components/schemas/Reference"
description: "Individuals or organizations that agreed to the consent."
+ policy:
+ type: array
+ items:
+ $ref: "#/components/schemas/Policy"
provision:
$ref: "#/components/schemas/Provision"
+
+ Policy:
+ type: object
+ properties:
+ authority:
+ type: string
+ description: "Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives."
+ format: uri
+ uri:
+ type: string
+ description: "The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law."
+ format: uri
Provision:
type: object
From 710792a5a849ae110ac31b9d1b6fe1e8229d84a9 Mon Sep 17 00:00:00 2001
From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com>
Date: Mon, 4 Aug 2025 13:18:11 +0100
Subject: [PATCH 4/8] NPA-5395: Update postman collection with policy in
expected responses
---
...ip Service Sandbox.postman_collection.json | 272 +++++++++++++++++-
1 file changed, 270 insertions(+), 2 deletions(-)
diff --git a/postman/Validate Relationship Service Sandbox.postman_collection.json b/postman/Validate Relationship Service Sandbox.postman_collection.json
index c0c7aa1d..890721c5 100644
--- a/postman/Validate Relationship Service Sandbox.postman_collection.json
+++ b/postman/Validate Relationship Service Sandbox.postman_collection.json
@@ -2189,6 +2189,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -2348,6 +2354,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -2394,6 +2406,13 @@
"type": "text/javascript",
"packages": {}
}
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "packages": {},
+ "type": "text/javascript"
+ }
}
],
"protocolProfileBehavior": {
@@ -2497,6 +2516,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -2571,6 +2596,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -2621,8 +2652,11 @@
{
"listen": "prerequest",
"script": {
- "packages": {},
- "type": "text/javascript"
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript",
+ "packages": {}
}
}
],
@@ -2707,6 +2741,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -2781,6 +2821,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -2855,6 +2901,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -2929,6 +2981,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -3066,6 +3124,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -3140,6 +3204,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -3214,6 +3284,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -3390,6 +3466,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -3511,6 +3593,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -3632,6 +3720,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -3804,6 +3898,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -3916,6 +4016,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -4028,6 +4134,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -4251,6 +4363,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -4410,6 +4528,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -4569,6 +4693,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -4702,6 +4832,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -4776,6 +4912,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -4850,6 +4992,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -5065,6 +5213,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -5177,6 +5331,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -5289,6 +5449,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -5465,6 +5631,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -5577,6 +5749,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -5689,6 +5867,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -5865,6 +6049,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -5939,6 +6129,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -6013,6 +6209,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -6191,6 +6393,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -6401,6 +6609,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -6534,6 +6748,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -6753,6 +6973,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -7621,6 +7847,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -7788,6 +8020,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -7926,6 +8164,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -8111,6 +8355,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -8241,6 +8491,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
@@ -8411,6 +8667,12 @@
" \"value\": \"9000000019\"",
" }",
" }",
+ " ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
" ]",
" },",
" \"search\": {",
@@ -8749,6 +9011,12 @@
" }",
" }",
" ],",
+ " \"policy\": [",
+ " {",
+ " \"authority\": \"https://www.england.nhs.uk\",",
+ " \"uri\": \"REPLACE_WITH_LINK_TO_PUBLISHED_NATIONAL_PROXY_STANDARD\"",
+ " }",
+ " ],",
" \"provision\": {",
" \"actor\": [",
" {",
From 53c9387a04286d47a1b3b1c89874bbbc4efd158e Mon Sep 17 00:00:00 2001
From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com>
Date: Mon, 4 Aug 2025 14:11:40 +0100
Subject: [PATCH 5/8] NPA-5395: Update postman collection and examples with new
link property on Consent bundle
---
...ip Service Sandbox.postman_collection.json | 149 +++++++++++++++++-
...onships-status-active-include-details.yaml | 3 +
...iltered-relationships-status-inactive.yaml | 3 +
...-relationships-status-proposed-active.yaml | 3 +
...ultiple-relationships-include-patient.yaml | 3 +
...lationships-include-performer-patient.yaml | 3 +
...tiple-relationships-include-performer.yaml | 3 +
...nships-single-patient-include-patient.yaml | 3 +
...gle-patient-include-performer-patient.yaml | 3 +
...hips-single-patient-include-performer.yaml | 3 +
...multiple-relationships-single-patient.yaml | 3 +
.../GET_Consent/multiple-relationships.yaml | 3 +
.../GET_Consent/no-relationships.yaml | 3 +
...ng-adult-relationship-include-patient.yaml | 3 +
...elationship-include-performer-patient.yaml | 3 +
...-adult-relationship-include-performer.yaml | 3 +
.../single-consenting-adult-relationship.yaml | 3 +
...er-child-relationship-include-patient.yaml | 3 +
...elationship-include-performer-patient.yaml | 3 +
...-child-relationship-include-performer.yaml | 3 +
.../single-mother-child-relationship.yaml | 3 +
.../validated-relationships-service-api.yaml | 17 ++
22 files changed, 224 insertions(+), 2 deletions(-)
diff --git a/postman/Validate Relationship Service Sandbox.postman_collection.json b/postman/Validate Relationship Service Sandbox.postman_collection.json
index 890721c5..59defd40 100644
--- a/postman/Validate Relationship Service Sandbox.postman_collection.json
+++ b/postman/Validate Relationship Service Sandbox.postman_collection.json
@@ -2051,6 +2051,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 2,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=active&_include=Consent:performer&_include=Consent:patient\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742\",",
@@ -2472,6 +2478,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 2,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=inactive\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/AATD11A1\",",
@@ -2697,6 +2709,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 4,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=proposed&status=active&_include=Consent:patient\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9\",",
@@ -3080,6 +3098,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 3,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9\",",
@@ -3371,6 +3395,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 3,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:patient\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2\",",
@@ -3811,6 +3841,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 3,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:performer\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742\",",
@@ -4225,6 +4261,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 3,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:performer&_include=Consent:patient\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742\",",
@@ -4788,6 +4830,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 3,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9\",",
@@ -5079,6 +5127,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 3,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:performer&_include=Consent:patient\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2\",",
@@ -5544,6 +5598,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 3,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:performer\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742\",",
@@ -5958,6 +6018,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 3,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:patient\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2\",",
@@ -6300,6 +6366,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 0,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000025&_include=Consent:performer&_include=Consent:patient\"",
+ " }",
+ " ],",
" \"entry\": []",
"}",
"",
@@ -6312,7 +6384,8 @@
" pm.expect(responseJson).to.eql(expectedResponseBody);",
"});"
],
- "type": "text/javascript"
+ "type": "text/javascript",
+ "packages": {}
}
}
],
@@ -6349,6 +6422,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 1,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1\",",
@@ -6480,6 +6559,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 1,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer&_include=Consent:patient\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720\",",
@@ -6704,6 +6789,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 1,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9\",",
@@ -6835,6 +6926,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 1,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer&_include=Consent:patient\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742\",",
@@ -7803,6 +7900,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 1,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1\",",
@@ -7929,6 +8032,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 1,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:patient\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/DFCC67F5\",",
@@ -8082,6 +8191,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 1,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720\",",
@@ -8226,6 +8341,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 1,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer&_include=Consent:patient\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720\",",
@@ -8447,6 +8568,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 1,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9\",",
@@ -8573,6 +8700,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 1,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:patient\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2\",",
@@ -8730,6 +8863,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 1,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742\",",
@@ -8873,6 +9012,12 @@
" \"timestamp\": \"2020-08-26T14:00:00+00:00\",",
" \"total\": 1,",
" \"type\": \"searchset\",",
+ " \"link\": [",
+ " {",
+ " \"relation\": \"self\",",
+ " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer&_include=Consent:patient\"",
+ " }",
+ " ],",
" \"entry\": [",
" {",
" \"fullUrl\": \"https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742\",",
@@ -9956,4 +10101,4 @@
"type": "string"
}
]
-}
+}
\ No newline at end of file
diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml
index 336c6e13..f66b9456 100644
--- a/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml
+++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml
@@ -8,6 +8,9 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
timestamp: "2020-08-26T14:00:00+00:00"
total: 2
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=active&_include=Consent:performer&_include=Consent:patient
entry:
- fullUrl: "https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742"
resource:
diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml
index 8c477baa..de8d04ec 100644
--- a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml
+++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml
@@ -6,6 +6,9 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 2
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=inactive
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/AATD11A1
resource:
diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml
index f5e6efcb..b444d1dd 100644
--- a/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml
+++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml
@@ -6,6 +6,9 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 4
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=proposed&status=active&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9
resource:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml
index d60cba30..7f4c61bf 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml
@@ -7,6 +7,9 @@ ConsentMultipleRelationshipsIncludePatientBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 3
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2
resource:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml
index 5061bcdb..cd3b9444 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml
@@ -8,6 +8,9 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 3
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:performer&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
resource:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml
index 3d41ea25..a3430fab 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml
@@ -7,6 +7,9 @@ ConsentMultipleRelationshipsIncludePerformerBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 3
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:performer
entry:
- fullUrl: >-
https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml
index 2e588222..2291b91f 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml
@@ -6,6 +6,9 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 3
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2
resource:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml
index 76252c66..e218220c 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml
@@ -6,6 +6,9 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 3
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:performer&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2
resource:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml
index ea174d7d..a057dd9e 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml
@@ -6,6 +6,9 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 3
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:performer
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
resource:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml
index c32bace3..82298c1a 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml
@@ -6,6 +6,9 @@ ConsentMultipleRelationshipsSinglePatientBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 3
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9
resource:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships.yaml b/specification/examples/responses/GET_Consent/multiple-relationships.yaml
index 04233841..a47b6e39 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships.yaml
@@ -6,6 +6,9 @@ ConsentMultipleRelationshipsBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 3
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9
resource:
diff --git a/specification/examples/responses/GET_Consent/no-relationships.yaml b/specification/examples/responses/GET_Consent/no-relationships.yaml
index e08be294..930afaf0 100644
--- a/specification/examples/responses/GET_Consent/no-relationships.yaml
+++ b/specification/examples/responses/GET_Consent/no-relationships.yaml
@@ -6,4 +6,7 @@ ConsentNoRelationshipsEmptyBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 0
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000025&_include=Consent:performer&_include=Consent:patient
entry: []
diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml
index e3d2fd7d..1e40893f 100644
--- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml
+++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml
@@ -7,6 +7,9 @@ ConsentSingleConsentingAdultRelationshipIncludePatientBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 1
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/DFCC67F5
resource:
diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml
index 859d5576..05feae45 100644
--- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml
+++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml
@@ -8,6 +8,9 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 1
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720
resource:
diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml
index 38da7bad..c3adbd40 100644
--- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml
+++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml
@@ -7,6 +7,9 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 1
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720
resource:
diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml
index bc94cdf5..6ba15f56 100644
--- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml
+++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml
@@ -6,6 +6,9 @@ ConsentSingleConsentingAdultRelationshipBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 1
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1
resource:
diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml
index 92e2da3a..27a91348 100644
--- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml
+++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml
@@ -7,6 +7,9 @@ ConsentSingleAdultChildRelationshipIncludePatientBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 1
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2
resource:
diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml
index 3490b5fb..0f050114 100644
--- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml
+++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml
@@ -8,6 +8,9 @@ ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 1
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
resource:
diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml
index 5f2584d9..1b090c36 100644
--- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml
+++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml
@@ -7,6 +7,9 @@ ConsentSingleAdultChildRelationshipIncludePerformerBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 1
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
resource:
diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml
index 536201b7..6ebdbb00 100644
--- a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml
+++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml
@@ -6,6 +6,9 @@ ConsentSingleAdultChildRelationshipBundle:
timestamp: '2020-08-26T14:00:00+00:00'
total: 1
type: searchset
+ link:
+ - relation: self
+ uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9
resource:
diff --git a/specification/validated-relationships-service-api.yaml b/specification/validated-relationships-service-api.yaml
index 406eaa77..7023f81d 100644
--- a/specification/validated-relationships-service-api.yaml
+++ b/specification/validated-relationships-service-api.yaml
@@ -1945,6 +1945,22 @@ components:
type: string
description: Denotes that the Bundle is a collection of resources returned as a result of a search.
enum: [searchset]
+
+ Link:
+ type: array
+ description: Links related to the entry
+ items:
+ type: object
+ properties:
+ relation:
+ type: string
+ description: |
+ A name which details the functional use for this link - see:
+ http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
+ url:
+ type: string
+ format: uri
+ description: The reference details for the link.
RelatedPersonBundle:
allOf:
@@ -1978,6 +1994,7 @@ components:
ConsentBundle:
allOf:
- $ref: "#/components/schemas/Searchset"
+ - $ref: "#/components/schemas/Link"
- type: object
properties:
entry:
From 57408c1ae249592f9aef1d8299cf55bf074c7f8c Mon Sep 17 00:00:00 2001
From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com>
Date: Mon, 4 Aug 2025 14:48:13 +0100
Subject: [PATCH 6/8] NPA-5359: Revert updating post and patch
---
.../requests/PATCH_Consent/replace_status.yaml | 12 +++++++++++-
.../POST_Consent/adult_to_adult_proxy_creation.yaml | 7 +++++++
.../POST_Consent/parent_child_proxy_creation.yaml | 7 +++++++
.../validated-relationships-service-api.yaml | 13 +++++++++++++
4 files changed, 38 insertions(+), 1 deletion(-)
diff --git a/specification/examples/requests/PATCH_Consent/replace_status.yaml b/specification/examples/requests/PATCH_Consent/replace_status.yaml
index bb5d101f..74766426 100644
--- a/specification/examples/requests/PATCH_Consent/replace_status.yaml
+++ b/specification/examples/requests/PATCH_Consent/replace_status.yaml
@@ -1,7 +1,17 @@
StatusUpdate:
summary: Update consent status
- description: Example status change to inactive.
+ description: Example status change to inactive. Along with reason for the status change.
value:
- op: replace
path: /status
value: inactive
+ - op: replace
+ path: /extension
+ value:
+ - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
+ valueCodeableConcept:
+ coding:
+ - system: http://terminology.hl7.org/CodeSystem/consent-reason
+ code: TBC
+ display: TBC
+
diff --git a/specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml b/specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml
index 7f903a0b..c26c343a 100644
--- a/specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml
+++ b/specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml
@@ -40,3 +40,10 @@ ConsentAdultToAdultGuardianRequest:
identifier:
system: https://fhir.nhs.uk/Id/nhs-number
value: "9000000017"
+ extension:
+ - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
+ valueCodeableConcept:
+ coding:
+ - system: http://terminology.hl7.org/CodeSystem/consent-reason
+ code: TBC
+ display: TBC
\ No newline at end of file
diff --git a/specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml b/specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml
index 6693583e..c7374722 100644
--- a/specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml
+++ b/specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml
@@ -41,3 +41,10 @@ ConsentParentChildProxyCreationRequest:
identifier:
system: https://fhir.nhs.uk/Id/nhs-number
value: "9000000009"
+ extension:
+ - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
+ valueCodeableConcept:
+ coding:
+ - system: http://terminology.hl7.org/CodeSystem/consent-reason
+ code: TBC
+ display: TBC
\ No newline at end of file
diff --git a/specification/validated-relationships-service-api.yaml b/specification/validated-relationships-service-api.yaml
index 7023f81d..879c1a09 100644
--- a/specification/validated-relationships-service-api.yaml
+++ b/specification/validated-relationships-service-api.yaml
@@ -751,6 +751,7 @@ paths:
| 422 | `INVALID_CATEGORY` | Invalid category. |
| 422 | `INVALID_DATETIME` | Invalid datetime. |
| 422 | `INVALID_PROVISION` | Invalid provision. |
+ | 422 | `INVALID_EXTENSION` | Invalid extension. |
| 422 | `INVALID_PARAMETER` | Invalid request parameter. For details, see the diagnostics field. |
| 429 | `THROTTLED` | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |
@@ -2266,6 +2267,8 @@ components:
$ref: "#/components/schemas/Policy"
provision:
$ref: "#/components/schemas/Provision"
+ extension:
+ $ref: "#/components/schemas/Extension"
Policy:
type: object
@@ -2306,6 +2309,15 @@ components:
role:
$ref: "#/components/schemas/CodeableConcept"
description: "Classification of the role of consent, bound to http://terminology.hl7.org/CodeSystem/v3-RoleCode"
+
+ Extension:
+ type: object
+ properties:
+ url:
+ type: string
+ valueCodeableConcept:
+ $ref: "#/components/schemas/CodeableConcept"
+ description: Classification of the status of consent, bound to http://terminology.hl7.org/CodeSystem/consent-reason.
OperationOutcome:
type: object
@@ -2457,6 +2469,7 @@ components:
- /status
- /provision/period/end
- /provision/actor
+ - /extension
value:
oneOf:
- type: string
From aecfac30cec1cf3af7c5062e51a12f5694a7a759 Mon Sep 17 00:00:00 2001
From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com>
Date: Mon, 4 Aug 2025 15:12:47 +0100
Subject: [PATCH 7/8] NPA-5395: Ensure link contians url prpoerty not uri
---
...ip Service Sandbox.postman_collection.json | 57 ++++++++++---------
...onships-status-active-include-details.yaml | 2 +-
...iltered-relationships-status-inactive.yaml | 2 +-
...-relationships-status-proposed-active.yaml | 2 +-
...ultiple-relationships-include-patient.yaml | 2 +-
...lationships-include-performer-patient.yaml | 2 +-
...tiple-relationships-include-performer.yaml | 2 +-
...nships-single-patient-include-patient.yaml | 2 +-
...gle-patient-include-performer-patient.yaml | 2 +-
...hips-single-patient-include-performer.yaml | 2 +-
...multiple-relationships-single-patient.yaml | 2 +-
.../GET_Consent/multiple-relationships.yaml | 2 +-
.../GET_Consent/no-relationships.yaml | 2 +-
...ng-adult-relationship-include-patient.yaml | 2 +-
...elationship-include-performer-patient.yaml | 2 +-
...-adult-relationship-include-performer.yaml | 2 +-
.../single-consenting-adult-relationship.yaml | 2 +-
...er-child-relationship-include-patient.yaml | 2 +-
...elationship-include-performer-patient.yaml | 2 +-
...-child-relationship-include-performer.yaml | 2 +-
.../single-mother-child-relationship.yaml | 2 +-
21 files changed, 50 insertions(+), 47 deletions(-)
diff --git a/postman/Validate Relationship Service Sandbox.postman_collection.json b/postman/Validate Relationship Service Sandbox.postman_collection.json
index 59defd40..16720d30 100644
--- a/postman/Validate Relationship Service Sandbox.postman_collection.json
+++ b/postman/Validate Relationship Service Sandbox.postman_collection.json
@@ -2054,7 +2054,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=active&_include=Consent:performer&_include=Consent:patient\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=active&_include=Consent:performer&_include=Consent:patient\"",
" }",
" ],",
" \"entry\": [",
@@ -2416,8 +2416,11 @@
{
"listen": "prerequest",
"script": {
- "packages": {},
- "type": "text/javascript"
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript",
+ "packages": {}
}
}
],
@@ -2481,7 +2484,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=inactive\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=inactive\"",
" }",
" ],",
" \"entry\": [",
@@ -2712,7 +2715,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=proposed&status=active&_include=Consent:patient\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=proposed&status=active&_include=Consent:patient\"",
" }",
" ],",
" \"entry\": [",
@@ -3101,7 +3104,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022\"",
" }",
" ],",
" \"entry\": [",
@@ -3398,7 +3401,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:patient\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:patient\"",
" }",
" ],",
" \"entry\": [",
@@ -3844,7 +3847,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:performer\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:performer\"",
" }",
" ],",
" \"entry\": [",
@@ -4264,7 +4267,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:performer&_include=Consent:patient\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:performer&_include=Consent:patient\"",
" }",
" ],",
" \"entry\": [",
@@ -4833,7 +4836,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100\"",
" }",
" ],",
" \"entry\": [",
@@ -5130,7 +5133,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:performer&_include=Consent:patient\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:performer&_include=Consent:patient\"",
" }",
" ],",
" \"entry\": [",
@@ -5601,7 +5604,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:performer\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:performer\"",
" }",
" ],",
" \"entry\": [",
@@ -6021,7 +6024,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:patient\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:patient\"",
" }",
" ],",
" \"entry\": [",
@@ -6369,7 +6372,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000025&_include=Consent:performer&_include=Consent:patient\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000025&_include=Consent:performer&_include=Consent:patient\"",
" }",
" ],",
" \"entry\": []",
@@ -6425,7 +6428,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010\"",
" }",
" ],",
" \"entry\": [",
@@ -6503,7 +6506,7 @@
" \"end\": \"2026-02-11\",",
" \"start\": \"2025-02-11\"",
" }",
- " },",
+ " }",
" },",
" \"search\": {",
" \"mode\": \"match\"",
@@ -6562,7 +6565,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer&_include=Consent:patient\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer&_include=Consent:patient\"",
" }",
" ],",
" \"entry\": [",
@@ -6792,7 +6795,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019\"",
" }",
" ],",
" \"entry\": [",
@@ -6929,7 +6932,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer&_include=Consent:patient\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer&_include=Consent:patient\"",
" }",
" ],",
" \"entry\": [",
@@ -7903,7 +7906,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010\"",
" }",
" ],",
" \"entry\": [",
@@ -8035,7 +8038,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:patient\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:patient\"",
" }",
" ],",
" \"entry\": [",
@@ -8194,7 +8197,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer\"",
" }",
" ],",
" \"entry\": [",
@@ -8344,7 +8347,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer&_include=Consent:patient\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer&_include=Consent:patient\"",
" }",
" ],",
" \"entry\": [",
@@ -8571,7 +8574,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019\"",
" }",
" ],",
" \"entry\": [",
@@ -8703,7 +8706,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:patient\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:patient\"",
" }",
" ],",
" \"entry\": [",
@@ -8866,7 +8869,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer\"",
" }",
" ],",
" \"entry\": [",
@@ -9015,7 +9018,7 @@
" \"link\": [",
" {",
" \"relation\": \"self\",",
- " \"uri\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer&_include=Consent:patient\"",
+ " \"url\": \"https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer&_include=Consent:patient\"",
" }",
" ],",
" \"entry\": [",
diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml
index f66b9456..31c664aa 100644
--- a/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml
+++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml
@@ -10,7 +10,7 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=active&_include=Consent:performer&_include=Consent:patient
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=active&_include=Consent:performer&_include=Consent:patient
entry:
- fullUrl: "https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742"
resource:
diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml
index de8d04ec..80f2c988 100644
--- a/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml
+++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml
@@ -8,7 +8,7 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=inactive
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=inactive
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/AATD11A1
resource:
diff --git a/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml b/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml
index b444d1dd..c56c95f8 100644
--- a/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml
+++ b/specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml
@@ -8,7 +8,7 @@ ConsentMultipleRelationshipsStatusProposedActiveBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=proposed&status=active&_include=Consent:patient
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000017&status=proposed&status=active&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9
resource:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml
index 7f4c61bf..39ad0337 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml
@@ -9,7 +9,7 @@ ConsentMultipleRelationshipsIncludePatientBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:patient
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2
resource:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml
index cd3b9444..51072605 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml
@@ -10,7 +10,7 @@ ConsentMultipleRelationshipsIncludePerformerPatientBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:performer&_include=Consent:patient
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:performer&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
resource:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml
index a3430fab..07e3b9f2 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml
@@ -9,7 +9,7 @@ ConsentMultipleRelationshipsIncludePerformerBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:performer
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022&_include=Consent:performer
entry:
- fullUrl: >-
https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml
index 2291b91f..a3f0757f 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml
@@ -8,7 +8,7 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:patient
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2
resource:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml
index e218220c..01d7d6be 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml
@@ -8,7 +8,7 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:performer&_include=Consent:patient
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:performer&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2
resource:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml
index a057dd9e..9f2d842c 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml
@@ -8,7 +8,7 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:performer
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100&_include=Consent:performer
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
resource:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml
index 82298c1a..d88fb3e3 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml
@@ -8,7 +8,7 @@ ConsentMultipleRelationshipsSinglePatientBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?patient:identifier=9000000100
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9
resource:
diff --git a/specification/examples/responses/GET_Consent/multiple-relationships.yaml b/specification/examples/responses/GET_Consent/multiple-relationships.yaml
index a47b6e39..5f866c67 100644
--- a/specification/examples/responses/GET_Consent/multiple-relationships.yaml
+++ b/specification/examples/responses/GET_Consent/multiple-relationships.yaml
@@ -8,7 +8,7 @@ ConsentMultipleRelationshipsBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000022
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9
resource:
diff --git a/specification/examples/responses/GET_Consent/no-relationships.yaml b/specification/examples/responses/GET_Consent/no-relationships.yaml
index 930afaf0..4b01ee7d 100644
--- a/specification/examples/responses/GET_Consent/no-relationships.yaml
+++ b/specification/examples/responses/GET_Consent/no-relationships.yaml
@@ -8,5 +8,5 @@ ConsentNoRelationshipsEmptyBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000025&_include=Consent:performer&_include=Consent:patient
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000025&_include=Consent:performer&_include=Consent:patient
entry: []
diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml
index 1e40893f..f93a0ca4 100644
--- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml
+++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml
@@ -9,7 +9,7 @@ ConsentSingleConsentingAdultRelationshipIncludePatientBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:patient
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/DFCC67F5
resource:
diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml
index 05feae45..1ca06a25 100644
--- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml
+++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml
@@ -10,7 +10,7 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer&_include=Consent:patient
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720
resource:
diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml
index c3adbd40..733b31d4 100644
--- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml
+++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml
@@ -9,7 +9,7 @@ ConsentSingleConsentingAdultRelationshipIncludePerformerBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010&_include=Consent:performer
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/RP974720
resource:
diff --git a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml
index 6ba15f56..df3c7429 100644
--- a/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml
+++ b/specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml
@@ -8,7 +8,7 @@ ConsentSingleConsentingAdultRelationshipBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000010
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/WWCC67T1
resource:
diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml
index 27a91348..01104808 100644
--- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml
+++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml
@@ -9,7 +9,7 @@ ConsentSingleAdultChildRelationshipIncludePatientBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:patient
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Patient/A3CC67E2
resource:
diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml
index 0f050114..ba5a2095 100644
--- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml
+++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml
@@ -10,7 +10,7 @@ ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer&_include=Consent:patient
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer&_include=Consent:patient
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
resource:
diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml
index 1b090c36..ee23cd19 100644
--- a/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml
+++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml
@@ -9,7 +9,7 @@ ConsentSingleAdultChildRelationshipIncludePerformerBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019&_include=Consent:performer
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/RelatedPerson/BE974742
resource:
diff --git a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml
index 6ebdbb00..b6afb9c3 100644
--- a/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml
+++ b/specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml
@@ -8,7 +8,7 @@ ConsentSingleAdultChildRelationshipBundle:
type: searchset
link:
- relation: self
- uri: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019
+ url: https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/Consent?performer:identifier=9000000019
entry:
- fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/BBCC67E9
resource:
From 00231e458035477714581d29aebcc2d716c418b0 Mon Sep 17 00:00:00 2001
From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com>
Date: Tue, 5 Aug 2025 14:19:45 +0100
Subject: [PATCH 8/8] NPA-5395: Fix schema
---
.../validated-relationships-service-api.yaml | 31 ++++++++++---------
1 file changed, 17 insertions(+), 14 deletions(-)
diff --git a/specification/validated-relationships-service-api.yaml b/specification/validated-relationships-service-api.yaml
index 879c1a09..6a5e0f41 100644
--- a/specification/validated-relationships-service-api.yaml
+++ b/specification/validated-relationships-service-api.yaml
@@ -1948,20 +1948,23 @@ components:
enum: [searchset]
Link:
- type: array
- description: Links related to the entry
- items:
- type: object
- properties:
- relation:
- type: string
- description: |
- A name which details the functional use for this link - see:
- http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
- url:
- type: string
- format: uri
- description: The reference details for the link.
+ type: object
+ properties:
+ link:
+ type: array
+ description: Links related to the entry
+ items:
+ type: object
+ properties:
+ relation:
+ type: string
+ description: |
+ A name which details the functional use for this link - see:
+ http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
+ url:
+ type: string
+ format: uri
+ description: The reference details for the link.
RelatedPersonBundle:
allOf: