# Reports ## List `ReportListResponse autoScribe().reports().list(ReportListParamsparams = ReportListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **get** `/v1/autoScribe/reports` Retrieves all reports (including versions and addendums) for a specific study. Must provide either study ID or DICOM Study Instance UID. Returns report metadata including status, version, and timestamps. ### Parameters - `ReportListParams params` - `Optional studyId` Unique study identifier. Format: stu_{32-hex-chars} - `Optional studyInstanceUid` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') ### Returns - `class ReportListResponse:` Response containing a list of reports for a study - `List reports` Array of report objects with full details - `Optional createdAt` Timestamp when the report was created - `boolean isAddendum` Whether this report is an addendum to a previous report - `String reportId` Unique report identifier. Format: rep_{32-hex-chars} - `Optional signedAt` Timestamp when the report was signed, null if not yet signed - `StudyReportMetadata snapshotMetadata` Patient demographics and scan information for report generation - `Optional age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `double value` - `Status status` Report status: 'in_progress' or 'completed' - `IN_PROGRESS("in_progress")` - `COMPLETED("completed")` - `String studyId` Study ID this report belongs to. Format: stu_{32-hex-chars} - `Optional updatedAt` Timestamp when the report was last updated - `String userId` User ID of the radiologist who created/signed this report. Format: usr_{32-hex-chars} - `Optional reportPlainText` Plain text content of the report - `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') ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.reports.ReportListParams; import com.avara.models.autoscribe.reports.ReportListResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); ReportListResponse reports = client.autoScribe().reports().list(); } } ``` ## Text `ReportTextResponse autoScribe().reports().text(ReportTextParamsparams = ReportTextParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **get** `/v1/autoScribe/reports/text` Retrieves the text content of a report. Can fetch a single report by report ID, or all reports for a study by study ID/DICOM UID. Returns plain text report content. ### Parameters - `ReportTextParams params` - `Optional reportId` Unique report identifier. Format: rep_{32-hex-chars} - `Optional studyId` Unique study identifier. Format: stu_{32-hex-chars} - `Optional studyInstanceUid` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') ### Returns - `class ReportTextResponse: A class that can be one of several variants.union` Response containing a single report with its plain text - `SingleReportTextResponse` - `String reportId` Unique report identifier. Format: rep_{32-hex-chars} - `StudyReportMetadata snapshotMetadata` Patient demographics and scan information for report generation - `Optional age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `double value` - `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') - `Optional plainText` Plain text content of the report - `ListReportsTextResponse` - `List reports` Array of report text items - `String reportId` Unique report identifier. Format: rep_{32-hex-chars} - `StudyReportMetadata snapshotMetadata` Patient demographics and scan information for report generation - `Optional age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `double value` - `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') - `Optional plainText` Plain text content of the report - `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') ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.reports.ReportTextParams; import com.avara.models.autoscribe.reports.ReportTextResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); ReportTextResponse response = client.autoScribe().reports().text(); } } ``` ## Pdf `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. ### Parameters - `ReportPdfParams params` - `Optional reportId` Unique report identifier. Format: rep_{32-hex-chars} - `Optional studyId` Unique study identifier. Format: stu_{32-hex-chars} - `Optional studyInstanceUid` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') ### Returns - `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 age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `double value` - `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') - `ListReportsPdfResponse` - `List 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 age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `double value` - `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') - `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') ### Example ```java 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(); } } ``` ## Addendum `ReportAddendumResponse autoScribe().reports().addendum(ReportAddendumParamsparams = ReportAddendumParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **post** `/v1/autoScribe/reports/{reportId}/addendum` Initiates the creation of an addendum to an existing completed report. The study status will change to 'addendum_active' allowing the radiologist to dictate additional findings. ### Parameters - `ReportAddendumParams params` - `Optional reportId` Unique report identifier. Format: rep_{32-hex-chars} ### Returns - `class ReportAddendumResponse:` Response for creating a report addendum - `boolean success` - `Optional message` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.reports.ReportAddendumParams; import com.avara.models.autoscribe.reports.ReportAddendumResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); ReportAddendumResponse response = client.autoScribe().reports().addendum("rep_1234567890abcdef1234567890abcdef"); } } ``` ## Cancel Addendum `ReportCancelAddendumResponse autoScribe().reports().cancelAddendum(ReportCancelAddendumParamsparams = ReportCancelAddendumParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **post** `/v1/autoScribe/reports/{reportId}/cancel-addendum` Cancels an in-progress addendum and reverts the study status to 'completed'. The original report remains unchanged. Only valid for active addendums. ### Parameters - `ReportCancelAddendumParams params` - `Optional reportId` Unique report identifier. Format: rep_{32-hex-chars} ### Returns - `class ReportCancelAddendumResponse:` Response for cancelling a report addendum - `boolean success` - `Optional message` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.reports.ReportCancelAddendumParams; import com.avara.models.autoscribe.reports.ReportCancelAddendumResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); ReportCancelAddendumResponse response = client.autoScribe().reports().cancelAddendum("rep_1234567890abcdef1234567890abcdef"); } } ```