Skip to main content
PATCH
Partially Update Patient Letter

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
integer<int64>
required

Body

application/json
attachments
object[]
body
string
delivery_date
string<date-time> | null
document_date
string<date-time>
files
object[] | null

Files attached to this letter. Binary upload: set content_type='application/octet-stream' and provide 'base64_content' (and optional 'original_filename'). When any file uses base64, all files in the same request must use base64. On GET, returns file references.

is_patient_initiated
boolean | null
patient
integer<int64>
patient_read_time
string<date-time> | null
practice
integer<int64>
send_out
boolean
sign_date
string<date-time> | null
signed_by
integer<int64> | null

The user who signed the letter.

subject
string
Maximum string length: 200
tags
integer<int64>[]

A list of Document Tags associated with the letter.

viewed_at
string<date-time> | null

Response

200 - application/json
patient
integer<int64>
required
practice
integer<int64>
required
attachments
object[]
body
string
category
integer<int64> | null
read-only
created_date
string<date-time> | null
read-only
deleted_date
string<date-time> | null
read-only
delivery_date
string<date-time> | null
document_date
string<date-time>
files
object[] | null

Files attached to this letter. Binary upload: set content_type='application/octet-stream' and provide 'base64_content' (and optional 'original_filename'). When any file uses base64, all files in the same request must use base64. On GET, returns file references.

id
integer
read-only
is_patient_initiated
boolean | null
is_processed
boolean
read-only
letter_type
string
read-only
patient_read_time
string<date-time> | null
send_out
boolean
send_to_patient
boolean
read-only
sign_date
string<date-time> | null
signed_by
integer<int64> | null

The user who signed the letter.

subject
string
Maximum string length: 200
tags
integer<int64>[]

A list of Document Tags associated with the letter.

viewed_at
string<date-time> | null