HIhint
FormInteraction

Create Form Interaction

Changed on
post/provider/partner-invisible/patients/{patient_id}/interactions/form

Request

  • Base URL
    https://api.sandbox.hint.com/api
  • URL
    https://api.sandbox.hint.com/api/provider/partner-invisible/patients/{patient_id}/interactions/form
  • Auth
    API key in header AUTHORIZATION

Path parameters

patient_idstring required

Unique Patient ID

Request body

form_idstring required

Stable identifier for the form template, used to map questions to the health history. The same value should be sent every time this form is submitted.

form_namestring required

The name of the form that was completed.

event_timestampstring date-time

When the form was completed. Defaults to the current time.

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