/cl/note-templates.
Overview
The Note Templates page lists all active note templates for the current organization, loaded viauseNoteTemplatesList from the cl_note_templates table. Templates are displayed in a card with a divide-separated list showing template name, note type label, service line (if set), active/inactive badge, an Edit button, and a toggle button to activate or deactivate. Users click “New Template” (top-right button) to open a side-sheet form (TemplateForm via Sheet) for creating a new template. Clicking “Edit” on a row opens the same sheet pre-populated with the template’s current values. Note type choices are: Progress Note, Addendum, Outpatient, Residential, IOP/PHP. Service line is an optional free-text field. The useNoteTemplateMutation hook provides createTemplate, updateTemplate, activateTemplate, and deactivateTemplate actions, each invalidating the cl_note_templates query on success and showing a toast notification.
Who it’s for
Requires thecl.note_templates.manage permission (enforced by RequirePermission in cl.tsx and the component itself).
Before you start
- You must hold
cl.note_templates.manageto access this page.
Steps
1
Navigate to Note Templates
Open the Clinical core and go to
/cl/note-templates. All active note templates for your organization are listed.2
Create a new template
Click “New Template” (top right). The side-sheet opens. Enter a Template Name (required), select a Note Type (required), and optionally enter a Service Line. Click “Create” to save.
3
Edit an existing template
Click “Edit” next to the template you want to update. The side-sheet opens pre-filled. Modify the fields as needed and click “Update” to save.
4
Deactivate or activate a template
Click the toggle icon button next to the template. Active templates show a ToggleRight icon (clicking deactivates); inactive templates show a ToggleLeft icon (clicking activates). A toast notification confirms the action.
Key concepts
Note:/cl/note-templates/new is not a registered route in the Clinical core router. Template creation is handled entirely through the “New Template” sheet on this page. Navigating to /cl/note-templates/new renders the NotFound component.
Note type values
Note type values
The
note_type field accepts: progress (Progress Note), addendum (Addendum), outpatient (Outpatient), residential (Residential), iop_php (IOP/PHP). These labels are from NOTE_TYPE_LABEL in the component. Clinical or billing significance of each type requires SME confirmation.Active vs. inactive templates
Active vs. inactive templates
useNoteTemplatesList queries only rows where is_active = true. Deactivated templates are hidden from the list. The activateTemplate mutation sets is_active: true and re-queries.Empty and error states
Empty and error states
When no active templates exist, an empty state shows a FileText icon with “No templates yet” and “Create templates to standardize session documentation.” If the query errors, the sanitized error message is shown in destructive text within the card.
Related
Clinical
Overview of the Clinical core.
Governance & parity
Documentation coverage and governance.
This page documents shipped product behavior. It is not medical, legal, or
billing advice. Verify against your organization’s policies and applicable
regulations before using it for clinical, compliance, or billing decisions.
Protected health information (PHI) shown in the product is governed by your
tenant’s access controls and is never exposed in this documentation.
Documentation sources
Documentation sources
- src/routes/cl.tsx
- src/cores/cl/pages/NoteTemplatesPage.tsx
- src/cores/cl/hooks/useNoteTemplatesList.ts
- src/cores/cl/hooks/useNoteTemplateMutation.ts
- src/cores/cl/types/progress-notes.ts