Skip to content

apm-000 added new values to consultationMedium enum #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stevesmith-nhs merged 5 commits into from
Jun 12, 2026
Merged

apm-000 added new values to consultationMedium enum #149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2661ed7
added new values to consultationMedium enum
priyasadh-nhs May 21, 2026
cba5efb
Merge branch 'master' into apm-000-consultation-medium
priyasadh-nhs May 27, 2026
9e879cc
bump api version numbers
simeonparris-nhs May 29, 2026
230743b
WPP-9725 update consultation medium description
simeonparris-nhs Jun 3, 2026
8f1a55d
Merge branch 'master' into apm-000-consultation-medium
stevesmith-nhs Jun 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions specification/patient-care-aggregator-api-consumer-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: Wayfinder Patient Care Aggregator API
version: v3.9.0
version: v3.10.0
description: |
<div class="nhsd-m-emphasis-box nhsd-m-emphasis-box--emphasis nhsd-!t-margin-bottom-6" aria-label="Highlighted Information">
<div class="nhsd-a-box nhsd-a-box--border-blue">
Expand Down Expand Up @@ -757,7 +757,7 @@ components:
- bookedPendingReschedule
- bookedPendingChange
- cancelledPendingReschedule
- description: The consultation medium for the booking (face-to-face or virtual). Always present if the activity is a booking, but might be blank if the underlying consultation type is not recognised.
- description: The consultation medium for the booking (face-to-face, telephone or video call). Always present if the activity is a booking, but might be blank if the underlying consultation type is not recognised. VIRTUAL is now deprecated, but remains in the API for backward compatibility reasons, so it might still be passed by systems integrated with the Aggregator.
type: object
required:
- url
Expand All @@ -774,6 +774,8 @@ components:
enum:
- FACE_TO_FACE
- VIRTUAL
- VIDEO_CONSULTATION
- TELEPHONE
- description: Encounter class element
type: object
required:
Expand Down
6 changes: 4 additions & 2 deletions specification/patient-care-aggregator-api-producer-api-standards.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
openapi: '3.0.3'
info:
title: "Patient Care Aggregator Get Appointments, Documents and Questionnaires API Standard"
version: "3.10.0"
version: "3.11.0"
description: |
## Overview
![Patient Care Aggregator Get Appointments, Documents and Questionnaires API Standard context diagram](https://digital.nhs.uk/binaries/content/gallery/website/developer/api-catalogue/patient-care-aggregator-fhir-api/patient-care-aggregator-get-appointments-api-standard.svg?raw=true)
Expand Down Expand Up @@ -404,7 +404,7 @@ components:
- Pending Reschedule
- Pending Cancellation
- Confirmed Attendance
- description: "Consultation medium - whether visit is face-to-face or remote (required)."
- 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."
type: object
required:
- url
Expand All @@ -421,6 +421,8 @@ components:
enum:
- "FACE_TO_FACE"
- "VIRTUAL"
- "VIDEO_CONSULTATION"
- "TELEPHONE"
- description: "Deep link URL to appointment in portal system (required)."
type: object
required:
Expand Down
Loading