Vital home pagelight logo
Lab Tests
labtest.order.created

​
Properties

event_typerequired
const string

Constant: labtest.order.created

datarequired
ClientFacingOrder
user_idrequired
string

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.

user_key
string | null

[⚠️ Deprecated] User key returned by vital create user key request. This key should be stored in your database against the user and used for all interactions with the vital api.

idrequired
string

The Vital Order ID

team_idrequired
string

Your team id.

patient_detailsrequired
ClientFacingPatientDetailsCompatible

Patient Details

first_name
string | null
last_name
string | null
dobrequired
string
genderrequired
string
phone_number
string | null
email
string | null
patient_addressrequired
PatientAddressCompatible

Patient Address

receiver_name
string | null
streetrequired
string
street_number
string | null
cityrequired
string
staterequired
string
ziprequired
string
countryrequired
string
phone_number
string | null
lab_testrequired
ClientFacingLabTest

The Vital Test associated with the order

idrequired
string
slugrequired
string
namerequired
string
sample_typerequired
LabTestSampleType
methodrequired
LabTestMethod
pricerequired
number
is_activerequired
boolean
lab
ClientFacingLab | null
idrequired
integer
slugrequired
string
namerequired
string
first_line_addressrequired
string
cityrequired
string
zipcoderequired
string
markers
ClientFacingMarker[] | null
idrequired
integer
namerequired
string
slugrequired
string
description
string | null
lab_id
integer | null
provider_id
string | null
type
MarkerType | null
unit
string | null
price
string | null
detailsrequired
anyOf
sample_id
string | null

Sample ID

notes
string | null

Notes associated with the order

created_atrequired
string

When your order was created

updated_atrequired
string

When your order was last updated

eventsrequired
ClientFacingOrderEvent[]
idrequired
integer
created_atrequired
string
statusrequired
OrderV2Status
status
OrderV2TopLevelStatus | null
physician
PhysicianClientFacing | null
first_namerequired
string
last_namerequired
string
npirequired
string
health_insurance_id
string | null

Vital ID of the health insurance.

requisition_form_url
string | null

Requistion form url.

​
Examples

{
  "event_type": "labtest.order.created",
  "data": {
    "id": "95695249-3a3d-4d03-8f9e-ae80f017590b",
    "team_id": "82aa93d1-4a00-41f1-a677-f15eb9d49813",
    "user_id": "51edb7f1-f77d-462a-b322-e8f4a93d7b28",
    "patient_details": {
      "dob": "2020-01-01",
      "gender": "male"
    },
    "patient_address": {
      "receiver_name": "John Doe",
      "first_line": "123 Main St.",
      "second_line": "Apt. 208",
      "city": "San Francisco",
      "state": "CA",
      "zip": "91189",
      "country": "United States",
      "phone_number": "+11234567890"
    },
    "details": {
      "type": "testkit",
      "data": {
        "id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7",
        "shipment": {
          "id": "d55210cc-3d9f-4115-8262-5013f700c7be",
          "outbound_tracking_number": "<outbound_tracking_number>",
          "outbound_tracking_url": "<outbound_tracking_url>",
          "inbound_tracking_number": "<inbound_tracking_number>",
          "inbound_tracking_url": "<inbound_tracking_url>",
          "outbound_courier": "usps",
          "inbound_courier": "usps",
          "notes": "<notes>",
          "created_at": "2020-01-01T00:00:00.000Z",
          "updated_at": "2020-01-01T00:00:00.000Z"
        },
        "created_at": "2020-01-01T00:00:00Z",
        "updated_at": "2020-01-01T00:00:00Z"
      }
    },
    "lab_test": {
      "name": "Lipids Panel",
      "description": "Cholesterol test",
      "method": "testkit"
    },
    "sample_id": "123456789",
    "health_insurace_id": "d0a95372-446a-4ac7-ab0a-fef8808874e6",
    "requisition_form_url": "https://www.example.com",
    "notes": "This is a note",
    "created_at": "2020-01-01T00:00:00Z",
    "updated_at": "2020-01-01T00:00:00Z",
    "status": "collecting_sample",
    "events": [
      {
        "id": 1,
        "created_at": "2022-01-01T00:00:00Z",
        "status": "received.testkit.ordered"
      },
      {
        "id": 2,
        "created_at": "2022-01-02T00:00:00Z",
        "status": "received.testkit.requisition_created"
      },
      {
        "id": 3,
        "created_at": "2022-01-03T00:00:00Z",
        "status": "collecting_sample.testkit.transit_customer"
      }
    ]
  }
}