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, and references to prior studies/reports for context.

ParametersExpand Collapse

StudyCreateParams parameters

required StudyReportMetadata reportMetadata

Patient demographics and scan information for report generation

required Severity severity

Priority level of the 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 expressCustomerID

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

IReadOnlyDictionary<string, string> metadata

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

IReadOnlyList<string> priorReportTexts

IReadOnlyList<string> priorStudyIds

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 time of scan (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 Unit Unit

Accepts one of the following:

required Double Value

minimum0

string Mrn

Medical Record Number - unique patient identifier

string PatientName

Full name of the patient

string ReferringPhysicianName

Name of the physician who referred the patient for this scan

string ScanDate

Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15')

string ScanTime

Time the scan was performed. Format: HH:MM (e.g., '14:30')

string ScanType

Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound')

Sex Sex

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

Accepts one of the following:

Weight Weight

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

required Unit Unit

Accepts one of the following:

required Double Value

minimum0

required Severity Severity

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

Accepts one of the following:

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

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

Accepts one of the following:

required DateTimeOffset? UpdatedAt

Timestamp when the study was last updated

formatdate-time

AssignedTo? AssignedTo

Reference to the assigned radiologist, null if unassigned

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

CreatedByApiKey? CreatedByApiKey

Reference to the API key used to create this study

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

CreatedByUser? CreatedByUser

Reference to the user who created this study via dashboard

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

ExpressCustomer? ExpressCustomer

Reference to the Express customer this study belongs to

required string ExpressCustomerID

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

required string ExpressCustomerName

Name of the Express customer

minLength1

IReadOnlyDictionary<string, string> Metadata

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

IReadOnlyList<string> PriorReportTexts

Array of prior report texts to provide clinical context

IReadOnlyList<string> PriorStudyIds

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

IReadOnlyList<ReportIDWithStatus> ReportIds

Array of report IDs associated with this study, including addendums

required string ReportID

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

required Status Status

Current status of the report

Accepts one of the following:

Create a new study

StudyCreateParams parameters = new()
{
    ReportMetadata = new()
    {
        Age = "38 years",
        DateOfBirth = "1985-07-20",
        FacilityName = "City Medical Center",
        Height = new()
        {
            Unit = Unit.Cm,
            Value = 165,
        },
        Mrn = "MRN-2024-001234",
        PatientName = "Jane Doe",
        ReferringPhysicianName = "Dr. Michael Chen",
        ScanDate = "2024-03-15",
        ScanTime = "14:30",
        ScanType = "MRI Brain with Contrast",
        Sex = Sex.Female,
        Weight = new()
        {
            Unit = Unit.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",
    "referringPhysicianName": "Dr. Michael Chen",
    "scanDate": "2024-03-15",
    "scanTime": "14:30",
    "scanType": "MRI Brain with Contrast",
    "sex": "female",
    "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"
  },
  "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"
  },
  "metadata": {
    "department": "radiology",
    "priority": "routine"
  },
  "priorReportTexts": [
    "Previous imaging shows stable findings."
  ],
  "priorStudyIds": [
    "stu_abcdef1234567890abcdef1234567890"
  ],
  "reportIds": [
    {
      "reportId": "rep_1234567890abcdef1234567890abcdef",
      "status": "in_progress"
    }
  ]
}

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",
    "referringPhysicianName": "Dr. Michael Chen",
    "scanDate": "2024-03-15",
    "scanTime": "14:30",
    "scanType": "MRI Brain with Contrast",
    "sex": "female",
    "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"
  },
  "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"
  },
  "metadata": {
    "department": "radiology",
    "priority": "routine"
  },
  "priorReportTexts": [
    "Previous imaging shows stable findings."
  ],
  "priorStudyIds": [
    "stu_abcdef1234567890abcdef1234567890"
  ],
  "reportIds": [
    {
      "reportId": "rep_1234567890abcdef1234567890abcdef",
      "status": "in_progress"
    }
  ]
}