Skip to main content

DischargeChecklist

ComplexInpatient flow<co-discharge-checklist>

DischargeChecklist tracks the tasks that must be done before a patient leaves, who owns each one, and turns on Ready for Discharge only when the required ones are done.

import { DischargeChecklist } from 'health-components';

Examples​

Showcase​

Storybook

Ready​

Storybook

Read Only​

Storybook

Usage​

<DischargeChecklist patient="Okafor, Grace" edd="Today 14:00" items={tasks} onReady={sendToADT} />

When to use​

  • Discharge huddles, case management, nursing discharge.

When not to use​

  • The patient's own instructions: AfterVisitSummary.

Variants and states​

VariantWhat it is
in progressProgress bar in warning, button shows how many required items remain.
readyAll required done, success bar, button on.
auto itemsTicked from the chart and locked (signed med rec, for example).
readOnlyLocked.

Accessibility​

  • Each task is a real checkbox with its detail as description.
  • Progress bar has a text value.

Do and don't​

  • Do: Name an owner for every open item.
  • Don't: Let staff untick an item that came from a signed chart record.

Props​

PropTypeDefaultDescription
items *DischargeItem[]—Array of { label, detail, required, done, auto, owner, by }: the starting list (uncontrolled); required
itemsValueDischargeItem[]uncontrolledThe list (controlled); pair with onItemsChange
onItemsChange(items: DischargeItem[]) => voidnoneCalled with the new list when a task is ticked or unticked
patientstringnonePatient name
eddstring'not set'Expected discharge
userstring'You'Name stamped on ticks
readOnlybooleanfalseView only
onReady() => voidnoneCalled by Ready for Discharge (enabled once every required task is done)
rangeContextRangeContextId'inpatient' when no global context is setWhich shared reference range flags use; the lab range on a result still wins

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-discharge-checklist>. 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-discharge-checklist patient="…" edd="…" [items]="items" (co-items-change)="onItemsChange($event.detail)"></co-discharge-checklist>
KindNameDescription
property / JSON attributeitemsArray of { label, detail, required, done, auto, owner, by }: the starting list (uncontrolled); required
property / JSON attributeitems-value / itemsValueThe list (controlled); pair with onItemsChange; default uncontrolled
attributepatientPatient name; default none
attributeeddExpected discharge; default 'not set'
attributeuserName stamped on ticks; default 'You'
attributeread-only / readOnlyView only; default false
attributerange-context / rangeContextWhich shared reference range flags use; the lab range on a result still wins; default 'inpatient' when no global context is set
attributedefault-checked / defaultChecked
property / JSON attributedefault-value / defaultValue
attributeauto-focus / autoFocus
eventco-items-changeCalled with the new list when a task is ticked or unticked; default none (React: onItemsChange)
eventco-readyCalled by Ready for Discharge (enabled once every required task is done); default none (React: onReady)