Sign in

v1

latestOpenAPI 3.1.0Private2026-07-24196240439.2 KB
DocumentInteraction

Create Document Interaction

post/provider/patients/{patient_id}/interactions/document

Path parameters

patient_idstring required

Unique Patient ID

Request body

status'draft' | 'signed' | 'addended' | 'deleted' | 'failed' required

The status of the interaction.

titlestring

The title of the interaction.

bodystring

The body of the interaction. Markdown formatted.

attachmentsstring[]

The attachments of the interaction. Files will be downloaded as part of the request.

event_timestampstring date-time

The event timestamp of the interaction.

integration_record_idstring
integration_error_messagestring
integration_web_linkstring

Response

Successful response

idstring
bodystring
event_timestampstring date-time
patient_accessboolean
patient_idstring
statusstring
titlestring
typestring