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
Missing Time Out
Signed With Addendum
Cesarean High EBL
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
| Variant | What it is |
|---|---|
| draft | Template fields are editable; Sign disabled until consent and time out exist. |
| signed | Read-only with lock tag. |
| time out missing | Red tag. |
| addendum | Note alert under a signed note. |
| templates | laceration 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
| Prop | Type | Default | Description |
|---|---|---|---|
template | ProcedureTemplateKey | 'laceration repair' | 'laceration repair' | 'central line' | 'lumbar puncture' | 'cesarean delivery' |
values | ProcedureNoteValues | {} | Note values |
status | ProcedureNoteStatus | 'draft' | 'draft' (template fields editable) | 'signed' (read-only) |
addendum | { at: string; text: string } | none | Addendum under a signed note {at, text} |
onSign | (details: Record<string, string>) => void | none | Called by Sign Note with the template field text |
onSaveDraft | (details: Record<string, string>) => void | none | Called by Save Draft with the template field text |
onDetailsChange | (details: Record<string, string>) => void | none | Called when a template field changes |
rangeContext | RangeContextId | 'ed' when no global context is set | Which 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>
| Kind | Name | Description |
|---|---|---|
| attribute | template | 'laceration repair' | 'central line' | 'lumbar puncture' | 'cesarean delivery'; default 'laceration repair' |
| property / JSON attribute | values | Note values; default {} |
| attribute | status | 'draft' (template fields editable) | 'signed' (read-only); default 'draft' |
| property / JSON attribute | addendum | Addendum under a signed note {at, text}; default none |
| attribute | range-context / rangeContext | Which shared reference range flags use; the lab range on a result still wins; default 'ed' when no global context is set |
| attribute | default-checked / defaultChecked | |
| property / JSON attribute | default-value / defaultValue | |
| attribute | auto-focus / autoFocus | |
| event | co-sign | Called by Sign Note with the template field text; default none (React: onSign) |
| event | co-save-draft | Called by Save Draft with the template field text; default none (React: onSaveDraft) |
| event | co-details-change | Called when a template field changes; default none (React: onDetailsChange) |