GET
/
v3
/
order
/
{order_id}

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.

id
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

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
status
enum<string> | null
Available options:
received,
collecting_sample,
sample_with_lab,
completed,
cancelled,
failed
physician
object | null
health_insurance_id
string | null
required

Vital ID of the health insurance.

requisition_form_url
string | null
required

DEPRECATED. Requistion form url.

priority
boolean
default: false

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

shipping_details
object | null
required

Shipping Details. For unregistered testkit orders.

activate_by
string | null

Schedule an Order to be processed in a future date.

passthrough
string | null
Get OrdersCancel Order