Authorizations
Vital Team API Key
Body
application/json
Schema for the create Order endpoint.
Patient details with validation for first_name, last_name, email, and dob.
The method used to perform a lab test. ℹ️ This enum is non-exhaustive.
Available options:
testkit
, walk_in_test
, at_home_phlebotomy
, on_site_collection
Defines whether order is priority or not. For some labs, this refers to a STAT order.
ℹ️ This enum is non-exhaustive.
Available options:
client_bill
, commercial_insurance
, patient_bill_passthrough
, patient_bill
Schedule an Order to be processed in a future date.
Response
Successful Response
Example:
{
"activate_by": "2020-01-01",
"created_at": "2020-01-01T00:00:00Z",
"details": {
"data": {
"created_at": "2020-01-01T00:00:00Z",
"id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7",
"shipment": {
"created_at": "2020-01-01T00:00:00.000Z",
"id": "d55210cc-3d9f-4115-8262-5013f700c7be",
"inbound_courier": "usps",
"inbound_tracking_number": "<inbound_tracking_number>",
"inbound_tracking_url": "<inbound_tracking_url>",
"notes": "<notes>",
"outbound_courier": "usps",
"outbound_tracking_number": "<outbound_tracking_number>",
"outbound_tracking_url": "<outbound_tracking_url>",
"updated_at": "2020-01-01T00:00:00.000Z"
},
"updated_at": "2020-01-01T00:00:00Z"
},
"type": "testkit"
},
"events": [
{
"created_at": "2022-01-01T00:00:00Z",
"id": 1,
"status": "received.testkit.ordered"
},
{
"created_at": "2022-01-02T00:00:00Z",
"id": 2,
"status": "received.testkit.requisition_created"
},
{
"created_at": "2022-01-03T00:00:00Z",
"id": 3,
"status": "collecting_sample.testkit.transit_customer"
}
],
"has_abn": false,
"health_insurace_id": "2c1e90e7-1428-49db-a8e8-55af6bb22ebc",
"id": "c43e6c5e-e461-4305-b7a1-4d6873517ce0",
"lab_test": {
"description": "Cholesterol test",
"method": "testkit",
"name": "Lipids Panel"
},
"notes": "This is a note",
"patient_address": {
"city": "San Francisco",
"country": "United States",
"first_line": "123 Main St.",
"phone_number": "+11234567890",
"receiver_name": "John Doe",
"second_line": "Apt. 208",
"state": "CA",
"zip": "91189"
},
"patient_details": { "dob": "2020-01-01", "gender": "male" },
"requisition_form_url": "https://www.example.com",
"sample_id": "123456789",
"status": "collecting_sample",
"team_id": "80dd811f-aa84-42cb-9bbc-dc6c0e13e980",
"updated_at": "2020-01-01T00:00:00Z",
"user_id": "b251576d-24ee-483d-ad17-4e33a1873038"
}