Create a new study

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

ParametersExpand Collapse

report_metadata: StudyReportMetadataParam

Patient demographics and scan information for report generation

age: Optional[str]

Patient's age at time of scan (e.g., '34.5 years', '2 months')

date_of_birth: Optional[str]

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

facility_name: Optional[str]

Name of the medical facility where the scan was performed

height: Optional[Height]

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

unit: Literal["in", "cm"]

Accepts one of the following:

"in"

"cm"

value: float

minimum0

mrn: Optional[str]

Medical Record Number - unique patient identifier

patient_name: Optional[str]

Full name of the patient

referring_physician_name: Optional[str]

Name of the physician who referred the patient for this scan

scan_date: Optional[str]

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

scan_time: Optional[str]

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

scan_type: Optional[str]

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

sex: Optional[Literal["male", "female", "other"]]

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

Accepts one of the following:

"male"

"female"

"other"

weight: Optional[Weight]

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

unit: Literal["lbs", "kg"]

Accepts one of the following:

"lbs"

"kg"

value: float

minimum0

severity: Literal["normal", "high", "stat"]

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

Accepts one of the following:

"normal"

"high"

"stat"

study_description: str

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

minLength1

study_instance_uid: str

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

minLength1

assigned_to: Optional[str]

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

metadata: Optional[Dict[str, str]]

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

org_id: Optional[str]

Organization ID for the study. Format: org_{32-hex-chars}

prior_report_texts: Optional[SequenceNotStr[str]]

prior_study_ids: Optional[SequenceNotStr[str]]

ReturnsExpand Collapse

class StudyCreateResponse: …

A study entity in the AutoScribe system with report workflow status

cancelled_at: Optional[datetime]

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

created_at: Optional[datetime]

Timestamp when the study was created

formatdate-time

is_cancelled: bool

Whether the study has been cancelled

report_metadata: StudyReportMetadata

Patient demographics and scan information for report generation

age: Optional[str]

Patient's age at time of scan (e.g., '34.5 years', '2 months')

date_of_birth: Optional[str]

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

facility_name: Optional[str]

Name of the medical facility where the scan was performed

height: Optional[Height]

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

unit: Literal["in", "cm"]

Accepts one of the following:

"in"

"cm"

value: float

minimum0

mrn: Optional[str]

Medical Record Number - unique patient identifier

patient_name: Optional[str]

Full name of the patient

referring_physician_name: Optional[str]

Name of the physician who referred the patient for this scan

scan_date: Optional[str]

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

scan_time: Optional[str]

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

scan_type: Optional[str]

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

sex: Optional[Literal["male", "female", "other"]]

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

Accepts one of the following:

"male"

"female"

"other"

weight: Optional[Weight]

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

unit: Literal["lbs", "kg"]

Accepts one of the following:

"lbs"

"kg"

value: float

minimum0

severity: Literal["normal", "high", "stat"]

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

Accepts one of the following:

"normal"

"high"

"stat"

study_description: str

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

minLength1

study_id: str

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

study_instance_uid: str

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

minLength1

study_report_status: Literal["unassigned", "assigned", "in_progress", 2 more]

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:

"unassigned"

"assigned"

"in_progress"

"completed"

"addendum_active"

updated_at: Optional[datetime]

Timestamp when the study was last updated

formatdate-time

assigned_to: Optional[AssignedTo]

Reference to the assigned radiologist, null if unassigned

email: str

User's email address

user_id: str

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

first_name: Optional[str]

User's first name

last_name: Optional[str]

User's last name

middle_name: Optional[str]

User's middle name

suffix1: Optional[str]

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

suffix2: Optional[str]

Additional name suffix

created_by_api_key: Optional[CreatedByAPIKey]

Reference to the API key used to create this study

api_key_id: str

Unique API key identifier (UUIDv4 format)

formatuuid

description: str

Human-readable description of the API key

minLength1

is_viewer_enabled: Optional[bool]

Whether this API key has access to the Viewer product

created_by_user: Optional[CreatedByUser]

Reference to the user who created this study via dashboard

email: str

User's email address

user_id: str

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

first_name: Optional[str]

User's first name

last_name: Optional[str]

User's last name

middle_name: Optional[str]

User's middle name

suffix1: Optional[str]

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

suffix2: Optional[str]

Additional name suffix

metadata: Optional[Dict[str, str]]

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

org: Optional[Org]

Reference to the organization this study belongs to

org_id: str

Unique organization identifier. Format: org_{32-hex-chars}

org_name: str

Name of the organization

minLength1

prior_report_texts: Optional[List[str]]

Array of prior report texts to provide clinical context

prior_study_ids: Optional[List[str]]

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

report_ids: Optional[List[ReportIDWithStatus]]

Array of report IDs associated with this study, including addendums

report_id: str

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

status: Literal["in_progress", "completed"]

Current status of the report

Accepts one of the following:

"in_progress"

"completed"

Create a new study

import os
from avara import Avara

client = Avara(
    api_key=os.environ.get("AVARA_API_KEY"),  # This is the default and can be omitted
)
study = client.auto_scribe.studies.create(
    report_metadata={},
    severity="normal",
    study_description="Brain MRI with Contrast",
    study_instance_uid="1.2.840.113619.2.55.3.604688119.868.1234567890.123",
)
print(study.study_instance_uid)

{
  "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"
  },
  "metadata": {
    "department": "radiology",
    "priority": "routine"
  },
  "org": {
    "orgId": "org_1234567890abcdef1234567890abcdef",
    "orgName": "City Medical Center"
  },
  "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"
  },
  "metadata": {
    "department": "radiology",
    "priority": "routine"
  },
  "org": {
    "orgId": "org_1234567890abcdef1234567890abcdef",
    "orgName": "City Medical Center"
  },
  "priorReportTexts": [
    "Previous imaging shows stable findings."
  ],
  "priorStudyIds": [
    "stu_abcdef1234567890abcdef1234567890"
  ],
  "reportIds": [
    {
      "reportId": "rep_1234567890abcdef1234567890abcdef",
      "status": "in_progress"
    }
  ]
}