NPA-6154: Change the spec and Postman

postman/validated_relationship_service.integration.postman_collection.json

@@ -10050,4 +10050,4 @@
 			"value": ""
 		}
 	]
-}
+}

postman/validated_relationship_service.sandbox.postman_collection.json

@@ -11554,4 +11554,4 @@
 			"value": "https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4"
 		}
 	]
-}
+}

sandbox/api/post_consent.py

@@ -30,7 +30,8 @@ def post_consent_response() -> Union[dict, tuple]:
         logger.debug("Received request to POST consent")
         # Validate body - beyond the scope of sandbox - assume body is valid for scenario
         json = request.get_json()
-        patient_identifier = json["performer"][0]["identifier"]["value"]
+        grantee_ext = next(ext for ext in json["extension"] if "grantee" in ext["url"])
+        patient_identifier = grantee_ext["valueReference"]["identifier"]["value"]
         response = None
 
         # Successful parent-child proxy creation

sandbox/api/tests/test_post_consent.py

@@ -99,7 +99,14 @@ def test_post_consent_when_valid_returns_expected_response(
         content_type="application/json",
     )
     # Act
-    json = {"performer": [{"identifier": {"value": nhs_num}}]}
+    json = {
+        "extension": [
+            {
+                "url": "https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee",
+                "valueReference": {"identifier": {"value": nhs_num}},
+            }
+        ]
+    }
     response = client.post(CONSENT_API_ENDPOINT, json=json)
     # Assert
     if id is not None:

specification/examples/requests/PATCH_Consent/replace_regulatory_basis.yaml

@@ -0,0 +1,13 @@
+ReplaceRegulatoryBasisRequest:
+  summary: Replace regulatory basis
+  description: payload used to add a new actor (regulatory basis) to the consent provision
+  value:
+    - op: add
+      path: /extension/-
+      value:
+      - url: "http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.regulatoryBasis"
+        valueCodeableConcept:
+          coding:
+            - system: "https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis"
+              code: court-appointed-personal-welfare-deputy
+              display: Court appointed personal welfare deputy

specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml

@@ -24,24 +24,25 @@ ConsentAdultToAdultGuardianRequest:
       period:
         start: "2026-02-11T14:30:00Z"
       actor:
-        - role:
-            coding:
-              - system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
-                code: court-appointed-personal-welfare-deputy
-                display: Court appointed personal welfare deputy
-          reference:
-            type: RelatedPerson
-            identifier:
-              system: https://fhir.nhs.uk/Id/nhs-number
-              value: "9000000017"
+          - reference:
+              type: RelatedPerson
+              identifier:
+                system: https://fhir.nhs.uk/Id/nhs-number
+                value: "9000000017"
     extension:
       - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason
         valueCodeableConcept:
           coding:
             - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason
               code: ROLE_CREATED
-              display: Role created
-      - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee
+              display: Role created from scratch by GP
+      - url: "http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.regulatoryBasis"
+        valueCodeableConcept:
+          coding:
+            - system: "https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis"
+              code: "court-appointed-personal-welfare-deputy"
+              display: "Court Appointed Personal Welfare Deputy"
+      - url: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee
         valueReference:
           identifier:
             system: https://fhir.nhs.uk/Id/nhs-number

specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml

@@ -25,28 +25,30 @@ ConsentParentChildProxyCreationRequest:
         start: "2025-02-11T14:30:00Z"
         end: "2029-02-11T14:30:00Z"
       actor:
-        - role:
-            coding:
-              - system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
-                code: parental-responsibility
-                display: Parental responsibility
-          reference:
-            type: RelatedPerson
-            identifier:
-              system: https://fhir.nhs.uk/Id/nhs-number
-              value: "9000000009"
+          - reference:
+              type: RelatedPerson
+              identifier:
+                system: https://fhir.nhs.uk/Id/nhs-number
+                value: "9000000009"
     extension:
       - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason
         valueCodeableConcept:
           coding:
             - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason
               code: ROLE_CREATED
-              display: Role created
-      - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee
+              display: Role created from scratch by GP
+      - url: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee
         valueReference:
           identifier:
             system: https://fhir.nhs.uk/Id/nhs-number
             value: '9000000009'
+            display: Role created
+      - url: "http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.regulatoryBasis"
+        valueCodeableConcept:
+          coding:
+            - system: "https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis"
+              code: "parental-responsibility"
+              display: "Parental responsibility"
       - url: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor
         valueReference:
           identifier:

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

@@ -96,11 +96,6 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
                 identifier:
                   system: "https://fhir.nhs.uk/Id/nhs-number"
                   value: "9000000017"
-              role:
-                coding:
-                  - code: parental-responsibility
-                    display: "Parental responsibility"
-                    system: "https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis"
             period:
               end: "2026-02-11"
               start: "2025-02-11"
@@ -111,6 +106,12 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
                 - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason
                   code: ROLE_CREATED
                   display: Role created
+          - url: "http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.regulatoryBasis"
+            valueCodeableConcept:
+              coding:
+                - system: "https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis"
+                  code: "parental-responsibility"
+                  display: "Parental responsibility"
           - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee
             valueReference:
               identifier:
@@ -200,30 +201,31 @@ ConsentMultipleRelationshipsStatusActiveIncludeDetailsBundle:
                 identifier:
                   system: https://fhir.nhs.uk/Id/nhs-number
                   value: "9000000017"
-              role:
-                coding:
-                - code: parental-responsibility
-                  display: Parental responsibility
-                  system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
             period:
               end: "2026-02-11"
               start: "2025-02-11"
           extension:
-          - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason
-            valueCodeableConcept:
-              coding:
-                - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason
-                  code: ROLE_CREATED
-                  display: Role created
-          - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee
-            valueReference:
-              identifier:
-                system: https://fhir.nhs.uk/Id/nhs-number
-                value: '9000000017'
-          - url: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor
-            valueReference:
-              identifier:
-                system: https://fhir.nhs.uk/Id/ods-organization-code
-                value: "G8101234"
+            - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason
+              valueCodeableConcept:
+                coding:
+                  - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason
+                    code: ROLE_CREATED
+                    display: Role created
+            - url: "http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.regulatoryBasis"
+              valueCodeableConcept:
+                coding:
+                  - system: "https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis"
+                    code: "parental-responsibility"
+                    display: "Parental responsibility"
+            - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee
+              valueReference:
+                identifier:
+                  system: https://fhir.nhs.uk/Id/nhs-number
+                  value: '9000000017'
+            - url: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantor
+              valueReference:
+                identifier:
+                  system: https://fhir.nhs.uk/Id/ods-organization-code
+                  value: "G8101234"
         search:
           mode: match

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

@@ -40,26 +40,27 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
                 identifier:
                   system: https://fhir.nhs.uk/Id/nhs-number
                   value: '9000000017'
-              role:
-                coding:
-                - code: parental-responsibility
-                  display: Parental responsibility
-                  system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
             period:
               end: '2026-02-11'
               start: '2025-02-11'
           extension:
-          - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason
-            valueCodeableConcept:
-              coding:
-                - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason
-                  code: ROLE_DEACTIVATED_END_DATE_REACHED
-                  display: End date reached
-          - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee
-            valueReference:
-              identifier:
-                system: https://fhir.nhs.uk/Id/nhs-number
-                value: '9000000017'
+            - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason
+              valueCodeableConcept:
+                coding:
+                  - system: https://fhir.nhs.uk/England/CodeSystem/England-ConsentStatusReason
+                    code: ROLE_DEACTIVATED_END_DATE_REACHED
+                    display: End date reached
+            - url: "http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.regulatoryBasis"
+              valueCodeableConcept:
+                coding:
+                  - system: "https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis"
+                    code: "parental-responsibility"
+                    display: "Parental responsibility"
+            - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee
+              valueReference:
+                identifier:
+                  system: https://fhir.nhs.uk/Id/nhs-number
+                  value: '9000000017'
         search:
           mode: match
       - fullUrl: https://api.service.nhs.uk/validated-relationships/FHIR/R4/Consent/ABCD12B3
@@ -88,30 +89,31 @@ ConsentMultipleRelationshipsStatusInactiveBundle:
           provision:
             type: permit
             actor:
-            - reference:
-                identifier:
-                  system: https://fhir.nhs.uk/Id/nhs-number
-                  value: '9000000017'
-              role:
-                coding:
-                - code: parental-responsibility
-                  display: Parental responsibility
-                  system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
+              - reference:
+                  identifier:
+                    system: https://fhir.nhs.uk/Id/nhs-number
+                    value: '9000000017'
             period:
               end: '2026-02-11'
               start: '2025-02-11'
           extension:
-          - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason
-            valueCodeableConcept:
-              coding:
-                - system: http://terminology.hl7.org/CodeSystem/consent-reason
-                  code: OTHER
-                  display: Other reason
-              text: Patient would not respond to phone calls
-          - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee
-            valueReference:
-              identifier:
-                system: https://fhir.nhs.uk/Id/nhs-number
-                value: '9000000017'
+            - url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-Consent-Status-Reason
+              valueCodeableConcept:
+                coding:
+                  - system: http://terminology.hl7.org/CodeSystem/consent-reason
+                    code: OTHER
+                    display: Other reason
+                text: Patient would not respond to phone calls
+            - url: "http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.regulatoryBasis"
+              valueCodeableConcept:
+                coding:
+                  - system: "https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis"
+                    code: "parental-responsibility"
+                    display: "Parental responsibility"
+            - url: https://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee
+              valueReference:
+                identifier:
+                  system: https://fhir.nhs.uk/Id/nhs-number
+                  value: '9000000017'
         search:
           mode: match