HIhint
PartnerInteraction

Create Partner Interaction

Changed on
post/provider/patients/{patient_id}/interactions/partner

Request

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

Path parameters

patient_idstring required

Unique Patient ID

Request body

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

The status of the interaction.

titlestring

The title of the interaction.

integration_record_idstring
integration_error_messagestring
integration_web_linkstring
partner_product_idstring

The installed product to attribute this interaction to. Defaults to the product whose surface the call came from, then to the practice's only installed product of yours. Required when neither applies.

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
    • 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