HIhint
LabInteraction

Update Lab Interaction

Changed on

Hint stores order, report, and results as one block. If an update sends one of them, Hint replaces the full block with the content of that request. Hint removes the parts that the request does not send. Send order, report, and results together in every update that sends one of them. Send every result, not only the new ones. status and event_timestamp change only when sent. See Lab Interactions.

patch/provider/patients/{patient_id}/interactions/lab/{id}

Request

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

Path parameters

patient_idstring required

Unique Patient ID

idstring required

Unique Lab Interaction ID

Request body

status'sent' | 'fulfilled'

The status of the interaction. Defaults to "sent" on create

vendor_order_idstring

Your order number. An update that sends order, report, or results removes it.

event_timestampstring date-time

Defaults to current time

integration_record_idstring
integration_error_messagestring
integration_web_linkstring
partner_product_idstring

The installed product to attribute this lab to. Defaults to the product whose surface the call came from, then to the practice's only installed product of yours.

Response

Successful response

idstring
created_atstring date-time
event_timestampstring date-time
patient_accessboolean
patient_idstring
statusstring
typestring
updated_atstring date-time
vendor_order_idstring

Changes

  • c9bda0d2dd87Revision changes
    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • breaking

      the / request property format changed from no format to date-time

    • breaking

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

    • breaking

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

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the ///// request property type was generalized from integer to number, and format from int32 to float

    • info

      the ///// request property type was generalized from integer to number, and format from int32 to float

    • info

      the /// request property type was generalized from integer to number, and format from int32 to float

    • 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