Skip to content
Avara
Get started
API Reference
Auto Scribe

Reports

List reports for a study
ReportListResponse AutoScribe.Reports.List(ReportListParams?parameters, CancellationTokencancellationToken = default)
GET/v1/autoScribe/reports
Retrieve report text
ReportTextResponse AutoScribe.Reports.Text(ReportTextParams?parameters, CancellationTokencancellationToken = default)
GET/v1/autoScribe/reports/text
Retrieve report PDF URL
ReportPdfResponse AutoScribe.Reports.Pdf(ReportPdfParams?parameters, CancellationTokencancellationToken = default)
GET/v1/autoScribe/reports/pdf
Create a report addendum
ReportAddendumResponse AutoScribe.Reports.Addendum(ReportAddendumParamsparameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/reports/{reportId}/addendum
Cancel a report addendum
ReportCancelAddendumResponse AutoScribe.Reports.CancelAddendum(ReportCancelAddendumParamsparameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/reports/{reportId}/cancel-addendum
ModelsExpand Collapse
class Report:

A radiology report in the AutoScribe system

required DateTimeOffset? CreatedAt

Timestamp when the report was created

formatdate-time
required Boolean IsAddendum

Whether this report is an addendum to a previous report

required Boolean? IsCritical

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

required string ReportID

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

required DateTimeOffset? SignedAt

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

formatdate-time
required StudyReportMetadata SnapshotMetadata

Patient demographics and scan information for report generation

string Age

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

string DateOfBirth

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

string FacilityName

Name of the medical facility where the scan was performed

Height Height

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

required HeightUnit Unit

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

One of the following:
"in"In
"cm"Cm
required Double Value
minimum0
string Mrn

Medical Record Number - unique patient identifier

string PatientName

Full name of the patient

string Procedure

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

string ReferringPhysicianName

Name of the physician who referred the patient for this scan

Sex Sex

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:
"male"Male
"female"Female
"other"Other
string StudyDate

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

string StudyTime

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

Weight Weight

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

required WeightUnit Unit

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

One of the following:
"lbs"Lbs
"kg"Kg
required Double Value
minimum0
required ReportStatus Status

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

One of the following:
"in_progress"InProgress
"completed"Completed
required string StudyID

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

required DateTimeOffset? UpdatedAt

Timestamp when the report was last updated

formatdate-time
required string UserID

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

string ReportPlainText

Plain text content of the report

class ReportPdfItem:

A report with its PDF download URL

required Boolean? IsCritical

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

required string PresignedUrl

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

required string ReportID

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

required StudyReportMetadata SnapshotMetadata

Patient demographics and scan information for report generation

string Age

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

string DateOfBirth

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

string FacilityName

Name of the medical facility where the scan was performed

Height Height

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

required HeightUnit Unit

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

One of the following:
"in"In
"cm"Cm
required Double Value
minimum0
string Mrn

Medical Record Number - unique patient identifier

string PatientName

Full name of the patient

string Procedure

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

string ReferringPhysicianName

Name of the physician who referred the patient for this scan

Sex Sex

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:
"male"Male
"female"Female
"other"Other
string StudyDate

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

string StudyTime

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

Weight Weight

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

required WeightUnit Unit

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

One of the following:
"lbs"Lbs
"kg"Kg
required Double Value
minimum0
required string StudyID

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

required 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
class ReportTextItem:

A report with its plain text content

required Boolean? IsCritical

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

required string ReportID

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

required StudyReportMetadata SnapshotMetadata

Patient demographics and scan information for report generation

string Age

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

string DateOfBirth

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

string FacilityName

Name of the medical facility where the scan was performed

Height Height

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

required HeightUnit Unit

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

One of the following:
"in"In
"cm"Cm
required Double Value
minimum0
string Mrn

Medical Record Number - unique patient identifier

string PatientName

Full name of the patient

string Procedure

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

string ReferringPhysicianName

Name of the physician who referred the patient for this scan

Sex Sex

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:
"male"Male
"female"Female
"other"Other
string StudyDate

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

string StudyTime

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

Weight Weight

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

required WeightUnit Unit

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

One of the following:
"lbs"Lbs
"kg"Kg
required Double Value
minimum0
required string StudyID

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

required 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 PlainText

Plain text content of the report