Skip to main content

Video Appointments


The Video Appointments screen supports secure video consultation for an appointment.


Video appointment screen showing patient video, controls, and session timer

This screen includes:

  • Live video area - Displays active participant video feeds.
  • Participant labels - Display participant names.
  • Session timer - Displays elapsed call duration.
  • Control bar
    • Mute
    • Disable Video
    • Swap Camera
    • Chat
    • End Call
    • Report Issue when available

Access

Open the video session from:

  • Appointment List
  • Appointment Details

Session Lifecycle

The video session follows these states:

  1. Appointment is scheduled.
  2. User starts the video session.
  3. Permissions are validated.
  4. Waiting state displays until the other participant joins.
  5. Active session starts.
  6. Session ends when a participant leaves or the call is terminated.

Workflow

This flow starts when the video appointment screen opens.

  1. Select Start Video.
  2. Grant camera and microphone access.
  3. Wait for the other participant to join.
  4. Use session controls during the call.
  5. Select End Call to leave the session.

Validations

These rules enforce session readiness and device support.

ScenarioApp behaviorSDK output
Camera or microphone permission missing.Block session start.Permission validation error.
Permission request dismissed.Require explicit approval before continuing.Permission state remains incomplete.
Device does not support camera switching.Hide Swap Camera.Camera capability flag disabled.
Network quality below minimum threshold.Prevent connection.Connection readiness check fails.
Session remains inactive past timeout.Disconnect session.Session timeout event emitted.

Session Behavior

  • Synchronize session state across participants.
  • Display waiting state until the other participant joins.
  • Update live controls based on device capability and session state.

Actions

ScenarioApp behaviorSDK output
User selects Start Video.Initialize session and validate permissions.Session start requested.
User selects Mute.Toggle microphone state.Audio state updated.
User selects Disable Video.Toggle local video stream.Video state updated.
User selects Swap Camera.Switch active camera on supported devices.Camera source updated.
User selects Chat.Open chat interface.Chat panel state updated.
User selects End Call.End session and exit video screen.Session terminated event emitted.
User selects Report Issue.Open feedback flow with session context.Issue report flow triggered with session metadata.

Endpoint Resources

PUT 

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

Initializes and manages the video room for the appointment session.

LevelReferenceTypeValuePlacement
1start-callButtonStart call (invisible and autostart)
1Can’t find link
1Can’t find link
1end-callLink[End call]~
1report-issueLink[Report issue]~
1spacerSpacer~
1swap-cameraLink[Swap camera]~
1disable-videoLink[Disable video]~
1muteLink[Mute]~