Skip to content
Avara
Get started
API Reference
Auto Scribe
Reports

Retrieve report PDF URL

ReportPdfResponse autoScribe().reports().pdf(ReportPdfParamsparams = ReportPdfParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
get/v1/autoScribe/reports/pdf

Retrieves presigned URLs for accessing report PDFs. Can fetch a single report by report ID, or all reports for a study by study ID/DICOM UID. URLs are time-limited for security.

ParametersExpand Collapse
ReportPdfParams params
Optional<String> reportId

Unique report identifier. Format: rep_{32-hex-chars}

Optional<String> studyId

Unique study identifier. Format: stu_{32-hex-chars}

Optional<String> studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

ReturnsExpand Collapse
class ReportPdfResponse: A class that can be one of several variants.union

Response containing a single report with its PDF download URL

SingleReportPdfResponse
String presignedUrl

Time-limited presigned URL to download the PDF (expires after 1 hour)

String reportId

Unique report identifier. Format: rep_{32-hex-chars}

StudyReportMetadata snapshotMetadata

Patient demographics and scan information for report generation

Optional<String> age

Patient's age at time of scan (e.g., '34.5 years', '2 months')

Optional<String> dateOfBirth

Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20')

Optional<String> facilityName

Name of the medical facility where the scan was performed

Optional<Height> height

Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'})

Unit unit
Accepts one of the following:
IN("in")
CM("cm")
double value
minimum0
Optional<String> mrn

Medical Record Number - unique patient identifier

Optional<String> patientName

Full name of the patient

Optional<String> referringPhysicianName

Name of the physician who referred the patient for this scan

Optional<String> scanDate

Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15')

Optional<String> scanTime

Time the scan was performed. Format: HH:MM (e.g., '14:30')

Optional<String> scanType

Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound')

Optional<Sex> sex

Patient's biological sex. Options: 'male', 'female', 'other'

Accepts one of the following:
MALE("male")
FEMALE("female")
OTHER("other")
Optional<Weight> weight

Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'})

Unit unit
Accepts one of the following:
LBS("lbs")
KG("kg")
double value
minimum0
String studyId

Study ID this report belongs to. Format: stu_{32-hex-chars}

String studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

minLength1
ListReportsPdfResponse
List<Report> reports

Array of report PDF items with download URLs

String presignedUrl

Time-limited presigned URL to download the PDF (expires after 1 hour)

String reportId

Unique report identifier. Format: rep_{32-hex-chars}

StudyReportMetadata snapshotMetadata

Patient demographics and scan information for report generation

Optional<String> age

Patient's age at time of scan (e.g., '34.5 years', '2 months')

Optional<String> dateOfBirth

Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20')

Optional<String> facilityName

Name of the medical facility where the scan was performed

Optional<Height> height

Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'})

Unit unit
Accepts one of the following:
IN("in")
CM("cm")
double value
minimum0
Optional<String> mrn

Medical Record Number - unique patient identifier

Optional<String> patientName

Full name of the patient

Optional<String> referringPhysicianName

Name of the physician who referred the patient for this scan

Optional<String> scanDate

Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15')

Optional<String> scanTime

Time the scan was performed. Format: HH:MM (e.g., '14:30')

Optional<String> scanType

Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound')

Optional<Sex> sex

Patient's biological sex. Options: 'male', 'female', 'other'

Accepts one of the following:
MALE("male")
FEMALE("female")
OTHER("other")
Optional<Weight> weight

Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'})

Unit unit
Accepts one of the following:
LBS("lbs")
KG("kg")
double value
minimum0
String studyId

Study ID this report belongs to. Format: stu_{32-hex-chars}

String studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

minLength1
String studyId

Study ID the reports belong to. Format: stu_{32-hex-chars}

String studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

minLength1
Retrieve report PDF URL
package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.autoscribe.reports.ReportPdfParams;
import com.avara.models.autoscribe.reports.ReportPdfResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        ReportPdfResponse response = client.autoScribe().reports().pdf();
    }
}
{
  "presignedUrl": "https://storage.avarasoftware.com/reports/rep_1234.pdf?token=abc123",
  "reportId": "rep_1234567890abcdef1234567890abcdef",
  "snapshotMetadata": {
    "age": "38 years",
    "dateOfBirth": "1985-07-20",
    "facilityName": "City Medical Center",
    "height": {
      "unit": "cm",
      "value": 165
    },
    "mrn": "MRN-2024-001234",
    "patientName": "Jane Doe",
    "referringPhysicianName": "Dr. Michael Chen",
    "scanDate": "2024-03-15",
    "scanTime": "14:30",
    "scanType": "MRI Brain with Contrast",
    "sex": "female",
    "weight": {
      "unit": "kg",
      "value": 62
    }
  },
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123"
}
Returns Examples
{
  "presignedUrl": "https://storage.avarasoftware.com/reports/rep_1234.pdf?token=abc123",
  "reportId": "rep_1234567890abcdef1234567890abcdef",
  "snapshotMetadata": {
    "age": "38 years",
    "dateOfBirth": "1985-07-20",
    "facilityName": "City Medical Center",
    "height": {
      "unit": "cm",
      "value": 165
    },
    "mrn": "MRN-2024-001234",
    "patientName": "Jane Doe",
    "referringPhysicianName": "Dr. Michael Chen",
    "scanDate": "2024-03-15",
    "scanTime": "14:30",
    "scanType": "MRI Brain with Contrast",
    "sex": "female",
    "weight": {
      "unit": "kg",
      "value": 62
    }
  },
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123"
}