WPP-10854:Aligned spec for Consultation Medium with Aggreagtor code behaviour, …#164
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.
|
This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket: APM-000 |
simeonparris-nhs
left a comment
simeonparris-nhs
left a comment
There was a problem hiding this comment.
The changes look good to me.
|
This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket: APM-000 |
edwardbowyer-nhs
deleted the
apm-000-WPP-10569-aling-spec-consultation-medium
branch
edwardbowyer-nhs
changed the title
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.