Skip to content
Avara
Get started
API Reference
Auto Scribe

Reports

List reports for a study
auto_scribe.reports.list(ReportListParams**kwargs) -> ReportListResponse
GET/v1/autoScribe/reports
Retrieve report text
auto_scribe.reports.text(ReportTextParams**kwargs) -> ReportTextResponse
GET/v1/autoScribe/reports/text
Retrieve report PDF URL
auto_scribe.reports.pdf(ReportPdfParams**kwargs) -> ReportPdfResponse
GET/v1/autoScribe/reports/pdf
Create a report addendum
auto_scribe.reports.addendum(strreport_id) -> ReportAddendumResponse
POST/v1/autoScribe/reports/{reportId}/addendum
Cancel a report addendum
auto_scribe.reports.cancel_addendum(strreport_id) -> ReportCancelAddendumResponse
POST/v1/autoScribe/reports/{reportId}/cancel-addendum
ModelsExpand Collapse
class Report: …

A radiology report in the AutoScribe system

created_at: Optional[datetime]

Timestamp when the report was created

formatdate-time
is_addendum: bool

Whether this report is an addendum to a previous report

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.

report_id: str

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

signed_at: Optional[datetime]

Timestamp when the report was signed, null if not yet signed

formatdate-time
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
status: ReportStatus

Status of an individual report. 'in_progress' = actively being dictated, 'completed' = signed.

Accepts one of the following:
"in_progress"
"completed"
study_id: str

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

updated_at: Optional[datetime]

Timestamp when the report was last updated

formatdate-time
user_id: str

User ID of the radiologist who created/signed this report. Format: usr_{32-hex-chars}

report_plain_text: Optional[str]

Plain text content of the report

class ReportPdfItem: …

A 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 ReportTextItem: …

A report with its plain text content

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.

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
plain_text: Optional[str]

Plain text content of the report