Skip to main content
GET
/
v3
/
order
/
{order_id}
from vital import Client

client = Client(
  api_key=<API_KEY>,
  environment="sandbox",
  region="us"
)

data = client.LabTests.get_order(order_id='<order_id>');

{
  "id": "0ee312e2-6773-4a21-a6e1-506882cd98ed",
  "team_id": "cbb64555-af07-46c1-be09-ef89308e9b60",
  "user_id": "94e2d9f2-d600-4a23-9f08-536df378e2c7",
  "patient_details": {
    "dob": "2020-01-01",
    "gender": "male"
  },
  "priority": false,
  "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"
  },
  "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"
    }
  ]
}

from vital import Client

client = Client(
  api_key=<API_KEY>,
  environment="sandbox",
  region="us"
)

data = client.LabTests.get_order(order_id='<order_id>');

{
  "id": "0ee312e2-6773-4a21-a6e1-506882cd98ed",
  "team_id": "cbb64555-af07-46c1-be09-ef89308e9b60",
  "user_id": "94e2d9f2-d600-4a23-9f08-536df378e2c7",
  "patient_details": {
    "dob": "2020-01-01",
    "gender": "male"
  },
  "priority": false,
  "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"
  },
  "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"
    }
  ]
}

Authorizations

​
x-vital-api-key
string
header
required

Vital Team API Key

Path Parameters

​
order_id
string<uuid>
required

Your Order ID.

Response

Successful Response

​
user_id
string<uuid>
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<uuid>
required

The Vital Order ID

​
team_id
string<uuid>
required

Your team id.

​
patient_details
object | null
required

Patient Details

​
patient_address
object | null
required

Patient Address

​
lab_test
object
required

The Vital Test associated with the order

Example:
{
  "lab_test": {
    "description": "Cholesterol test",
    "fasting": false,
    "has_collection_instructions": 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"
  }
}
​
details
object
required
  • ClientFacingWalkInOrderDetails
  • ClientFacingTestKitOrderDetails
  • ClientFacingAtHomePhlebotomyOrderDetails
  • ClientFacingOnSiteCollectionOrderDetails
​
sample_id
string | null
required

Sample ID

​
notes
string | null
required

Notes associated with the order

​
created_at
string<date-time>
required

When your order was created

​
updated_at
string<date-time>
required

When your order was last updated.

​
events
ClientFacingOrderEvent · object[]
required
​
health_insurance_id
string<uuid> | null
required

Vital ID of the health insurance.

​
requisition_form_url
string | null
required

DEPRECATED. Requistion form url.

​
shipping_details
object | null
required

Shipping Details. For unregistered testkit orders.

​
has_abn
boolean
required

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

​
status
enum<string> | null

ℹ️ This enum is non-exhaustive.

Available options:
received,
collecting_sample,
sample_with_lab,
completed,
cancelled,
failed
​
physician
object | null
​
priority
boolean
default:false

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

​
activate_by
string<date> | null

Schedule an Order to be processed in a future date.

​
passthrough
string | null
​
billing_type
enum<string>

ℹ️ This enum is non-exhaustive.

Available options:
client_bill,
commercial_insurance,
patient_bill_passthrough,
patient_bill
​
icd_codes
string[] | null
​
interpretation
enum<string> | null

Interpretation of the order result. Can be one of (normal, abnormal, critical). ℹ️ This enum is non-exhaustive.

Available options:
normal,
abnormal,
critical
​
has_missing_results
boolean | null

Defines whether the order result has missing biomarkers.

​
expected_result_by_date
string<date> | null

The common-case date by which the order result is expected to be available.

​
worst_case_result_by_date
string<date> | null

The latest date by which the order result is expected to be available.

⌘I