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
| # | Element | Description |
|---|---|---|
| 1 | Interpreter option | Opens the interpreter invite dialog |
| 2 | Language selector | Selects interpreter language |
| 3 | Information message | Displays interpreter availability guidance |
| 4 | Invite action | Sends interpreter invite |
| 5 | Cancel action | Dismisses 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.
- Open an active video appointment.
- Select the interpreter option.
- Render supported interpreter languages.
- Select an interpreter language.
- Send the interpreter invite.
- Update video session participants.
Validations
| Scenario | App Behavior | SDK Output |
|---|---|---|
| Appointment is not video | Hide interpreter option | interpreter = unavailable |
| Video session inactive | Block interpreter invite | error = session_inactive |
| Interpreter unavailable | Hide invite action | interpreter = unavailable |
| Language unsupported | Block selection | error = unsupported_language |
| Language not selected | Block invite | error = language_required |
| Invite in progress | Display loading state | state = loading |
| Invite rejected | Display error state | state = error |
| Invite succeeds | Update participant state | interpreter = invited |
Actions
| Scenario | App Behavior | SDK Output |
|---|---|---|
| Interpreter option selected | Open invite dialog | PUT /api/v3/appointments/{appointment-id}/video-room/interpreter |
| Language selected | Update selected language | interpreterLanguage = updated |
| Invite selected | Request interpreter | POST /api/v3/appointments/{appointment-id}/video-room/interpreter/invite |
| Invite succeeds | Add interpreter to session | interpreter = invited |
| Cancel selected | Dismiss dialog | state = 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.
