​
Properties

event_type
const string
required

Constant: labtest.order.created

team_id
string
required
user_id
string
required
client_user_id
string
required
data
ClientFacingOrder
required
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
anyOf
required

Patient Details Any of:

  • ClientFacingPatientDetailsCompatible
  • null
patient_address
anyOf
required

Patient Address Any of:

  • PatientAddressCompatible
  • null
lab_test
ClientFacingLabTest
required

The Vital Test associated with the order

id
string
required
slug
string
required
name
string
required
sample_type
enum<string>
required

Available options: dried_blood_spot, arm_collector, serum, saliva, urine.

method
enum<string>
required

Available options: testkit, walk_in_test, at_home_phlebotomy.

price
number
required
is_active
boolean
required

Deprecated. Use status instead.

status
enum<string>
required

Available options: active, pending_approval, inactive.

fasting
boolean | null

Defines whether a lab test requires fasting.

lab
anyOf
required

Any of:

  • ClientFacingLab
  • null
markers
anyOf
required

Any of:

  • array
  • null
is_delegated
boolean | null

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

auto_generated
boolean | null

Whether the lab test was auto-generated by Vital

details
anyOf
required

Any of:

  • ClientFacingWalkInOrderDetails
  • ClientFacingTestKitOrderDetails
  • ClientFacingAtHomePhlebotomyOrderDetails
sample_id
anyOf
required

Sample ID Any of:

  • string
  • null
notes
anyOf
required

Notes associated with the order Any of:

  • string
  • null
created_at
string
required

When your order was created

updated_at
string
required

When your order was last updated.

events
ClientFacingOrderEvent[]
required
id
integer
required
created_at
string
required
status
enum<string>
required

Available options: received.walk_in_test.ordered, received.walk_in_test.requisition_created, completed.walk_in_test.completed, sample_with_lab.walk_in_test.partial_results, failed.walk_in_test.sample_error, cancelled.walk_in_test.cancelled, collecting_sample.walk_in_test.appointment_pending, collecting_sample.walk_in_test.appointment_scheduled, collecting_sample.walk_in_test.appointment_cancelled, received.at_home_phlebotomy.ordered, received.at_home_phlebotomy.requisition_created, collecting_sample.at_home_phlebotomy.appointment_pending, collecting_sample.at_home_phlebotomy.appointment_scheduled, collecting_sample.at_home_phlebotomy.draw_completed, collecting_sample.at_home_phlebotomy.appointment_cancelled, completed.at_home_phlebotomy.completed, sample_with_lab.at_home_phlebotomy.partial_results, cancelled.at_home_phlebotomy.cancelled, failed.at_home_phlebotomy.sample_error, received.testkit.ordered, received.testkit.awaiting_registration, received.testkit.requisition_created, received.testkit.registered, collecting_sample.testkit.transit_customer, collecting_sample.testkit.out_for_delivery, collecting_sample.testkit.with_customer, collecting_sample.testkit.transit_lab, sample_with_lab.testkit.delivered_to_lab, completed.testkit.completed, failed.testkit.failure_to_deliver_to_customer, failed.testkit.failure_to_deliver_to_lab, failed.testkit.sample_error, failed.testkit.lost, cancelled.testkit.cancelled, cancelled.testkit.do_not_process.

status
anyOf | null

Any of:

  • OrderTopLevelStatus
  • null
physician
anyOf | null

Any of:

  • ClientFacingPhysician
  • null
health_insurance_id
anyOf
required

Vital ID of the health insurance. Any of:

  • string
  • null
requisition_form_url
anyOf
required

DEPRECATED. Requistion form url. Any of:

  • string
  • null
priority
boolean | null

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

shipping_details
anyOf
required

Shipping Details. For unregistered testkit orders. Any of:

  • ShippingAddress
  • null
activate_by
anyOf | null

Schedule an Order to be processed in a future date. Any of:

  • string
  • null
passthrough
anyOf | null

Any of:

  • string
  • null
billing_type
enum<string> | null

Available options: client_bill, commercial_insurance, patient_bill_passthrough, patient_bill.

icd_codes
anyOf | null

Any of:

  • array
  • null
labtest.order.updated