TelehealthCallFrame
ComplexScheduling
<co-telehealth-call-frame>TelehealthCallFrame is the video visit frame: waiting room, live call, weak connection, controls and the consent and billing note.
import { TelehealthCallFrame } from 'health-components';
Examples
Live And Waiting
Waiting
Weak Connection
Usage
<TelehealthCallFrame remote="Nora Scott" state="live" elapsed="12:41" consent location="Home, Chicago IL" />
When to use
- Provider and patient video visits.
When not to use
- Phone-only visits.
Variants and states
| Variant | What it is |
|---|---|
| waiting | Admit Patient. |
| live | Timer, End Visit. |
| poor | Weak connection notice. |
| consent | POS and modifier note. |
Accessibility
- Controls are labelled icon buttons, 44px.
Do and don't
- Do: Record patient location each visit.
- Don't: Start without consent.
Props
| Prop | Type | Default | Description |
|---|---|---|---|
remote * | string | — | Remote participant, e.g. "Nora Scott". Required |
state | TelehealthCallState | 'live' | 'waiting' (waiting room, Admit Patient) | 'live' (End Visit) | 'poor' (weak connection) |
elapsed | string | "00:00" | Elapsed call time |
consent | boolean | false | Shows the consent, location and billing note |
location | string | none | Patient location for the visit |
pos | string | "10" | Place of service code for the billing note |
muted | boolean | undefined (uncontrolled) | Controlled microphone muted state |
defaultMuted | boolean | false | Initial muted state when uncontrolled |
onMutedChange | (muted: boolean) => void | — | Called when Mute is toggled |
cameraOff | boolean | undefined (uncontrolled) | Controlled camera off state |
defaultCameraOff | boolean | false | Initial camera off state when uncontrolled |
onCameraOffChange | (cameraOff: boolean) => void | — | Called when the camera button is toggled |
onChat | () => void | none | Called when Chat is pressed |
onAdmit | () => void | none | Called when Admit Patient is pressed (waiting state) |
onEnd | () => void | none | Called when End Visit is pressed (live and poor states) |
Also accepts native attributes, including defaultChecked, defaultValue, autoFocus, plus className and event handlers on the root element.
Angular, Vue and HTML
Register the elements once (Angular guide), then use <co-telehealth-call-frame>. Attributes take strings; arrays and objects are set as properties (Angular [prop], Vue :prop) or as JSON attributes. Callbacks are DOM events with the value in event.detail.
Angular template
<co-telehealth-call-frame remote="…" state="…" [defaultValue]="defaultValue" (co-muted-change)="onMutedChange($event.detail)"></co-telehealth-call-frame>
| Kind | Name | Description |
|---|---|---|
| attribute | remote | Remote participant, e.g. "Nora Scott". Required |
| attribute | state | 'waiting' (waiting room, Admit Patient) | 'live' (End Visit) | 'poor' (weak connection); default 'live' |
| attribute | elapsed | Elapsed call time; default "00:00" |
| attribute | consent | Shows the consent, location and billing note; default false |
| attribute | location | Patient location for the visit; default none |
| attribute | pos | Place of service code for the billing note; default "10" |
| attribute | muted | Controlled microphone muted state; default undefined (uncontrolled) |
| attribute | default-muted / defaultMuted | Initial muted state when uncontrolled; default false |
| attribute | camera-off / cameraOff | Controlled camera off state; default undefined (uncontrolled) |
| attribute | default-camera-off / defaultCameraOff | Initial camera off state when uncontrolled; default false |
| attribute | default-checked / defaultChecked | |
| property / JSON attribute | default-value / defaultValue | |
| attribute | auto-focus / autoFocus | |
| event | co-muted-change | Called when Mute is toggled (React: onMutedChange) |
| event | co-camera-off-change | Called when the camera button is toggled (React: onCameraOffChange) |
| event | co-chat | Called when Chat is pressed; default none (React: onChat) |
| event | co-admit | Called when Admit Patient is pressed (waiting state); default none (React: onAdmit) |
| event | co-end | Called when End Visit is pressed (live and poor states); default none (React: onEnd) |