Create Order

POST

order

Authorization

Body

CreateOrderRequestCompatible · object

consents

Consents · array

health_insurance

HealthInsuranceCreateRequest · object

assessment_plan

Assessment Plan · string

back_image

Option 1 · object

content

Content · string

content_type

Content Type · enum<string>

diagnosis_codes

Diagnosis Codes · array

front_image

Option 1 · object

content

Content · string

content_type

Content Type · enum<string>

insurance_id

Insurance Id · string

patient_signature_image

Option 1 · object

content

Content · string

content_type

Content Type · enum<string>

payor_code

Payor Code · string

responsible_details

Responsible Details · object

address

Address · object

city

City · string

country

Country · string

first_line

First Line · string

second_line

Second Line · string

state

State · string

zip

Zip · string

first_name

First Name · string

last_name

Last Name · string

phone_number

Phone Number · string

phone_type

Phone Type · string

responsible_relationship

ResponsibleRelationship · enum<string>

subjective

Subjective · string

lab_test_id

Lab Test Id · string

patient_address

PatientAddressCompatible · object

city

City · string

country

Country · string

first_line

Street · string

phone_number

Phone Number · string

receiver_name

Receiver Name · string

second_line

Street Number · string

state

State · string

zip

Zip · string

patient_details

PatientDetails · object

dob

Dob · string

Email · string

first_name

First Name · string

gender

Gender · enum<string>

last_name

Last Name · string

phone_number

Phone Number · string

physician

PhysicianCreateRequest · object

Email · string

first_name

First Name · string

last_name

Last Name · string

licensed_states

Licensed States · array

npi

Npi · string

signature_image

Option 1 · object

content

Content · string

content_type

Content Type · enum<string>

priority

Priority · boolean

user_id

User Id · string

from vital.client import Vital
from vital.environment import VitalEnvironment
from vital.types.gender import Gender
from vital.types.patient_address_compatible import PatientAddressCompatible
from vital.types.patient_details import PatientDetails
from datetime import datetime

client = Vital(
  api_key="YOUR_API_KEY",
  environment=VitalEnvironment.SANDBOX
)

data = client.lab_tests.create_order(
    user_id="63661a2b-2bb3-4125-bb1a-b590f64f057f",
    lab_test_id="5b41f610-ebc5-4803-8f0c-a61c3bdc7faf",
    patient_details=PatientDetails(
        first_name="John",
        last_name="Doe",
        dob=datetime.fromisoformat("2020-01-01"),
        gender=Gender.MALE,
        phone_number="+1123456789",
        email="email@email.com"
    ),
    patient_address=PatientAddressCompatible(
      receiver_name="john Doe",
      first_line="123 Main St.",
      second_line="Apt. 208",
      city="San Francisco",
      state="CA",
      zip="91189",
      country="US",
      phone_number="+1123456789"
    ),
)

{
   "order": {
      "id": "ea7eae96-2c25-404f-b043-bfc08584610d",
      "team_id": "c26a9cc7-cdff-4f23-a5f6-74d40088c16a",
      "user_id": "63661a2b-2bb3-4125-bb1a-b590f64f057f",
      "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": "+1123456789"
      },
      "priority": false,
      "health_insurance_id": "33ec11aa-d8bf-4f46-950d-c9171be3c22f",
      "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",
      "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"
         }
      ]
   },
   "status": "string",
   "message": "string"
}

Authorizations

x-vital-api-key

string

headerrequired

API key based authentication

Body

application/json

consents

object[]

health_insurance

object

health_insurance.assessment_plan

string

Textual description of what are the physician assessments and testing plans.

health_insurance.back_image

object

An image of the back of the patient insurance card.

Option 1
Option 2

health_insurance.diagnosis_codes

string[]

Diagnosis codes for insurance billing.

health_insurance.front_image

object

An image of the front of the patient insurance card.

Option 1
Option 2

health_insurance.insurance_id

string

Insurance unique number assigned to a patient, usually present on the insurance card.

health_insurance.patient_signature_image

object

An image of the patient signature for health insurance billing.

Option 1
Option 2

health_insurance.payor_code

string

Unique identifier representing a specific Health Insurance.

health_insurance.responsible_details

object

Responsible details when the value of responsible_relationship is not 'Self'.

health_insurance.responsible_relationship

enum<string>

Relationship between the patient and the insurance contractor. Values can be (Self, Spouse, Other Relationship).

Available options:

Self,

Spouse,

Other Relationship

health_insurance.subjective

string

Textual description of what are the patient symptoms and attempted treatments.

lab_test_id

string

required

patient_address

object

required

patient_details

object

required

physician

object

priority

boolean

default: false

Defines whether order is priority or not. Only available for Labcorp. For Labcorp, this corresponds to a STAT order.

user_id

string

required

Response

200 - application/json

message

string

required

order

object

required

order.created_at

string

required

When your order was created

order.details

object

required

Option 1
Option 2
Option 3

order.events

object[]

required

order.health_insurance_id

string

Vital ID of the health insurance.

order.id

string

required

The Vital Order ID

order.lab_test

object

required

The Vital Test associated with the order

order.notes

string

Notes associated with the order

order.patient_address

object

Patient Address

order.patient_details

object

Patient Details

order.physician

object

order.priority

boolean

default: false

Defines whether order is priority or not. Only available for Labcorp. For Labcorp, this corresponds to a STAT order.

order.requisition_form_url

string

DEPRECATED. Requistion form url.

order.sample_id

string

Sample ID

order.shipping_details

object

Shipping Details. For unregistered testkit orders.

order.status

enum<string>

An enumeration.

Available options:

received,

collecting_sample,

sample_with_lab,

completed,

cancelled,

failed

order.team_id

string

required

Your team id.

order.updated_at

string

required

When your order was last updated.

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

status

string

required

Steps Get Orders

from vital.client import Vital
from vital.environment import VitalEnvironment
from vital.types.gender import Gender
from vital.types.patient_address_compatible import PatientAddressCompatible
from vital.types.patient_details import PatientDetails
from datetime import datetime

client = Vital(
  api_key="YOUR_API_KEY",
  environment=VitalEnvironment.SANDBOX
)

data = client.lab_tests.create_order(
    user_id="63661a2b-2bb3-4125-bb1a-b590f64f057f",
    lab_test_id="5b41f610-ebc5-4803-8f0c-a61c3bdc7faf",
    patient_details=PatientDetails(
        first_name="John",
        last_name="Doe",
        dob=datetime.fromisoformat("2020-01-01"),
        gender=Gender.MALE,
        phone_number="+1123456789",
        email="email@email.com"
    ),
    patient_address=PatientAddressCompatible(
      receiver_name="john Doe",
      first_line="123 Main St.",
      second_line="Apt. 208",
      city="San Francisco",
      state="CA",
      zip="91189",
      country="US",
      phone_number="+1123456789"
    ),
)

{
   "order": {
      "id": "ea7eae96-2c25-404f-b043-bfc08584610d",
      "team_id": "c26a9cc7-cdff-4f23-a5f6-74d40088c16a",
      "user_id": "63661a2b-2bb3-4125-bb1a-b590f64f057f",
      "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": "+1123456789"
      },
      "priority": false,
      "health_insurance_id": "33ec11aa-d8bf-4f46-950d-c9171be3c22f",
      "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",
      "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"
         }
      ]
   },
   "status": "string",
   "message": "string"
}

User

Providers

Link

Sleep

Meal

Workouts

Profile

Activity

Body

Timeseries

Lab Testing - Orders

Lab Testing - At-home Phlebotomy

Lab Testing - Tests

Lab Testing - Results

Lab Testing - Health Insurance

Create Order

Authorizations

Body

Option 1

Option 2

Option 1

Option 2

Option 1

Option 2

Option 1

Option 2

Response

Option 1

Option 2

Option 3