Skip to main content
POST
Patient name fields (first_name, last_name) must follow specific validation rules due to lab restrictions. See Patient Name Validation for complete details.

Authorizations

x-vital-api-key
string
header
required

Vital Team API Key

Headers

X-Idempotency-Key
string | null
X-Idempotency-Error
string | null
Allowed value: "no-cache"

Body

application/json

Schema for the create Order endpoint.

user_id
string<uuid>
required
patient_details
PatientDetailsWithValidation · object
required

Patient details with validation for first_name, last_name, email, and dob.

patient_address
PatientAddressWithValidation · object
required
lab_test_id
string<uuid> | null
deprecated
order_set
OrderSetRequest · object | null
collection_method
enum<string> | null

ℹ️ This enum is non-exhaustive.

Available options:
testkit,
walk_in_test,
at_home_phlebotomy,
on_site_collection
physician
PhysicianCreateRequest · object | null
health_insurance
HealthInsuranceCreateRequest · 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>
default:client_bill

ℹ️ This enum is non-exhaustive.

Available options:
client_bill,
commercial_insurance,
patient_bill_passthrough,
patient_bill
icd_codes
string[] | null
consents
Consent · object[]
activate_by
string<date> | null

Schedule an Order to be processed in a future date.

aoe_answers
AoEAnswer · object[] | null
passthrough
string | null
clinical_notes
string | null
lab_account_id
string<uuid> | null
creator_member_id
string<uuid> | null

Response

Successful Response

order
ClientFacingOrder · object
required
Example:
status
string
required
message
string
required