From 2661ed77ebd56684bb1c67a7cfcc6f20f60f100c Mon Sep 17 00:00:00 2001 From: priyasadh-nhs <275971378+priyasadh-nhs@users.noreply.github.com> Date: Thu, 21 May 2026 15:04:33 +0100 Subject: [PATCH 1/3] added new values to consultationMedium enum --- specification/patient-care-aggregator-api-consumer-api.yaml | 2 ++ .../patient-care-aggregator-api-producer-api-standards.yaml | 2 ++ 2 files changed, 4 insertions(+) diff --git a/specification/patient-care-aggregator-api-consumer-api.yaml b/specification/patient-care-aggregator-api-consumer-api.yaml index 630917b..c9a099e 100644 --- a/specification/patient-care-aggregator-api-consumer-api.yaml +++ b/specification/patient-care-aggregator-api-consumer-api.yaml @@ -774,6 +774,8 @@ components: enum: - FACE_TO_FACE - VIRTUAL + - VIDEO_CONSULTATION + - TELEPHONE - description: Encounter class element type: object required: diff --git a/specification/patient-care-aggregator-api-producer-api-standards.yaml b/specification/patient-care-aggregator-api-producer-api-standards.yaml index 7fed516..a6820a4 100644 --- a/specification/patient-care-aggregator-api-producer-api-standards.yaml +++ b/specification/patient-care-aggregator-api-producer-api-standards.yaml @@ -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: From 9e879cc9c2accd3b8e823f8363aec1a26f630a81 Mon Sep 17 00:00:00 2001 From: Simeon Parris <275962675+simeonparris-nhs@users.noreply.github.com> Date: Fri, 29 May 2026 13:35:52 +0100 Subject: [PATCH 2/3] bump api version numbers --- specification/patient-care-aggregator-api-consumer-api.yaml | 2 +- .../patient-care-aggregator-api-producer-api-standards.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/patient-care-aggregator-api-consumer-api.yaml b/specification/patient-care-aggregator-api-consumer-api.yaml index 4f0086c..b99ce75 100644 --- a/specification/patient-care-aggregator-api-consumer-api.yaml +++ b/specification/patient-care-aggregator-api-consumer-api.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Wayfinder Patient Care Aggregator API - version: v3.9.0 + version: v3.10.0 description: |
diff --git a/specification/patient-care-aggregator-api-producer-api-standards.yaml b/specification/patient-care-aggregator-api-producer-api-standards.yaml index b2c0b25..1314c02 100644 --- a/specification/patient-care-aggregator-api-producer-api-standards.yaml +++ b/specification/patient-care-aggregator-api-producer-api-standards.yaml @@ -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) From 230743b5530efe344671392db1ea79f3a242eeb0 Mon Sep 17 00:00:00 2001 From: Simeon Parris <275962675+simeonparris-nhs@users.noreply.github.com> Date: Wed, 3 Jun 2026 17:14:25 +0100 Subject: [PATCH 3/3] WPP-9725 update consultation medium description to explain which three of the four codes should still be used now that VIRTUAL is being deprecated --- specification/patient-care-aggregator-api-consumer-api.yaml | 2 +- .../patient-care-aggregator-api-producer-api-standards.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/patient-care-aggregator-api-consumer-api.yaml b/specification/patient-care-aggregator-api-consumer-api.yaml index b99ce75..5cb180b 100644 --- a/specification/patient-care-aggregator-api-consumer-api.yaml +++ b/specification/patient-care-aggregator-api-consumer-api.yaml @@ -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 diff --git a/specification/patient-care-aggregator-api-producer-api-standards.yaml b/specification/patient-care-aggregator-api-producer-api-standards.yaml index 1314c02..2183038 100644 --- a/specification/patient-care-aggregator-api-producer-api-standards.yaml +++ b/specification/patient-care-aggregator-api-producer-api-standards.yaml @@ -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