BehavioralTreatmentPlan
<co-behavioral-treatment-plan>BehavioralTreatmentPlan lays out a behavioral health plan as problems, goals, measurable objectives and the interventions for each, with target dates, progress, review date and signatures.
import { BehavioralTreatmentPlan } from 'health-components';
Examples
Review Overdue
Usage
<BehavioralTreatmentPlan problems={[{ code: "F33.1", label: "Major depressive disorder, recurrent, moderate", goals: [{ text: "Reduce depressive symptoms", objectives: [{ text: "PHQ-9 under 10", target: "12/15/2026", status: "progressing", measure: { name: "PHQ-9", baseline: 17, current: 12, target: 9 }, interventions: [{ text: "CBT", frequency: "weekly", who: "LCSW" }] }] }] }]} />
When to use
- Mental health and substance use treatment plans at intake, at each review and at discharge.
When not to use
- Crisis safety planning: a safety plan form.
- Medical problem lists: ProblemList.
Variants and states
| Variant | What it is |
|---|---|
| problem | Code, label, priority and the evidence for it. |
| goal | Clinical wording plus the client’s own words. |
| objective | Measurable step with a measure (baseline, now, target), a target date and status: met, progressing, not started, not met, revised. |
| intervention | What the clinician does, how often and who. |
| signatures | Client and clinician badges, signed or needed. |
| review | Next review date, or overdue in danger. |
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: scale scores whole points. Ranges in the previews are sample values for the design system, not clinical guidance; a real deployment passes its own.
Accessibility
- Each problem is a labelled region; numbering (1.1a) ties objectives to goals in text.
- Status is a word badge.
Do and don't
- Do: Write objectives the client can see progress on.
- Do: Keep the client’s own words beside the goal.
- Don't: List interventions without frequency or owner.
- Don't: Let the review date pass silently.
Props
| Prop | Type | Default | Description |
|---|---|---|---|
problems | ReadonlyArray<TreatmentProblem> | [] | Problems with goals, objectives and interventions |
reviewDue | string | none | Next review date |
reviewOverdue | boolean | false | The review date has passed |
signatures | ReadonlyArray<PlanSignature> | [] | Signatures |
title | string | 'Treatment plan' | Card title |
subtitle | string | none | Line under the title |
readOnly | boolean | false | Hides Review Plan and Sign Plan |
onReviewPlan | () => void | none | Review Plan action |
onSignPlan | () => void | none | Sign Plan action |
rangeContext | RangeContextId | the 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-behavioral-treatment-plan>. 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.
<co-behavioral-treatment-plan review-due="…" review-overdue [problems]="problems" (co-review-plan)="onReviewPlan($event.detail)"></co-behavioral-treatment-plan>
| Kind | Name | Description |
|---|---|---|
| property / JSON attribute | problems | Problems with goals, objectives and interventions; default [] |
| attribute | review-due / reviewDue | Next review date; default none |
| attribute | review-overdue / reviewOverdue | The review date has passed; default false |
| property / JSON attribute | signatures | Signatures; default [] |
| attribute | title | Card title; default 'Treatment plan' |
| attribute | subtitle | Line under the title; default none |
| attribute | read-only / readOnly | Hides Review Plan and Sign Plan; default false |
| attribute | range-context / rangeContext | Which shared reference range flags use; the lab range on a result still wins; default the global context, else 'outpatient' |
| attribute | default-checked / defaultChecked | |
| property / JSON attribute | default-value / defaultValue | |
| attribute | auto-focus / autoFocus | |
| event | co-review-plan | Review Plan action; default none (React: onReviewPlan) |
| event | co-sign-plan | Sign Plan action; default none (React: onSignPlan) |