Visit Notes

Notes written about a visit by the caregiver or office staff.

Endpoints

The VisitNote object

object
stringread-only

String representing the object's type. Always visit_note.

id
stringread-only

Unique identifier of the visit note.

visitId
string | nullmax length 64

The visit the note is about.

content
string | nullmax length 20000

The note.

authorType
string | nullread-only

Whether office staff (User) or a caregiver wrote the note. Set from the API key's user.

One ofUserCaregivernull
authorId
string | nullread-onlymax length 64

ID of the staff user or caregiver who wrote the note. Set from the API key's user.

createdAt
string · date-time | nullread-only

When the visit note was created.

updatedAt
string · date-time | nullread-only

When the visit note was last changed.