GuidesAPI Reference
API Reference

Create Clinical Note Interaction

post
https://api.sandbox.hint.com/api/provider/patients//interactions/clinical_note
Path Params
string
required

Unique Patient ID

Body Params
string

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

string

The title of the interaction.

string

The plain text body of the interaction.

string

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

date-time

The event timestamp of the interaction.

files
array of strings

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

files
string

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

string
string
string
Response

Updated about 18 hours ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 18 hours ago