Partial Result Notifications
Orders may have partial results, meaning that the lab has made available part of the result, while the full result is not complete. In general, these are short lived and as such, Vital does not expose them via webhooks. Some orders however have long lived partial results, specifically when one ordered marker takes significantly longer to result than the others.
In these situations, clients may want to be notified of the existance of partial results. As such, Vital provides a team level configuration that enables the delivery of partial result webhooks. Similarly to other events, these are triggered via a labtest.order.updated
event in the system.
Orders can also experience multiple partials in their lifecycle. In these cases, Vital will send a webhook for each partial update. So if your order experiences two partial results before a final, complete result, you should expect to receive two labtest.order.updated
webhooks with partial
status.
For example, in the second partial result, you would receive a webhook with the following body:
events
block contains two sample_with_lab.walk_in_test.partial_results
events.{
"id": "84d96c03-6b1c-4226-ad8f-ef44a6bc08af",
"team_id": "6353bcab-3526-4838-8c92-063fa760fb6b",
"user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"patient_details": { "dob": "2020-01-01", "gender": "male" },
"patient_address": {
"receiver_name": "John Doe",
"first_line": "123 Main St.",
"second_line": "Apt. 208",
"city": "San Francisco",
"state": "CA",
"zip": "91189",
"country": "United States",
"phone_number": "+1123456789"
},
"details": {
"type": "walk_in_test",
"data": {
"id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z"
}
},
"sample_id": "123456789",
"notes": "This is a note",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"status": "sample_with_lab",
"events": [
{
"id": 1,
"created_at": "2022-01-01T00:00:00Z",
"status": "received.walk_in_test.ordered"
},
{
"id": 2,
"created_at": "2022-01-02T00:00:00Z",
"status": "received.walk_in_test.requisition_created"
},
{
"id": 3,
"created_at": "2022-01-03T00:00:00Z",
"status": "sample_with_lab.walk_in_test.partial_results"
},
{
"id": 4,
"created_at": "2022-01-04T00:00:00Z",
"status": "sample_with_lab.walk_in_test.partial_results"
}
]
}