Fetch Results (for X-Rays)

Learn how to fetch results for your uploaded DICOMs using the /results API.

Related Guides: For X-Rays

Overview

You can use the /results API to fetch the diagnostic results of the uploaded DICOM images. Append the SeriesInstanceUID or the SOPInstanceUID in the request URL.

API Format

GET /results/<SOPInstanceUID>

Request Formats

cURL

curl -X GET \\
-L 'Base_URL/results/<SOPInstanceUID>' \\
-H 'Authorization: Token <PASTE_YOUR_TOKEN>' \\
-H 'Source: <PASTE_YOUR_SOURCE>' \\
-H 'User-Agent: <YOUR_USER_AGENT>'

Python

import requests
import pydicom

# To fetch sopInstanceUID using pydicom 

sop_instance_uid = pydicom.read_file('<path/to/your/dicom_file.dcm>').SOPInstanceUID

url = f"Base_URL/results/{sop_instance_uid}"

# Headers, including the Authorization token and Source
headers = {
    'Authorization': 'Token <PASTE_YOUR_TOKEN>',
    'Source': '<PASTE_YOUR_SOURCE>',
    'User-Agent': '<YOUR_USER_AGENT>'
}

# Perform the GET request
response = requests.get(url, headers=headers)

# Print the response text
print(response.text)

Fetch Results(for X-Rays).

GETBASE_URL/results/{SOPInstanceUID}

Path parameters

SOPInstanceUID*string

The unique identifier for a specific instance of a service object pair (SOP), such as a single x-ray, to fetch results for.

Response

200202400401403404409

Results fetched successfully

Body

application/json

successboolean

Example: true

messagestring

A message that validates the request based on the response status code.

Example: "Results retrieved successfully!"

triage_statusstring

Indicates the urgency of results.'Critical' for high priority needing immediate expert review, and 'Routine' for standard priority also requiring expert supervision.

Example: "critical"

resultobject

Contains the results for the uploaded DICOMs.

usecasestring

Describes the usecase.

Example: "qxr"

Request

cURLPython

curl -X GET \\
-L 'Base_URL/results/<SOPInstanceUID>' \\
-H 'Authorization: Token <PASTE_YOUR_TOKEN>' \\
-H 'Source: <PASTE_YOUR_SOURCE>'

Response

200202400401403404409

{
  "success": true,
  "message": "Results retrieved successfully!",
  "triage_status": "critical",
  "result": {
    "report": {
      "findings": "<findings_text>\\\\n\\\\n<additional_findings_text>\\\\n\\\\n<more_findings_text>",
      "impression": "Abnormal study",
      "findings_list": [
        []
      ]
    },
    "files": {
      "sc": [
        "<https://exampleurl.com>"
      ],
      "sc_full_png": [
        "<https://exampleurl.com>"
      ],
      "sc_thumbnail": [
        "<https://exampleurl.com>"
      ],
      "sc_dicom_thumbnail": [
        "<https://exampleurl.com>"
      ],
      "original_thumbnail": [
        "<https://exampleurl.com>"
      ],
      "original": [
        "<https://exampleurl.com>"
      ],
      "report_pdf": [
        "<https://exampleurl.com>"
      ],
      "report_dcm": [
        "<https://exampleurl.com>"
      ],
      "report_sr": [
        "<https://exampleurl.com>"
      ]
    }
  },
  "usecase": "qxr"
}