[RAA-9579]-[NB]-[A031 shortlist editable by SPC/SPCA]-[RK] - #2870
Open
rkacn wants to merge 1 commit into
Open
Conversation
rkacn
force-pushed
the
feature/RAA-9579_A031_shortlist_access
branch
from
September 1, 2026 08:58
1edf91c to
fae1dcf
Compare
rkacn
force-pushed
the
feature/RAA-9579_A031_shortlist_access
branch
from
September 2, 2026 08:35
fae1dcf to
9972c07
Compare
rkacn
force-pushed
the
feature/RAA-9579_A031_shortlist_access
branch
from
September 4, 2026 14:27
9972c07 to
c2436d8
Compare
rkacn
requested review from
nicolebalmer1-nhs
and
a lite review from Copilot
September 4, 2026 14:28
There was a problem hiding this comment.
🟡 Changes recommended
The updated A031 endpoint spec introduces OBO support but needs small consistency and wording fixes to align with existing header conventions and improve clarity.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates the STU3 OpenAPI contract for the A031 “Change shortlist” endpoint to support service provider roles (including SPCA acting on behalf of SPC) and to document an additional 422 error condition.
Changes:
- Added
INVALID_STATEto the A031 422 (Unprocessable Entity) error-code table. - Extended A031 documentation to include
SERVICE_PROVIDER_CLINICIAN/SERVICE_PROVIDER_CLINICIAN_ADMINand added guidance for SPCA “on behalf of” usage. - Added the
OnBehalfOfUserIDrequest header parameter to A031.
File summaries
| File | Description |
|---|---|
| specification/components/stu3/schemas/responses/changeShortlist/422Response.yaml | Adds INVALID_STATE to the documented 422 error codes for the change-shortlist response. |
| specification/components/stu3/schemas/endpoints/a031-change-shortlist.yaml | Expands supported roles, documents SPCA OBO usage, and adds the OnBehalfOfUserID header to the endpoint parameters. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| You can check to see what referral letter information has already been added to a referral by using [[HYPERLINK_A005]], [[HYPERLINK_A007]], and [[HYPERLINK_A006]] endpoints where necessary. | ||
|
|
||
| When making a request as a `SERVICE_PROVIDER_CLINICIAN_ADMIN` (SPCA) use endpoint [[HYPERLINK_A040]] to determine which `SERVICE_PROVIDER_CLINICIAN` (SPC), the SPCA is allowed to act 'on-behalf-of'. |
| @@ -75,6 +81,7 @@ parameters: | |||
| - $ref: '../headers/request/BusinessFunction.yaml' | |||
Author
There was a problem hiding this comment.
Won't apply. Reason: manual tests indicated that the endpoint doesn't reject the request even if the header is missing.
rkacn
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add any other relevant notes or explanations here. Remove this line if you have nothing to add.
Reviews Required
Review Checklist
ℹ️ This section is to be filled in by the reviewer.