Skip to main content

ProcedureNote

ComplexED & periop<co-procedure-note>

ProcedureNote is a structured procedure note from a template (laceration repair, central line, lumbar puncture, cesarean delivery): procedure, indication, consent, time out, EBL, complications, specimens and the template's own fields.

import { ProcedureNote } from 'health-components';

Examples​

Showcase​

Storybook

Missing Time Out​

Storybook

Signed With Addendum​

Storybook

Cesarean High EBL​

Storybook

Usage​

<ProcedureNote template="lumbar puncture" values={lpValues} status="draft" />

When to use​

  • Bedside procedures in the ED, ICU and L&D; brief OR notes.

When not to use​

  • Full operative reports dictated by the surgeon: VisitNoteEditor.

Variants and states​

VariantWhat it is
draftTemplate fields are editable; Sign disabled until consent and time out exist.
signedRead-only with lock tag.
time out missingRed tag.
addendumNote alert under a signed note.
templateslaceration repair, central line, lumbar puncture, cesarean delivery.

Accessibility​

  • Fields are labelled text areas; signed fields are plain text with headings.
  • Why Sign is disabled is written next to it.

Do and don't​

  • Do: Record the time out time.
  • Don't: Edit a signed note in place; add an addendum.

Props​

PropTypeDefaultDescription
templateProcedureTemplateKey'laceration repair''laceration repair' | 'central line' | 'lumbar puncture' | 'cesarean delivery'
valuesProcedureNoteValues{}Note values
statusProcedureNoteStatus'draft''draft' (template fields editable) | 'signed' (read-only)
addendum{ at: string; text: string }noneAddendum under a signed note {at, text}
onSign(details: Record<string, string>) => voidnoneCalled by Sign Note with the template field text
onSaveDraft(details: Record<string, string>) => voidnoneCalled by Save Draft with the template field text
onDetailsChange(details: Record<string, string>) => voidnoneCalled when a template field changes
rangeContextRangeContextId'ed' 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-procedure-note>. 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-procedure-note template="…" status="…" [values]="values" (co-sign)="onSign($event.detail)"></co-procedure-note>
KindNameDescription
attributetemplate'laceration repair' | 'central line' | 'lumbar puncture' | 'cesarean delivery'; default 'laceration repair'
property / JSON attributevaluesNote values; default {}
attributestatus'draft' (template fields editable) | 'signed' (read-only); default 'draft'
property / JSON attributeaddendumAddendum under a signed note {at, text}; default none
attributerange-context / rangeContextWhich shared reference range flags use; the lab range on a result still wins; default 'ed' when no global context is set
attributedefault-checked / defaultChecked
property / JSON attributedefault-value / defaultValue
attributeauto-focus / autoFocus
eventco-signCalled by Sign Note with the template field text; default none (React: onSign)
eventco-save-draftCalled by Save Draft with the template field text; default none (React: onSaveDraft)
eventco-details-changeCalled when a template field changes; default none (React: onDetailsChange)