Get Order

Authorizations

x-vital-api-key

string

headerrequired

Vital Team API Key

Path Parameters

order_id

string

required

Your Order ID.

Response

200 - application/json

user_id

string

required

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.

string

required

The Vital Order ID

team_id

string

required

Your team id.

patient_details

object | null

required

Patient Details

patient_address

object | null

required

Patient Address

lab_test

object

required

The Vital Test associated with the order

lab_test.id

string

required

lab_test.slug

string

required

lab_test.name

string

required

lab_test.sample_type

enum<string>

required

Available options:

dried_blood_spot,

arm_collector,

serum,

saliva,

urine

lab_test.method

enum<string>

required

Available options:

testkit,

walk_in_test,

at_home_phlebotomy

lab_test.price

number

required

lab_test.is_active

boolean

required

Deprecated. Use status instead.

lab_test.status

enum<string>

required

Available options:

active,

pending_approval,

inactive

lab_test.lab

object | null

required

lab_test.markers

object[] | null

required

lab_test.fasting

boolean

default: false

Defines whether a lab test requires fasting.

lab_test.is_delegated

boolean

default: false

Denotes whether a lab test requires using non-Vital physician networks. If it does then it's delegated - no otherwise.

lab_test.auto_generated

boolean

default: false

Whether the lab test was auto-generated by Vital

details

object

required

sample_id

string | null

required

Sample ID

notes

string | null

required

Notes associated with the order

created_at

string

required

When your order was created

updated_at

string

required

When your order was last updated.

events

object[]

required

health_insurance_id

string | null

required

Vital ID of the health insurance.

requisition_form_url

string | null

required

DEPRECATED. Requistion form url.

shipping_details

object | null

required

Shipping Details. For unregistered testkit orders.

status

enum<string> | null

Available options:

received,

collecting_sample,

sample_with_lab,

completed,

cancelled,

failed

physician

object | null

priority

boolean

default: false

Defines whether order is priority or not. For some labs, this refers to a STAT order.

activate_by

string | null

Schedule an Order to be processed in a future date.

passthrough

string | null

billing_type

enum<string>

Available options:

client_bill,

commercial_insurance,

patient_bill_passthrough,

patient_bill

icd_codes

string[] | null

Orders

Area Info

At-home Phlebotomy

Patient Service Center (PSC)

Tests

Results

Health Insurance

Authorizations

Path Parameters

Response