Skip to main content

​
NoteEditor

A clinical note editor supporting multiple note types, document status management, category tagging, and practice setting.

​
Usage

import { NoteEditor } from '@clinikapi/react';

<NoteEditor
  proxyUrl="/api/clinik"
  patientId="pt_abc123"
  authorId="prac_def456"
  encounterId="enc_xyz789"
  theme="light"
/>

​
Props

PropTypeRequiredDescription
proxyUrlstringYesBackend proxy URL
patientIdstringYesPatient ID
authorIdstringNoPractitioner who authored the note
encounterIdstringNoAssociated encounter
theme'light' | 'dark'NoColor theme

​
Form Fields

FieldDescription
Note typeProgress note, consultation, discharge summary, H&P, operative, procedure, referral, transfer summary
Document statusDraft (preliminary), final, amended
CategoryFree-text category tag (e.g. “cardiology”, “oncology”)
Practice settingClinical specialty context (e.g. “cardiology”, “family-medicine”)
TitleNote title / description
ContentClinical note content (supports plain text and markdown)

​
Note Types

TypeLOINC CodeDescription
progress-note11506-3Standard visit documentation
consultation-note11488-4Specialist consultation
discharge-summary18842-5Hospital discharge summary
history-and-physical34117-2H&P documentation
operative-note11504-8Surgical procedure note
procedure-note28570-0Non-surgical procedure note
referral-note57133-1Referral documentation
transfer-summary18761-7Patient transfer summary

​
Proxy Action

The widget sends notes.create with: 
{
  "action": "notes.create",
  "data": {
    "patientId": "pt_abc123",
    "authorId": "prac_def456",
    "encounterId": "enc_xyz789",
    "title": "Follow-up Visit - Hypertension",
    "content": "## Subjective\nPatient reports...",
    "type": "progress-note",
    "docStatus": "final",
    "category": "cardiology",
    "practiceSetting": "cardiology"
  }
}