Skip to main content

OncologyRegimen

ComplexSpecialty<co-oncology-regimen>

OncologyRegimen tracks a chemotherapy regimen cycle by cycle, with BSA-based doses, dose reductions, pre-cycle labs against hold rules and lifetime cumulative doses.

import { OncologyRegimen } from 'health-components';

Examples​

Hold Criteria Met​

Storybook

Bsa Capped Cumulative​

Storybook

Usage​

<OncologyRegimen regimen={{ name: "FOLFOX6", cycleDays: 14, cycles: 12, hold: { anc: 1.5, plt: 75 }, drugs: [{ name: "Oxaliplatin", route: "IV", days: "D1", mgm2: 85 }] }} patient={{ heightCm: 172, weightKg: 70 }} cycles={[{ n: 1, date: "08/03/2026", status: "given" }]} />

When to use​

  • Infusion center and oncology clinic, before releasing each cycle to pharmacy.

When not to use​

  • Oral targeted therapy refills: MedicationList.
  • Weight-based pediatric doses: PediatricDosingCalculator.

Variants and states​

VariantWhat it is
cycle stripGiven (success), due today (info, highlighted), planned, delayed (warning), held (danger), with any dose reduction.
BSAMosteller from height and weight to 0.01 m²; optional cap; weight change since cycle 1.
dose tablemg/m² or flat dose, calculated mg, reduction and final mg.
hold criteriaANC, platelets or creatinine past the regimen’s hold rule: error Alert and Release to Pharmacy disabled.
cumulativeLifetime dose against its limit, warning from 80%.
readOnlyHides actions.

Clinical values​

Every number goes through the shared clinical value rules (CareOS.fmt and ClinicalValue from the clinical-values card): tabular digits, the unit always shown, a fixed precision per measure, the reference range in the tooltip, and H, L or critical flags. Medication amounts follow the ISMP dose style through fmt.doseNumber: rounded to the stated precision, then shown with no trailing zero (5 mg, never 5.0 mg) and a leading zero (0.5 mL). The specialty measures this card adds sit in CareOS.specialty.MEAS with their precision: BSA 2 decimals m², mg/m² whole, final dose 0.1 mg, ANC 0.1 ×10⁹/L, platelets whole ×10⁹/L, creatinine 0.01 mg/dL. Ranges in the previews are sample values for the design system, not clinical guidance; a real deployment passes its own.

Accessibility​

  • Cycles are a list with status words.
  • The hold reason is written out, and the blocked button says why in the Alert above it.
  • Lifetime dose meters have value text.

Do and don't​

  • Do: Show the BSA used and its source on the screen that releases the dose.
  • Do: Block release when hold rules are met until a provider decides.
  • Don't: Round BSA before multiplying.
  • Don't: Hide a dose reduction inside the final number.

Props​

PropTypeDefaultDescription
regimen *OncologyRegimenDef—{name, intent, cycleDays, cycles, bsaCap?, hold, drugs}; required
patient *OncologyPatient—{heightCm, weightKg, bsa?, weightChange?}; required
cyclesReadonlyArray<RegimenCycle>[]Cycles
cumulativeReadonlyArray<CumulativeDose>[]Lifetime doses
readOnlybooleanfalseHides Hold Cycle and Release to Pharmacy
onHoldCycle() => voidnoneHold Cycle action
onRelease() => voidnoneRelease to Pharmacy action (disabled while hold criteria are met)
rangeContextRangeContextIdthe global context, else 'outpatient'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-oncology-regimen>. 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-oncology-regimen read-only range-context="…" [regimen]="regimen" (co-hold-cycle)="onHoldCycle($event.detail)"></co-oncology-regimen>
KindNameDescription
property / JSON attributeregimen{name, intent, cycleDays, cycles, bsaCap?, hold, drugs}; required
property / JSON attributepatient{heightCm, weightKg, bsa?, weightChange?}; required
property / JSON attributecyclesCycles; default []
property / JSON attributecumulativeLifetime doses; default []
attributeread-only / readOnlyHides Hold Cycle and Release to Pharmacy; default false
attributerange-context / rangeContextWhich shared reference range flags use; the lab range on a result still wins; default the global context, else 'outpatient'
attributedefault-checked / defaultChecked
property / JSON attributedefault-value / defaultValue
attributeauto-focus / autoFocus
eventco-hold-cycleHold Cycle action; default none (React: onHoldCycle)
eventco-releaseRelease to Pharmacy action (disabled while hold criteria are met); default none (React: onRelease)