v71

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-032076961.5 MB

order

Get Order

GET individual order by ID.

get/v3/order/{order_id}

Path parameters

order_idstring uuid required

Your Order ID.

Response

Successful Response

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

idstring uuid required

The Vital Order ID

team_idstring uuid required

Your team id.

sample_idstring nullable required

Sample ID

notesstring nullable required

Notes associated with the order

clinical_notesstring nullable

created_atstring date-time required

When your order was created

updated_atstring date-time required

When your order was last updated.

ℹ️ This enum is non-exhaustive.

health_insurance_idstring uuid nullable required

Vital ID of the health insurance.

requisition_form_urlstring nullable required

DEPRECATED. Requistion form url.

priorityboolean

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

activate_bystring date nullable

Schedule an Order to be processed in a future date.

passthroughstring nullable

billing_type'client_bill' | 'commercial_insurance' | 'patient_bill_passthrough' | 'patient_bill'

ℹ️ This enum is non-exhaustive.

icd_codesstring[] nullable

has_abnboolean required

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

interpretation'normal' | 'abnormal' | 'critical' | 'unknown'

ℹ️ This enum is non-exhaustive.

has_missing_resultsboolean nullable

Defines whether the order result has missing biomarkers.

expected_result_by_datestring date nullable

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

worst_case_result_by_datestring date nullable

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

origin'initial' | 'redraw' | 'recreation'

ℹ️ This enum is non-exhaustive.

Example response

{
  "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"
    }
  ],
  "has_abn": false,
  "health_insurace_id": "cf36a74f-c24e-474b-ba6a-683dba898745",
  "id": "e80b8ddb-04f5-40a8-921c-3f81ec936ed6",
  "lab_test": {
    "description": "Cholesterol test",
    "method": "testkit",
    "name": "Lipids Panel"
  },
  "last_event": {
    "created_at": "2022-01-03T00:00:00Z",
    "id": 3,
    "status": "collecting_sample.testkit.transit_customer"
  },
  "notes": "This is a note",
  "order_transaction": {
    "id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7",
    "orders": [
      {
        "created_at": "2020-01-01T00:00:00Z",
        "id": "d55210cc-3d9f-4115-8262-5013f700c7be",
        "low_level_status": "transit_customer",
        "low_level_status_created_at": "2020-01-05T00:00:00Z",
        "origin": "initial",
        "updated_at": "2020-01-05T00:00:00Z"
      },
      {
        "created_at": "2020-01-05T01:00:00Z",
        "id": "e66321dd-4e0g-5226-9373-6124g811d8cf",
        "low_level_status": "requisition_created",
        "low_level_status_created_at": "2020-01-05T01:00:00Z",
        "origin": "redraw",
        "updated_at": "2020-01-05T01:00:00Z"
      }
    ],
    "status": "active"
  },
  "origin": "initial",
  "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": "89f5d2ab-507a-423a-bb51-9b2b58c6eba2",
  "updated_at": "2020-01-01T00:00:00Z",
  "user_id": "47f6af56-da87-4b1d-bf95-023c970e3769"
}