Skip to main content

ImmunizationSchedule

ComplexClinical<co-immunization-schedule>

ImmunizationSchedule is the vaccine grid by dose with Given, Due, Overdue, Declined and Later states, synced with the state registry.

import { ImmunizationSchedule } from 'health-components';

Examples​

Up To Date​

Storybook

Read Only​

Storybook

Usage​

<ImmunizationSchedule columns={["2 mo", "4 mo", "6 mo"]} rows={forecast} />

When to use​

  • Pediatric and adult immunization history and forecast.

When not to use​

  • Recording one dose: a form in a Drawer.

Variants and states​

VariantWhat it is
givenDate in green.
dueBlue.
overdueRed.
declinedNeutral.
laterOutline.

Accessibility​

  • Each cell has a word or date and an icon.

Do and don't​

  • Do: Use the registry forecast.
  • Don't: Colour-only cells.

Props​

PropTypeDefaultDescription
columns *string[]—string[]: dose ages ("Birth", "2 mo"...); required
rows *ImmunizationRow[]—Array<{vaccine, doses: Array<{status?, date?}>}>; required
syncedstringsubtitle; default "today"Registry sync time, in the
subtitleReactNode"CDC schedule . IIS synced {synced}"Replaces the subtitle
readOnlybooleanfalseHides Record Dose
onRecordDose() => voidnoneRecord Dose clicked

Also accepts native attributes, including defaultChecked, defaultValue, autoFocus, onChange, onInput, plus className and event handlers on the root element.

Angular, Vue and HTML​

Register the elements once (Angular guide), then use <co-immunization-schedule>. 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-immunization-schedule synced="…" read-only [columns]="columns" (co-record-dose)="onRecordDose($event.detail)"></co-immunization-schedule>
KindNameDescription
property / JSON attributecolumnsstring[]: dose ages ("Birth", "2 mo"...); required
property / JSON attributerowsArray<{vaccine, doses: Array<{status?, date?}>}>; required
attributesyncedRegistry sync time, in the default subtitle; default "today"
attributeread-only / readOnlyHides Record Dose; default false
attributedefault-checked / defaultChecked
property / JSON attributedefault-value / defaultValue
attributeauto-focus / autoFocus
eventco-record-doseRecord Dose clicked; default none (React: onRecordDose)
eventco-change (React: onChange)
eventco-input (React: onInput)
slotsubtitleReplaces the subtitle; default "CDC schedule . IIS synced {synced}" Plain text also works as the `subtitle` attribute.