List reports for a study

ReportListResponse autoScribe().reports().list(, )

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.

ParametersExpand Collapse

ReportListParams params

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 ReportListResponse:

Response containing a list of reports for a study

List<Report> reports

Array of report objects with full details

Optional<LocalDateTime> createdAt

Timestamp when the report was created

formatdate-time

boolean isAddendum

Whether this report is an addendum to a previous report

String reportId

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

Optional<LocalDateTime> signedAt

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

formatdate-time

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

Status status

Report status: 'in_progress' or 'completed'

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

String studyId

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

Optional<LocalDateTime> updatedAt

Timestamp when the report was last updated

formatdate-time

String userId

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

Optional<String> 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')

minLength1

List reports for a study

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();
    }
}

{
  "reports": [
    {
      "createdAt": "2024-03-15T14:30:00Z",
      "isAddendum": false,
      "reportId": "rep_1234567890abcdef1234567890abcdef",
      "signedAt": "2024-03-15T16:00:00Z",
      "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
        }
      },
      "status": "completed",
      "studyId": "stu_1234567890abcdef1234567890abcdef",
      "updatedAt": "2024-03-15T16:00:00Z",
      "userId": "usr_1234567890abcdef1234567890abcdef",
      "reportPlainText": "FINDINGS: Normal brain MRI. No acute intracranial abnormality. IMPRESSION: Unremarkable brain MRI."
    }
  ],
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123"
}

Returns Examples

{
  "reports": [
    {
      "createdAt": "2024-03-15T14:30:00Z",
      "isAddendum": false,
      "reportId": "rep_1234567890abcdef1234567890abcdef",
      "signedAt": "2024-03-15T16:00:00Z",
      "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
        }
      },
      "status": "completed",
      "studyId": "stu_1234567890abcdef1234567890abcdef",
      "updatedAt": "2024-03-15T16:00:00Z",
      "userId": "usr_1234567890abcdef1234567890abcdef",
      "reportPlainText": "FINDINGS: Normal brain MRI. No acute intracranial abnormality. IMPRESSION: Unremarkable brain MRI."
    }
  ],
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123"
}