diff --git a/specification/patient-care-aggregator-api-consumer-api.yaml b/specification/patient-care-aggregator-api-consumer-api.yaml index 5cb180b..c4867fc 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, 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. + - description: The consultation medium for the booking (face-to-face, telephone or video call). Only present if the underlying consultation type is recognised. type: object required: - url @@ -769,11 +769,10 @@ components: enum: - https://fhir.nhs.uk/StructureDefinition/Extension-Consultation-Medium valueCode: - description: The consultation code medium itself. Will be blank (empty string) if the underlying consultation type is not recognised. + description: The consultation code medium itself, only set if the underlying consultation type is recognised. type: string enum: - FACE_TO_FACE - - VIRTUAL - VIDEO_CONSULTATION - TELEPHONE - description: Encounter class element diff --git a/specification/patient-care-aggregator-api-producer-api-standards.yaml b/specification/patient-care-aggregator-api-producer-api-standards.yaml index 2183038..4960791 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 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." type: object required: - url @@ -420,7 +420,6 @@ components: description: The consultation medium itself. enum: - "FACE_TO_FACE" - - "VIRTUAL" - "VIDEO_CONSULTATION" - "TELEPHONE" - description: "Deep link URL to appointment in portal system (required)."