NPA-6154: Change the spec and Postman by ChristopherBacon · Pull Request #299 · NHSDigital/validated-relationships-service-api

ChristopherBacon · 2026-02-04T13:55:33Z

Pull Request

🧾 Ticket Link

https://nhsd-jira.digital.nhs.uk/browse/NPA-6154

📄 Description/Summary of Changes

Update Postman
Update Spec

🧪 Developer Testing Carried Out

🧪 Reviewer Testing Required

✅ Developer Checklist

PR title follows the format: NPA-XXXX: <short-description>
Branch name follows the convention: <type>/NPA-XXXX/<short-description>
Commit messages follow the template: NPA-XXXX: <short-description>
All acceptance criteria from the Jira ticket are addressed
Automated tests (unit/integration/API/infrastructure etc. tests) are added or updated
Assignees and appropriate labels (e.g. terraform, documentation) are added

👀 Reviewer Checklist

Changes meet the acceptance criteria of the Jira ticket
Code is able to be merged (no conflicts and adheres to coding standards)
Sufficient test evidence is provided (manual and/or automated)
Infrastructure/operational/build changes are validated (if applicable)

🚀 Post-merge

After merging and deploying changes to the sandbox, Postman collection or spec examples please run the Run Postman
collection workflow.

This will run the tests within the collection to check that the sandbox is working as expected once deployed.

github-actions · 2026-02-05T10:54:40Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6154

github-actions · 2026-02-05T16:33:15Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6154

github-actions · 2026-02-05T16:43:39Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6154

github-actions · 2026-02-05T16:56:52Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6154

github-actions · 2026-02-06T10:08:13Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6154

ellie-bound1-NHSD

Need to remove provision.actor.role from examples and in the postman as we are deprecating it. have added a few comments where to remove but applies too all places. Please remove 🙏

specification/validated-relationships-service-api.yaml

ellie-bound1-NHSD · 2026-02-06T10:28:52Z

specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml

-                  value: '9000000019'
-              role:
+            - role:
                coding:


Please remove the whole role object
So that we are not showing a deprecated property in our examples
so line 39 to 43 should be gone as that is what you have replaced with regulatory basis

ellie-bound1-NHSD · 2026-02-06T10:29:18Z

...ion/examples/responses/GET_Consent/single-mother-child-relationship-unknown-legal-basis.yaml

@@ -45,9 +45,9 @@ ConsentSingleAdultChildRelationshipUnknownLegalBasisBundle:
                  type: RelatedPerson
                role:


Please remove role

ellie-bound1-NHSD · 2026-02-06T10:29:26Z

...ation/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml

-                - code: parental-responsibility
-                  display: Parental responsibility
-                  system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
+                  coding:


Please remove role

ellie-bound1-NHSD · 2026-02-06T10:29:31Z

...amples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml

-                - code: parental-responsibility
-                  display: Parental responsibility
-                  system: https://fhir.nhs.uk/England/CodeSystem/England-NHSProxyLegalBasis
+                  coding:


Please remove role

ellie-bound1-NHSD · 2026-02-06T10:33:13Z

...s/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml

@@ -163,8 +170,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
                  value: '9000000021'
              role:


Please remove role

ellie-bound1-NHSD · 2026-02-06T10:33:17Z

...s/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml

@@ -93,9 +93,10 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
                  value: '9000000020'
              role:


Please remove role

ellie-bound1-NHSD · 2026-02-06T10:33:22Z

...on/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml

@@ -175,8 +187,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle:
                  value: '9000000022'
              role:


Please remove role

ellie-bound1-NHSD · 2026-02-06T10:33:27Z

...on/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml

@@ -123,8 +129,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle:
                  value: '9000000021'
              role:


Please remove role

ellie-bound1-NHSD · 2026-02-06T10:33:32Z

...on/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml

@@ -71,8 +71,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle:
                  value: '9000000020'
              role:


Please remove role

github-actions · 2026-02-06T12:01:08Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6154

ellie-bound1-NHSD · 2026-02-09T11:59:04Z

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

@@ -141,7 +147,7 @@ ConsentMultipleRelationshipsIncludePerformerBundle:
                role:


Remove role

ellie-bound1-NHSD · 2026-02-09T11:59:14Z

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

Remove role

ellie-bound1-NHSD · 2026-02-09T11:59:20Z

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

                identifier:
                  system: https://fhir.nhs.uk/Id/nhs-number
                  value: '9000000022'
-              role:


Remove role

ellie-bound1-NHSD · 2026-02-09T11:59:25Z

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

                identifier:
                  system: https://fhir.nhs.uk/Id/nhs-number
                  value: '9000000022'
-              role:


Remove role

ellie-bound1-NHSD · 2026-02-09T11:59:31Z

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

                identifier:
                  system: https://fhir.nhs.uk/Id/nhs-number
                  value: '9000000022'
-              role:


Remove role

ellie-bound1-NHSD · 2026-02-09T12:00:14Z

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

Remove role

ellie-bound1-NHSD · 2026-02-09T12:00:23Z

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

-                identifier:
-                  system: https://fhir.nhs.uk/Id/nhs-number
-                  value: '9000000017'
-              role:


Remove role

ellie-bound1-NHSD · 2026-02-09T12:00:50Z

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

-                  system: "https://fhir.nhs.uk/Id/nhs-number"
-                  value: "9000000017"
-              role:
+            - role:


Remove role

Is still here?

ellie-bound1-NHSD · 2026-02-09T12:01:00Z

specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml

Remove role

ellie-bound1-NHSD · 2026-02-09T12:01:06Z

specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml

@@ -25,10 +25,10 @@ ConsentAdultToAdultGuardianRequest:
        start: "2026-02-11T14:30:00Z"
      actor:
        - role:


Remove role

github-actions · 2026-02-09T14:40:02Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6154

ellie-bound1-NHSD

A few performers are added back into postman

ellie-bound1-NHSD · 2026-02-09T15:30:28Z

postman/validated_relationship_service.integration.postman_collection.json

Would expect this to be different if following these docs -> https://nhsd-confluence.digital.nhs.uk/spaces/NPA/pages/874694621/How+to+update+Postman+Collections

I reimported, updated to follow date format and exported back into the repo. So hopefully this is now correct?

ellie-bound1-NHSD · 2026-02-09T15:30:59Z

postman/validated_relationship_service.sandbox.postman_collection.json

 									"                    }",
 									"                },",
 									"                \"dateTime\": \"2024-07-21T17:32:28Z\",",
+									"                \"performer\": [",


why is performer back?

Should now all be removed

github-actions · 2026-02-10T16:46:38Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6154

github-actions · 2026-02-11T09:05:46Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6154

github-actions · 2026-02-11T09:14:18Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6154

github-actions · 2026-02-11T09:26:01Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6154

github-actions · 2026-02-11T12:25:26Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6154

…thub.com/NHSDigital/validated-relationships-service-api into task/NPA-6154/regulatory-basis-extension

github-actions · 2026-02-12T10:40:38Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6154

github-actions · 2026-02-13T10:53:04Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6154

ellie-bound1-NHSD · 2026-02-12T14:57:55Z

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

-                  system: "https://fhir.nhs.uk/Id/nhs-number"
-                  value: "9000000017"
-              role:
+            - role:


Is still here?

https://nhsd-jira.digital.nhs.uk/browse/NPA-6154 ---  - Update Postman - Update Spec -  ---    -  -  -  ---    - [ ]  - [ ]  - [ ]  ---  - [x] PR title follows the format: `NPA-XXXX: <short-description>` - [x] Branch name follows the convention: `<type>/NPA-XXXX/<short-description>` - [x] Commit messages follow the template: `NPA-XXXX: <short-description>` - [ ] All acceptance criteria from the Jira ticket are addressed - [ ] Automated tests (unit/integration/API/infrastructure etc. tests) are added or updated - [ ] Assignees and appropriate labels (e.g. `terraform`, `documentation`) are added ---  - [ ] Changes meet the acceptance criteria of the Jira ticket - [ ] Code is able to be merged (no conflicts and adheres to coding standards) - [ ] Sufficient test evidence is provided (manual and/or automated) - [ ] Infrastructure/operational/build changes are validated (if applicable) ---  After merging and deploying changes to the sandbox, Postman collection or spec examples please run the Run Postman collection workflow. This will run the tests within the collection to check that the sandbox is working as expected once deployed. --------- Co-authored-by: Leo Howard <38526889+LeoKHoward@users.noreply.github.com>

ChristopherBacon added 4 commits January 27, 2026 14:42

NPA-1654: Update responses, from GET and POST Consent responses

c51cca4

NPA-6154: Put back in the role from the actor object

3700478

NPA-6154: Change the replace legal basis to regulatory basis

f7fe3e6

NPA-6154: Changes to the Postman collections

c53e8c6

ChristopherBacon added postman Changes to the postman collection OAS Updated the OpenAPI Specification (OAS) labels Feb 4, 2026

ChristopherBacon self-assigned this Feb 4, 2026

ChristopherBacon force-pushed the task/NPA-6154/regulatory-basis-extension branch from 03db0ab to c53e8c6 Compare February 5, 2026 12:10

ChristopherBacon and others added 2 commits February 5, 2026 15:15

NPA-6154: Round 2 Postman collection updates

16a985b

Merge branch 'master' into task/NPA-6154/regulatory-basis-extension

6c084bb

NPA-6154: Formatting extension issues

9b90f80

NPA-6154: Spec fixes

09880d3

NPA-6154: File Change for breaking spec

143323e

ellie-bound1-NHSD reviewed Feb 6, 2026

View reviewed changes

NPA-6154: Updated spec changes

2b6ec58

ellie-bound1-NHSD reviewed Feb 9, 2026

View reviewed changes

NPA-6154: Commented changes removing roles

b17f8e2

ellie-bound1-NHSD reviewed Feb 9, 2026

View reviewed changes

ChristopherBacon added 3 commits February 10, 2026 16:21

NPA-6154: remove performer

9a8fc92

NPA-6154: Remove performer blocks from Integration

9658df9

Merge branch 'master' into task/NPA-6154/regulatory-basis-extension

63ab835

NPA-6154: Update the Sandbox tests

2a0662a

NPA-6154: Format python

cc513f8

NPA-6154: Formatting the python file

fb3f346

Merge branch 'master' into task/NPA-6154/regulatory-basis-extension

2277117

ChristopherBacon added 2 commits February 12, 2026 10:40

NPA-6154: Update date for the Postman collections

8e4143b

Merge branch 'task/NPA-6154/regulatory-basis-extension' of https://gi…

5729187

…thub.com/NHSDigital/validated-relationships-service-api into task/NPA-6154/regulatory-basis-extension

NPA-6154: Remove final provision.actor. role

a8d90d4

ellie-bound1-NHSD approved these changes Feb 13, 2026

View reviewed changes

ChristopherBacon merged commit ee628da into master Feb 13, 2026
17 checks passed

ChristopherBacon deleted the task/NPA-6154/regulatory-basis-extension branch February 13, 2026 13:15

		@@ -45,9 +45,9 @@ ConsentSingleAdultChildRelationshipUnknownLegalBasisBundle:
		type: RelatedPerson
		role:

		@@ -163,8 +170,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
		value: '9000000021'
		role:

		@@ -93,9 +93,10 @@ ConsentMultipleRelationshipsSinglePatientIncludePerformerPatientBundle:
		value: '9000000020'
		role:

		@@ -175,8 +187,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle:
		value: '9000000022'
		role:

		@@ -123,8 +129,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle:
		value: '9000000021'
		role:

		@@ -71,8 +71,8 @@ ConsentMultipleRelationshipsSinglePatientIncludePatientBundle:
		value: '9000000020'
		role:

		@@ -141,7 +147,7 @@ ConsentMultipleRelationshipsIncludePerformerBundle:
		role:

Conversation

ChristopherBacon commented Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

🧾 Ticket Link

📄 Description/Summary of Changes

🧪 Developer Testing Carried Out

🧪 Reviewer Testing Required

✅ Developer Checklist

👀 Reviewer Checklist

🚀 Post-merge

Uh oh!

github-actions bot commented Feb 5, 2026

Uh oh!

github-actions bot commented Feb 5, 2026

Uh oh!

github-actions bot commented Feb 5, 2026

Uh oh!

github-actions bot commented Feb 5, 2026

Uh oh!

github-actions bot commented Feb 6, 2026

Uh oh!

ellie-bound1-NHSD left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 6, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ChristopherBacon commented Feb 4, 2026 •

edited

Loading