POST
/
v3
/
order

Authorizations

x-vital-api-key
string
headerrequired

Vital Team API Key

Body

application/json

Schema for the create Order endpoint.

user_id
string
required
patient_details
object
required
patient_address
object
required
lab_test_id
string | null
deprecated
order_set
object | null
collection_method
enum<string> | null

The method used to perform a lab test.

Available options:
testkit,
walk_in_test,
at_home_phlebotomy
physician
object | null
health_insurance
object | null
deprecated
priority
boolean
default: false

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

billing_type
enum<string>
Available options:
client_bill,
commercial_insurance,
patient_bill_passthrough,
patient_bill
icd_codes
string[] | null
consents
object[]
activate_by
string | null

Schedule an Order to be processed in a future date.

aoe_answers
object[] | null
passthrough
string | null

Response

200 - application/json
order
object
required
status
string
required
message
string
required