Skip to main content
POST
Create a patient note

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
clinic_patient_id
integer
required

The ID of the clinic patient this note is associated with

kind
enum<string>
required

The kind of patient note. Documentation notes are not supported via external API.

Available options:
GENERAL,
COMMUNICATION
note
string
required

The note content as plain text

created_by_id
integer | null

The ID of the user who created this note

is_internal
boolean
default:true

Whether this note is internal or visible to clients

Response

201 - application/json

Created

Patient notes are used to record information about a patient that should appear on their timeline. Notes can be of different kinds (general, communication, documentation) and can be marked as internal (visible only to clinic staff) or external (visible to clients as well).

clinic_patient_id
integer
required

The ID of the clinic patient this note is associated with

date
string<date-time>
required

The date and time when the note was created

deleted
string<date-time> | null
required

The datetime this record was soft deleted.

details
Details · object[] | null
required

Additional details about the note in JSON format

id
integer
required

The unique identifier for the patient note

is_deleted
boolean
required

Whether this record is soft deleted or not.

is_internal
boolean
required

Whether this note is internal or visible to clients

is_locked
boolean
required

Whether this note is locked and cannot be modified

kind
required

The kind of patient note

Available options:
GENERAL,
COMMUNICATION,
DOCUMENTATION
created_by_name
string | null

The full name of the user who created this note