NPA-5608: IOPS amendments for get consent and get consent ID by ChristopherBacon · Pull Request #259 · NHSDigital/validated-relationships-service-api

ChristopherBacon · 2025-09-29T14:22:16Z

Pull Request

🧾 Ticket Link

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

📄 Description/Summary of Changes

Updated specification with postman and schema changes for get constent and get consent ID
Updated examples for get consent and get consent ID

🧪 Developer Testing Carried Out

Ran Postman testing to check that responses were correct

🧪 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 · 2025-09-29T14:22:34Z

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

NPA-5608

github-actions · 2025-09-29T14:24:35Z

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

NPA-5608

Copilot

Pull Request Overview

Updates the Validated Relationship Service API specification to align with FHIR standards by removing redundant type references and fixing schema inconsistencies across consent response examples.

Removed redundant type fields from reference objects in schema and examples
Updated Postman collection references and metadata
Fixed malformed JSON structures in consent response examples

Reviewed Changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 20 comments.

File	Description
specification/validated-relationships-service-api.yaml	Removed redundant type field from schema definition and updated Postman collection URL
specification/examples/responses/GET_Consent/*.yaml	Removed redundant type references and fixed JSON structure issues across all consent response examples
postman/Validated Relationship Service Sandbox.postman_collection.json	Updated collection metadata and removed redundant type references throughout test responses

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-29T15:17:47Z

                - system: 'http://terminology.hl7.org/CodeSystem/v3-RoleCode'
                  code: PRN
                  display: parent
+            - coding:


The role array structure is malformed. This line should be indented to align with the previous coding array entry within the same role object.

Suggested change

- coding:

Updated spacing

Copilot · 2025-09-29T15:17:48Z

                - system: 'http://terminology.hl7.org/CodeSystem/v3-RoleCode'
                  code: PRN
                  display: parent
+            - coding:


The role array structure is malformed. This line should be indented to align with the previous coding array entry within the same role object.

Updated the spacing

Copilot · 2025-09-29T15:17:48Z

                value: ODS12345
                system: 'https://fhir.nhs.uk/Id/ods-organization-code'


The generalPractitioner array structure is malformed. This line should be indented correctly as an array element.

Suggested change

value: ODS12345

system: 'https://fhir.nhs.uk/Id/ods-organization-code'

system: 'https://fhir.nhs.uk/Id/ods-organization-code'

value: ODS12345

Corrected spacing

Copilot · 2025-09-29T15:17:52Z

                - system: "http://terminology.hl7.org/CodeSystem/v3-RoleCode"
                  code: PRN
                  display: parent
+            - coding:


The role array structure is malformed. This line should be indented to align with the previous coding array entry within the same role object.

Applied indentation fixes from line 33

…ld-relationship-include-performer-patient.yaml NPA-5608: Altered generalPractitioner structure Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-10-01T10:02:05Z

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

NPA-5608

…ships-status-active-include-details.yaml NPA-5608: commit structure change for generalPractioner remove spaces Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-10-01T10:02:58Z

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

NPA-5608

…ships-status-active-include-details.yaml NPA-5608: Remove the spaces for generalPractitioner object Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-10-01T10:04:23Z

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

NPA-5608

…ships-include-patient.yaml NPA-5608: remove spaces from generalPractioner object Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-10-01T10:05:31Z

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

NPA-5608

…ships-include-patient.yaml NPA-5608: remove spacing from generalPractioner object Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-10-01T10:07:09Z

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

NPA-5608

…ships-include-patient.yaml NPDA-5608: remove spacing from generalPractitioner Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-10-01T10:09:04Z

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

NPA-5608

…ships-include-performer-patient.yaml NPA-5608: remove spacing from generalPractitioner object Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-10-01T10:10:21Z

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

NPA-5608

…ships-include-performer-patient.yaml NPA-5608: remove spacing from generalPractitioner Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-10-01T10:11:51Z

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

NPA-5608

…ships-include-performer-patient.yaml NPA-5608: remove spaces from generalPracitioner Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-10-01T10:13:26Z

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

NPA-5608

…ships-single-patient-include-patient.yaml NPA-5608: remove spaces from generalPractitioner object Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-10-01T10:14:38Z

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

NPA-5608

…ships-single-patient-include-performer-patient.yaml NPA-5608: remove spaces from generalPractitioner object Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-10-01T10:15:28Z

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

NPA-5608

…-adult-relationship-include-patient.yaml NPA-5608: remove spaces from generalPractitioner object Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-10-01T10:16:19Z

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

NPA-5608

…com/NHSDigital/validated-relationships-service-api into task/NPA-5608/consent-id-spec-fixes

github-actions · 2025-10-01T10:27:20Z

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

NPA-5608

github-actions · 2025-10-01T17:03:03Z

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

NPA-5608

github-actions · 2025-10-01T17:09:58Z

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

NPA-5608

github-actions · 2025-10-01T17:19:44Z

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

NPA-5608

github-actions · 2025-10-01T17:21:26Z

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

NPA-5608

github-actions · 2025-11-03T11:21:20Z

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

NPA-5608

github-actions · 2025-11-03T13:03:52Z

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

NPA-5608

ChristopherBacon added 3 commits September 26, 2025 15:00

NPA-5608: mandatory fixes - remove id and patient see mandatory changes

e7b37e6

NPA-5608: example changes and spec changes and postman changes

ff21bec

NPA-5608: postman change and spec update and examples update

431a5f3

ChristopherBacon self-assigned this Sep 29, 2025

ChristopherBacon added documentation Improvements or additions to documentation postman Changes to the postman collection OAS Updated the OpenAPI Specification (OAS) labels Sep 29, 2025

Merge branch 'master' into task/NPA-5608/consent-id-spec-fixes

a4d3f47

simonstead requested a review from Copilot September 29, 2025 15:13

Copilot AI reviewed Sep 29, 2025

View reviewed changes

Update specification/examples/responses/GET_Consent/single-mother-chi…

6765c5d

…ld-relationship-include-performer-patient.yaml NPA-5608: Altered generalPractitioner structure Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update specification/examples/responses/GET_Consent/filtered-relation…

54a63c1

…ships-status-active-include-details.yaml NPA-5608: commit structure change for generalPractioner remove spaces Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update specification/examples/responses/GET_Consent/filtered-relation…

93c63b0

…ships-status-active-include-details.yaml NPA-5608: Remove the spaces for generalPractitioner object Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update specification/examples/responses/GET_Consent/multiple-relation…

3338085

…ships-include-patient.yaml NPA-5608: remove spaces from generalPractioner object Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update specification/examples/responses/GET_Consent/multiple-relation…

5930b1f

…ships-include-patient.yaml NPA-5608: remove spacing from generalPractioner object Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update specification/examples/responses/GET_Consent/multiple-relation…

9b816a9

…ships-include-patient.yaml NPDA-5608: remove spacing from generalPractitioner Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update specification/examples/responses/GET_Consent/multiple-relation…

14c43fc

…ships-include-performer-patient.yaml NPA-5608: remove spacing from generalPractitioner object Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update specification/examples/responses/GET_Consent/multiple-relation…

5be9d8b

…ships-include-performer-patient.yaml NPA-5608: remove spacing from generalPractitioner Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update specification/examples/responses/GET_Consent/multiple-relation…

99d52ef

…ships-include-performer-patient.yaml NPA-5608: remove spaces from generalPracitioner Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update specification/examples/responses/GET_Consent/multiple-relation…

f28a9eb

…ships-single-patient-include-patient.yaml NPA-5608: remove spaces from generalPractitioner object Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update specification/examples/responses/GET_Consent/multiple-relation…

cc27962

…ships-single-patient-include-performer-patient.yaml NPA-5608: remove spaces from generalPractitioner object Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update specification/examples/responses/GET_Consent/single-consenting…

cb9bc88

…-adult-relationship-include-patient.yaml NPA-5608: remove spaces from generalPractitioner object Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

ChristopherBacon added 2 commits October 1, 2025 11:26

NPA-5608: remove spacing from examples data

a4855c4

Merge branch 'task/NPA-5608/consent-id-spec-fixes' of https://github.…

f7bc425

…com/NHSDigital/validated-relationships-service-api into task/NPA-5608/consent-id-spec-fixes

NPA-5608: updated specs from commit recommendations

82a2e83

NPA-5608: minor schema tweaks

39bd841

NPA-6508: minor generalPractitioner schema fix

c302cf6

Merge branch 'master' into task/NPA-5608/consent-id-spec-fixes

d9d26e5

Merge branch 'master' into task/NPA-5608/consent-id-spec-fixes

9808541

NPA-5608: Update postman collection with latest master

5dc8306

LeoKHoward approved these changes Nov 3, 2025

View reviewed changes

LeoKHoward merged commit 682e850 into master Nov 3, 2025
17 checks passed

LeoKHoward deleted the task/NPA-5608/consent-id-spec-fixes branch November 3, 2025 13:18

		value: ODS12345
		system: 'https://fhir.nhs.uk/Id/ods-organization-code'

Conversation

ChristopherBacon commented Sep 29, 2025

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 Sep 29, 2025

Uh oh!

github-actions Bot commented Sep 29, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

ChristopherBacon Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Oct 1, 2025

Uh oh!

github-actions Bot commented Oct 1, 2025

Uh oh!

github-actions Bot commented Oct 1, 2025

Uh oh!

github-actions Bot commented Oct 1, 2025

Uh oh!

github-actions Bot commented Oct 1, 2025

Uh oh!

github-actions Bot commented Oct 1, 2025

Uh oh!

github-actions Bot commented Oct 1, 2025

Uh oh!

github-actions Bot commented Oct 1, 2025

Uh oh!

github-actions Bot commented Oct 1, 2025

Uh oh!

github-actions Bot commented Oct 1, 2025

Uh oh!

github-actions Bot commented Oct 1, 2025

Uh oh!

github-actions Bot commented Oct 1, 2025

Uh oh!

github-actions Bot commented Oct 1, 2025

Uh oh!

github-actions Bot commented Oct 1, 2025

Uh oh!

github-actions Bot commented Oct 1, 2025

Uh oh!

github-actions Bot commented Oct 1, 2025

Uh oh!

ChristopherBacon Oct 1, 2025 •

edited

Loading