Skip to main content
POST
/
v3
/
order
/
{order_id}
/
test
curl --request POST \
     --url '{{BASE_URL}}/v3/order/<order_id>/test' \
     --header 'x-vital-api-key: {YOUR_KEY}'

{
  "detail": "<unknown>"
}
curl --request POST \
     --url '{{BASE_URL}}/v3/order/<order_id>/test' \
     --header 'x-vital-api-key: {YOUR_KEY}'

Authorizations

​
x-vital-api-key
string
header
required

Vital Team API Key

Path Parameters

​
order_id
string<uuid>
required

Query Parameters

​
final_status
enum<string> | null

Used in combination with OrderStatusDetail to represent the current order state. OrderStatus is driven by a FSM whereas OrderStatusDetail is descriptive only. ℹ️ This enum is non-exhaustive.

Available options:
received.walk_in_test.ordered,
received.walk_in_test.requisition_created,
received.walk_in_test.requisition_bypassed,
completed.walk_in_test.completed,
sample_with_lab.walk_in_test.partial_results,
failed.walk_in_test.sample_error,
cancelled.walk_in_test.cancelled,
collecting_sample.walk_in_test.appointment_pending,
collecting_sample.walk_in_test.appointment_scheduled,
collecting_sample.walk_in_test.appointment_cancelled,
collecting_sample.walk_in_test.redraw_available,
received.at_home_phlebotomy.ordered,
received.at_home_phlebotomy.requisition_created,
received.at_home_phlebotomy.requisition_bypassed,
collecting_sample.at_home_phlebotomy.appointment_pending,
collecting_sample.at_home_phlebotomy.appointment_scheduled,
collecting_sample.at_home_phlebotomy.draw_completed,
collecting_sample.at_home_phlebotomy.appointment_cancelled,
completed.at_home_phlebotomy.completed,
sample_with_lab.at_home_phlebotomy.partial_results,
cancelled.at_home_phlebotomy.cancelled,
failed.at_home_phlebotomy.sample_error,
received.testkit.ordered,
received.testkit.awaiting_registration,
received.testkit.requisition_created,
received.testkit.requisition_bypassed,
received.testkit.registered,
collecting_sample.testkit.transit_customer,
collecting_sample.testkit.out_for_delivery,
collecting_sample.testkit.with_customer,
collecting_sample.testkit.transit_lab,
sample_with_lab.testkit.delivered_to_lab,
sample_with_lab.testkit.lab_processing_blocked,
completed.testkit.completed,
failed.testkit.failure_to_deliver_to_customer,
failed.testkit.failure_to_deliver_to_lab,
failed.testkit.sample_error,
failed.testkit.lost,
cancelled.testkit.cancelled,
cancelled.testkit.do_not_process,
collecting_sample.testkit.problem_in_transit_customer,
collecting_sample.testkit.problem_in_transit_lab,
received.on_site_collection.ordered,
received.on_site_collection.requisition_created,
received.on_site_collection.requisition_bypassed,
sample_with_lab.on_site_collection.draw_completed,
completed.on_site_collection.completed,
cancelled.on_site_collection.cancelled,
sample_with_lab.on_site_collection.partial_results,
failed.on_site_collection.sample_error,
completed.walk_in_test.corrected,
completed.at_home_phlebotomy.corrected,
completed.on_site_collection.corrected,
completed.testkit.corrected
​
delay
integer | null

Body

application/json
​
interpretation
enum<string>
default:normal

ℹ️ This enum is non-exhaustive.

Available options:
normal,
abnormal,
critical,
unknown
​
result_types
enum<string>[] | null

ℹ️ This enum is non-exhaustive.

Available options:
numeric,
range,
comment,
coded_value
​
has_missing_results
boolean | null

Response

Successful Response