Orders
At-home Phlebotomy
Patient Service Center (PSC)
Tests
Health Insurance
Get Orders
GET many orders with filters.
Vital Team API Key
Search by order id, user id, patient name, shipping dob, or shipping recipient name.
Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
Filter by user ID.
Filter by patient name.
Filter by shipping recipient name.
Filter by order ids.
Authorizations
Vital Team API Key
Query Parameters
Search by order id, user id, patient name, shipping dob, or shipping recipient name.
Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
created_at
, patient_name
, last_status
asc
, desc
Filter by user ID.
Filter by patient name.
Filter by shipping recipient name.
Filter by order ids.
x > 1
1 < x < 100
Response
User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api.
The Vital Order ID
Your team id.
Patient Address
The Vital Test associated with the order
dried_blood_spot
, arm_collector
, serum
, saliva
, urine
testkit
, walk_in_test
, at_home_phlebotomy
Deprecated. Use status instead.
active
, pending_approval
, inactive
testkit
, walk_in_test
, at_home_phlebotomy
dried_blood_spot
, arm_collector
, serum
, saliva
, urine
biomarker
, panel
Defines whether a lab test requires fasting.
Denotes whether a lab test requires using non-Vital physician networks. If it does then it's delegated - no otherwise.
Whether the lab test was auto-generated by Vital
walk_in_test
Schema for a walk-in test order in the client facing API.
To be used as part of a ClientFacingOrder.
Sample ID
Notes associated with the order
When your order was created
When your order was last updated.
received.walk_in_test.ordered
, received.walk_in_test.requisition_created
, 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
, received.at_home_phlebotomy.ordered
, received.at_home_phlebotomy.requisition_created
, 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.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
, 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
received
, collecting_sample
, sample_with_lab
, completed
, cancelled
, failed
Vital ID of the health insurance.
DEPRECATED. Requistion form url.
Defines whether order is priority or not. For some labs, this refers to a STAT order.
Shipping Details. For unregistered testkit orders.
Schedule an Order to be processed in a future date.
client_bill
, commercial_insurance
, patient_bill_passthrough
, patient_bill