Interpreter
The Interpreter option enables language support for video appointments by including an interpreter in the session.
Availability
This option appears only for eligible video appointments and supported languages.
This screen includes
- Interpreter checkbox
- Preferred language selector
- Information tooltip
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.
- Select the interpreter option.
- Select a preferred interpreter language.
- Submit the appointment request.
Validations
These rules determine availability and input correctness.
| Scenario | App behavior | SDK output |
|---|---|---|
| Appointment type is not video. | Hide interpreter option. | No interpreter field in request. |
| Interpreter checkbox selected without language. | Display required field error. | Validation error for missing language. |
| Language not supported. | Prevent selection. | Unsupported language validation error. |
| Doctor language matches patient language. | Do not require interpreter. | includeInterpreter = false. |
State Behavior
- Show interpreter option only when eligibility conditions are met.
- Re-evaluate availability when appointment type or language changes.
- Prompt interpreter suggestion when mismatch occurs.
ASAP Behavior
- Display interpreter option for ASAP flows.
- If language mismatch exists and interpreter is not selected:
- Show confirmation dialog suggesting interpreter.
Actions
| Scenario | App behavior | SDK output |
|---|---|---|
| User selects interpreter option. | Enable language selection. | includeInterpreter = true. |
| User selects language. | Store selected language. | interpreterLanguage = <value>. |
| User submits request with interpreter. | Include interpreter in appointment. | Request payload includes interpreter fields. |
| User submits without interpreter (language mismatch). | Show confirmation prompt. | Interpreter suggestion state triggered. |
| Appointment confirmed. | Display interpreter participation. | Appointment metadata includes interpreter configuration. |
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.