Skip to main content

CheckInStepper

ComplexScheduling<co-check-in-stepper>

CheckInStepper is the front desk check-in checklist: steps, issues per step and Complete Check-In.

import { CheckInStepper } from 'health-components';

Examples​

Just Arrived​

Storybook

Complete​

Storybook

Usage​

<CheckInStepper patient="Henna West" appt="9:20 AM with Dr. Bell" current={2} issues={[2]} items={checks} />

When to use​

  • Front desk check-in.

When not to use​

  • Patient self check-in: KioskStep.

Variants and states​

VariantWhat it is
issuesSteps with errors block completion.
doneChecked In tag.

Accessibility​

  • Each item has icon label Done or Needs attention.

Do and don't​

  • Do: Say exactly what is missing.
  • Don't: Check in with an inactive coverage silently.

Props​

PropTypeDefaultDescription
patient *string—Patient name, shown in the title. Required
appt *string—Appointment line under the title. Required
stepsstring[]Arrived, Demographics, Insurance, Forms, Copay, ReadyStep labels
currentnumber0Current step, 0-based
issuesnumber[][]Indexes of steps with issues (they show the error state and block Complete Check-In)
itemsCheckInItem[][]Checklist lines
donebooleanfalseCheck-in complete: the tag reads Checked In instead of Arrived
onItemAction(item: CheckInItem, index: number) => voidnoneCalled with the item and its index when its action button is pressed
onComplete() => voidnoneCalled when Complete Check-In is pressed (enabled only with no issues)

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-check-in-stepper>. 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-check-in-stepper patient="…" appt="…" [steps]="steps" (co-item-action)="onItemAction($event.detail)"></co-check-in-stepper>
KindNameDescription
attributepatientPatient name, shown in the title. Required
attributeapptAppointment line under the title. Required
property / JSON attributestepsStep labels; default Arrived, Demographics, Insurance, Forms, Copay, Ready
attributecurrentCurrent step, 0-based; default 0
property / JSON attributeissuesIndexes of steps with issues (they show the error state and block Complete Check-In); default []
property / JSON attributeitemsChecklist lines; default []
attributedoneCheck-in complete: the tag reads Checked In instead of Arrived; default false
attributedefault-checked / defaultChecked
property / JSON attributedefault-value / defaultValue
attributeauto-focus / autoFocus
eventco-item-actionCalled with the item and its index when its action button is pressed; default none (React: onItemAction)
eventco-completeCalled when Complete Check-In is pressed (enabled only with no issues); default none (React: onComplete)