Video Appointments

Use Video Appointments to conduct a secure video consultation for an appointment.
Open the video session from Appointment List or Appointment Details.

This screen includes:

A live video interface for real-time consultation.
A primary video feed that displays the patient.
A secondary video feed that displays the user.
Name labels for all participants.
A session timer that displays elapsed call duration.
A bottom control bar for audio, video, camera, chat, and call actions.
Synchronized session state across doctor and patient devices.

Call Lifecycle

This flow illustrates the stages of a video consultation from scheduling to session start.

Video call lifecycle

(Appointment Scheduled)
       |
       |-- App Sends Reminder
       v
(User Starts Video)
       |
       |-- Has Doctor Joined?
       |       |
       |       |-- No
       |       v
       |   (Display Waiting Message)
       |
       |-- Yes
       v
(Video Session Started)

Workflow

Start a Video Appointment

Open the Appointments screen.
Select an appointment to open Appointment Details.
Select Start Video.
Grant camera and microphone access.
Wait for the other participant to join.
Use on-screen controls during the session:
- Mute to toggle the microphone.
- Disable Video to toggle the camera.
- Swap Camera to change cameras on supported devices.
- End Call to leave the session.
- Report Issue to open the feedback form.

Validations

These rules ensure session readiness and stability.

Scenario	App behavior
Camera or microphone permission missing.	Blocks session start.
Permission request dismissed.	Requires explicit user approval before continuing.
Device does not support camera switching.	Hides Swap Camera.
Network quality below minimum threshold.	Prevents connection.
Session remains inactive past timeout.	Disconnects the session.

Actions

Video session controls affect live call behavior.

Scenario	App behavior
User selects Start Video.	Initializes the session and validates permissions.
User selects Mute.	Toggles microphone state.
User selects Disable Video.	Toggles video stream state.
User selects Swap Camera.	Switches cameras on supported devices.
User selects End Call.	Ends the session and exits the video screen.
User selects Report Issue.	Opens a feedback modal with session context.

Endpoint Resources

PUT

/appointments/{appointment-id}/video-room

Initializes and manages the video room for the appointment session.

Level	Reference	Type	Value	Placement
1	start-call	Button	Start call (invisible and autostart)
1	—	Can’t find link	—
1	—	Can’t find link	—
1	end-call	Link	[End call]	~
1	report-issue	Link	[Report issue]	~
1	spacer	Spacer	—	~
1	swap-camera	Link	[Swap camera]	~
1	disable-video	Link	[Disable video]	~
1	mute	Link	[Mute]	~

Call Lifecycle​

Workflow​

Start a Video Appointment​

Validations​

Actions​

Endpoint Resources​