Update Lab Interaction

patch

https://api.sandbox.hint.com/api/provider/patients/{patient_id}/interactions/lab/{id}

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.

Path Params

patient_id

string

required

Unique Patient ID

string

required

Unique Lab Interaction ID

Body Params

status

string

enum

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

Allowed:

vendor_order_id

string

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

event_timestamp

date-time

Defaults to current time

order

object

Lab order details

report

object

Diagnostic report details

results

array of objects

Lab result observations

results

files

array of objects

The files to attach. They will be downloaded as part of the request. A bare URL string is also accepted in place of an object. When filename is omitted Hint infers one and rejects the request with a 422 if it cannot.

files

requisition_files

array of objects

The documents that ordered the lab, attached the same way as files.

requisition_files

result_files

array of objects

The documents reporting the lab results, attached the same way as files.

result_files

integration_record_id

string

integration_error_message

string

integration_web_link

string

partner_product_id

string

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

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response