Create a new study

StudyCreateResponse autoScribe().studies().create(, )

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.

ParametersExpand Collapse

StudyCreateParams params

StudyReportMetadata reportMetadata

Patient demographics and scan information for report generation

Severity severity

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

String studyDescription

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

minLength1

String studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

minLength1

Optional<String> assignedTo

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

Optional<String> clinicalHistory

Relevant clinical history for the patient/study

Optional<String> clinicalIndication

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

Optional<String> expressCustomerId

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

Optional<String> externalPatientId

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

Optional<Metadata> metadata

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

Optional<String> modality

Imaging modality for the study (free text, e.g., 'CT', 'MRI', 'X-Ray')

Optional<List<PriorReport>> priorReports

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

String reportText

Full prior report text

minLength1

maxLength50000

Optional<String> externalStudyId

Integrator's external study identifier

minLength1

maxLength256

Optional<String> modality

Imaging modality for the prior study

minLength1

maxLength100

Optional<String> studyDate

Prior study date (YYYY-MM-DD)

Optional<String> studyDescription

Description of the prior study

minLength1

maxLength1000

Optional<List<String>> technologistNotes

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

Optional<String> technologistTechnique

Imaging technique description provided by the technologist

ReturnsExpand Collapse

class StudyCreateResponse:

A study entity in the AutoScribe system with report workflow status

Optional<LocalDateTime> cancelledAt

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

Optional<LocalDateTime> createdAt

Timestamp when the study was created

formatdate-time

boolean isCancelled

Whether the study has been cancelled

StudyReportMetadata reportMetadata

Patient demographics and scan information for report generation

Optional<String> age

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

Optional<String> dateOfBirth

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

Optional<String> facilityName

Name of the medical facility where the scan was performed

Optional<Height> height

Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'})

HeightUnit unit

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

Accepts one of the following:

IN("in")

CM("cm")

double value

minimum0

Optional<String> mrn

Medical Record Number - unique patient identifier

Optional<String> patientName

Full name of the patient

Optional<String> procedure

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

Optional<String> referringPhysicianName

Name of the physician who referred the patient for this scan

Optional<Sex> sex

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

Accepts one of the following:

MALE("male")

FEMALE("female")

OTHER("other")

Optional<String> studyDate

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

Optional<String> studyTime

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

Optional<Weight> weight

Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'})

WeightUnit unit

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

Accepts one of the following:

LBS("lbs")

KG("kg")

double value

minimum0

Severity severity

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

Accepts one of the following:

NORMAL("normal")

HIGH("high")

STAT("stat")

String studyDescription

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

minLength1

String studyId

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

String studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

minLength1

StudyReportStatus studyReportStatus

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

Accepts one of the following:

UNASSIGNED("unassigned")

ASSIGNED("assigned")

IN_PROGRESS("in_progress")

COMPLETED("completed")

ADDENDUM_ACTIVE("addendum_active")

Optional<LocalDateTime> updatedAt

Timestamp when the study was last updated

formatdate-time

Optional<UserReference> assignedTo

A reference to a user with basic identifying information

String email

User's email address

String userId

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

Optional<String> firstName

User's first name

Optional<String> lastName

User's last name

Optional<String> middleName

User's middle name

Optional<String> suffix1

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

Optional<String> suffix2

Additional name suffix

Optional<String> clinicalHistory

Relevant clinical history for the study

Optional<String> clinicalIndication

Clinical indication for the study

Optional<ApiKeyReference> createdByApiKey

A reference to an API key with basic identifying information

String apiKeyId

Unique API key identifier (UUIDv4 format)

formatuuid

String description

Human-readable description of the API key

minLength1

Optional<Boolean> isViewerEnabled

Whether this API key has access to the Viewer product

Optional<UserReference> createdByUser

A reference to a user with basic identifying information

String email

User's email address

String userId

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

Optional<String> firstName

User's first name

Optional<String> lastName

User's last name

Optional<String> middleName

User's middle name

Optional<String> suffix1

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

Optional<String> suffix2

Additional name suffix

Optional<ExpressCustomerReference> expressCustomer

A reference to an Express customer with basic identifying information

String expressCustomerId

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

String expressCustomerName

Name of the Express customer

minLength1

Optional<String> externalPatientId

Integrator-provided stable patient identifier for linking studies

Optional<Boolean> isCritical

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

Optional<Metadata> metadata

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

Optional<String> modality

Imaging modality for the study (free text)

Optional<List<PriorReport>> priorReports

External prior reports with metadata and text

String reportText

Full prior report text

minLength1

maxLength50000

Optional<String> externalStudyId

Integrator's external study identifier

minLength1

maxLength256

Optional<String> modality

Imaging modality for the prior study

minLength1

maxLength100

Optional<String> studyDate

Prior study date (YYYY-MM-DD)

Optional<String> studyDescription

Description of the prior study

minLength1

maxLength1000

Optional<List<ReportIdWithStatus>> reportIds

Array of report IDs associated with this study, including addendums

Optional<Boolean> isCritical

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

String reportId

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

ReportStatus status

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

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

Optional<List<String>> technologistNotes

Technologist notes for the study

Optional<String> technologistTechnique

Imaging technique description

Create a new study

package com.avara.example;

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

public final class Main {
    private Main() {}

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

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

{
  "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",
    "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",
  "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"
    }
  ],
  "technologistNotes": [
    "x"
  ],
  "technologistTechnique": "technologistTechnique"
}

Returns Examples

{
  "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",
    "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",
  "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"
    }
  ],
  "technologistNotes": [
    "x"
  ],
  "technologistTechnique": "technologistTechnique"
}