Vital home pagelight logo
Lab Testing
Get Order
GET

/v3/order/{order_id}

x-vital-api-key*
curl --request GET \
  --url https://api.tryvital.io/v3/order/{order_id} \
  --header 'x-vital-api-key: <x-vital-api-key>'
from vital import Client

client = Client(api_key, "sandbox")

data = client.LabTests.get_order("<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"
  },
  "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"
    }
  ]
}

​
Path Parameters

order_idrequired
string

Your Order ID.

​
Response

created_atrequired
string

When your order was created

detailsrequired

Details

eventsrequired
array
health_insurance_id
string

Vital ID of the health insurance.

idrequired
string

The Vital Order ID

lab_testrequired
object

The Vital Test associated with the order

notes
string

Notes associated with the order

patient_addressrequired
object

Patient Address

patient_detailsrequired
object

Patient Details

physician
object

PhysicianClientFacing

requisition_form_url
string

Requistion form url.

sample_id
string

Sample ID

status
string

An enumeration.

Available options:
received,
collecting_sample,
sample_with_lab,
completed,
cancelled,
failed
team_idrequired
string

Your team id.

updated_atrequired
string

When your order was last updated

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

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.