Create Reports Internal Note

Create an internal note

Creates a new internal note for the specified report. Internal notes are private practice notes that are not visible to patients.

Path Parameters

ParameterTypeRequiredDescription
idintegerYesThe unique identifier of the report

Request Body

FieldTypeRequiredDescription
textstringYesThe internal note text content (max 256 characters)

Example Request

{
  "text": "This is an internal note for the report"
}

Response

Returns the created internal note object with its assigned id and associated document ID.

Path Params
integer
required

Report ID

Body Params
string
required
length ≤ 256

The internal note text content

Response

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