Skip to content
Avara
Get started
API Reference
Auto Scribe
Studies

Create a new study

StudyCreateResponse AutoScribe.Studies.Create(StudyCreateParamsparameters, CancellationTokencancellationToken = default)
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 parameters
required StudyReportMetadata reportMetadata

Patient demographics and scan information for report generation

required Severity severity

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

required string studyDescription

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

minLength1
required 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
string assignedTo

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

string? clinicalHistory

Relevant clinical history for the patient/study

string? clinicalIndication

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

string expressCustomerID

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

string? externalPatientID

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

IReadOnlyDictionary<string, string> metadata

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

string? modality

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

IReadOnlyList<PriorReport> priorReports

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

required string ReportText

Full prior report text

minLength1
maxLength50000
string ExternalStudyID

Integrator's external study identifier

minLength1
maxLength256
string Modality

Imaging modality for the prior study

minLength1
maxLength100
string StudyDate

Prior study date (YYYY-MM-DD)

string StudyDescription

Description of the prior study

minLength1
maxLength1000
IReadOnlyList<string> technologistNotes

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

string? technologistTechnique

Imaging technique description provided by the technologist

ReturnsExpand Collapse
class StudyCreateResponse:

A study entity in the AutoScribe system with report workflow status

required DateTimeOffset? CancelledAt

Timestamp when the study was cancelled, null if not cancelled

formatdate-time
required DateTimeOffset? CreatedAt

Timestamp when the study was created

formatdate-time
required Boolean IsCancelled

Whether the study has been cancelled

required StudyReportMetadata ReportMetadata

Patient demographics and scan information for report generation

string Age

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

string DateOfBirth

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

string FacilityName

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

required HeightUnit Unit

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

Accepts one of the following:
"in"In
"cm"Cm
required Double Value
minimum0
string Mrn

Medical Record Number - unique patient identifier

string PatientName

Full name of the patient

string Procedure

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

string ReferringPhysicianName

Name of the physician who referred the patient for this scan

Sex Sex

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

Accepts one of the following:
"male"Male
"female"Female
"other"Other
string StudyDate

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

string StudyTime

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

required WeightUnit Unit

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

Accepts one of the following:
"lbs"Lbs
"kg"Kg
required Double Value
minimum0
required 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
required string StudyDescription

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

minLength1
required string StudyID

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

required 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
required 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"InProgress
"completed"Completed
"addendum_active"AddendumActive
required DateTimeOffset? UpdatedAt

Timestamp when the study was last updated

formatdate-time
UserReference? AssignedTo

A reference to a user with basic identifying information

required string Email

User's email address

required string UserID

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

string FirstName

User's first name

string LastName

User's last name

string MiddleName

User's middle name

string Suffix1

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

string Suffix2

Additional name suffix

string? ClinicalHistory

Relevant clinical history for the study

string? ClinicalIndication

Clinical indication for the study

ApiKeyReference? CreatedByApiKey

A reference to an API key with basic identifying information

required string ApiKeyID

Unique API key identifier (UUIDv4 format)

formatuuid
required string Description

Human-readable description of the API key

minLength1
Boolean IsViewerEnabled

Whether this API key has access to the Viewer product

UserReference? CreatedByUser

A reference to a user with basic identifying information

required string Email

User's email address

required string UserID

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

string FirstName

User's first name

string LastName

User's last name

string MiddleName

User's middle name

string Suffix1

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

string Suffix2

Additional name suffix

ExpressCustomerReference? ExpressCustomer

A reference to an Express customer with basic identifying information

required string ExpressCustomerID

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

required string ExpressCustomerName

Name of the Express customer

minLength1
string? ExternalPatientID

Integrator-provided stable patient identifier for linking studies

Boolean IsCritical

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

IReadOnlyDictionary<string, string> Metadata

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

string? Modality

Imaging modality for the study (free text)

IReadOnlyList<PriorReport> PriorReports

External prior reports with metadata and text

required string ReportText

Full prior report text

minLength1
maxLength50000
string ExternalStudyID

Integrator's external study identifier

minLength1
maxLength256
string Modality

Imaging modality for the prior study

minLength1
maxLength100
string StudyDate

Prior study date (YYYY-MM-DD)

string StudyDescription

Description of the prior study

minLength1
maxLength1000
IReadOnlyList<ReportIDWithStatus> ReportIds

Array of report IDs associated with this study, including addendums

required Boolean? IsCritical

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

required string ReportID

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

required ReportStatus Status

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

Accepts one of the following:
"in_progress"InProgress
"completed"Completed
IReadOnlyList<string> TechnologistNotes

Technologist notes for the study

string? TechnologistTechnique

Imaging technique description

Create a new study

StudyCreateParams parameters = new()
{
    ReportMetadata = new()
    {
        Age = "38 years",
        DateOfBirth = "1985-07-20",
        FacilityName = "City Medical Center",
        Height = new()
        {
            Unit = HeightUnit.Cm,
            Value = 165,
        },
        Mrn = "MRN-2024-001234",
        PatientName = "Jane Doe",
        Procedure = "MRI Brain with Contrast",
        ReferringPhysicianName = "Dr. Michael Chen",
        Sex = Sex.Female,
        StudyDate = "2024-03-15",
        StudyTime = "14:30",
        Weight = new()
        {
            Unit = WeightUnit.Kg,
            Value = 62,
        },
    },
    Severity = Severity.Normal,
    StudyDescription = "Brain MRI with Contrast",
    StudyInstanceUid = "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
};

var study = await client.AutoScribe.Studies.Create(parameters);

Console.WriteLine(study);
{
  "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"
}