Sign in
Patient Letters (BETA)

Create Patient Letter

Create a patient letter. Set is_patient_initiated=true when patient is the author (requires active ChartAccessGrant). Sign separately, then PATCH send_out=true to send.

post/api/2.0/patient_letters/

Request body

bodystring
categoryinteger nullable
created_datestring date-time nullable
deleted_datestring date-time nullable
delivery_datestring date-time nullable
document_datestring date-time
idinteger
is_patient_initiatedboolean nullable
is_processedboolean
letter_typestring
patientinteger required
patient_read_timestring date-time nullable
practiceinteger required
send_outboolean
send_to_patientboolean
sign_datestring date-time nullable
signed_byinteger nullable

The user who signed the letter.

subjectstring
tagsinteger[]

A list of Document Tags associated with the letter.

viewed_atstring date-time nullable

Response

bodystring
categoryinteger nullable
created_datestring date-time nullable
deleted_datestring date-time nullable
delivery_datestring date-time nullable
document_datestring date-time
idinteger
is_patient_initiatedboolean nullable
is_processedboolean
letter_typestring
patientinteger required
patient_read_timestring date-time nullable
practiceinteger required
send_outboolean
send_to_patientboolean
sign_datestring date-time nullable
signed_byinteger nullable

The user who signed the letter.

subjectstring
tagsinteger[]

A list of Document Tags associated with the letter.

viewed_atstring date-time nullable

Changes