Update Clinical Note Interaction

patch

https://api.sandbox.hint.com/api/provider/patients/{patient_id}/interactions/clinical_note/{id}

Responses return formatted_text as Markdown. Reading and resubmitting
this value is not a lossless round trip for all rich-text formatting. For example, link titles
and new-window settings may be lost.

Path Params

patient_id

string

required

Unique Patient ID

string

required

Unique Clinical Note Interaction ID

Body Params

string

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

title

string

The title of the interaction.

text

string

The plain text version of the body of the interaction.

formatted_text

string

The formatted body as Markdown. Converted to sanitized HTML server-side.

event_timestamp

date-time

The event timestamp of the interaction.

files

array of objects

The files to attach. They will be downloaded as part of the request. A bare URL string is also accepted in place of an object. When filename is omitted Hint infers one and rejects the request with a 422 if it cannot.

files

provider_name

string

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_id

string

integration_error_message

string

integration_web_link

string

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response