Skip to main content

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​

Storybook

Waiting​

Storybook

Weak Connection​

Storybook

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​

VariantWhat it is
waitingAdmit Patient.
liveTimer, End Visit.
poorWeak connection notice.
consentPOS 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​

PropTypeDefaultDescription
remote *string—Remote participant, e.g. "Nora Scott". Required
stateTelehealthCallState'live''waiting' (waiting room, Admit Patient) | 'live' (End Visit) | 'poor' (weak connection)
elapsedstring"00:00"Elapsed call time
consentbooleanfalseShows the consent, location and billing note
locationstringnonePatient location for the visit
posstring"10"Place of service code for the billing note
mutedbooleanundefined (uncontrolled)Controlled microphone muted state
defaultMutedbooleanfalseInitial muted state when uncontrolled
onMutedChange(muted: boolean) => void—Called when Mute is toggled
cameraOffbooleanundefined (uncontrolled)Controlled camera off state
defaultCameraOffbooleanfalseInitial camera off state when uncontrolled
onCameraOffChange(cameraOff: boolean) => void—Called when the camera button is toggled
onChat() => voidnoneCalled when Chat is pressed
onAdmit() => voidnoneCalled when Admit Patient is pressed (waiting state)
onEnd() => voidnoneCalled 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>
KindNameDescription
attributeremoteRemote participant, e.g. "Nora Scott". Required
attributestate'waiting' (waiting room, Admit Patient) | 'live' (End Visit) | 'poor' (weak connection); default 'live'
attributeelapsedElapsed call time; default "00:00"
attributeconsentShows the consent, location and billing note; default false
attributelocationPatient location for the visit; default none
attributeposPlace of service code for the billing note; default "10"
attributemutedControlled microphone muted state; default undefined (uncontrolled)
attributedefault-muted / defaultMutedInitial muted state when uncontrolled; default false
attributecamera-off / cameraOffControlled camera off state; default undefined (uncontrolled)
attributedefault-camera-off / defaultCameraOffInitial camera off state when uncontrolled; default false
attributedefault-checked / defaultChecked
property / JSON attributedefault-value / defaultValue
attributeauto-focus / autoFocus
eventco-muted-changeCalled when Mute is toggled (React: onMutedChange)
eventco-camera-off-changeCalled when the camera button is toggled (React: onCameraOffChange)
eventco-chatCalled when Chat is pressed; default none (React: onChat)
eventco-admitCalled when Admit Patient is pressed (waiting state); default none (React: onAdmit)
eventco-endCalled when End Visit is pressed (live and poor states); default none (React: onEnd)