NPA-5825: Updated examples and postman to align with Proxy Role Data …#267
Conversation
ellie-bound1-NHSD
added
documentation
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-5825 |
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-5825 |
There was a problem hiding this comment.
Pull request overview
This PR updates the API specification and examples to align with the Proxy Role Data Model, standardizing terminology systems, role codes, and status reasons across GET and POST Consent operations. It also introduces new error response examples for invalid POST Consent requests.
Key Changes:
- Updated all HL7 terminology system URLs from
http://tohttps:// - Replaced generic HL7 role codes (PRN, GUARD, CHILD, etc.) with NHS-specific proxy legal basis codes
- Added structured extension for consent status reasons with appropriate codes
- Introduced two new error response examples for POST Consent validation failures
Reviewed changes
Copilot reviewed 24 out of 25 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| validated-relationships-service-api.yaml | Updated Postman link, added BAD_REQUEST error code, referenced new error examples, and restructured extension schema as array |
| invalid_request.yaml | New error response examples for invalid request and FHIR validation failures |
| Multiple GET_Consent/*.yaml | Updated terminology URLs to HTTPS, replaced role codes with NHS proxy legal basis codes, and added status reason extensions |
| POST_Consent/*.yaml | Updated request examples with HTTPS URLs, NHS role codes, and proper status reason codes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…oxy_creation.yaml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ships-status-inactive.yaml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…y_creation.yaml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-5825 |
1 similar comment
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-5825 |
…ships-status-inactive.yaml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-5825 |
1 similar comment
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-5825 |
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-5825 |
1 similar comment
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-5825 |
…ld-relationship-include-patient.yaml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
ellie-bound1-NHSD
force-pushed
the
task/NPA-5825/state-machine-post-and-get-consent
branch
from
443bc5f to
c500bfd
Compare
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-5825 |
ellie-bound1-NHSD
deleted the
task/NPA-5825/state-machine-post-and-get-consent
branch
…Model
Pull Request
🧾 Ticket Link
https://nhsd-jira.digital.nhs.uk/browse/NPA-5825
📄 Description/Summary of Changes
🧪 Developer Testing Carried Out
🧪 Reviewer Testing Required
✅ Developer Checklist
NPA-XXXX: <short-description><type>/NPA-XXXX/<short-description>NPA-XXXX: <short-description>terraform,documentation) are added👀 Reviewer Checklist
🚀 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.