# Studies

## Create a new study

`client.autoScribe.studies.create(StudyCreateParamsbody, RequestOptionsoptions?): StudyCreateResponse`

**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, clinical context (indication, history, technologist technique/notes), an imaging modality, an external patient identifier for linking studies, and external prior reports for comparison context.

### Parameters

- `body: StudyCreateParams`

  - `reportMetadata: StudyReportMetadata`

    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`

      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.

        - `"in"`

        - `"cm"`

      - `value: number`

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

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

      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.

        - `"lbs"`

        - `"kg"`

      - `value: number`

  - `severity: Severity`

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

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `studyDescription: string`

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

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

  - `assignedTo?: string`

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

  - `clinicalHistory?: string | null`

    Relevant clinical history for the patient/study

  - `clinicalIndication?: string | null`

    Clinical indication for the study (reason the study was ordered)

  - `expressCustomerId?: string`

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

  - `externalPatientId?: string | null`

    Integrator-provided stable patient identifier used to link studies for the same patient across the AutoScribe system

  - `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, e.g., 'CT', 'MRI', 'X-Ray')

  - `priorReports?: Array<PriorReport>`

    External prior reports (metadata + full report text) to provide longitudinal/comparison context for this study. Maximum 50 items

    - `reportText: string`

      Full prior report text

    - `externalStudyId?: string`

      Integrator's external study identifier

    - `modality?: string`

      Imaging modality for the prior study

    - `studyDate?: string`

      Prior study date (YYYY-MM-DD)

    - `studyDescription?: string`

      Description of the prior study

  - `technologistNotes?: Array<string>`

    Technologist notes for the study. Maximum 50 items, each up to 1000 characters

  - `technologistTechnique?: string | null`

    Imaging technique description provided by the technologist

### Returns

- `StudyCreateResponse`

  A study entity in the AutoScribe system with report workflow status

  - `cancelledAt: string | null`

    Timestamp when the study was cancelled, null if not cancelled

  - `createdAt: string | null`

    Timestamp when the study was created

  - `isCancelled: boolean`

    Whether the study has been cancelled

  - `reportMetadata: StudyReportMetadata`

    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`

      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.

        - `"in"`

        - `"cm"`

      - `value: number`

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

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

      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.

        - `"lbs"`

        - `"kg"`

      - `value: number`

  - `severity: Severity`

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

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `studyDescription: string`

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

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

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

    - `"unassigned"`

    - `"assigned"`

    - `"in_progress"`

    - `"completed"`

    - `"addendum_active"`

  - `updatedAt: string | null`

    Timestamp when the study was last updated

  - `assignedTo?: UserReference | 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 | null`

    A reference to an API key with basic identifying information

    - `apiKeyId: string`

      Unique API key identifier (UUIDv4 format)

    - `description: string`

      Human-readable description of the API key

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

    A reference to a user with basic identifying information

  - `expressCustomer?: ExpressCustomerReference | 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

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

    External prior reports with metadata and text

    - `reportText: string`

      Full prior report text

    - `externalStudyId?: string`

      Integrator's external study identifier

    - `modality?: string`

      Imaging modality for the prior study

    - `studyDate?: string`

      Prior study date (YYYY-MM-DD)

    - `studyDescription?: string`

      Description of the prior study

  - `reportIds?: Array<ReportIDWithStatus>`

    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.

      - `"in_progress"`

      - `"completed"`

  - `studyType?: StudyType`

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

    - `"standard"`

    - `"external"`

  - `technologistNotes?: Array<string>`

    Technologist notes for the study

  - `technologistTechnique?: string | null`

    Imaging technique description

### Example

```typescript
import Avara from 'avara-software';

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

const study = await client.autoScribe.studies.create({
  reportMetadata: {},
  severity: 'normal',
  studyDescription: 'Brain MRI with Contrast',
  studyInstanceUid: '1.2.840.113619.2.55.3.604688119.868.1234567890.123',
});

console.log(study.studyInstanceUid);
```

#### Response

```json
{
  "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"
}
```

## List studies with pagination

`client.autoScribe.studies.list(StudyListParamsquery?, RequestOptionsoptions?): CursorStudies<StudyListResponse>`

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

- `query: StudyListParams`

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

  - `severity?: Severity`

    Filter by study severity

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `studyDescription?: string`

    Filter by study description (contains match)

  - `studyReportStatus?: Array<StudyReportStatus>`

    Filter by report status(es)

    - `"unassigned"`

    - `"assigned"`

    - `"in_progress"`

    - `"completed"`

    - `"addendum_active"`

  - `studyType?: StudyType`

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

    - `"standard"`

    - `"external"`

### Returns

- `StudyListResponse`

  A study entity in the AutoScribe system with report workflow status

  - `cancelledAt: string | null`

    Timestamp when the study was cancelled, null if not cancelled

  - `createdAt: string | null`

    Timestamp when the study was created

  - `isCancelled: boolean`

    Whether the study has been cancelled

  - `reportMetadata: StudyReportMetadata`

    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`

      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.

        - `"in"`

        - `"cm"`

      - `value: number`

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

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

      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.

        - `"lbs"`

        - `"kg"`

      - `value: number`

  - `severity: Severity`

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

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `studyDescription: string`

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

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

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

    - `"unassigned"`

    - `"assigned"`

    - `"in_progress"`

    - `"completed"`

    - `"addendum_active"`

  - `updatedAt: string | null`

    Timestamp when the study was last updated

  - `assignedTo?: UserReference | 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 | null`

    A reference to an API key with basic identifying information

    - `apiKeyId: string`

      Unique API key identifier (UUIDv4 format)

    - `description: string`

      Human-readable description of the API key

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

    A reference to a user with basic identifying information

  - `expressCustomer?: ExpressCustomerReference | 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

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

    External prior reports with metadata and text

    - `reportText: string`

      Full prior report text

    - `externalStudyId?: string`

      Integrator's external study identifier

    - `modality?: string`

      Imaging modality for the prior study

    - `studyDate?: string`

      Prior study date (YYYY-MM-DD)

    - `studyDescription?: string`

      Description of the prior study

  - `reportIds?: Array<ReportIDWithStatus>`

    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.

      - `"in_progress"`

      - `"completed"`

  - `studyType?: StudyType`

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

    - `"standard"`

    - `"external"`

  - `technologistNotes?: Array<string>`

    Technologist notes for the study

  - `technologistTechnique?: string | null`

    Imaging technique description

### Example

```typescript
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);
}
```

#### Response

```json
{
  "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"
}
```

## Retrieve a study by ID

`client.autoScribe.studies.retrieve(stringstudyID, RequestOptionsoptions?): StudyRetrieveResponse`

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

- `studyID: string`

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

### Returns

- `StudyRetrieveResponse`

  A study entity in the AutoScribe system with report workflow status

  - `cancelledAt: string | null`

    Timestamp when the study was cancelled, null if not cancelled

  - `createdAt: string | null`

    Timestamp when the study was created

  - `isCancelled: boolean`

    Whether the study has been cancelled

  - `reportMetadata: StudyReportMetadata`

    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`

      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.

        - `"in"`

        - `"cm"`

      - `value: number`

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

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

      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.

        - `"lbs"`

        - `"kg"`

      - `value: number`

  - `severity: Severity`

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

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `studyDescription: string`

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

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

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

    - `"unassigned"`

    - `"assigned"`

    - `"in_progress"`

    - `"completed"`

    - `"addendum_active"`

  - `updatedAt: string | null`

    Timestamp when the study was last updated

  - `assignedTo?: UserReference | 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 | null`

    A reference to an API key with basic identifying information

    - `apiKeyId: string`

      Unique API key identifier (UUIDv4 format)

    - `description: string`

      Human-readable description of the API key

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

    A reference to a user with basic identifying information

  - `expressCustomer?: ExpressCustomerReference | 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

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

    External prior reports with metadata and text

    - `reportText: string`

      Full prior report text

    - `externalStudyId?: string`

      Integrator's external study identifier

    - `modality?: string`

      Imaging modality for the prior study

    - `studyDate?: string`

      Prior study date (YYYY-MM-DD)

    - `studyDescription?: string`

      Description of the prior study

  - `reportIds?: Array<ReportIDWithStatus>`

    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.

      - `"in_progress"`

      - `"completed"`

  - `studyType?: StudyType`

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

    - `"standard"`

    - `"external"`

  - `technologistNotes?: Array<string>`

    Technologist notes for the study

  - `technologistTechnique?: string | null`

    Imaging technique description

### Example

```typescript
import Avara from 'avara-software';

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

const study = await client.autoScribe.studies.retrieve('stu_1234567890abcdef1234567890abcdef');

console.log(study.studyInstanceUid);
```

#### Response

```json
{
  "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"
}
```

## Update a study

`client.autoScribe.studies.update(stringstudyID, StudyUpdateParamsbody?, RequestOptionsoptions?): StudyUpdateResponse`

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

- `studyID: string`

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

- `body: StudyUpdateParams`

  - `assignedTo?: string`

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

  - `clinicalHistory?: string | null`

    Relevant clinical history for the patient/study. Null clears.

  - `clinicalIndication?: string | null`

    Clinical indication for the study. Null clears.

  - `expressCustomerId?: string`

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

  - `externalPatientId?: string | null`

    Integrator-provided stable patient identifier used to link studies for the same patient. Null clears.

  - `metadata?: Record<string, string> | null`

  - `modality?: string | null`

    Imaging modality for the study (free text). Null clears.

  - `priorReports?: Array<PriorReport> | null`

    External prior reports (metadata + full report text) for comparison context. Null clears; an array replaces the existing set. Maximum 50 items

    - `reportText: string`

      Full prior report text

    - `externalStudyId?: string`

      Integrator's external study identifier

    - `modality?: string`

      Imaging modality for the prior study

    - `studyDate?: string`

      Prior study date (YYYY-MM-DD)

    - `studyDescription?: string`

      Description of the prior study

  - `reportMetadata?: ReportMetadata`

    - `age?: string | null`

    - `dateOfBirth?: string | null`

    - `facilityName?: string | null`

    - `height?: Height | null`

      - `unit: HeightUnit`

        Unit of measure for a height value. 'in' = inches, 'cm' = centimeters.

        - `"in"`

        - `"cm"`

      - `value: number`

    - `mrn?: string | null`

    - `patientName?: string | null`

    - `procedure?: string | null`

      Procedure or study type. Nullable on PATCH. Maps to DB scan_type and report_header.scan_type.

    - `referringPhysicianName?: string | null`

    - `sex?: Sex | null`

      Patient's biological sex. Options: 'male', 'female', 'other'

      - `"male"`

      - `"female"`

      - `"other"`

    - `studyDate?: string | null`

      Study date (YYYY-MM-DD). Nullable on PATCH. Maps to DB scan_date and report_header.scan_date.

    - `studyTime?: string | null`

      Study time (HH:MM). Nullable on PATCH. Maps to DB scan_time and report_header.scan_time.

    - `weight?: Weight | null`

      - `unit: WeightUnit`

        Unit of measure for a weight value. 'lbs' = pounds, 'kg' = kilograms.

        - `"lbs"`

        - `"kg"`

      - `value: number`

  - `severity?: Severity`

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

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `studyDescription?: string`

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

  - `technologistNotes?: Array<string> | null`

    Technologist notes for the study. Null clears; an array replaces the existing set. Maximum 50 items, each up to 1000 characters

  - `technologistTechnique?: string | null`

    Imaging technique description provided by the technologist. Null clears.

### Returns

- `StudyUpdateResponse`

  A study entity in the AutoScribe system with report workflow status

  - `cancelledAt: string | null`

    Timestamp when the study was cancelled, null if not cancelled

  - `createdAt: string | null`

    Timestamp when the study was created

  - `isCancelled: boolean`

    Whether the study has been cancelled

  - `reportMetadata: StudyReportMetadata`

    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`

      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.

        - `"in"`

        - `"cm"`

      - `value: number`

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

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

      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.

        - `"lbs"`

        - `"kg"`

      - `value: number`

  - `severity: Severity`

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

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `studyDescription: string`

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

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

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

    - `"unassigned"`

    - `"assigned"`

    - `"in_progress"`

    - `"completed"`

    - `"addendum_active"`

  - `updatedAt: string | null`

    Timestamp when the study was last updated

  - `assignedTo?: UserReference | 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 | null`

    A reference to an API key with basic identifying information

    - `apiKeyId: string`

      Unique API key identifier (UUIDv4 format)

    - `description: string`

      Human-readable description of the API key

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

    A reference to a user with basic identifying information

  - `expressCustomer?: ExpressCustomerReference | 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

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

    External prior reports with metadata and text

    - `reportText: string`

      Full prior report text

    - `externalStudyId?: string`

      Integrator's external study identifier

    - `modality?: string`

      Imaging modality for the prior study

    - `studyDate?: string`

      Prior study date (YYYY-MM-DD)

    - `studyDescription?: string`

      Description of the prior study

  - `reportIds?: Array<ReportIDWithStatus>`

    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.

      - `"in_progress"`

      - `"completed"`

  - `studyType?: StudyType`

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

    - `"standard"`

    - `"external"`

  - `technologistNotes?: Array<string>`

    Technologist notes for the study

  - `technologistTechnique?: string | null`

    Imaging technique description

### Example

```typescript
import Avara from 'avara-software';

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

const study = await client.autoScribe.studies.update('stu_1234567890abcdef1234567890abcdef');

console.log(study.studyInstanceUid);
```

#### Response

```json
{
  "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"
}
```

## Cancel a study

`client.autoScribe.studies.cancel(StudyCancelParamsbody?, RequestOptionsoptions?): StudyCancelResponse`

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

- `body: StudyCancelParams`

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

### Returns

- `StudyCancelResponse`

  Response for cancelling a study in AutoScribe

  - `success: boolean`

  - `message?: string`

### Example

```typescript
import Avara from 'avara-software';

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

const response = await client.autoScribe.studies.cancel();

console.log(response.success);
```

#### Response

```json
{
  "success": true,
  "message": "message"
}
```

## Uncancel a study

`client.autoScribe.studies.uncancel(StudyUncancelParamsbody?, RequestOptionsoptions?): StudyUncancelResponse`

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

- `body: StudyUncancelParams`

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

### Returns

- `StudyUncancelResponse`

  Response for uncancelling a study in AutoScribe

  - `success: boolean`

  - `message?: string`

### Example

```typescript
import Avara from 'avara-software';

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

const response = await client.autoScribe.studies.uncancel();

console.log(response.success);
```

#### Response

```json
{
  "success": true,
  "message": "message"
}
```

## Generate a reroute URL with viewer and dictation

`client.autoScribe.studies.rerouteURL(StudyRerouteURLParamsbody, RequestOptionsoptions?): StudyRerouteURLResponse`

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

- `body: StudyRerouteURLParams`

  - `assignedToUserId: string`

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

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

### Returns

- `StudyRerouteURLResponse`

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

  - `url: string`

### Example

```typescript
import Avara from 'avara-software';

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

const response = await client.autoScribe.studies.rerouteURL({
  assignedToUserId: 'usr_1234567890abcdef1234567890abcdef',
});

console.log(response.url);
```

#### Response

```json
{
  "url": "https://autoscribe.avarasoftware.com/study/stu_1234?token=abc123"
}
```

## Generate a viewer-only reroute URL

`client.autoScribe.studies.viewerOnlyRerouteURL(StudyViewerOnlyRerouteURLParamsbody?, RequestOptionsoptions?): StudyViewerOnlyRerouteURLResponse`

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

- `body: StudyViewerOnlyRerouteURLParams`

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

  - `userId?: string`

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

### Returns

- `StudyViewerOnlyRerouteURLResponse`

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

  - `url: string`

### Example

```typescript
import Avara from 'avara-software';

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

const response = await client.autoScribe.studies.viewerOnlyRerouteURL();

console.log(response.url);
```

#### Response

```json
{
  "url": "https://viewer.avarasoftware.com/study/stu_1234?token=abc123"
}
```

## Retrieve a study by DICOM UID

`client.autoScribe.studies.retrieveByUid(stringstudyInstanceUid, RequestOptionsoptions?): StudyRetrieveByUidResponse`

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

- `studyInstanceUid: string`

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

### Returns

- `StudyRetrieveByUidResponse`

  A study entity in the AutoScribe system with report workflow status

  - `cancelledAt: string | null`

    Timestamp when the study was cancelled, null if not cancelled

  - `createdAt: string | null`

    Timestamp when the study was created

  - `isCancelled: boolean`

    Whether the study has been cancelled

  - `reportMetadata: StudyReportMetadata`

    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`

      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.

        - `"in"`

        - `"cm"`

      - `value: number`

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

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

      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.

        - `"lbs"`

        - `"kg"`

      - `value: number`

  - `severity: Severity`

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

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `studyDescription: string`

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

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

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

    - `"unassigned"`

    - `"assigned"`

    - `"in_progress"`

    - `"completed"`

    - `"addendum_active"`

  - `updatedAt: string | null`

    Timestamp when the study was last updated

  - `assignedTo?: UserReference | 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 | null`

    A reference to an API key with basic identifying information

    - `apiKeyId: string`

      Unique API key identifier (UUIDv4 format)

    - `description: string`

      Human-readable description of the API key

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

    A reference to a user with basic identifying information

  - `expressCustomer?: ExpressCustomerReference | 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

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

    External prior reports with metadata and text

    - `reportText: string`

      Full prior report text

    - `externalStudyId?: string`

      Integrator's external study identifier

    - `modality?: string`

      Imaging modality for the prior study

    - `studyDate?: string`

      Prior study date (YYYY-MM-DD)

    - `studyDescription?: string`

      Description of the prior study

  - `reportIds?: Array<ReportIDWithStatus>`

    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.

      - `"in_progress"`

      - `"completed"`

  - `studyType?: StudyType`

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

    - `"standard"`

    - `"external"`

  - `technologistNotes?: Array<string>`

    Technologist notes for the study

  - `technologistTechnique?: string | null`

    Imaging technique description

### Example

```typescript
import Avara from 'avara-software';

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

const response = await client.autoScribe.studies.retrieveByUid('1.2.840.10008.5.1.4.1.1.2');

console.log(response.studyInstanceUid);
```

#### Response

```json
{
  "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"
}
```

## Domain Types

### Prior Report

- `PriorReport`

  External prior report metadata and text stored on a study

  - `reportText: string`

    Full prior report text

  - `externalStudyId?: string`

    Integrator's external study identifier

  - `modality?: string`

    Imaging modality for the prior study

  - `studyDate?: string`

    Prior study date (YYYY-MM-DD)

  - `studyDescription?: string`

    Description of the prior study

### Report ID With Status

- `ReportIDWithStatus`

  A report ID paired with its current status

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

    - `"in_progress"`

    - `"completed"`

### Study Create Response

- `StudyCreateResponse`

  A study entity in the AutoScribe system with report workflow status

  - `cancelledAt: string | null`

    Timestamp when the study was cancelled, null if not cancelled

  - `createdAt: string | null`

    Timestamp when the study was created

  - `isCancelled: boolean`

    Whether the study has been cancelled

  - `reportMetadata: StudyReportMetadata`

    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`

      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.

        - `"in"`

        - `"cm"`

      - `value: number`

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

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

      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.

        - `"lbs"`

        - `"kg"`

      - `value: number`

  - `severity: Severity`

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

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `studyDescription: string`

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

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

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

    - `"unassigned"`

    - `"assigned"`

    - `"in_progress"`

    - `"completed"`

    - `"addendum_active"`

  - `updatedAt: string | null`

    Timestamp when the study was last updated

  - `assignedTo?: UserReference | 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 | null`

    A reference to an API key with basic identifying information

    - `apiKeyId: string`

      Unique API key identifier (UUIDv4 format)

    - `description: string`

      Human-readable description of the API key

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

    A reference to a user with basic identifying information

  - `expressCustomer?: ExpressCustomerReference | 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

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

    External prior reports with metadata and text

    - `reportText: string`

      Full prior report text

    - `externalStudyId?: string`

      Integrator's external study identifier

    - `modality?: string`

      Imaging modality for the prior study

    - `studyDate?: string`

      Prior study date (YYYY-MM-DD)

    - `studyDescription?: string`

      Description of the prior study

  - `reportIds?: Array<ReportIDWithStatus>`

    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.

      - `"in_progress"`

      - `"completed"`

  - `studyType?: StudyType`

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

    - `"standard"`

    - `"external"`

  - `technologistNotes?: Array<string>`

    Technologist notes for the study

  - `technologistTechnique?: string | null`

    Imaging technique description

### Study List Response

- `StudyListResponse`

  A study entity in the AutoScribe system with report workflow status

  - `cancelledAt: string | null`

    Timestamp when the study was cancelled, null if not cancelled

  - `createdAt: string | null`

    Timestamp when the study was created

  - `isCancelled: boolean`

    Whether the study has been cancelled

  - `reportMetadata: StudyReportMetadata`

    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`

      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.

        - `"in"`

        - `"cm"`

      - `value: number`

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

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

      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.

        - `"lbs"`

        - `"kg"`

      - `value: number`

  - `severity: Severity`

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

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `studyDescription: string`

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

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

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

    - `"unassigned"`

    - `"assigned"`

    - `"in_progress"`

    - `"completed"`

    - `"addendum_active"`

  - `updatedAt: string | null`

    Timestamp when the study was last updated

  - `assignedTo?: UserReference | 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 | null`

    A reference to an API key with basic identifying information

    - `apiKeyId: string`

      Unique API key identifier (UUIDv4 format)

    - `description: string`

      Human-readable description of the API key

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

    A reference to a user with basic identifying information

  - `expressCustomer?: ExpressCustomerReference | 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

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

    External prior reports with metadata and text

    - `reportText: string`

      Full prior report text

    - `externalStudyId?: string`

      Integrator's external study identifier

    - `modality?: string`

      Imaging modality for the prior study

    - `studyDate?: string`

      Prior study date (YYYY-MM-DD)

    - `studyDescription?: string`

      Description of the prior study

  - `reportIds?: Array<ReportIDWithStatus>`

    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.

      - `"in_progress"`

      - `"completed"`

  - `studyType?: StudyType`

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

    - `"standard"`

    - `"external"`

  - `technologistNotes?: Array<string>`

    Technologist notes for the study

  - `technologistTechnique?: string | null`

    Imaging technique description

### Study Retrieve Response

- `StudyRetrieveResponse`

  A study entity in the AutoScribe system with report workflow status

  - `cancelledAt: string | null`

    Timestamp when the study was cancelled, null if not cancelled

  - `createdAt: string | null`

    Timestamp when the study was created

  - `isCancelled: boolean`

    Whether the study has been cancelled

  - `reportMetadata: StudyReportMetadata`

    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`

      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.

        - `"in"`

        - `"cm"`

      - `value: number`

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

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

      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.

        - `"lbs"`

        - `"kg"`

      - `value: number`

  - `severity: Severity`

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

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `studyDescription: string`

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

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

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

    - `"unassigned"`

    - `"assigned"`

    - `"in_progress"`

    - `"completed"`

    - `"addendum_active"`

  - `updatedAt: string | null`

    Timestamp when the study was last updated

  - `assignedTo?: UserReference | 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 | null`

    A reference to an API key with basic identifying information

    - `apiKeyId: string`

      Unique API key identifier (UUIDv4 format)

    - `description: string`

      Human-readable description of the API key

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

    A reference to a user with basic identifying information

  - `expressCustomer?: ExpressCustomerReference | 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

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

    External prior reports with metadata and text

    - `reportText: string`

      Full prior report text

    - `externalStudyId?: string`

      Integrator's external study identifier

    - `modality?: string`

      Imaging modality for the prior study

    - `studyDate?: string`

      Prior study date (YYYY-MM-DD)

    - `studyDescription?: string`

      Description of the prior study

  - `reportIds?: Array<ReportIDWithStatus>`

    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.

      - `"in_progress"`

      - `"completed"`

  - `studyType?: StudyType`

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

    - `"standard"`

    - `"external"`

  - `technologistNotes?: Array<string>`

    Technologist notes for the study

  - `technologistTechnique?: string | null`

    Imaging technique description

### Study Update Response

- `StudyUpdateResponse`

  A study entity in the AutoScribe system with report workflow status

  - `cancelledAt: string | null`

    Timestamp when the study was cancelled, null if not cancelled

  - `createdAt: string | null`

    Timestamp when the study was created

  - `isCancelled: boolean`

    Whether the study has been cancelled

  - `reportMetadata: StudyReportMetadata`

    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`

      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.

        - `"in"`

        - `"cm"`

      - `value: number`

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

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

      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.

        - `"lbs"`

        - `"kg"`

      - `value: number`

  - `severity: Severity`

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

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `studyDescription: string`

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

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

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

    - `"unassigned"`

    - `"assigned"`

    - `"in_progress"`

    - `"completed"`

    - `"addendum_active"`

  - `updatedAt: string | null`

    Timestamp when the study was last updated

  - `assignedTo?: UserReference | 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 | null`

    A reference to an API key with basic identifying information

    - `apiKeyId: string`

      Unique API key identifier (UUIDv4 format)

    - `description: string`

      Human-readable description of the API key

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

    A reference to a user with basic identifying information

  - `expressCustomer?: ExpressCustomerReference | 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

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

    External prior reports with metadata and text

    - `reportText: string`

      Full prior report text

    - `externalStudyId?: string`

      Integrator's external study identifier

    - `modality?: string`

      Imaging modality for the prior study

    - `studyDate?: string`

      Prior study date (YYYY-MM-DD)

    - `studyDescription?: string`

      Description of the prior study

  - `reportIds?: Array<ReportIDWithStatus>`

    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.

      - `"in_progress"`

      - `"completed"`

  - `studyType?: StudyType`

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

    - `"standard"`

    - `"external"`

  - `technologistNotes?: Array<string>`

    Technologist notes for the study

  - `technologistTechnique?: string | null`

    Imaging technique description

### Study Cancel Response

- `StudyCancelResponse`

  Response for cancelling a study in AutoScribe

  - `success: boolean`

  - `message?: string`

### Study Uncancel Response

- `StudyUncancelResponse`

  Response for uncancelling a study in AutoScribe

  - `success: boolean`

  - `message?: string`

### Study Reroute URL Response

- `StudyRerouteURLResponse`

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

  - `url: string`

### Study Viewer Only Reroute URL Response

- `StudyViewerOnlyRerouteURLResponse`

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

  - `url: string`

### Study Retrieve By Uid Response

- `StudyRetrieveByUidResponse`

  A study entity in the AutoScribe system with report workflow status

  - `cancelledAt: string | null`

    Timestamp when the study was cancelled, null if not cancelled

  - `createdAt: string | null`

    Timestamp when the study was created

  - `isCancelled: boolean`

    Whether the study has been cancelled

  - `reportMetadata: StudyReportMetadata`

    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`

      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.

        - `"in"`

        - `"cm"`

      - `value: number`

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

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

      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.

        - `"lbs"`

        - `"kg"`

      - `value: number`

  - `severity: Severity`

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

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `studyDescription: string`

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

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

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

    - `"unassigned"`

    - `"assigned"`

    - `"in_progress"`

    - `"completed"`

    - `"addendum_active"`

  - `updatedAt: string | null`

    Timestamp when the study was last updated

  - `assignedTo?: UserReference | 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 | null`

    A reference to an API key with basic identifying information

    - `apiKeyId: string`

      Unique API key identifier (UUIDv4 format)

    - `description: string`

      Human-readable description of the API key

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

    A reference to a user with basic identifying information

  - `expressCustomer?: ExpressCustomerReference | 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

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

    External prior reports with metadata and text

    - `reportText: string`

      Full prior report text

    - `externalStudyId?: string`

      Integrator's external study identifier

    - `modality?: string`

      Imaging modality for the prior study

    - `studyDate?: string`

      Prior study date (YYYY-MM-DD)

    - `studyDescription?: string`

      Description of the prior study

  - `reportIds?: Array<ReportIDWithStatus>`

    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.

      - `"in_progress"`

      - `"completed"`

  - `studyType?: StudyType`

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

    - `"standard"`

    - `"external"`

  - `technologistNotes?: Array<string>`

    Technologist notes for the study

  - `technologistTechnique?: string | null`

    Imaging technique description

# External

## Create an external study

`client.autoScribe.studies.external.create(ExternalCreateParamsbody, RequestOptionsoptions?): ExternalCreateResponse`

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

Creates an archive (external) AutoScribe study. Clinical context fields are not accepted. If no report fields are sent, no report row is created. Study create is all-or-nothing, including file ingest.

### Parameters

- `body: ExternalCreateParams`

  - `reportMetadata: StudyReportMetadata`

    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`

      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.

        - `"in"`

        - `"cm"`

      - `value: number`

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

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

      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.

        - `"lbs"`

        - `"kg"`

      - `value: number`

  - `severity: Severity`

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

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `studyDescription: string`

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

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

  - `expressCustomerId?: string`

  - `externalPatientId?: string | null`

    Strongly recommended if you want to leverage priors functionality for future reads for this patient.

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

  - `readerName?: string`

    Optional original reader / author name. Shown as-is. May be set on study create or a later report create; a later create overwrites it when provided.

  - `reportFileName?: string`

    File name including extension. Required when reportFileUrl is provided. Supported types: PDF, PNG, JPG, GIF, WEBP.

  - `reportFileUrl?: string`

    HTTPS download URL for a PDF or image (PNG, JPG, GIF, WEBP). Not used for AI tooling; the reader can still access it. Avara fetches this URL server-side. If omitted, you can add it later. Once set, it cannot be edited; delete the study to remake it. Whitelist https://api.avarasoftware.com on the file host if the fetch is origin-restricted.

  - `reportText?: string`

    When this study is used as a prior, report AI tools leverage this text directly. If omitted, you can add it later via POST /studies/external/reports. Once set, it cannot be edited; delete the study to remake it.

  - `signedAt?: string`

    Optional original sign-off timestamp or label. Shown as-is with no format validation. May be set on study create or a later report create; a later create overwrites it when provided.

### Returns

- `ExternalCreateResponse`

  A study entity in the AutoScribe system with report workflow status

  - `cancelledAt: string | null`

    Timestamp when the study was cancelled, null if not cancelled

  - `createdAt: string | null`

    Timestamp when the study was created

  - `isCancelled: boolean`

    Whether the study has been cancelled

  - `reportMetadata: StudyReportMetadata`

    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`

      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.

        - `"in"`

        - `"cm"`

      - `value: number`

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

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

      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.

        - `"lbs"`

        - `"kg"`

      - `value: number`

  - `severity: Severity`

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

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `studyDescription: string`

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

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

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

    - `"unassigned"`

    - `"assigned"`

    - `"in_progress"`

    - `"completed"`

    - `"addendum_active"`

  - `updatedAt: string | null`

    Timestamp when the study was last updated

  - `assignedTo?: UserReference | 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 | null`

    A reference to an API key with basic identifying information

    - `apiKeyId: string`

      Unique API key identifier (UUIDv4 format)

    - `description: string`

      Human-readable description of the API key

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

    A reference to a user with basic identifying information

  - `expressCustomer?: ExpressCustomerReference | 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

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

    External prior reports with metadata and text

    - `reportText: string`

      Full prior report text

    - `externalStudyId?: string`

      Integrator's external study identifier

    - `modality?: string`

      Imaging modality for the prior study

    - `studyDate?: string`

      Prior study date (YYYY-MM-DD)

    - `studyDescription?: string`

      Description of the prior study

  - `reportIds?: Array<ReportIDWithStatus>`

    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.

      - `"in_progress"`

      - `"completed"`

  - `studyType?: StudyType`

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

    - `"standard"`

    - `"external"`

  - `technologistNotes?: Array<string>`

    Technologist notes for the study

  - `technologistTechnique?: string | null`

    Imaging technique description

### Example

```typescript
import Avara from 'avara-software';

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

const external = await client.autoScribe.studies.external.create({
  reportMetadata: {},
  severity: 'normal',
  studyDescription: 'CT Chest without contrast',
  studyInstanceUid: '1.2.840.113619.2.55.3.604688119.868.1234567890.123',
});

console.log(external.studyInstanceUid);
```

#### Response

```json
{
  "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"
}
```

## Delete an external study

`client.autoScribe.studies.external.delete(ExternalDeleteParamsbody?, RequestOptionsoptions?): ExternalDeleteResponse`

**post** `/v1/autoScribe/studies/external/delete`

Soft-deletes an external study. This is one-way; POST /studies/uncancel cannot reverse it.

### Parameters

- `body: ExternalDeleteParams`

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

### Returns

- `ExternalDeleteResponse`

  Result of deleting an external study

  - `success: boolean`

  - `message?: string`

### Example

```typescript
import Avara from 'avara-software';

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

const external = await client.autoScribe.studies.external.delete();

console.log(external.success);
```

#### Response

```json
{
  "success": true,
  "message": "message"
}
```

## Domain Types

### External Create Response

- `ExternalCreateResponse`

  A study entity in the AutoScribe system with report workflow status

  - `cancelledAt: string | null`

    Timestamp when the study was cancelled, null if not cancelled

  - `createdAt: string | null`

    Timestamp when the study was created

  - `isCancelled: boolean`

    Whether the study has been cancelled

  - `reportMetadata: StudyReportMetadata`

    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`

      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.

        - `"in"`

        - `"cm"`

      - `value: number`

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

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

      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.

        - `"lbs"`

        - `"kg"`

      - `value: number`

  - `severity: Severity`

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

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `studyDescription: string`

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

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

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

    - `"unassigned"`

    - `"assigned"`

    - `"in_progress"`

    - `"completed"`

    - `"addendum_active"`

  - `updatedAt: string | null`

    Timestamp when the study was last updated

  - `assignedTo?: UserReference | 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 | null`

    A reference to an API key with basic identifying information

    - `apiKeyId: string`

      Unique API key identifier (UUIDv4 format)

    - `description: string`

      Human-readable description of the API key

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

    A reference to a user with basic identifying information

  - `expressCustomer?: ExpressCustomerReference | 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

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

    External prior reports with metadata and text

    - `reportText: string`

      Full prior report text

    - `externalStudyId?: string`

      Integrator's external study identifier

    - `modality?: string`

      Imaging modality for the prior study

    - `studyDate?: string`

      Prior study date (YYYY-MM-DD)

    - `studyDescription?: string`

      Description of the prior study

  - `reportIds?: Array<ReportIDWithStatus>`

    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.

      - `"in_progress"`

      - `"completed"`

  - `studyType?: StudyType`

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

    - `"standard"`

    - `"external"`

  - `technologistNotes?: Array<string>`

    Technologist notes for the study

  - `technologistTechnique?: string | null`

    Imaging technique description

### External Delete Response

- `ExternalDeleteResponse`

  Result of deleting an external study

  - `success: boolean`

  - `message?: string`

# Reports

## Attach an external report

`client.autoScribe.studies.external.reports.create(ReportCreateParamsbody?, RequestOptionsoptions?): ReportCreateResponse`

**post** `/v1/autoScribe/studies/external/reports`

Attach or fill missing report fields on an existing external study. Text and file are write-once. readerName and signedAt overwrite when provided.

### Parameters

- `body: ReportCreateParams`

  - `readerName?: string`

    Optional original reader / author name. Shown as-is. May be set on study create or a later report create; a later create overwrites it when provided.

  - `reportFileName?: string`

    File name including extension. Required when reportFileUrl is provided. Supported types: PDF, PNG, JPG, GIF, WEBP.

  - `reportFileUrl?: string`

    HTTPS download URL for a PDF or image (PNG, JPG, GIF, WEBP). Not used for AI tooling; the reader can still access it. Avara fetches this URL server-side. If omitted, you can add it later. Once set, it cannot be edited; delete the study to remake it. Whitelist https://api.avarasoftware.com on the file host if the fetch is origin-restricted.

  - `reportText?: string`

    When this study is used as a prior, report AI tools leverage this text directly. If omitted, you can add it later via POST /studies/external/reports. Once set, it cannot be edited; delete the study to remake it.

  - `signedAt?: string`

    Optional original sign-off timestamp or label. Shown as-is with no format validation. May be set on study create or a later report create; a later create overwrites it when provided.

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

### Returns

- `ReportCreateResponse`

  Created or updated external report identifiers

  - `externalReportId: string`

  - `studyId: string`

  - `studyInstanceUid: string`

### Example

```typescript
import Avara from 'avara-software';

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

const report = await client.autoScribe.studies.external.reports.create();

console.log(report.studyInstanceUid);
```

#### Response

```json
{
  "externalReportId": "ext_1234567890abcdef1234567890abcdef",
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123"
}
```

## List external reports

`client.autoScribe.studies.external.reports.list(ReportListParamsquery?, RequestOptionsoptions?): CursorExternalReports<ReportListResponse>`

**get** `/v1/autoScribe/studies/external/reports`

Cursor-paginated list of external reports. List items omit report text and download URLs.

### Parameters

- `query: ReportListParams`

  - `cursor?: string`

    Base64 encoded cursor from previous response

  - `limit?: number`

    Number of results to return (1-100)

  - `studyId?: string`

    Filter to one study. Format: stu_{32-hex-chars}

### Returns

- `ReportListResponse`

  - `createdAt: string | null`

  - `externalReportId: string`

  - `hasReportText: boolean`

  - `reportPdfPresent: boolean`

  - `studyId: string`

  - `studyInstanceUid: string`

  - `readerName?: string | null`

  - `signedAt?: string | null`

### Example

```typescript
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 reportListResponse of client.autoScribe.studies.external.reports.list()) {
  console.log(reportListResponse.studyInstanceUid);
}
```

#### Response

```json
{
  "hasMore": true,
  "reports": [
    {
      "createdAt": "2019-12-27T18:11:19.117Z",
      "externalReportId": "ext_1234567890abcdef1234567890abcdef",
      "hasReportText": true,
      "reportPdfPresent": true,
      "studyId": "stu_1234567890abcdef1234567890abcdef",
      "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
      "readerName": "readerName",
      "signedAt": "signedAt"
    }
  ],
  "cursor": "cursor"
}
```

## Retrieve an external report

`client.autoScribe.studies.external.reports.retrieve(stringexternalReportID, RequestOptionsoptions?): ReportRetrieveResponse`

**get** `/v1/autoScribe/studies/external/reports/{externalReportId}`

Returns snapshot metadata plus report text and/or a short-lived download URL. Text is what AI priors use; the file is reader-only and is not used for AI.

### Parameters

- `externalReportID: string`

  External report identifier. Format: ext_{32-hex-chars}

### Returns

- `ReportRetrieveResponse`

  External report snapshot including text and/or a presigned file URL

  - `createdAt: string | null`

  - `externalReportId: string`

  - `studyId: string`

  - `studyInstanceUid: string`

  - `presignedUrl?: string | null`

    Short-lived download URL for the attached PDF or image. Not used for AI tooling; the reader can still access it.

  - `readerName?: string | null`

  - `reportText?: string | null`

    When this study is used as a prior, report AI tools leverage this text directly.

  - `signedAt?: string | null`

  - `snapshotMetadata?: StudyReportMetadata`

    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`

      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.

        - `"in"`

        - `"cm"`

      - `value: number`

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

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

      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.

        - `"lbs"`

        - `"kg"`

      - `value: number`

### Example

```typescript
import Avara from 'avara-software';

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

const report = await client.autoScribe.studies.external.reports.retrieve(
  'ext_1234567890abcdef1234567890abcdef',
);

console.log(report.studyInstanceUid);
```

#### Response

```json
{
  "createdAt": "2019-12-27T18:11:19.117Z",
  "externalReportId": "ext_1234567890abcdef1234567890abcdef",
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
  "presignedUrl": "https://viewer.avarasoftware.com/study/stu_1234",
  "readerName": "readerName",
  "reportText": "reportText",
  "signedAt": "signedAt",
  "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
    }
  }
}
```

## Domain Types

### Report Create Response

- `ReportCreateResponse`

  Created or updated external report identifiers

  - `externalReportId: string`

  - `studyId: string`

  - `studyInstanceUid: string`

### Report List Response

- `ReportListResponse`

  - `createdAt: string | null`

  - `externalReportId: string`

  - `hasReportText: boolean`

  - `reportPdfPresent: boolean`

  - `studyId: string`

  - `studyInstanceUid: string`

  - `readerName?: string | null`

  - `signedAt?: string | null`

### Report Retrieve Response

- `ReportRetrieveResponse`

  External report snapshot including text and/or a presigned file URL

  - `createdAt: string | null`

  - `externalReportId: string`

  - `studyId: string`

  - `studyInstanceUid: string`

  - `presignedUrl?: string | null`

    Short-lived download URL for the attached PDF or image. Not used for AI tooling; the reader can still access it.

  - `readerName?: string | null`

  - `reportText?: string | null`

    When this study is used as a prior, report AI tools leverage this text directly.

  - `signedAt?: string | null`

  - `snapshotMetadata?: StudyReportMetadata`

    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`

      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.

        - `"in"`

        - `"cm"`

      - `value: number`

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

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

      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.

        - `"lbs"`

        - `"kg"`

      - `value: number`