Skip to main content
The clinik.notes namespace manages FHIR DocumentReference resources — clinical notes authored by practitioners. A note has a type (progress note, discharge summary, referral, etc.), a title, content in plain text or markdown, and optional links to the encounter and authoring practitioner. Use clinik.documents for multi-section structured compositions like care plans.

​
create

Create a new clinical note. patientId, title, and content are required. 
const { data, meta } = await clinik.notes.create(request: NoteCreateRequest): Promise<ApiResponse<DocumentReference>>
​
patientId
string
required
ID of the patient the note is about.
​
title
string
required
A brief title for the note.
​
content
string
required
The note body in plain text or markdown.
​
authorId
string
ID of the practitioner who authored the note.
​
encounterId
string
Encounter this note is associated with.
​
type
NoteType
Clinical note type. See note types below.
​
contentType
string
MIME type for the content. Defaults to text/plain. Use text/markdown for markdown content.
​
docStatus
string
Document status. Accepted values: preliminary, final, amended.
​
category
string
Free-text category tag for grouping notes.
​
date
string
Clinically relevant date in ISO 8601 format.

​
Example

const { data: note } = await clinik.notes.create({
  patientId: 'pt_abc123',
  authorId: 'prac_def456',
  encounterId: 'enc_xyz789',
  type: 'progress-note',
  title: 'Follow-up visit — hypertension management',
  content: `Patient reports blood pressure readings averaging 128/82 at home.
Current medication: Lisinopril 10mg daily.
Plan: Continue current regimen. Recheck in 3 months.`,
  contentType: 'text/plain',
  docStatus: 'final',
  date: '2025-06-01',
});

​
Note types

TypeDescription
progress-noteOngoing encounter documentation
discharge-summarySummary on patient discharge
consultation-noteSpecialist consultation record
history-and-physicalHistory and physical examination (H&P)
operative-noteSurgical procedure documentation
procedure-noteProcedure documentation
referral-noteReferral to another provider
transfer-summarySummary for patient transfer
otherAny other note type

​
read

Fetch a single note by ID. 
const { data, meta } = await clinik.notes.read(id: string): Promise<ApiResponse<DocumentReference>>

​
update

Partially update a note. Typically used to finalize a preliminary note or make an amendment. 
const { data, meta } = await clinik.notes.update(id: string, request: NoteUpdateRequest): Promise<ApiResponse<DocumentReference>>

​
Example: finalize a preliminary note

await clinik.notes.update('note_abc123', {
  docStatus: 'final',
  content: 'Revised note content after attending review.',
});

​
delete

Permanently delete a clinical note. 
const { data, meta } = await clinik.notes.delete(id: string): Promise<ApiResponse<void>>
Search notes with filters on patient, author, encounter, type, and date. 
const { data } = await clinik.notes.search(params?: NoteSearchParams): Promise<ApiResponse<PaginatedResponse<DocumentReference>>>
​
patientId
string
Filter by patient.
​
authorId
string
Filter by authoring practitioner.
​
encounterId
string
Filter by encounter.
​
type
NoteType
Filter by note type.
​
category
string
Filter by category tag.
​
date
string
Filter by clinically relevant date.
​
count
number
Results per page.
​
cursor
string
Pagination cursor from a previous response.

​
Example

const { data } = await clinik.notes.search({
  patientId: 'pt_abc123',
  type: 'progress-note',
  authorId: 'prac_def456',
});

console.log('Progress notes:', data.data.length);