---
title: "Create Clinical Note Interaction"
method: POST
path: "/provider/patients/{patient_id}/interactions/clinical_note"
tags: ["ClinicalNoteInteraction"]
---

# Create Clinical Note Interaction

`POST /provider/patients/{patient_id}/interactions/clinical_note`

## Request

- Base URL: `https://api.sandbox.hint.com/api`
- URL: `https://api.sandbox.hint.com/api/provider/patients/{patient_id}/interactions/clinical_note`
- Auth: API key in header `AUTHORIZATION`

## Path parameters

- `patient_id` string, required

## Request body

- InteractionClinicalNoteSanitizer
  - string: status [draft, signed, addended, deleted, failed] The status of the interaction.
  - `title` string: The title of the interaction.
  - `text` string: The plain text body of the interaction.
  - `formatted_text` string: The formatted text body (markdown). Converted to HTML server-side.
  - `event_timestamp` string, date-time: The event timestamp of the interaction.
  - `files` InteractionFileSanitizer[]: 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.
    - `url` string, required: An https URL to download, or a `data:` URI carrying the file inline.
    - `filename` string: The name to store the file under. When omitted it is taken from the response's Content-Disposition, then the URL's path, and any missing extension is derived from the file's contents. A file that cannot be named is rejected with a 422.
  - `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 `200`

Successful response

- PublicInteractionClinicalNoteBlueprintOne
  - `id` string
  - `author` string
  - `created_at` string, date-time
  - `event_timestamp` string, date-time
  - `formatted_text` string
  - `patient_access` boolean
  - `patient_id` string
  - `signed` string
  - `status` string
  - `text` string
  - `title` string
  - `type` string
  - `updated_at` string, date-time
  - `files` PublicInteractionFileBlueprintLeaf[]
    - `id` string
    - `filename` string
    - `type` string

## Changes

- **2026-11-03** `c9bda0d2dd87`: 3 breaking, 3 info
  - added the new required request property `files/items/url`
  - the `files/items/` request property type changed from `string` to `object`
  - the `files` response's property type changed from `string` to `array` for status `200`
  - added the new optional request property `files/items/filename`
  - …2 more

[Operation history](https://skmtc.dev/hint/apis/partner-endpoints/changes/provider/patients/:patient_id/interactions/clinical_note/post.md)

---

[API](https://skmtc.dev/hint/apis/partner-endpoints.md) - [All operations](https://skmtc.dev/hint/apis/partner-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/hint/apis/partner-endpoints/revisions/c9bda0d2dd87?raw)