Skip to main content

Interpreter


Use the Interpreter option to invite an interpreter to an active video appointment.

Interpreter availability derives from appointment eligibility, selected language, and video session state.

note

The interpreter option displays only for eligible video appointments and supported languages.



This screen includes

#ElementDescription
1Interpreter optionOpens the interpreter invite dialog
2Language selectorSelects interpreter language
3Information messageDisplays interpreter availability guidance
4Invite actionSends interpreter invite
5Cancel actionDismisses the dialog

Workflow

This flow starts when the interpreter option is visible.

View the interpreter option when all of the following conditions apply:
  • The appointment type is video.
  • The patient qualifies for interpreter services.
  • The patient language differs from the doctor language set.
  • Interpreter services support the selected language.
  1. Open an active video appointment.
  2. Select the interpreter option.
  3. Render supported interpreter languages.
  4. Select an interpreter language.
  5. Send the interpreter invite.
  6. Update video session participants.

Validations

ScenarioApp BehaviorSDK Output
Appointment is not videoHide interpreter optioninterpreter = unavailable
Video session inactiveBlock interpreter inviteerror = session_inactive
Interpreter unavailableHide invite actioninterpreter = unavailable
Language unsupportedBlock selectionerror = unsupported_language
Language not selectedBlock inviteerror = language_required
Invite in progressDisplay loading statestate = loading
Invite rejectedDisplay error statestate = error
Invite succeedsUpdate participant stateinterpreter = invited

Actions

ScenarioApp BehaviorSDK Output
Interpreter option selectedOpen invite dialogPUT /api/v3/appointments/{appointment-id}/video-room/interpreter
Language selectedUpdate selected languageinterpreterLanguage = updated
Invite selectedRequest interpreterPOST /api/v3/appointments/{appointment-id}/video-room/interpreter/invite
Invite succeedsAdd interpreter to sessioninterpreter = invited
Cancel selectedDismiss dialogstate = unchanged

Endpoint Resources

Present Interpreter Popup

PUT 

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

Produces the Invite Interpreter dialog for the specified video session.

Request Interpreter

POST 

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

Invites an interpreter to join the active video consultation using the selected language.