List studies with pagination

client.autoScribe.studies.list(?, ?): CursorStudies<StudyListResponse { cancelledAt, createdAt, isCancelled, 23 more } >

GET/v1/autoScribe/studies

Retrieves a paginated list of studies with optional filtering by assignment, severity, description, cancellation status, and report status. Returns up to 100 studies per request.

ParametersExpand Collapse

query: StudyListParams { assignedTo, cursor, expressCustomerId, 6 more }

assignedTo?: string | null

Filter by assigned user ID (null = explicitly unassigned). Format: usr_<32-hex-chars>

cursor?: string

Base64 encoded cursor from previous response

expressCustomerId?: string | null

Filter by Express customer ID (null = studies with no customer). Format: cus_{32-hex-chars}

isCancelled?: boolean | null

Filter by cancellation status

limit?: number

Number of results to return (1-100)

minimum1

maximum100

severity?: Severity

Filter by study severity

One of the following:

"normal"

"high"

"stat"

studyDescription?: string

Filter by study description (contains match)

studyReportStatus?: Array<StudyReportStatus>

Filter by report status(es)

One of the following:

"unassigned"

"assigned"

"in_progress"

"completed"

"addendum_active"

studyType?: StudyType

Filter by study kind. Omit to return both ‘standard’ and ‘external’ studies.

One of the following:

"standard"

"external"

ReturnsExpand Collapse

StudyListResponse { cancelledAt, createdAt, isCancelled, 23 more }

A study entity in the AutoScribe system with report workflow status

cancelledAt: string | null

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

createdAt: string | null

Timestamp when the study was created

formatdate-time

isCancelled: boolean

Whether the study has been cancelled

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

severity: Severity

Priority level of a study. ‘normal’ for routine, ‘high’ for urgent, ‘stat’ for immediate attention.

One of the following:

"normal"

"high"

"stat"

studyDescription: string

Description of the study/scan (e.g., ‘Brain MRI with Contrast’, ‘Chest CT’)

minLength1

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’)

minLength1

studyReportStatus: StudyReportStatus

AutoScribe report workflow status for a study. ‘unassigned’ = no radiologist assigned, ‘assigned’ = assigned but not started, ‘in_progress’ = actively being dictated, ‘completed’ = report signed, ‘addendum_active’ = addendum in progress.

One of the following:

"unassigned"

"assigned"

"in_progress"

"completed"

"addendum_active"

updatedAt: string | null

Timestamp when the study was last updated

formatdate-time

assignedTo?: UserReference { email, userId, firstName, 4 more } | null

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

Unique user identifier. Format: usr_{32-hex-chars}

firstName?: string

User’s first name

lastName?: string

User’s last name

middleName?: string

User’s middle name

suffix1?: string

Name suffix (e.g., ‘MD’, ‘Jr.’)

suffix2?: string

Additional name suffix

clinicalHistory?: string | null

Relevant clinical history for the study

clinicalIndication?: string | null

Clinical indication for the study

createdByApiKey?: APIKeyReference { apiKeyId, description, isClinicalContextEnrichmentEnabled, isViewerEnabled } | null

A reference to an API key with basic identifying information

apiKeyId: string

Unique API key identifier (UUIDv4 format)

formatuuid

description: string

Human-readable description of the API key

minLength1

isClinicalContextEnrichmentEnabled?: boolean

Whether this API key has a clinical-context enrichment webhook configured

isViewerEnabled?: boolean

Whether this API key has access to the Viewer product

createdByUser?: UserReference { email, userId, firstName, 4 more } | null

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

Unique user identifier. Format: usr_{32-hex-chars}

firstName?: string

User’s first name

lastName?: string

User’s last name

middleName?: string

User’s middle name

suffix1?: string

Name suffix (e.g., ‘MD’, ‘Jr.’)

suffix2?: string

Additional name suffix

expressCustomer?: ExpressCustomerReference { expressCustomerId, expressCustomerName } | null

A reference to an Express customer with basic identifying information

expressCustomerId: string

Unique Express customer identifier. Format: cus_{32-hex-chars}

expressCustomerName: string

Name of the Express customer

minLength1

externalPatientId?: string | null

Integrator-provided stable patient identifier for linking studies

externalReportId?: string

External report identifier when this study has an attached archive report. Format: ext_{32-hex-chars}

isCritical?: boolean

Whether the primary report was marked as critical at sign-off

metadata?: Record<string, string>

Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

modality?: string | null

Imaging modality for the study (free text)

priorReports?: Array<PriorReport { reportText, externalStudyId, modality, 2 more } >

External prior reports with metadata and text

reportText: string

Full prior report text

minLength1

maxLength50000

externalStudyId?: string

Integrator’s external study identifier

minLength1

maxLength256

modality?: string

Imaging modality for the prior study

minLength1

maxLength100

studyDate?: string

Prior study date (YYYY-MM-DD)

studyDescription?: string

Description of the prior study

minLength1

maxLength1000

reportIds?: Array<ReportIDWithStatus { isCritical, reportId, status } >

Array of report IDs associated with this study, including addendums

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}

status: ReportStatus

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

One of the following:

"in_progress"

"completed"

studyType?: StudyType

Kind of study. ‘standard’ is a live AutoScribe reading-workflow study. ‘external’ is an imported archive study.

One of the following:

"standard"

"external"

technologistNotes?: Array<string>

Technologist notes for the study

technologistTechnique?: string | null

Imaging technique description

List studies with pagination

import Avara from 'avara-software';

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

// Automatically fetches more pages as needed.
for await (const studyListResponse of client.autoScribe.studies.list()) {
  console.log(studyListResponse.studyInstanceUid);
}

{
  "hasMore": true,
  "studies": [
    {
      "cancelledAt": null,
      "createdAt": "2024-03-15T10:30:00Z",
      "isCancelled": false,
      "reportMetadata": {
        "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
        }
      },
      "severity": "normal",
      "studyDescription": "Brain MRI with Contrast",
      "studyId": "stu_1234567890abcdef1234567890abcdef",
      "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
      "studyReportStatus": "in_progress",
      "updatedAt": "2024-03-15T14:20:00Z",
      "assignedTo": {
        "email": "dr.smith@radiology.com",
        "userId": "usr_1234567890abcdef1234567890abcdef",
        "firstName": "John",
        "lastName": "Smith",
        "middleName": "Robert",
        "suffix1": "MD",
        "suffix2": "FACR"
      },
      "clinicalHistory": "clinicalHistory",
      "clinicalIndication": "clinicalIndication",
      "createdByApiKey": {
        "apiKeyId": "550e8400-e29b-41d4-a716-446655440000",
        "description": "Production API Key",
        "isClinicalContextEnrichmentEnabled": true,
        "isViewerEnabled": true
      },
      "createdByUser": {
        "email": "dr.smith@radiology.com",
        "userId": "usr_1234567890abcdef1234567890abcdef",
        "firstName": "John",
        "lastName": "Smith",
        "middleName": "Robert",
        "suffix1": "MD",
        "suffix2": "FACR"
      },
      "expressCustomer": {
        "expressCustomerId": "cus_1234567890abcdef1234567890abcdef",
        "expressCustomerName": "City Medical Center"
      },
      "externalPatientId": "externalPatientId",
      "externalReportId": "ext_1234567890abcdef1234567890abcdef",
      "isCritical": true,
      "metadata": {
        "department": "radiology",
        "priority": "routine"
      },
      "modality": "modality",
      "priorReports": [
        {
          "reportText": "IMPRESSION: No acute cardiopulmonary process.",
          "externalStudyId": "EXT-2024-001",
          "modality": "CT",
          "studyDate": "2024-01-15",
          "studyDescription": "CT Chest without contrast"
        }
      ],
      "reportIds": [
        {
          "isCritical": null,
          "reportId": "rep_1234567890abcdef1234567890abcdef",
          "status": "in_progress"
        }
      ],
      "studyType": "standard",
      "technologistNotes": [
        "x"
      ],
      "technologistTechnique": "technologistTechnique"
    }
  ],
  "cursor": "cursor"
}

Returns Examples

{
  "hasMore": true,
  "studies": [
    {
      "cancelledAt": null,
      "createdAt": "2024-03-15T10:30:00Z",
      "isCancelled": false,
      "reportMetadata": {
        "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
        }
      },
      "severity": "normal",
      "studyDescription": "Brain MRI with Contrast",
      "studyId": "stu_1234567890abcdef1234567890abcdef",
      "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
      "studyReportStatus": "in_progress",
      "updatedAt": "2024-03-15T14:20:00Z",
      "assignedTo": {
        "email": "dr.smith@radiology.com",
        "userId": "usr_1234567890abcdef1234567890abcdef",
        "firstName": "John",
        "lastName": "Smith",
        "middleName": "Robert",
        "suffix1": "MD",
        "suffix2": "FACR"
      },
      "clinicalHistory": "clinicalHistory",
      "clinicalIndication": "clinicalIndication",
      "createdByApiKey": {
        "apiKeyId": "550e8400-e29b-41d4-a716-446655440000",
        "description": "Production API Key",
        "isClinicalContextEnrichmentEnabled": true,
        "isViewerEnabled": true
      },
      "createdByUser": {
        "email": "dr.smith@radiology.com",
        "userId": "usr_1234567890abcdef1234567890abcdef",
        "firstName": "John",
        "lastName": "Smith",
        "middleName": "Robert",
        "suffix1": "MD",
        "suffix2": "FACR"
      },
      "expressCustomer": {
        "expressCustomerId": "cus_1234567890abcdef1234567890abcdef",
        "expressCustomerName": "City Medical Center"
      },
      "externalPatientId": "externalPatientId",
      "externalReportId": "ext_1234567890abcdef1234567890abcdef",
      "isCritical": true,
      "metadata": {
        "department": "radiology",
        "priority": "routine"
      },
      "modality": "modality",
      "priorReports": [
        {
          "reportText": "IMPRESSION: No acute cardiopulmonary process.",
          "externalStudyId": "EXT-2024-001",
          "modality": "CT",
          "studyDate": "2024-01-15",
          "studyDescription": "CT Chest without contrast"
        }
      ],
      "reportIds": [
        {
          "isCritical": null,
          "reportId": "rep_1234567890abcdef1234567890abcdef",
          "status": "in_progress"
        }
      ],
      "studyType": "standard",
      "technologistNotes": [
        "x"
      ],
      "technologistTechnique": "technologistTechnique"
    }
  ],
  "cursor": "cursor"
}