Skip to main content
GET
/
lab_report
/
v1
/
parser
/
job
/
{job_id}
curl --request GET \
     --url '{{BASE_URL}}/lab_report/v1/parser/job/<job_id>' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: {YOUR_KEY}'

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "data": {
    "metadata": {
      "patient_first_name": "John",
      "patient_last_name": "Doe",
      "dob": "1990-05-15",
      "lab_name": "Quest Diagnostics",
      "date_reported": "2024-01-15",
      "date_collected": "2024-01-14",
      "specimen_number": "SP123456"
    },
    "results": [
      {
        "test_name": "Glucose",
        "value": "95",
        "type": "numeric",
        "units": "mg/dL",
        "min_reference_range": 70,
        "max_reference_range": 100,
        "interpretation": "normal",
        "is_above_max_range": false,
        "is_below_min_range": false,
        "loinc_matches": [
          {
            "loinc_code": "2345-7",
            "loinc_name": "Glucose [Mass/volume] in Serum or Plasma",
            "display_name": "Glucose [Mass/volume] in Serum or Plasma",
            "aliases": ["Blood Sugar", "Fasting Glucose"],
            "confidence_score": 0.95
          }
        ]
      },
      {
        "test_name": "Hemoglobin A1c",
        "value": "5.4",
        "type": "numeric",
        "units": "%",
        "min_reference_range": 4.0,
        "max_reference_range": 5.6,
        "interpretation": "normal",
        "is_above_max_range": false,
        "is_below_min_range": false,
        "loinc_matches": [
          {
            "loinc_code": "4548-4",
            "loinc_name": "Hemoglobin A1c/Hemoglobin.total in Blood",
            "display_name": "Hemoglobin A1c/Hemoglobin.total in Blood",
            "aliases": ["HbA1c", "Glycated Hemoglobin"],
            "confidence_score": 0.98
          }
        ]
      }
    ]
  },
  "needs_human_review": false,
  "is_reviewed": false
}
Retrieve the status and results of a lab report parsing job. When the job status is completed, the data field will contain the extracted lab results with LOINC matches. Job Status Values:
  • upload_pending - Job created, waiting for file upload
  • started - File uploaded, parsing in progress
  • completed - Parsing complete, results available in data
  • failed - Parsing failed
curl --request GET \
     --url '{{BASE_URL}}/lab_report/v1/parser/job/<job_id>' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: {YOUR_KEY}'

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "data": {
    "metadata": {
      "patient_first_name": "John",
      "patient_last_name": "Doe",
      "dob": "1990-05-15",
      "lab_name": "Quest Diagnostics",
      "date_reported": "2024-01-15",
      "date_collected": "2024-01-14",
      "specimen_number": "SP123456"
    },
    "results": [
      {
        "test_name": "Glucose",
        "value": "95",
        "type": "numeric",
        "units": "mg/dL",
        "min_reference_range": 70,
        "max_reference_range": 100,
        "interpretation": "normal",
        "is_above_max_range": false,
        "is_below_min_range": false,
        "loinc_matches": [
          {
            "loinc_code": "2345-7",
            "loinc_name": "Glucose [Mass/volume] in Serum or Plasma",
            "display_name": "Glucose [Mass/volume] in Serum or Plasma",
            "aliases": ["Blood Sugar", "Fasting Glucose"],
            "confidence_score": 0.95
          }
        ]
      },
      {
        "test_name": "Hemoglobin A1c",
        "value": "5.4",
        "type": "numeric",
        "units": "%",
        "min_reference_range": 4.0,
        "max_reference_range": 5.6,
        "interpretation": "normal",
        "is_above_max_range": false,
        "is_below_min_range": false,
        "loinc_matches": [
          {
            "loinc_code": "4548-4",
            "loinc_name": "Hemoglobin A1c/Hemoglobin.total in Blood",
            "display_name": "Hemoglobin A1c/Hemoglobin.total in Blood",
            "aliases": ["HbA1c", "Glycated Hemoglobin"],
            "confidence_score": 0.98
          }
        ]
      }
    ]
  },
  "needs_human_review": false,
  "is_reviewed": false
}

Authorizations

​
x-vital-api-key
string
header
required

Vital Team API Key

Path Parameters

​
job_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required
​
job_id
string<uuid>
required
deprecated
​
status
enum<string>
required

ℹ️ This enum is non-exhaustive.

Available options:
upload_pending,
started,
completed,
failed
​
needs_human_review
boolean
required
​
is_reviewed
boolean
required
​
data
ParsedLabReportData · object