Orders
At-home Phlebotomy
Patient Service Center (PSC)
Tests
Health Insurance
Create Order
POST create new order
Vital Team API Key
Schema for the create Order endpoint.
The method used to perform a lab test.
An image of the physician signature for health insurance billing
An image of the front of the patient insurance card.
An image of the back of the patient insurance card.
An image of the patient signature for health insurance billing.
Textual description of what are the patient symptoms and attempted treatments.
Textual description of what are the physician assessments and testing plans.
Unique identifier representing a specific Health Insurance.
Insurance unique number assigned to a patient, usually present on the insurance card.
Relationship between the patient and the insurance contractor. Values can be (Self, Spouse, Other Relationship).
Responsible details when the value of responsible_relationship is not 'Self'.
Diagnosis codes for insurance billing.
Defines whether order is priority or not. For some labs, this refers to a STAT order.
Schedule an Order to be processed in a future date.
Patient details with validation for first_name, last_name, email, and dob.
Authorizations
Vital Team API Key
Body
Schema for the create Order endpoint.
Patient details with validation for first_name, last_name, email, and dob.
1 - 501 - 50female, male, other, unknown The method used to perform a lab test.
testkit, walk_in_test, at_home_phlebotomy Textual description of what are the patient symptoms and attempted treatments.
Textual description of what are the physician assessments and testing plans.
Unique identifier representing a specific Health Insurance.
Insurance unique number assigned to a patient, usually present on the insurance card.
Relationship between the patient and the insurance contractor. Values can be (Self, Spouse, Other Relationship).
Self, Spouse, Other Responsible details when the value of responsible_relationship is not 'Self'.
Diagnosis codes for insurance billing.
Defines whether order is priority or not. For some labs, this refers to a STAT order.
client_bill, commercial_insurance, patient_bill_passthrough, patient_bill Schedule an Order to be processed in a future date.
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 Vital ID of the health insurance.
DEPRECATED. Requistion form url.
Shipping Details. For unregistered testkit orders.
received, collecting_sample, sample_with_lab, completed, cancelled, failed Defines whether order is priority or not. For some labs, this refers to a STAT order.
Schedule an Order to be processed in a future date.
client_bill, commercial_insurance, patient_bill_passthrough, patient_bill