TRtryvital
lab_tests

Create Lab Test For Team

Changed on
post/v3/lab_tests

Request

  • Base URL
    https://api.us.junction.com
  • URL
    https://api.us.junction.com/v3/lab_tests
  • Auth
    API key in header x-vital-api-key

Request body

marker_idsinteger[] nullable
provider_idsstring[] nullable
namestring required
method'testkit' | 'walk_in_test' | 'at_home_phlebotomy' | 'on_site_collection' required

The method used to perform a lab test. ℹ️ This enum is non-exhaustive.

descriptionstring required
fastingboolean nullable
lab_account_idstring uuid nullable
lab_slug'ayumetrix' | 'spiriplex' | 'ussl' | 'quest' | 'sonora_quest' | 'labcorp' | 'bioreference' | 'us_biotek' | 'manual' | 'sanocardio' | 'ihd' | 'nexus' | 'my_uti' | 'crl' | 'mtl'

ℹ️ This enum is non-exhaustive.

Response

Successful Response

idstring uuid required
versioninteger nullable

Immutable marker-set version represented by this response.

slugstring required
namestring required
sample_type'dried_blood_spot' | 'arm_collector' | 'serum' | 'saliva' | 'urine' | 'stool' required

The type of sample used to perform a lab test. ℹ️ This enum is non-exhaustive.

method'testkit' | 'walk_in_test' | 'at_home_phlebotomy' | 'on_site_collection' required

The method used to perform a lab test. ℹ️ This enum is non-exhaustive.

pricenumber required
is_activeboolean required

Deprecated. Use status instead.

status'active' | 'pending_approval' | 'inactive' required

ℹ️ This enum is non-exhaustive.

fastingboolean

Defines whether a lab test requires fasting.

is_delegatedboolean

Deprecated and always false. Delegation is now at the lab account level. Used to denote whether a lab test requires using non-Vital physician networks.

auto_generatedboolean

Whether the lab test was auto-generated by Vital

source_sandbox_lab_test_idstring uuid nullable
has_collection_instructionsboolean nullable

Whether or not the lab test has collection instructions.

common_tat_daysinteger nullable

The common turnaround time in days for the lab test. This is the expected time for the lab to process the test and return results. Uses their legacy or percentile-based values. Null if any included marker lacks a common or worst-case estimate.

worst_case_tat_daysinteger nullable

The worst-case turnaround time in days for the lab test. This is the maximum time the lab may take to process the test and return results. Uses their legacy or percentile-based values. Null if any included marker lacks a common or worst-case estimate.

updated_atstring date-time required

Example response

{
  "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"
  },
  "updated_at": "2020-01-01T00:00:00Z"
}

Changes

  • 8132a215da01Revision changes
    • info

      response property markers/anyOf[subschema #1]/items/price deprecated

    • info

      response property price deprecated

  • b1aa5d5cc8c0Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      response property markers/anyOf[subschema #1]/items/common_tat_days deprecated

    • info

      response property markers/anyOf[subschema #1]/items/worst_case_tat_days deprecated