List reports for a study

client.autoScribe.reports.list(?, ?): ReportListResponse { reports, studyId, studyInstanceUid }

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

query: ReportListParams { studyId, studyInstanceUid }

studyId?: string

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

studyInstanceUid?: string

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

ReportListResponse { reports, studyId, studyInstanceUid }

Response containing a list of reports for a study

reports: Array<Report { createdAt, isAddendum, isCritical, 8 more } >

Array of report objects with full details

createdAt: string | null

Timestamp when the report was created

formatdate-time

isAddendum: boolean

Whether this report is an addendum to a previous report

isCritical: boolean | null

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

reportId: string

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

signedAt: string | null

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

formatdate-time

snapshotMetadata: StudyReportMetadata { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age?: string

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

dateOfBirth?: string

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

facilityName?: string

Name of the medical facility where the scan was performed

height?: Height { unit, value }

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.

One of the following:

"in"

"cm"

value: number

minimum0

mrn?: string

Medical Record Number - unique patient identifier

patientName?: string

Full name of the patient

procedure?: string

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

referringPhysicianName?: string

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"

"female"

"other"

studyDate?: string

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

studyTime?: string

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

weight?: Weight { unit, value }

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.

One of the following:

"lbs"

"kg"

value: number

minimum0

status: ReportStatus

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

One of the following:

"in_progress"

"completed"

studyId: string

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

updatedAt: string | null

Timestamp when the report was last updated

formatdate-time

userId: string

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

reportPlainText?: string

Plain text content of the report

studyId: string

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

studyInstanceUid: string

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

import Avara from 'avara-software';

const client = new Avara({
  apiKey: process.env['AVARA_API_KEY'], // This is the default and can be omitted
});

const reports = await client.autoScribe.reports.list();

console.log(reports.studyInstanceUid);

{
  "reports": [
    {
      "createdAt": "2024-03-15T14:30:00Z",
      "isAddendum": false,
      "isCritical": 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",
        "procedure": "MRI Brain with Contrast",
        "referringPhysicianName": "Dr. Michael Chen",
        "sex": "female",
        "studyDate": "2024-03-15",
        "studyTime": "14:30",
        "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,
      "isCritical": 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",
        "procedure": "MRI Brain with Contrast",
        "referringPhysicianName": "Dr. Michael Chen",
        "sex": "female",
        "studyDate": "2024-03-15",
        "studyTime": "14:30",
        "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"
}