Sign in

v1

latestOpenAPI 3.1.0Private2026-07-24196240439.2 KB
ClinicalNoteInteraction

Create Clinical Note Interaction

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

Path parameters

patient_idstring required

Unique Patient ID

Request body

string

status [draft, signed, addended, deleted, failed] The status of the interaction.

titlestring

The title of the interaction.

textstring

The plain text body of the interaction.

formatted_textstring

The formatted text body (markdown). Converted to HTML server-side.

event_timestampstring date-time

The event timestamp of the interaction.

filesstring[]

File attachment paths. Files will be downloaded as part of the request.

provider_namestring

Name of the signing provider. When provided with status "signed", the API resolves it to a provider user ID for the signed field.

integration_record_idstring
integration_error_messagestring
integration_web_linkstring

Response

Successful response

idstring
authorstring
event_timestampstring date-time
filesstring
formatted_textstring
patient_accessboolean
patient_idstring
signedstring
statusstring
textstring
titlestring
typestring