labtest.order.created

Lab Tests

Orders
- labtest.order.created
- labtest.order.updated
Results
Appointments

Provider

Summaries

Activity
Body
Meal
Menstrual Cycle
Profile
Sleep
Sleep Cycle
Workout
Workout Stream

Activity Timeseries

Calories Active
Calories Basal
Distance
Floors Climbed
Steps
VO2 Max
Workout Duration
Wheelchair Push
Stand Hour
Stand Duration
Fall

Vitals Timeseries

Blood Pressure
Blood Oxygen
Cholesterol
Electrocardiogram Voltage
Glucose
IGE
IGG
Insulin Injection
Heart rate
HRV
Respiratory Rate
Forced Expiratory Volume 1
Forced Vital Capacity
Peak Expiratory Flow Rate
Inhaler Usage

Body Timeseries

Body Fat
Body Weight
Body Mass Index
Lean Body Mass
Waist Circumference
Body Temperature
Body Temperature Delta
Basal Body Temperature

Diary Timeseries

Note

Nutrition Timeseries

Caffeine
Carbohydrates
Water

Wellness Timeseries

Sleep Apnea Alert
Sleep Breathing Disturbance
Mindfulness Minutes
Stress Level
UV Exposure
Daylight Exposure
Handwashing

event_type

enum<string>

required

Available options:

labtest.order.created,

labtest.order.updated

user_id

string

required

client_user_id

string

required

team_id

string

required

data

object

required

data.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.

data.id

string

required

The Vital Order ID

data.team_id

string

required

Your team id.

data.patient_details

object | null

required

Patient Details

data.patient_details.dob

string

required

data.patient_details.gender

string

required

data.patient_details.first_name

string | null

data.patient_details.last_name

string | null

data.patient_details.phone_number

string | null

data.patient_details.email

string | null

data.patient_details.medical_proxy

object | null

Parent/medical_proxy details. Required if patient is a minor.

data.patient_details.race

enum<string> | null

If not provided, will be set to 'Not Specified'

Available options:

african_american_or_black,

asian,

indigenous_native_american_alaska_native,

other,

pacific_islander_or_hawaiian,

white_caucasian

data.patient_details.ethnicity

enum<string> | null

If not provided, will be set to 'Not Specified'

Available options:

hispanic,

non_hispanic,

ashkenazi_jewish,

other

data.patient_details.sexual_orientation

enum<string> | null

If not provided, will be set to 'Not Specified'

Available options:

lesbian_gay_or_homosexual,

heterosexual_or_straight,

bisexual,

dont_know,

other

data.patient_details.gender_identity

enum<string> | null

If not provided, will be set to 'Not Specified'

Available options:

male,

female,

female_to_male_ftm_transgender_male_trans_man,

male_to_female_mtf_transgender_female_trans_woman,

genderqueer,

other

data.patient_address

object | null

required

Patient Address

data.lab_test

object

required

The Vital Test associated with the order

data.lab_test.id

string

required

data.lab_test.slug

string

required

data.lab_test.name

string

required

data.lab_test.sample_type

enum<string>

required

Available options:

dried_blood_spot,

arm_collector,

serum,

saliva,

urine

data.lab_test.method

enum<string>

required

Available options:

testkit,

walk_in_test,

at_home_phlebotomy

data.lab_test.price

number

required

data.lab_test.is_active

boolean

required

Deprecated. Use status instead.

data.lab_test.status

enum<string>

required

Available options:

active,

pending_approval,

inactive

data.lab_test.lab

object | null

required

Example:

{
  "city": "San Francisco",
  "collection_methods": ["testkit"],
  "first_line_address": "123 Main St",
  "id": 1,
  "name": "LabCorp",
  "sample_types": ["saliva"],
  "slug": "labcorp",
  "zipcode": "91789"
}

data.lab_test.markers

object[] | null

required

data.lab_test.fasting

boolean

default:false

Defines whether a lab test requires fasting.

data.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.

data.lab_test.auto_generated

boolean

default:false

Whether the lab test was auto-generated by Vital

Example:

{
  "lab_test": {
    "description": "Cholesterol test",
    "fasting": false,
    "is_delegated": false,
    "lab": {
      "city": "New York",
      "first_line_address": "123 Main St",
      "name": "US Specialty Lab",
      "slug": "USSL",
      "zipcode": "10001"
    },
    "markers": [
      {
        "description": "Hemoglobin A1c is a form of hemoglobin that is measured identify your average blood sugar levels over the past 3 months.",
        "id": 1,
        "lab_id": 1,
        "name": "Hemoglobin A1c",
        "price": "10.00",
        "provider_id": "1234",
        "slug": "hemoglobin-a1c",
        "type": "biomarker",
        "unit": "%"
      }
    ],
    "method": "testkit",
    "name": "Lipids Panel",
    "price": 10,
    "sample_type": "dried blood spot",
    "status": "active"
  }
}

data.details

object

required

data.details.type

string

required

Allowed value: "walk_in_test"

data.details.data

object | null

Schema for a walk-in test order in the client facing API.

To be used as part of a ClientFacingOrder.

Example:

{
  "appointment_id": "ba72deb6-74dd-4db7-99c2-e57c969c7c16",
  "created_at": "2020-01-01T00:00:00Z",
  "id": "1f69ce6a-e21c-445a-91f7-9803c8460495",
  "updated_at": "2020-01-01T00:00:00Z"
}

data.sample_id

string | null

required

Sample ID

data.notes

string | null

required

Notes associated with the order

data.created_at

string

required

When your order was created

data.updated_at

string

required

When your order was last updated.

data.events

object[]

required

data.health_insurance_id

string | null

required

Vital ID of the health insurance.

data.requisition_form_url

string | null

required

DEPRECATED. Requistion form url.

data.shipping_details

object | null

required

Shipping Details. For unregistered testkit orders.

data.has_abn

boolean

required

Defines whether the order has an Advanced Beneficiary Notice (ABN) form or not.

data.status

enum<string> | null

ℹ️ This enum is non-exhaustive.

Available options:

received,

collecting_sample,

sample_with_lab,

completed,

cancelled,

failed

data.physician

object | null

data.priority

boolean

default:false

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

data.activate_by

string | null

Schedule an Order to be processed in a future date.

data.passthrough

string | null

data.billing_type

enum<string>

default:client_bill

ℹ️ This enum is non-exhaustive.

Available options:

client_bill,

commercial_insurance,

patient_bill_passthrough,

patient_bill

data.icd_codes

string[] | null

Example:

{
  "activate_by": "2020-01-01",
  "created_at": "2020-01-01T00:00:00Z",
  "details": {
    "data": {
      "created_at": "2020-01-01T00:00:00Z",
      "id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7",
      "shipment": {
        "created_at": "2020-01-01T00:00:00.000Z",
        "id": "d55210cc-3d9f-4115-8262-5013f700c7be",
        "inbound_courier": "usps",
        "inbound_tracking_number": "<inbound_tracking_number>",
        "inbound_tracking_url": "<inbound_tracking_url>",
        "notes": "<notes>",
        "outbound_courier": "usps",
        "outbound_tracking_number": "<outbound_tracking_number>",
        "outbound_tracking_url": "<outbound_tracking_url>",
        "updated_at": "2020-01-01T00:00:00.000Z"
      },
      "updated_at": "2020-01-01T00:00:00Z"
    },
    "type": "testkit"
  },
  "events": [
    {
      "created_at": "2022-01-01T00:00:00Z",
      "id": 1,
      "status": "received.testkit.ordered"
    },
    {
      "created_at": "2022-01-02T00:00:00Z",
      "id": 2,
      "status": "received.testkit.requisition_created"
    },
    {
      "created_at": "2022-01-03T00:00:00Z",
      "id": 3,
      "status": "collecting_sample.testkit.transit_customer"
    }
  ],
  "has_abn": false,
  "health_insurace_id": "588f338a-9472-47fa-8ba8-76fa6bc5f648",
  "id": "d54f0790-452d-4238-a55e-ca0b7970b25e",
  "lab_test": {
    "description": "Cholesterol test",
    "method": "testkit",
    "name": "Lipids Panel"
  },
  "notes": "This is a note",
  "patient_address": {
    "city": "San Francisco",
    "country": "United States",
    "first_line": "123 Main St.",
    "phone_number": "+11234567890",
    "receiver_name": "John Doe",
    "second_line": "Apt. 208",
    "state": "CA",
    "zip": "91189"
  },
  "patient_details": { "dob": "2020-01-01", "gender": "male" },
  "requisition_form_url": "https://www.example.com",
  "sample_id": "123456789",
  "status": "collecting_sample",
  "team_id": "7d0a12e8-3442-4d32-a2f8-08ce0b022f12",
  "updated_at": "2020-01-01T00:00:00Z",
  "user_id": "d41dce42-e16a-43d2-b2f1-f1eb032d75c9"
}

labtest.order.updated

{
  "event_type": "labtest.order.created",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "client_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "activate_by": "2020-01-01",
    "created_at": "2020-01-01T00:00:00Z",
    "details": {
      "data": {
        "created_at": "2020-01-01T00:00:00Z",
        "id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7",
        "shipment": {
          "created_at": "2020-01-01T00:00:00.000Z",
          "id": "d55210cc-3d9f-4115-8262-5013f700c7be",
          "inbound_courier": "usps",
          "inbound_tracking_number": "<inbound_tracking_number>",
          "inbound_tracking_url": "<inbound_tracking_url>",
          "notes": "<notes>",
          "outbound_courier": "usps",
          "outbound_tracking_number": "<outbound_tracking_number>",
          "outbound_tracking_url": "<outbound_tracking_url>",
          "updated_at": "2020-01-01T00:00:00.000Z"
        },
        "updated_at": "2020-01-01T00:00:00Z"
      },
      "type": "testkit"
    },
    "events": [
      {
        "created_at": "2022-01-01T00:00:00Z",
        "id": 1,
        "status": "received.testkit.ordered"
      },
      {
        "created_at": "2022-01-02T00:00:00Z",
        "id": 2,
        "status": "received.testkit.requisition_created"
      },
      {
        "created_at": "2022-01-03T00:00:00Z",
        "id": 3,
        "status": "collecting_sample.testkit.transit_customer"
      }
    ],
    "has_abn": false,
    "health_insurace_id": "588f338a-9472-47fa-8ba8-76fa6bc5f648",
    "id": "d54f0790-452d-4238-a55e-ca0b7970b25e",
    "lab_test": {
      "description": "Cholesterol test",
      "method": "testkit",
      "name": "Lipids Panel"
    },
    "notes": "This is a note",
    "patient_address": {
      "city": "San Francisco",
      "country": "United States",
      "first_line": "123 Main St.",
      "phone_number": "+11234567890",
      "receiver_name": "John Doe",
      "second_line": "Apt. 208",
      "state": "CA",
      "zip": "91189"
    },
    "patient_details": {
      "dob": "2020-01-01",
      "gender": "male"
    },
    "requisition_form_url": "https://www.example.com",
    "sample_id": "123456789",
    "status": "collecting_sample",
    "team_id": "7d0a12e8-3442-4d32-a2f8-08ce0b022f12",
    "updated_at": "2020-01-01T00:00:00Z",
    "user_id": "d41dce42-e16a-43d2-b2f1-f1eb032d75c9"
  }
}