HIhint
ClinicalNoteInteraction

Update Clinical Note Interaction

Changed on
patch/provider/patients/{patient_id}/interactions/clinical_note/{id}

Request

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

Path parameters

patient_idstring required

Unique Patient ID

idstring required

Unique Clinical Note Interaction 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.

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
created_atstring date-time
event_timestampstring date-time
formatted_textstring
patient_accessboolean
patient_idstring
signedstring
statusstring
textstring
titlestring
typestring
updated_atstring date-time

Changes

  • c9bda0d2dd87Revision changes
    • breaking

      added the new required request property //

    • breaking

      the / request property type changed from string to object

    • breaking

      the response's property type changed from string to array for status

    • info

      added the new optional request property //

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status