# Studies

## Create

`StudyCreateResponse autoScribe().studies().create(StudyCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

**post** `/v1/autoScribe/studies`

Creates a new study in the AutoScribe system with DICOM metadata and report generation information. The study can include patient demographics, scan details, and references to prior studies/reports for context.

### Parameters

- `StudyCreateParams params`

  - `StudyReportMetadata reportMetadata`

    Patient demographics and scan information for report generation

  - `Severity severity`

    Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention

    - `NORMAL("normal")`

    - `HIGH("high")`

    - `STAT("stat")`

  - `String studyDescription`

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

  - `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<String> assignedTo`

    User ID to assign the study to. Format: usr_{32-hex-chars}

  - `Optional<String> expressCustomerId`

    Express customer ID for the study. Format: cus_{32-hex-chars}

  - `Optional<Metadata> metadata`

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

  - `Optional<List<String>> priorReportTexts`

  - `Optional<List<String>> priorStudyIds`

### Returns

- `class StudyCreateResponse:`

  A study entity in the AutoScribe system with report workflow status

  - `Optional<LocalDateTime> cancelledAt`

    Timestamp when the study was cancelled, null if not cancelled

  - `Optional<LocalDateTime> createdAt`

    Timestamp when the study was created

  - `boolean isCancelled`

    Whether the study has been cancelled

  - `StudyReportMetadata reportMetadata`

    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`

        - `IN("in")`

        - `CM("cm")`

      - `double value`

    - `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'

      - `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`

        - `LBS("lbs")`

        - `KG("kg")`

      - `double value`

  - `Severity severity`

    Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention

    - `NORMAL("normal")`

    - `HIGH("high")`

    - `STAT("stat")`

  - `String studyDescription`

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

  - `String studyId`

    Unique study identifier. 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')

  - `StudyReportStatus studyReportStatus`

    Report workflow status. 'unassigned' = no radiologist assigned, 'assigned' = assigned but not started, 'in_progress' = actively being dictated, 'completed' = report signed, 'addendum_active' = addendum in progress

    - `UNASSIGNED("unassigned")`

    - `ASSIGNED("assigned")`

    - `IN_PROGRESS("in_progress")`

    - `COMPLETED("completed")`

    - `ADDENDUM_ACTIVE("addendum_active")`

  - `Optional<LocalDateTime> updatedAt`

    Timestamp when the study was last updated

  - `Optional<AssignedTo> assignedTo`

    Reference to the assigned radiologist, null if unassigned

    - `String email`

      User's email address

    - `String userId`

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

    - `Optional<String> firstName`

      User's first name

    - `Optional<String> lastName`

      User's last name

    - `Optional<String> middleName`

      User's middle name

    - `Optional<String> suffix1`

      Name suffix (e.g., 'MD', 'Jr.')

    - `Optional<String> suffix2`

      Additional name suffix

  - `Optional<CreatedByApiKey> createdByApiKey`

    Reference to the API key used to create this study

    - `String apiKeyId`

      Unique API key identifier (UUIDv4 format)

    - `String description`

      Human-readable description of the API key

    - `Optional<Boolean> isViewerEnabled`

      Whether this API key has access to the Viewer product

  - `Optional<CreatedByUser> createdByUser`

    Reference to the user who created this study via dashboard

    - `String email`

      User's email address

    - `String userId`

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

    - `Optional<String> firstName`

      User's first name

    - `Optional<String> lastName`

      User's last name

    - `Optional<String> middleName`

      User's middle name

    - `Optional<String> suffix1`

      Name suffix (e.g., 'MD', 'Jr.')

    - `Optional<String> suffix2`

      Additional name suffix

  - `Optional<ExpressCustomer> expressCustomer`

    Reference to the Express customer this study belongs to

    - `String expressCustomerId`

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

    - `String expressCustomerName`

      Name of the Express customer

  - `Optional<Metadata> metadata`

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

  - `Optional<List<String>> priorReportTexts`

    Array of prior report texts to provide clinical context

  - `Optional<List<String>> priorStudyIds`

    Array of prior study IDs for comparison context (format: stu_{32-hex-chars})

  - `Optional<List<ReportIdWithStatus>> reportIds`

    Array of report IDs associated with this study, including addendums

    - `String reportId`

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

    - `Status status`

      Current status of the report

      - `IN_PROGRESS("in_progress")`

      - `COMPLETED("completed")`

### Example

```java
package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.autoscribe.StudyReportMetadata;
import com.avara.models.autoscribe.studies.StudyCreateParams;
import com.avara.models.autoscribe.studies.StudyCreateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        StudyCreateParams params = StudyCreateParams.builder()
            .reportMetadata(StudyReportMetadata.builder().build())
            .severity(StudyCreateParams.Severity.NORMAL)
            .studyDescription("Brain MRI with Contrast")
            .studyInstanceUid("1.2.840.113619.2.55.3.604688119.868.1234567890.123")
            .build();
        StudyCreateResponse study = client.autoScribe().studies().create(params);
    }
}
```

## List

`StudyListPage autoScribe().studies().list(StudyListParamsparams = StudyListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

**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.

### Parameters

- `StudyListParams params`

  - `Optional<String> assignedTo`

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

  - `Optional<String> cursor`

    Base64 encoded cursor from previous response

  - `Optional<String> expressCustomerId`

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

  - `Optional<Boolean> isCancelled`

    Filter by cancellation status

  - `Optional<Double> limit`

    Number of results to return (1-100)

  - `Optional<Severity> severity`

    Filter by study severity

    - `NORMAL("normal")`

    - `HIGH("high")`

    - `STAT("stat")`

  - `Optional<String> studyDescription`

    Filter by study description (contains match)

  - `Optional<List<StudyReportStatus>> studyReportStatus`

    Filter by report status(es)

    - `UNASSIGNED("unassigned")`

    - `ASSIGNED("assigned")`

    - `IN_PROGRESS("in_progress")`

    - `COMPLETED("completed")`

    - `ADDENDUM_ACTIVE("addendum_active")`

### Returns

- `class StudyListResponse:`

  A study entity in the AutoScribe system with report workflow status

  - `Optional<LocalDateTime> cancelledAt`

    Timestamp when the study was cancelled, null if not cancelled

  - `Optional<LocalDateTime> createdAt`

    Timestamp when the study was created

  - `boolean isCancelled`

    Whether the study has been cancelled

  - `StudyReportMetadata reportMetadata`

    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`

        - `IN("in")`

        - `CM("cm")`

      - `double value`

    - `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'

      - `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`

        - `LBS("lbs")`

        - `KG("kg")`

      - `double value`

  - `Severity severity`

    Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention

    - `NORMAL("normal")`

    - `HIGH("high")`

    - `STAT("stat")`

  - `String studyDescription`

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

  - `String studyId`

    Unique study identifier. 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')

  - `StudyReportStatus studyReportStatus`

    Report workflow status. 'unassigned' = no radiologist assigned, 'assigned' = assigned but not started, 'in_progress' = actively being dictated, 'completed' = report signed, 'addendum_active' = addendum in progress

    - `UNASSIGNED("unassigned")`

    - `ASSIGNED("assigned")`

    - `IN_PROGRESS("in_progress")`

    - `COMPLETED("completed")`

    - `ADDENDUM_ACTIVE("addendum_active")`

  - `Optional<LocalDateTime> updatedAt`

    Timestamp when the study was last updated

  - `Optional<AssignedTo> assignedTo`

    Reference to the assigned radiologist, null if unassigned

    - `String email`

      User's email address

    - `String userId`

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

    - `Optional<String> firstName`

      User's first name

    - `Optional<String> lastName`

      User's last name

    - `Optional<String> middleName`

      User's middle name

    - `Optional<String> suffix1`

      Name suffix (e.g., 'MD', 'Jr.')

    - `Optional<String> suffix2`

      Additional name suffix

  - `Optional<CreatedByApiKey> createdByApiKey`

    Reference to the API key used to create this study

    - `String apiKeyId`

      Unique API key identifier (UUIDv4 format)

    - `String description`

      Human-readable description of the API key

    - `Optional<Boolean> isViewerEnabled`

      Whether this API key has access to the Viewer product

  - `Optional<CreatedByUser> createdByUser`

    Reference to the user who created this study via dashboard

    - `String email`

      User's email address

    - `String userId`

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

    - `Optional<String> firstName`

      User's first name

    - `Optional<String> lastName`

      User's last name

    - `Optional<String> middleName`

      User's middle name

    - `Optional<String> suffix1`

      Name suffix (e.g., 'MD', 'Jr.')

    - `Optional<String> suffix2`

      Additional name suffix

  - `Optional<ExpressCustomer> expressCustomer`

    Reference to the Express customer this study belongs to

    - `String expressCustomerId`

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

    - `String expressCustomerName`

      Name of the Express customer

  - `Optional<Metadata> metadata`

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

  - `Optional<List<String>> priorReportTexts`

    Array of prior report texts to provide clinical context

  - `Optional<List<String>> priorStudyIds`

    Array of prior study IDs for comparison context (format: stu_{32-hex-chars})

  - `Optional<List<ReportIdWithStatus>> reportIds`

    Array of report IDs associated with this study, including addendums

    - `String reportId`

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

    - `Status status`

      Current status of the report

      - `IN_PROGRESS("in_progress")`

      - `COMPLETED("completed")`

### Example

```java
package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.autoscribe.studies.StudyListPage;
import com.avara.models.autoscribe.studies.StudyListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        StudyListPage page = client.autoScribe().studies().list();
    }
}
```

## Retrieve

`StudyRetrieveResponse autoScribe().studies().retrieve(StudyRetrieveParamsparams = StudyRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

**get** `/v1/autoScribe/studies/{studyId}`

Retrieves a single study by its unique study ID. Returns the complete study object with all metadata, report status, and patient information.

### Parameters

- `StudyRetrieveParams params`

  - `Optional<String> studyId`

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

### Returns

- `class StudyRetrieveResponse:`

  A study entity in the AutoScribe system with report workflow status

  - `Optional<LocalDateTime> cancelledAt`

    Timestamp when the study was cancelled, null if not cancelled

  - `Optional<LocalDateTime> createdAt`

    Timestamp when the study was created

  - `boolean isCancelled`

    Whether the study has been cancelled

  - `StudyReportMetadata reportMetadata`

    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`

        - `IN("in")`

        - `CM("cm")`

      - `double value`

    - `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'

      - `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`

        - `LBS("lbs")`

        - `KG("kg")`

      - `double value`

  - `Severity severity`

    Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention

    - `NORMAL("normal")`

    - `HIGH("high")`

    - `STAT("stat")`

  - `String studyDescription`

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

  - `String studyId`

    Unique study identifier. 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')

  - `StudyReportStatus studyReportStatus`

    Report workflow status. 'unassigned' = no radiologist assigned, 'assigned' = assigned but not started, 'in_progress' = actively being dictated, 'completed' = report signed, 'addendum_active' = addendum in progress

    - `UNASSIGNED("unassigned")`

    - `ASSIGNED("assigned")`

    - `IN_PROGRESS("in_progress")`

    - `COMPLETED("completed")`

    - `ADDENDUM_ACTIVE("addendum_active")`

  - `Optional<LocalDateTime> updatedAt`

    Timestamp when the study was last updated

  - `Optional<AssignedTo> assignedTo`

    Reference to the assigned radiologist, null if unassigned

    - `String email`

      User's email address

    - `String userId`

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

    - `Optional<String> firstName`

      User's first name

    - `Optional<String> lastName`

      User's last name

    - `Optional<String> middleName`

      User's middle name

    - `Optional<String> suffix1`

      Name suffix (e.g., 'MD', 'Jr.')

    - `Optional<String> suffix2`

      Additional name suffix

  - `Optional<CreatedByApiKey> createdByApiKey`

    Reference to the API key used to create this study

    - `String apiKeyId`

      Unique API key identifier (UUIDv4 format)

    - `String description`

      Human-readable description of the API key

    - `Optional<Boolean> isViewerEnabled`

      Whether this API key has access to the Viewer product

  - `Optional<CreatedByUser> createdByUser`

    Reference to the user who created this study via dashboard

    - `String email`

      User's email address

    - `String userId`

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

    - `Optional<String> firstName`

      User's first name

    - `Optional<String> lastName`

      User's last name

    - `Optional<String> middleName`

      User's middle name

    - `Optional<String> suffix1`

      Name suffix (e.g., 'MD', 'Jr.')

    - `Optional<String> suffix2`

      Additional name suffix

  - `Optional<ExpressCustomer> expressCustomer`

    Reference to the Express customer this study belongs to

    - `String expressCustomerId`

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

    - `String expressCustomerName`

      Name of the Express customer

  - `Optional<Metadata> metadata`

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

  - `Optional<List<String>> priorReportTexts`

    Array of prior report texts to provide clinical context

  - `Optional<List<String>> priorStudyIds`

    Array of prior study IDs for comparison context (format: stu_{32-hex-chars})

  - `Optional<List<ReportIdWithStatus>> reportIds`

    Array of report IDs associated with this study, including addendums

    - `String reportId`

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

    - `Status status`

      Current status of the report

      - `IN_PROGRESS("in_progress")`

      - `COMPLETED("completed")`

### Example

```java
package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.autoscribe.studies.StudyRetrieveParams;
import com.avara.models.autoscribe.studies.StudyRetrieveResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        StudyRetrieveResponse study = client.autoScribe().studies().retrieve("stu_1234567890abcdef1234567890abcdef");
    }
}
```

## Update

`StudyUpdateResponse autoScribe().studies().update(StudyUpdateParamsparams = StudyUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

**patch** `/v1/autoScribe/studies/{studyId}`

Updates a study's properties including description, severity, assignment, organization, metadata, and report metadata. All fields are optional - only provided fields will be updated.

### Parameters

- `StudyUpdateParams params`

  - `Optional<String> studyId`

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

  - `Optional<String> assignedTo`

    User ID to assign the study to, or null to unassign. Format: usr_{32-hex-chars}

  - `Optional<String> expressCustomerId`

    Express Customer ID for the study, or null to remove. Format: cus_{32-hex-chars}

  - `Optional<Metadata> metadata`

  - `Optional<List<String>> priorReportTexts`

  - `Optional<List<String>> priorStudyIds`

  - `Optional<ReportMetadata> reportMetadata`

    - `Optional<String> age`

    - `Optional<String> dateOfBirth`

    - `Optional<String> facilityName`

    - `Optional<Height> height`

      - `Unit unit`

        - `IN("in")`

        - `CM("cm")`

      - `double value`

    - `Optional<String> mrn`

    - `Optional<String> patientName`

    - `Optional<String> referringPhysicianName`

    - `Optional<String> scanDate`

    - `Optional<String> scanTime`

    - `Optional<String> scanType`

    - `Optional<Sex> sex`

      - `MALE("male")`

      - `FEMALE("female")`

      - `OTHER("other")`

    - `Optional<Weight> weight`

      - `Unit unit`

        - `LBS("lbs")`

        - `KG("kg")`

      - `double value`

  - `Optional<Severity> severity`

    Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention

    - `NORMAL("normal")`

    - `HIGH("high")`

    - `STAT("stat")`

  - `Optional<String> studyDescription`

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

### Returns

- `class StudyUpdateResponse:`

  A study entity in the AutoScribe system with report workflow status

  - `Optional<LocalDateTime> cancelledAt`

    Timestamp when the study was cancelled, null if not cancelled

  - `Optional<LocalDateTime> createdAt`

    Timestamp when the study was created

  - `boolean isCancelled`

    Whether the study has been cancelled

  - `StudyReportMetadata reportMetadata`

    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`

        - `IN("in")`

        - `CM("cm")`

      - `double value`

    - `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'

      - `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`

        - `LBS("lbs")`

        - `KG("kg")`

      - `double value`

  - `Severity severity`

    Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention

    - `NORMAL("normal")`

    - `HIGH("high")`

    - `STAT("stat")`

  - `String studyDescription`

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

  - `String studyId`

    Unique study identifier. 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')

  - `StudyReportStatus studyReportStatus`

    Report workflow status. 'unassigned' = no radiologist assigned, 'assigned' = assigned but not started, 'in_progress' = actively being dictated, 'completed' = report signed, 'addendum_active' = addendum in progress

    - `UNASSIGNED("unassigned")`

    - `ASSIGNED("assigned")`

    - `IN_PROGRESS("in_progress")`

    - `COMPLETED("completed")`

    - `ADDENDUM_ACTIVE("addendum_active")`

  - `Optional<LocalDateTime> updatedAt`

    Timestamp when the study was last updated

  - `Optional<AssignedTo> assignedTo`

    Reference to the assigned radiologist, null if unassigned

    - `String email`

      User's email address

    - `String userId`

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

    - `Optional<String> firstName`

      User's first name

    - `Optional<String> lastName`

      User's last name

    - `Optional<String> middleName`

      User's middle name

    - `Optional<String> suffix1`

      Name suffix (e.g., 'MD', 'Jr.')

    - `Optional<String> suffix2`

      Additional name suffix

  - `Optional<CreatedByApiKey> createdByApiKey`

    Reference to the API key used to create this study

    - `String apiKeyId`

      Unique API key identifier (UUIDv4 format)

    - `String description`

      Human-readable description of the API key

    - `Optional<Boolean> isViewerEnabled`

      Whether this API key has access to the Viewer product

  - `Optional<CreatedByUser> createdByUser`

    Reference to the user who created this study via dashboard

    - `String email`

      User's email address

    - `String userId`

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

    - `Optional<String> firstName`

      User's first name

    - `Optional<String> lastName`

      User's last name

    - `Optional<String> middleName`

      User's middle name

    - `Optional<String> suffix1`

      Name suffix (e.g., 'MD', 'Jr.')

    - `Optional<String> suffix2`

      Additional name suffix

  - `Optional<ExpressCustomer> expressCustomer`

    Reference to the Express customer this study belongs to

    - `String expressCustomerId`

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

    - `String expressCustomerName`

      Name of the Express customer

  - `Optional<Metadata> metadata`

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

  - `Optional<List<String>> priorReportTexts`

    Array of prior report texts to provide clinical context

  - `Optional<List<String>> priorStudyIds`

    Array of prior study IDs for comparison context (format: stu_{32-hex-chars})

  - `Optional<List<ReportIdWithStatus>> reportIds`

    Array of report IDs associated with this study, including addendums

    - `String reportId`

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

    - `Status status`

      Current status of the report

      - `IN_PROGRESS("in_progress")`

      - `COMPLETED("completed")`

### Example

```java
package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.autoscribe.studies.StudyUpdateParams;
import com.avara.models.autoscribe.studies.StudyUpdateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        StudyUpdateResponse study = client.autoScribe().studies().update("stu_1234567890abcdef1234567890abcdef");
    }
}
```

## Cancel

`StudyCancelResponse autoScribe().studies().cancel(StudyCancelParamsparams = StudyCancelParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

**post** `/v1/autoScribe/studies/cancel`

Marks a study as cancelled. Cancelled studies are preserved but flagged as inactive. Can be identified by either study ID or DICOM Study Instance UID.

### Parameters

- `StudyCancelParams 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')

### Returns

- `class StudyCancelResponse:`

  Response for cancelling a study in AutoScribe

  - `boolean success`

  - `Optional<String> message`

### Example

```java
package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.autoscribe.studies.StudyCancelParams;
import com.avara.models.autoscribe.studies.StudyCancelResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        StudyCancelResponse response = client.autoScribe().studies().cancel();
    }
}
```

## Uncancel

`StudyUncancelResponse autoScribe().studies().uncancel(StudyUncancelParamsparams = StudyUncancelParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

**post** `/v1/autoScribe/studies/uncancel`

Restores a cancelled study to active status. The study must have been previously cancelled. Can be identified by either study ID or DICOM Study Instance UID.

### Parameters

- `StudyUncancelParams 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')

### Returns

- `class StudyUncancelResponse:`

  Response for uncancelling a study in AutoScribe

  - `boolean success`

  - `Optional<String> message`

### Example

```java
package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.autoscribe.studies.StudyUncancelParams;
import com.avara.models.autoscribe.studies.StudyUncancelResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        StudyUncancelResponse response = client.autoScribe().studies().uncancel();
    }
}
```

## Reroute URL

`StudyRerouteUrlResponse autoScribe().studies().rerouteUrl(StudyRerouteUrlParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

**post** `/v1/autoScribe/studies/reroute-url`

Generates a tokenized URL that redirects users to the AutoScribe interface (viewer + dictation) for the specified study and user. The URL includes authentication and is time-limited for security.

### Parameters

- `StudyRerouteUrlParams params`

  - `String assignedToUserId`

    User ID to assign study to. Format: usr_{32-hex-chars}

  - `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')

### Returns

- `class StudyRerouteUrlResponse:`

  Response containing the generated reroute URL for AutoScribe (viewer + dictation)

  - `String url`

### Example

```java
package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.autoscribe.studies.StudyRerouteUrlParams;
import com.avara.models.autoscribe.studies.StudyRerouteUrlResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        StudyRerouteUrlParams params = StudyRerouteUrlParams.builder()
            .assignedToUserId("usr_1234567890abcdef1234567890abcdef")
            .build();
        StudyRerouteUrlResponse response = client.autoScribe().studies().rerouteUrl(params);
    }
}
```

## Viewer Only Reroute URL

`StudyViewerOnlyRerouteUrlResponse autoScribe().studies().viewerOnlyRerouteUrl(StudyViewerOnlyRerouteUrlParamsparams = StudyViewerOnlyRerouteUrlParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

**post** `/v1/autoScribe/studies/viewer-only-reroute-url`

Generates a tokenized URL that redirects users to the viewer interface only (no dictation) for the specified study. Useful for read-only access or referring physicians. The URL includes authentication and is time-limited.

### Parameters

- `StudyViewerOnlyRerouteUrlParams 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')

  - `Optional<String> userId`

    Optional user ID for audit tracking. Format: usr_{32-hex-chars}

### Returns

- `class StudyViewerOnlyRerouteUrlResponse:`

  Response containing the generated viewer-only reroute URL. Requires viewer to be configured.

  - `String url`

### Example

```java
package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.autoscribe.studies.StudyViewerOnlyRerouteUrlParams;
import com.avara.models.autoscribe.studies.StudyViewerOnlyRerouteUrlResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        StudyViewerOnlyRerouteUrlResponse response = client.autoScribe().studies().viewerOnlyRerouteUrl();
    }
}
```

## Retrieve By Uid

`StudyRetrieveByUidResponse autoScribe().studies().retrieveByUid(StudyRetrieveByUidParamsparams = StudyRetrieveByUidParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

**get** `/v1/autoScribe/studies/by-uid/{studyInstanceUid}`

Retrieves a single study by its DICOM Study Instance UID. This is useful when you have the DICOM UID but not the Avara study ID.

### Parameters

- `StudyRetrieveByUidParams params`

  - `Optional<String> studyInstanceUid`

    DICOM Study Instance UID. Format: numbers and dots (e.g., 1.2.840.10008.5.1.4.1.1.2).

### Returns

- `class StudyRetrieveByUidResponse:`

  A study entity in the AutoScribe system with report workflow status

  - `Optional<LocalDateTime> cancelledAt`

    Timestamp when the study was cancelled, null if not cancelled

  - `Optional<LocalDateTime> createdAt`

    Timestamp when the study was created

  - `boolean isCancelled`

    Whether the study has been cancelled

  - `StudyReportMetadata reportMetadata`

    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`

        - `IN("in")`

        - `CM("cm")`

      - `double value`

    - `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'

      - `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`

        - `LBS("lbs")`

        - `KG("kg")`

      - `double value`

  - `Severity severity`

    Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention

    - `NORMAL("normal")`

    - `HIGH("high")`

    - `STAT("stat")`

  - `String studyDescription`

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

  - `String studyId`

    Unique study identifier. 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')

  - `StudyReportStatus studyReportStatus`

    Report workflow status. 'unassigned' = no radiologist assigned, 'assigned' = assigned but not started, 'in_progress' = actively being dictated, 'completed' = report signed, 'addendum_active' = addendum in progress

    - `UNASSIGNED("unassigned")`

    - `ASSIGNED("assigned")`

    - `IN_PROGRESS("in_progress")`

    - `COMPLETED("completed")`

    - `ADDENDUM_ACTIVE("addendum_active")`

  - `Optional<LocalDateTime> updatedAt`

    Timestamp when the study was last updated

  - `Optional<AssignedTo> assignedTo`

    Reference to the assigned radiologist, null if unassigned

    - `String email`

      User's email address

    - `String userId`

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

    - `Optional<String> firstName`

      User's first name

    - `Optional<String> lastName`

      User's last name

    - `Optional<String> middleName`

      User's middle name

    - `Optional<String> suffix1`

      Name suffix (e.g., 'MD', 'Jr.')

    - `Optional<String> suffix2`

      Additional name suffix

  - `Optional<CreatedByApiKey> createdByApiKey`

    Reference to the API key used to create this study

    - `String apiKeyId`

      Unique API key identifier (UUIDv4 format)

    - `String description`

      Human-readable description of the API key

    - `Optional<Boolean> isViewerEnabled`

      Whether this API key has access to the Viewer product

  - `Optional<CreatedByUser> createdByUser`

    Reference to the user who created this study via dashboard

    - `String email`

      User's email address

    - `String userId`

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

    - `Optional<String> firstName`

      User's first name

    - `Optional<String> lastName`

      User's last name

    - `Optional<String> middleName`

      User's middle name

    - `Optional<String> suffix1`

      Name suffix (e.g., 'MD', 'Jr.')

    - `Optional<String> suffix2`

      Additional name suffix

  - `Optional<ExpressCustomer> expressCustomer`

    Reference to the Express customer this study belongs to

    - `String expressCustomerId`

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

    - `String expressCustomerName`

      Name of the Express customer

  - `Optional<Metadata> metadata`

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

  - `Optional<List<String>> priorReportTexts`

    Array of prior report texts to provide clinical context

  - `Optional<List<String>> priorStudyIds`

    Array of prior study IDs for comparison context (format: stu_{32-hex-chars})

  - `Optional<List<ReportIdWithStatus>> reportIds`

    Array of report IDs associated with this study, including addendums

    - `String reportId`

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

    - `Status status`

      Current status of the report

      - `IN_PROGRESS("in_progress")`

      - `COMPLETED("completed")`

### Example

```java
package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.autoscribe.studies.StudyRetrieveByUidParams;
import com.avara.models.autoscribe.studies.StudyRetrieveByUidResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        StudyRetrieveByUidResponse response = client.autoScribe().studies().retrieveByUid("1.2.840.10008.5.1.4.1.1.2");
    }
}
```

## Domain Types

### Report ID With Status

- `class ReportIdWithStatus:`

  A report ID paired with its current status

  - `String reportId`

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

  - `Status status`

    Current status of the report

    - `IN_PROGRESS("in_progress")`

    - `COMPLETED("completed")`