Skip to main content

Video Appointments

Use the Video Appointments screen to conduct a real-time video consultation between a doctor and a patient.


Video consultation screen with participant feeds, session timer, and call controls

This screen includes:

#ElementDescription
1Video areaDisplays participant video feeds
2Session detailsDisplays participant labels and call duration
3Call controlsControl audio, video, camera, and call status
4Report issue actionOpens the issue report flow

Access​

Open the video room from:

  • Appointment List
  • Appointment Details

Session Lifecycle​

  1. Schedule the appointment.
  2. Start the video room.
  3. Validate camera and microphone access.
  4. Display the waiting state until the other participant joins.
  5. Start the active consultation.
  6. End the call and update the appointment state.

Workflow​

  1. Select Start call.
  2. Grant camera and microphone access.
  3. Wait for the patient to join.
  4. Use the call controls as required.
  5. Select End call.

Validations​

ScenarioApp behaviorSDK output
Camera or microphone access is unavailableBlock the call and display permission guidanceerror = permission_required
Permission request is dismissedPreserve the disconnected statestate = not_connected
Camera switch is unsupportedHide Swap cameraswapCamera = unavailable
Connection cannot startDisplay a connection errorstate = error
Session reaches the inactivity limitDisconnect the callstate = timed_out
Session is invalidReject the requeststate = unauthenticated

Actions​

ScenarioApp behaviorSDK output
Start call selectedInitialize the video roomstate = waiting
Microphone selectedToggle microphone accessaudioEnabled = true/false
Video selectedToggle the camera streamvideoEnabled = true/false
Swap camera selectedChange the active cameracamera = updated
End call selectedClose the sessionstate = ended
Report issue selectedOpen the issue report flowNavigation event

Endpoint Resources​

Video Visit​

PUT 

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

Returns the video room for the specified appointment.

UI Element Types​

LevelReferenceTypeValuePlacement
1start-callButtonStart call—
1end-callLinkEnd call~
1report-issueLinkReport issue~
1spacerSpacer—~
1swap-cameraLinkSwap camera~
1disable-videoLinkDisable video~
1muteLinkMute~