- Home
- Wearables
- Lab Testing
- API Reference
- Event Catalog
- Changelog
- Users
- Debugging
- Orders
- Area Info
- At-home Phlebotomy
- Tests
- Results
- Health Insurance
- Sleep
- Meal
- Workouts
- Profile
- Activity
- Body
- Menstrual Cycle
- Vitals
- Body
- Activity
- Wellness
- Nutrition
- Team
- Member
- Invite
- Org
- Team API Keys
- Team Custom Credentials
- Team Data Pull Preferences
- Team ETL Pipeline
- Team Scope Requirements
Core
Lab Testing
Summary Data
Timeseries Data
Org Management
Create Order
POST create new order
Vital Team API Key
Schema for the create Order endpoint.
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.
Authorizations
Vital Team API Key
Body
An image of the physician signature for health insurance billing
image/jpeg
An image of the front of the patient insurance card.
image/jpeg
An image of the back of the patient insurance card.
image/jpeg
An image of the patient signature for health insurance billing.
image/jpeg
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 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.
terms-of-use
, telehealth-informed-consent
, mobile-terms-and-conditions
, notice-of-privacy-practices
, privacy-policy
, hipaa-authorization
Schedule an Order to be processed in a future date.
female
, male
, other
, unknown
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 Details
Patient Address
The Vital Test associated with the order
dried_blood_spot
, serum
, saliva
, urine
testkit
, walk_in_test
, at_home_phlebotomy
Deprecated. Use status instead.
active
, pending_approval
, inactive
Defines whether a lab test requires fasting.
testkit
, walk_in_test
, at_home_phlebotomy
dried_blood_spot
, serum
, saliva
, urine
biomarker
, panel
choice
, text
, numeric
, multi_choice
Denotes whether a lab test requires using non-Vital physician networks. If it does then it's delegated - no otherwise.
walk_in_test
Schema for a walk-in test order in the client facing API.
To be used as part of a ClientFacingOrder.
The Vital walk-in test Order ID
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
, 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.