## Create `StudyCreateResponse autoScribe().studies().create(StudyCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())` **post** `/v1/autoScribe/studies` Creates a new study in the AutoScribe system with DICOM metadata and report generation information. The study can include patient demographics, scan details, and references to prior studies/reports for context. ### Parameters - `StudyCreateParams params` - `StudyReportMetadata reportMetadata` Patient demographics and scan information for report generation - `Severity severity` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `NORMAL("normal")` - `HIGH("high")` - `STAT("stat")` - `String studyDescription` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `String studyInstanceUid` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `Optional assignedTo` User ID to assign the study to. Format: usr_{32-hex-chars} - `Optional expressCustomerId` Express customer ID for the study. Format: cus_{32-hex-chars} - `Optional metadata` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `Optional> priorReportTexts` - `Optional> priorStudyIds` ### Returns - `class StudyCreateResponse:` A study entity in the AutoScribe system with report workflow status - `Optional cancelledAt` Timestamp when the study was cancelled, null if not cancelled - `Optional createdAt` Timestamp when the study was created - `boolean isCancelled` Whether the study has been cancelled - `StudyReportMetadata reportMetadata` Patient demographics and scan information for report generation - `Optional age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `double value` - `Severity severity` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `NORMAL("normal")` - `HIGH("high")` - `STAT("stat")` - `String studyDescription` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `String studyId` Unique study identifier. Format: stu_{32-hex-chars} - `String studyInstanceUid` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `StudyReportStatus studyReportStatus` Report workflow status. 'unassigned' = no radiologist assigned, 'assigned' = assigned but not started, 'in_progress' = actively being dictated, 'completed' = report signed, 'addendum_active' = addendum in progress - `UNASSIGNED("unassigned")` - `ASSIGNED("assigned")` - `IN_PROGRESS("in_progress")` - `COMPLETED("completed")` - `ADDENDUM_ACTIVE("addendum_active")` - `Optional updatedAt` Timestamp when the study was last updated - `Optional assignedTo` Reference to the assigned radiologist, null if unassigned - `String email` User's email address - `String userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional firstName` User's first name - `Optional lastName` User's last name - `Optional middleName` User's middle name - `Optional suffix1` Name suffix (e.g., 'MD', 'Jr.') - `Optional suffix2` Additional name suffix - `Optional createdByApiKey` Reference to the API key used to create this study - `String apiKeyId` Unique API key identifier (UUIDv4 format) - `String description` Human-readable description of the API key - `Optional isViewerEnabled` Whether this API key has access to the Viewer product - `Optional createdByUser` Reference to the user who created this study via dashboard - `String email` User's email address - `String userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional firstName` User's first name - `Optional lastName` User's last name - `Optional middleName` User's middle name - `Optional suffix1` Name suffix (e.g., 'MD', 'Jr.') - `Optional suffix2` Additional name suffix - `Optional expressCustomer` Reference to the Express customer this study belongs to - `String expressCustomerId` Unique Express customer identifier. Format: cus_{32-hex-chars} - `String expressCustomerName` Name of the Express customer - `Optional metadata` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `Optional> priorReportTexts` Array of prior report texts to provide clinical context - `Optional> priorStudyIds` Array of prior study IDs for comparison context (format: stu_{32-hex-chars}) - `Optional> reportIds` Array of report IDs associated with this study, including addendums - `String reportId` Unique report identifier. Format: rep_{32-hex-chars} - `Status status` Current status of the report - `IN_PROGRESS("in_progress")` - `COMPLETED("completed")` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.StudyReportMetadata; import com.avara.models.autoscribe.studies.StudyCreateParams; import com.avara.models.autoscribe.studies.StudyCreateResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); StudyCreateParams params = StudyCreateParams.builder() .reportMetadata(StudyReportMetadata.builder().build()) .severity(StudyCreateParams.Severity.NORMAL) .studyDescription("Brain MRI with Contrast") .studyInstanceUid("1.2.840.113619.2.55.3.604688119.868.1234567890.123") .build(); StudyCreateResponse study = client.autoScribe().studies().create(params); } } ```