HIhint
Interaction

List All Interactions

Changed on
get/provider/interactions

Request

  • Base URL
    https://api.sandbox.hint.com/api
  • URL
    https://api.sandbox.hint.com/api/provider/interactions
  • Auth
    API key in header AUTHORIZATION

Query parameters

patient_idstring[]

Allows filtering interactions by patient id.

statusstring[]

Allows filtering interactions by status.

typestring[]

Allows filtering interactions by type.

limitinteger

Allows limiting the number of interactions returned.

offsetinteger

Allows offsetting the number of interactions returned.

created_atstring date-time

Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See advanced querying for more information.

updated_atstring date-time

Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See advanced querying for more information.

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

      removed the enum value rx_dosespot from the property items/ of the query request parameter type

    • breaking

      removed the enum value rx_veradigm from the property items/ of the query request parameter type

    • info

      added the enum value erx to the property items/ of the query request parameter type

    • 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