Retrieve report PDF URL

auto_scribe.reports.pdf() -> ReportPdfResponse

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

report_id: Optional[str]

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

study_id: Optional[str]

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

study_instance_uid: Optional[str]

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

ReportPdfResponse

Response containing a single report with its PDF download URL

Accepts one of the following:

class SingleReportPdfResponse: …

Response containing a single report with its PDF download URL

is_critical: Optional[bool]

Whether the report was marked critical at sign-off. null when the report is not yet completed; true/false once completed.

presigned_url: str

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

report_id: str

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

snapshot_metadata: StudyReportMetadata

Patient demographics and scan information for report generation

age: Optional[str]

Patient's age at study date (e.g., '34.5 years', '2 months')

date_of_birth: Optional[str]

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

facility_name: Optional[str]

Name of the medical facility where the scan was performed

height: Optional[Height]

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

unit: HeightUnit

Unit of measure for a height value. 'in' = inches, 'cm' = centimeters.

Accepts one of the following:

"in"

"cm"

value: float

minimum0

mrn: Optional[str]

Medical Record Number - unique patient identifier

patient_name: Optional[str]

Full name of the patient

procedure: Optional[str]

Procedure or study type (e.g., 'MRI Brain with Contrast'). Maps to database scan_type and dictation report_header.scan_type.

referring_physician_name: Optional[str]

Name of the physician who referred the patient for this scan

sex: Optional[Sex]

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

Accepts one of the following:

"male"

"female"

"other"

study_date: Optional[str]

Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.

study_time: Optional[str]

Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.

weight: Optional[Weight]

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

unit: WeightUnit

Unit of measure for a weight value. 'lbs' = pounds, 'kg' = kilograms.

Accepts one of the following:

"lbs"

"kg"

value: float

minimum0

study_id: str

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

study_instance_uid: str

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

minLength1

class ListReportsPdfResponse: …

Response containing a list of reports with their PDF download URLs

reports: List[ReportPdfItem]

Array of report PDF items with download URLs

is_critical: Optional[bool]

Whether the report was marked critical at sign-off. null when the report is not yet completed; true/false once completed.

presigned_url: str

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

report_id: str

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

snapshot_metadata: StudyReportMetadata

Patient demographics and scan information for report generation

age: Optional[str]

Patient's age at study date (e.g., '34.5 years', '2 months')

date_of_birth: Optional[str]

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

facility_name: Optional[str]

Name of the medical facility where the scan was performed

height: Optional[Height]

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

unit: HeightUnit

Unit of measure for a height value. 'in' = inches, 'cm' = centimeters.

Accepts one of the following:

"in"

"cm"

value: float

minimum0

mrn: Optional[str]

Medical Record Number - unique patient identifier

patient_name: Optional[str]

Full name of the patient

procedure: Optional[str]

Procedure or study type (e.g., 'MRI Brain with Contrast'). Maps to database scan_type and dictation report_header.scan_type.

referring_physician_name: Optional[str]

Name of the physician who referred the patient for this scan

sex: Optional[Sex]

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

Accepts one of the following:

"male"

"female"

"other"

study_date: Optional[str]

Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.

study_time: Optional[str]

Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.

weight: Optional[Weight]

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

unit: WeightUnit

Unit of measure for a weight value. 'lbs' = pounds, 'kg' = kilograms.

Accepts one of the following:

"lbs"

"kg"

value: float

minimum0

study_id: str

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

study_instance_uid: str

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

minLength1

study_id: str

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

study_instance_uid: str

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

import os
from avara import Avara

client = Avara(
    api_key=os.environ.get("AVARA_API_KEY"),  # This is the default and can be omitted
)
response = client.auto_scribe.reports.pdf()
print(response)

{
  "isCritical": false,
  "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",
    "procedure": "MRI Brain with Contrast",
    "referringPhysicianName": "Dr. Michael Chen",
    "sex": "female",
    "studyDate": "2024-03-15",
    "studyTime": "14:30",
    "weight": {
      "unit": "kg",
      "value": 62
    }
  },
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123"
}

Returns Examples

{
  "isCritical": false,
  "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",
    "procedure": "MRI Brain with Contrast",
    "referringPhysicianName": "Dr. Michael Chen",
    "sex": "female",
    "studyDate": "2024-03-15",
    "studyTime": "14:30",
    "weight": {
      "unit": "kg",
      "value": 62
    }
  },
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123"
}