Progress Notes
Progress notes are the clinical summaries caregivers write after a visit.
Endpoints
The ProgressNote object
object
stringread-only
String representing the object's type. Always progress_note.
id
stringread-only
Unique identifier of the progress note.
visitId
string | nullmax length 64
The visit the note documents.
patientId
string | nullmax length 64
The patient.
caregiverId
string | nullmax length 64
The caregiver who wrote the note. With a caregiver's API key this is always that caregiver (leave it out), and the visit must be assigned to them.
caregiverName
string | nullread-onlymax length 2000
Display name of the caregiver, taken from the caregiver's record.
summary
string | nullmax length 20000
The written summary of the visit.
aiGenerated
boolean | nullread-only
Whether the summary was drafted with AI assistance.
createdAt
string · date-time | nullread-only
When the progress note was created.
updatedAt
string · date-time | nullread-only
When the progress note was last changed.