Skip to main content

clinik.notes

create

const { data, meta } = await clinik.notes.create(request: NoteCreateRequest): Promise<ApiResponse<DocumentReference>>
FieldTypeRequiredDescription
patientIdstringYesPatient reference
authorIdstringNoPractitioner who authored the note
encounterIdstringNoEncounter reference
typeNoteTypeNoType of clinical note
titlestringYesNote title
contentstringYesNote content (plain text or markdown)
contentTypestringNoMIME type (default: text/plain)
docStatusstringNopreliminary, final, amended
categorystringNoCategory tag
datestringNoClinically relevant date
relatesToArray<{ code, targetId }>NoRelationships to other documents
securityLabelArray<{ system?, code, display? }>NoDocument security tags
authenticatorIdstringNoWho authenticated the document
custodianIdstringNoOrganization maintaining the document
servicePeriod{ start?, end? }NoTime period of service documented
facilityTypestringNoKind of facility
practiceSettingstringNoClinical specialty

Note Types

TypeDescription
progress-noteProgress note
discharge-summaryDischarge summary
consultation-noteConsultation note
history-and-physicalH&P
operative-noteOperative note
procedure-noteProcedure note
referral-noteReferral note
transfer-summaryTransfer summary
otherOther

Relates To Codes

CodeDescription
replacesThis note replaces the target
transformsThis note transforms the target
signsThis note signs the target
appendsThis note appends to the target

search / read / update / delete

Same pattern as other resources.