Aligned spec for Consultation Medium with Aggreagtor code behaviour, …#164
Open
edwardbowyer-nhs wants to merge 2 commits into
Open
Aligned spec for Consultation Medium with Aggreagtor code behaviour, …#164edwardbowyer-nhs wants to merge 2 commits into
edwardbowyer-nhs wants to merge 2 commits into
Conversation
…removing the redunday VIRTUAL valueCode.
|
This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket: APM-000 |
There was a problem hiding this comment.
Pull request overview
Updates the Producer and Consumer OpenAPI specifications to align with agreed Aggregator behaviour for Consultation Medium handling, deprecating/removing VIRTUAL and only passing through recognised values to downstream consumers (NHS App).
Changes:
- Removed
VIRTUALfrom the Consultation Mediumenumvalues in both Producer and Consumer specs. - Updated schema descriptions to reflect that only recognised consultation mediums are included/passed through.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| specification/patient-care-aggregator-api-producer-api-standards.yaml | Removes VIRTUAL from Consultation Medium enum and updates related description text in the Producer API Standard schema. |
| specification/patient-care-aggregator-api-consumer-api.yaml | Removes VIRTUAL from Consultation Medium enum and updates descriptions to indicate the object is only present for recognised values. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Pending Cancellation | ||
| - Confirmed Attendance | ||
| - description: "Consultation medium - whether the appointment is face-to-face, on the telephone or via an online video consultation (required). VIRTUAL is now deprecated and only remains in the API spec for backwards compatibility reasons." | ||
| - description: "Consultation medium - whether the appointment is face-to-face, on the telephone or via an online video consultation (required). VIRTUAL is now deprecated, it will be filtered and removed from responses, along with any other values not listed." |
Comment on lines
420
to
424
| description: The consultation medium itself. | ||
| enum: | ||
| - "FACE_TO_FACE" | ||
| - "VIRTUAL" | ||
| - "VIDEO_CONSULTATION" | ||
| - "TELEPHONE" |
Comment on lines
773
to
777
| type: string | ||
| enum: | ||
| - FACE_TO_FACE | ||
| - VIRTUAL | ||
| - VIDEO_CONSULTATION | ||
| - TELEPHONE |
|
This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket: APM-000 |
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
Associated Aggregator code change details WPP-10569 and PR 433
Updated the Producer and Consumer spec to align to agreed behaviour with SCS team.
Removing the redundant VIRTUAL valueCode, VIRTUAL" will be accepted from PEPs but treated as invalid for downstream purposes, it will be filtered out by the Aggregator and not included in the response to the App. Only valid Consultation Mediums will cause the object to be present in response rather than passing empty strings for invalid values.
Only the following values will be passed through to the App: FACE_TO_FACE, VIDEO_CONSULTATION, TELEPHONE
Reviews Required
Review Checklist
ℹ️ This section is to be filled in by the reviewer.