Create Unregistered Testkit Order

POST

order

testkit

from vital import Client

client = Client(api_key, "sandbox")

data = client.LabTests.create_unregistered_testkit_order(
  user_id="63661a2b-2bb3-4125-bb1a-b590f64f057f",
  lab_test_id="5b41f610-ebc5-4803-8f0c-a61c3bdc7faf",
  shipping_details={
    "receiver_name": "john Doe",
    "street": "123 Main St.",
    "street_number": "Apt. 208",
    "city": "San Francisco",
    "state": "CA",
    "zip": "91189",
    "country": "US",
    "phone_number": "+11234567890"
  }
)

"order": {
    "id": "96edc6ef-3b2c-412b-b9e5-96f361f93aec",
    "team_id": "b080b20c-e162-4cf1-9c7d-8faee72ee08e",
    "user_id": "9f1e094e-1641-466b-b668-d4d3300e569f",
    "shipping_details": {
      "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",
        "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": "7695cc28-f9e5-400d-95d2-ec7d9ec580df",
    "notes": "This is a note",
    "created_at": "2020-01-01T00:00:00Z",
    "updated_at": "2020-01-01T00:00:00Z",
    "status": "received",
    "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.awaiting_registration"
      },
    ]
  },
  "status": "string",
  "message": "string"
}

from vital import Client

client = Client(api_key, "sandbox")

data = client.LabTests.create_unregistered_testkit_order(
  user_id="63661a2b-2bb3-4125-bb1a-b590f64f057f",
  lab_test_id="5b41f610-ebc5-4803-8f0c-a61c3bdc7faf",
  shipping_details={
    "receiver_name": "john Doe",
    "street": "123 Main St.",
    "street_number": "Apt. 208",
    "city": "San Francisco",
    "state": "CA",
    "zip": "91189",
    "country": "US",
    "phone_number": "+11234567890"
  }
)

"order": {
    "id": "96edc6ef-3b2c-412b-b9e5-96f361f93aec",
    "team_id": "b080b20c-e162-4cf1-9c7d-8faee72ee08e",
    "user_id": "9f1e094e-1641-466b-b668-d4d3300e569f",
    "shipping_details": {
      "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",
        "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": "7695cc28-f9e5-400d-95d2-ec7d9ec580df",
    "notes": "This is a note",
    "created_at": "2020-01-01T00:00:00Z",
    "updated_at": "2020-01-01T00:00:00Z",
    "status": "received",
    "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.awaiting_registration"
      },
    ]
  },
  "status": "string",
  "message": "string"
}

Authorizations

x-vital-api-key

string

header

required

Vital Team API Key

Body

application/json

user_id

string

required

lab_test_id

string

required

shipping_details

object

required

passthrough

string | null

Response

200

application/json

Successful Response

order

object

required

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.

order.id

string

required

The Vital Order ID

order.team_id

string

required

Your team id.

order.patient_details

object | null

required

Patient Details

order.patient_address

object | null

required

Patient Address

order.lab_test

object

required

The Vital Test associated with the order

order.lab_test.id

string

required

order.lab_test.slug

string

required

order.lab_test.name

string

required

order.lab_test.sample_type

enum<string>

required

Available options:

dried_blood_spot,

arm_collector,

serum,

saliva,

urine

order.lab_test.method

enum<string>

required

Available options:

testkit,

walk_in_test,

at_home_phlebotomy

order.lab_test.price

number

required

order.lab_test.is_active

boolean

required

Deprecated. Use status instead.

order.lab_test.status

enum<string>

required

Available options:

active,

pending_approval,

inactive

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

order.lab_test.markers

object[] | null

required

order.lab_test.fasting

boolean

default:false

Defines whether a lab test requires fasting.

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

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

order.details

object

required

order.details.type

enum<string>

required

Available options:

walk_in_test

order.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": "a608f30e-7a0f-4e1b-b53a-a87a549cd890",
  "created_at": "2020-01-01T00:00:00Z",
  "id": "688654c9-98b3-478a-ad64-bbbeb600f694",
  "updated_at": "2020-01-01T00:00:00Z"
}

order.sample_id

string | null

required

Sample ID

order.notes

string | null

required

Notes associated with the order

order.created_at

string

required

When your order was created

order.updated_at

string

required

When your order was last updated.

order.events

object[]

required

order.health_insurance_id

string | null

required

Vital ID of the health insurance.

order.requisition_form_url

string | null

required

DEPRECATED. Requistion form url.

order.shipping_details

object | null

required

Shipping Details. For unregistered testkit orders.

order.status

enum<string> | null

Available options:

received,

collecting_sample,

sample_with_lab,

completed,

cancelled,

failed

order.physician

object | null

order.priority

boolean

default:false

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

order.activate_by

string | null

Schedule an Order to be processed in a future date.

order.passthrough

string | null

order.billing_type

enum<string>

Available options:

client_bill,

commercial_insurance,

patient_bill_passthrough,

patient_bill

order.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"
    }
  ],
  "health_insurace_id": "9b83bea9-7c9c-4b40-99b9-da9f248fd99a",
  "id": "3f5c1016-952d-4033-8f27-8f644ad5c2d0",
  "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": "dc957cca-e5b2-46ec-b3d8-8e66ccd1d182",
  "updated_at": "2020-01-01T00:00:00Z",
  "user_id": "e1940a13-0ae7-42d2-bc53-8c00832c612d"
}

status

string

required

message

string

required

Get Requisition Form PDF Register Testkit Order

from vital import Client

client = Client(api_key, "sandbox")

data = client.LabTests.create_unregistered_testkit_order(
  user_id="63661a2b-2bb3-4125-bb1a-b590f64f057f",
  lab_test_id="5b41f610-ebc5-4803-8f0c-a61c3bdc7faf",
  shipping_details={
    "receiver_name": "john Doe",
    "street": "123 Main St.",
    "street_number": "Apt. 208",
    "city": "San Francisco",
    "state": "CA",
    "zip": "91189",
    "country": "US",
    "phone_number": "+11234567890"
  }
)

"order": {
    "id": "96edc6ef-3b2c-412b-b9e5-96f361f93aec",
    "team_id": "b080b20c-e162-4cf1-9c7d-8faee72ee08e",
    "user_id": "9f1e094e-1641-466b-b668-d4d3300e569f",
    "shipping_details": {
      "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",
        "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": "7695cc28-f9e5-400d-95d2-ec7d9ec580df",
    "notes": "This is a note",
    "created_at": "2020-01-01T00:00:00Z",
    "updated_at": "2020-01-01T00:00:00Z",
    "status": "received",
    "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.awaiting_registration"
      },
    ]
  },
  "status": "string",
  "message": "string"
}

Orders

Area Info

At-home Phlebotomy

Patient Service Center (PSC)

Tests

Results

Health Insurance

Create Unregistered Testkit Order

Authorizations

Body

Response