HIhint
DocumentInteraction

Update Interaction

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

Request

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

Path parameters

patient_idstring required

Unique Patient ID

idstring required

Unique Document Interaction ID

Request body

status'draft' | 'signed' | 'addended' | 'deleted' | 'failed' required

The status of the interaction.

titlestring

The title of the interaction.

bodystring

The body of the interaction.

event_timestampstring date-time

The event timestamp of the interaction.

integration_record_idstring
integration_error_messagestring
integration_web_linkstring

Response

Successful response

idstring
bodystring
created_atstring date-time
event_timestampstring date-time
patient_accessboolean
patient_idstring
quantityinteger nullable

Only returned for rx and erx. Historical order snapshot; unavailable values are null.

refillsinteger nullable

Only returned for rx and erx. Historical order snapshot; unavailable values are null.

rx_idstring nullable

Only returned for rx and erx. Historical order snapshot; unavailable values are null.

statusstring
titlestring
typestring
updated_atstring date-time
vendor_order_idstring

Only returned when the interaction type is lab.

Changes

  • c9bda0d2dd87Revision changes
    • warning

      removed the request property

    • 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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status