Skip to main content
GET
/
v3
/
order_transaction
/
{transaction_id}
/
result
curl --request GET \
     --url '{{BASE_URL}}/v3/order_transaction/<transaction_id>/result' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: {YOUR_KEY}'

{
  "metadata": {
    "age": 19,
    "dob": "18/08/1993",
    "clia_number": "12331231",
    "patient": "Bob Smith",
    "provider": "Dr. Jack Smith",
    "laboratory": "LabCorp",
    "date_reported": "2020-01-01",
    "date_collected": "2022-02-02",
    "specimen_number": "123131",
    "date_received": "2022-01-01",
    "status": "final",
    "interpretation": "abnormal"
  },
  "results": [
    {
      "name": "Sex Horm Binding Glob, Serum",
      "slug": "sex-horm-binding-glob-serum",
      "value": 30.4,
      "result": "30.4",
      "type": "numeric",
      "unit": "nmol/L",
      "timestamp": "2024-10-31T09:08:00+00:00",
      "notes": "Final",
      "min_range_value": 24.6,
      "max_range_value": 122,
      "is_above_max_range": false,
      "is_below_min_range": false,
      "interpretation": "normal",
      "loinc": "13967-5",
      "loinc_slug": "sex-hormone-binding-globulin-moles-vol",
      "provider_id": "082016",
      "source_markers": [
        {
          "marker_id": 229,
          "name": "Testosterone Free, Profile I",
          "slug": "testosterone-free-profile-i",
          "provider_id": "140226"
        }
      ]
    }
  ],
  "order_transaction": {
    "id": "6424dd45-ee1a-49c6-ad0c-5769b8e03fc1",
    "status": "completed",
    "orders": [
      {
        "id": "84d96c03-6b1c-4226-ad8f-ef44a6bc08af",
        "created_at": "2020-01-01T00:00:00Z",
        "updated_at": "2022-01-04T00:00:00Z",
        "low_level_status": "redraw_available",
        "low_level_status_created_at": "2022-01-04T00:00:00Z",
        "origin": "initial"
      },
      {
        "id": "15db29d7-ffeb-4540-9513-3c38f26b87aa",
        "created_at": "2020-01-10T00:00:00Z",
        "updated_at": "2022-01-14T00:00:00Z",
        "low_level_status": "completed",
        "low_level_status_created_at": "2022-01-14T00:00:00Z",
        "origin": "redraw"
      }
    ]
  }
}

curl --request GET \
     --url '{{BASE_URL}}/v3/order_transaction/<transaction_id>/result' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: {YOUR_KEY}'

{
  "metadata": {
    "age": 19,
    "dob": "18/08/1993",
    "clia_number": "12331231",
    "patient": "Bob Smith",
    "provider": "Dr. Jack Smith",
    "laboratory": "LabCorp",
    "date_reported": "2020-01-01",
    "date_collected": "2022-02-02",
    "specimen_number": "123131",
    "date_received": "2022-01-01",
    "status": "final",
    "interpretation": "abnormal"
  },
  "results": [
    {
      "name": "Sex Horm Binding Glob, Serum",
      "slug": "sex-horm-binding-glob-serum",
      "value": 30.4,
      "result": "30.4",
      "type": "numeric",
      "unit": "nmol/L",
      "timestamp": "2024-10-31T09:08:00+00:00",
      "notes": "Final",
      "min_range_value": 24.6,
      "max_range_value": 122,
      "is_above_max_range": false,
      "is_below_min_range": false,
      "interpretation": "normal",
      "loinc": "13967-5",
      "loinc_slug": "sex-hormone-binding-globulin-moles-vol",
      "provider_id": "082016",
      "source_markers": [
        {
          "marker_id": 229,
          "name": "Testosterone Free, Profile I",
          "slug": "testosterone-free-profile-i",
          "provider_id": "140226"
        }
      ]
    }
  ],
  "order_transaction": {
    "id": "6424dd45-ee1a-49c6-ad0c-5769b8e03fc1",
    "status": "completed",
    "orders": [
      {
        "id": "84d96c03-6b1c-4226-ad8f-ef44a6bc08af",
        "created_at": "2020-01-01T00:00:00Z",
        "updated_at": "2022-01-04T00:00:00Z",
        "low_level_status": "redraw_available",
        "low_level_status_created_at": "2022-01-04T00:00:00Z",
        "origin": "initial"
      },
      {
        "id": "15db29d7-ffeb-4540-9513-3c38f26b87aa",
        "created_at": "2020-01-10T00:00:00Z",
        "updated_at": "2022-01-14T00:00:00Z",
        "low_level_status": "completed",
        "low_level_status_created_at": "2022-01-14T00:00:00Z",
        "origin": "redraw"
      }
    ]
  }
}

Authorizations

​
x-vital-api-key
string
header
required

Vital Team API Key

Path Parameters

​
transaction_id
string<uuid>
required

Response

Successful Response

​
metadata
LabResultsMetadata · object
required
Example:
{
  "age": 19,
  "clia_number": "12331231",
  "date_collected": "2022-02-02",
  "date_received": "2022-01-01",
  "date_reported": "2020-01-01",
  "dob": "18/08/1993",
  "interpretation": "normal",
  "laboratory": "Quest Diagnostics",
  "patient": "Bob Smith",
  "provider": "Dr. Jack Smith",
  "specimen_number": "123131",
  "status": "final"
}
​
results
BiomarkerResult · object
required

Represent the schema for an individual biomarker result.

Example:
{
  "interpretation": "normal",
  "is_above_max_range": false,
  "is_below_min_range": false,
  "loinc": "742-7",
  "loinc_slug": "monocytes-auto-bld-vol",
  "max_range_value": 0.9,
  "min_range_value": 0.1,
  "name": "Monocytes(Absolute)",
  "notes": "Final",
  "result": "0.4",
  "slug": "monocytes-absolute",
  "timestamp": "2023-11-01T08:28:00+00:00",
  "type": "numeric",
  "unit": "x10E3/uL",
  "value": 0.4
}
​
missing_results
MissingBiomarkerResult · object[] | null
​
sample_information
Sample Information · object
​
order_transaction
ClientFacingOrderTransaction · object

Order transaction info.