Skip to content
Avara
Get started
API Reference
Auto Scribe

Studies

Create a new study
auto_scribe.studies.create(StudyCreateParams**kwargs) -> StudyCreateResponse
POST/v1/autoScribe/studies
List studies with pagination
auto_scribe.studies.list(StudyListParams**kwargs) -> SyncCursorStudies[StudyListResponse]
GET/v1/autoScribe/studies
Retrieve a study by ID
auto_scribe.studies.retrieve(strstudy_id) -> StudyRetrieveResponse
GET/v1/autoScribe/studies/{studyId}
Update a study
auto_scribe.studies.update(strstudy_id, StudyUpdateParams**kwargs) -> StudyUpdateResponse
PATCH/v1/autoScribe/studies/{studyId}
Cancel a study
auto_scribe.studies.cancel(StudyCancelParams**kwargs) -> StudyCancelResponse
POST/v1/autoScribe/studies/cancel
Uncancel a study
auto_scribe.studies.uncancel(StudyUncancelParams**kwargs) -> StudyUncancelResponse
POST/v1/autoScribe/studies/uncancel
Generate a reroute URL with viewer and dictation
auto_scribe.studies.reroute_url(StudyRerouteURLParams**kwargs) -> StudyRerouteURLResponse
POST/v1/autoScribe/studies/reroute-url
Generate a viewer-only reroute URL
auto_scribe.studies.viewer_only_reroute_url(StudyViewerOnlyRerouteURLParams**kwargs) -> StudyViewerOnlyRerouteURLResponse
POST/v1/autoScribe/studies/viewer-only-reroute-url
Retrieve a study by DICOM UID
auto_scribe.studies.retrieve_by_uid(strstudy_instance_uid) -> StudyRetrieveByUidResponse
GET/v1/autoScribe/studies/by-uid/{studyInstanceUid}
ModelsExpand Collapse
class PriorReport: …

External prior report metadata and text stored on a study

report_text: str

Full prior report text

minLength1
maxLength50000
external_study_id: Optional[str]

Integrator’s external study identifier

minLength1
maxLength256
modality: Optional[str]

Imaging modality for the prior study

minLength1
maxLength100
study_date: Optional[str]

Prior study date (YYYY-MM-DD)

study_description: Optional[str]

Description of the prior study

minLength1
maxLength1000
class ReportIDWithStatus: …

A report ID paired with its current status

is_critical: Optional[bool]

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

report_id: str

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

status: ReportStatus

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

One of the following:
"in_progress"
"completed"
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 study date (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: HeightUnit

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

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

procedure: Optional[str]

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

referring_physician_name: Optional[str]

Name of the physician who referred the patient for this scan

sex: Optional[Sex]

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:
"male"
"female"
"other"
study_date: Optional[str]

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

study_time: Optional[str]

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

weight: Optional[Weight]

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

unit: WeightUnit

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

One of the following:
"lbs"
"kg"
value: float
minimum0
severity: Severity

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

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: 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.

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[UserReference]

A reference to a user with basic identifying information

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

clinical_history: Optional[str]

Relevant clinical history for the study

clinical_indication: Optional[str]

Clinical indication for the study

created_by_api_key: Optional[APIKeyReference]

A reference to an API key with basic identifying information

api_key_id: str

Unique API key identifier (UUIDv4 format)

formatuuid
description: str

Human-readable description of the API key

minLength1
is_clinical_context_enrichment_enabled: Optional[bool]

Whether this API key has a clinical-context enrichment webhook configured

is_viewer_enabled: Optional[bool]

Whether this API key has access to the Viewer product

created_by_user: Optional[UserReference]

A reference to a user with basic identifying information

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

express_customer: Optional[ExpressCustomerReference]

A reference to an Express customer with basic identifying information

express_customer_id: str

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

express_customer_name: str

Name of the Express customer

minLength1
external_patient_id: Optional[str]

Integrator-provided stable patient identifier for linking studies

external_report_id: Optional[str]

External report identifier when this study has an attached archive report. Format: ext_{32-hex-chars}

is_critical: Optional[bool]

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

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

modality: Optional[str]

Imaging modality for the study (free text)

prior_reports: Optional[List[PriorReport]]

External prior reports with metadata and text

report_text: str

Full prior report text

minLength1
maxLength50000
external_study_id: Optional[str]

Integrator’s external study identifier

minLength1
maxLength256
modality: Optional[str]

Imaging modality for the prior study

minLength1
maxLength100
study_date: Optional[str]

Prior study date (YYYY-MM-DD)

study_description: Optional[str]

Description of the prior study

minLength1
maxLength1000
report_ids: Optional[List[ReportIDWithStatus]]

Array of report IDs associated with this study, including addendums

is_critical: Optional[bool]

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

report_id: str

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

status: ReportStatus

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

One of the following:
"in_progress"
"completed"
study_type: Optional[StudyType]

Kind of study. ‘standard’ is a live AutoScribe reading-workflow study. ‘external’ is an imported archive study.

One of the following:
"standard"
"external"
technologist_notes: Optional[List[str]]

Technologist notes for the study

technologist_technique: Optional[str]

Imaging technique description

class StudyListResponse: …

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 study date (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: HeightUnit

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

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

procedure: Optional[str]

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

referring_physician_name: Optional[str]

Name of the physician who referred the patient for this scan

sex: Optional[Sex]

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:
"male"
"female"
"other"
study_date: Optional[str]

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

study_time: Optional[str]

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

weight: Optional[Weight]

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

unit: WeightUnit

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

One of the following:
"lbs"
"kg"
value: float
minimum0
severity: Severity

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

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: 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.

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[UserReference]

A reference to a user with basic identifying information

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

clinical_history: Optional[str]

Relevant clinical history for the study

clinical_indication: Optional[str]

Clinical indication for the study

created_by_api_key: Optional[APIKeyReference]

A reference to an API key with basic identifying information

api_key_id: str

Unique API key identifier (UUIDv4 format)

formatuuid
description: str

Human-readable description of the API key

minLength1
is_clinical_context_enrichment_enabled: Optional[bool]

Whether this API key has a clinical-context enrichment webhook configured

is_viewer_enabled: Optional[bool]

Whether this API key has access to the Viewer product

created_by_user: Optional[UserReference]

A reference to a user with basic identifying information

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

express_customer: Optional[ExpressCustomerReference]

A reference to an Express customer with basic identifying information

express_customer_id: str

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

express_customer_name: str

Name of the Express customer

minLength1
external_patient_id: Optional[str]

Integrator-provided stable patient identifier for linking studies

external_report_id: Optional[str]

External report identifier when this study has an attached archive report. Format: ext_{32-hex-chars}

is_critical: Optional[bool]

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

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

modality: Optional[str]

Imaging modality for the study (free text)

prior_reports: Optional[List[PriorReport]]

External prior reports with metadata and text

report_text: str

Full prior report text

minLength1
maxLength50000
external_study_id: Optional[str]

Integrator’s external study identifier

minLength1
maxLength256
modality: Optional[str]

Imaging modality for the prior study

minLength1
maxLength100
study_date: Optional[str]

Prior study date (YYYY-MM-DD)

study_description: Optional[str]

Description of the prior study

minLength1
maxLength1000
report_ids: Optional[List[ReportIDWithStatus]]

Array of report IDs associated with this study, including addendums

is_critical: Optional[bool]

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

report_id: str

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

status: ReportStatus

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

One of the following:
"in_progress"
"completed"
study_type: Optional[StudyType]

Kind of study. ‘standard’ is a live AutoScribe reading-workflow study. ‘external’ is an imported archive study.

One of the following:
"standard"
"external"
technologist_notes: Optional[List[str]]

Technologist notes for the study

technologist_technique: Optional[str]

Imaging technique description

class StudyRetrieveResponse: …

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 study date (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: HeightUnit

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

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

procedure: Optional[str]

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

referring_physician_name: Optional[str]

Name of the physician who referred the patient for this scan

sex: Optional[Sex]

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:
"male"
"female"
"other"
study_date: Optional[str]

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

study_time: Optional[str]

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

weight: Optional[Weight]

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

unit: WeightUnit

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

One of the following:
"lbs"
"kg"
value: float
minimum0
severity: Severity

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

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: 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.

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[UserReference]

A reference to a user with basic identifying information

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

clinical_history: Optional[str]

Relevant clinical history for the study

clinical_indication: Optional[str]

Clinical indication for the study

created_by_api_key: Optional[APIKeyReference]

A reference to an API key with basic identifying information

api_key_id: str

Unique API key identifier (UUIDv4 format)

formatuuid
description: str

Human-readable description of the API key

minLength1
is_clinical_context_enrichment_enabled: Optional[bool]

Whether this API key has a clinical-context enrichment webhook configured

is_viewer_enabled: Optional[bool]

Whether this API key has access to the Viewer product

created_by_user: Optional[UserReference]

A reference to a user with basic identifying information

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

express_customer: Optional[ExpressCustomerReference]

A reference to an Express customer with basic identifying information

express_customer_id: str

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

express_customer_name: str

Name of the Express customer

minLength1
external_patient_id: Optional[str]

Integrator-provided stable patient identifier for linking studies

external_report_id: Optional[str]

External report identifier when this study has an attached archive report. Format: ext_{32-hex-chars}

is_critical: Optional[bool]

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

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

modality: Optional[str]

Imaging modality for the study (free text)

prior_reports: Optional[List[PriorReport]]

External prior reports with metadata and text

report_text: str

Full prior report text

minLength1
maxLength50000
external_study_id: Optional[str]

Integrator’s external study identifier

minLength1
maxLength256
modality: Optional[str]

Imaging modality for the prior study

minLength1
maxLength100
study_date: Optional[str]

Prior study date (YYYY-MM-DD)

study_description: Optional[str]

Description of the prior study

minLength1
maxLength1000
report_ids: Optional[List[ReportIDWithStatus]]

Array of report IDs associated with this study, including addendums

is_critical: Optional[bool]

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

report_id: str

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

status: ReportStatus

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

One of the following:
"in_progress"
"completed"
study_type: Optional[StudyType]

Kind of study. ‘standard’ is a live AutoScribe reading-workflow study. ‘external’ is an imported archive study.

One of the following:
"standard"
"external"
technologist_notes: Optional[List[str]]

Technologist notes for the study

technologist_technique: Optional[str]

Imaging technique description

class StudyUpdateResponse: …

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 study date (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: HeightUnit

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

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

procedure: Optional[str]

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

referring_physician_name: Optional[str]

Name of the physician who referred the patient for this scan

sex: Optional[Sex]

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:
"male"
"female"
"other"
study_date: Optional[str]

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

study_time: Optional[str]

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

weight: Optional[Weight]

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

unit: WeightUnit

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

One of the following:
"lbs"
"kg"
value: float
minimum0
severity: Severity

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

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: 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.

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[UserReference]

A reference to a user with basic identifying information

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

clinical_history: Optional[str]

Relevant clinical history for the study

clinical_indication: Optional[str]

Clinical indication for the study

created_by_api_key: Optional[APIKeyReference]

A reference to an API key with basic identifying information

api_key_id: str

Unique API key identifier (UUIDv4 format)

formatuuid
description: str

Human-readable description of the API key

minLength1
is_clinical_context_enrichment_enabled: Optional[bool]

Whether this API key has a clinical-context enrichment webhook configured

is_viewer_enabled: Optional[bool]

Whether this API key has access to the Viewer product

created_by_user: Optional[UserReference]

A reference to a user with basic identifying information

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

express_customer: Optional[ExpressCustomerReference]

A reference to an Express customer with basic identifying information

express_customer_id: str

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

express_customer_name: str

Name of the Express customer

minLength1
external_patient_id: Optional[str]

Integrator-provided stable patient identifier for linking studies

external_report_id: Optional[str]

External report identifier when this study has an attached archive report. Format: ext_{32-hex-chars}

is_critical: Optional[bool]

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

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

modality: Optional[str]

Imaging modality for the study (free text)

prior_reports: Optional[List[PriorReport]]

External prior reports with metadata and text

report_text: str

Full prior report text

minLength1
maxLength50000
external_study_id: Optional[str]

Integrator’s external study identifier

minLength1
maxLength256
modality: Optional[str]

Imaging modality for the prior study

minLength1
maxLength100
study_date: Optional[str]

Prior study date (YYYY-MM-DD)

study_description: Optional[str]

Description of the prior study

minLength1
maxLength1000
report_ids: Optional[List[ReportIDWithStatus]]

Array of report IDs associated with this study, including addendums

is_critical: Optional[bool]

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

report_id: str

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

status: ReportStatus

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

One of the following:
"in_progress"
"completed"
study_type: Optional[StudyType]

Kind of study. ‘standard’ is a live AutoScribe reading-workflow study. ‘external’ is an imported archive study.

One of the following:
"standard"
"external"
technologist_notes: Optional[List[str]]

Technologist notes for the study

technologist_technique: Optional[str]

Imaging technique description

class StudyCancelResponse: …

Response for cancelling a study in AutoScribe

success: bool
message: Optional[str]
class StudyUncancelResponse: …

Response for uncancelling a study in AutoScribe

success: bool
message: Optional[str]
class StudyRerouteURLResponse: …

Response containing the generated reroute URL for AutoScribe (viewer + dictation)

url: str
class StudyViewerOnlyRerouteURLResponse: …

Response containing the generated viewer-only reroute URL. Requires viewer to be configured.

url: str
class StudyRetrieveByUidResponse: …

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 study date (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: HeightUnit

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

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

procedure: Optional[str]

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

referring_physician_name: Optional[str]

Name of the physician who referred the patient for this scan

sex: Optional[Sex]

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:
"male"
"female"
"other"
study_date: Optional[str]

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

study_time: Optional[str]

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

weight: Optional[Weight]

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

unit: WeightUnit

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

One of the following:
"lbs"
"kg"
value: float
minimum0
severity: Severity

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

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: 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.

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[UserReference]

A reference to a user with basic identifying information

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

clinical_history: Optional[str]

Relevant clinical history for the study

clinical_indication: Optional[str]

Clinical indication for the study

created_by_api_key: Optional[APIKeyReference]

A reference to an API key with basic identifying information

api_key_id: str

Unique API key identifier (UUIDv4 format)

formatuuid
description: str

Human-readable description of the API key

minLength1
is_clinical_context_enrichment_enabled: Optional[bool]

Whether this API key has a clinical-context enrichment webhook configured

is_viewer_enabled: Optional[bool]

Whether this API key has access to the Viewer product

created_by_user: Optional[UserReference]

A reference to a user with basic identifying information

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

express_customer: Optional[ExpressCustomerReference]

A reference to an Express customer with basic identifying information

express_customer_id: str

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

express_customer_name: str

Name of the Express customer

minLength1
external_patient_id: Optional[str]

Integrator-provided stable patient identifier for linking studies

external_report_id: Optional[str]

External report identifier when this study has an attached archive report. Format: ext_{32-hex-chars}

is_critical: Optional[bool]

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

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

modality: Optional[str]

Imaging modality for the study (free text)

prior_reports: Optional[List[PriorReport]]

External prior reports with metadata and text

report_text: str

Full prior report text

minLength1
maxLength50000
external_study_id: Optional[str]

Integrator’s external study identifier

minLength1
maxLength256
modality: Optional[str]

Imaging modality for the prior study

minLength1
maxLength100
study_date: Optional[str]

Prior study date (YYYY-MM-DD)

study_description: Optional[str]

Description of the prior study

minLength1
maxLength1000
report_ids: Optional[List[ReportIDWithStatus]]

Array of report IDs associated with this study, including addendums

is_critical: Optional[bool]

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

report_id: str

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

status: ReportStatus

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

One of the following:
"in_progress"
"completed"
study_type: Optional[StudyType]

Kind of study. ‘standard’ is a live AutoScribe reading-workflow study. ‘external’ is an imported archive study.

One of the following:
"standard"
"external"
technologist_notes: Optional[List[str]]

Technologist notes for the study

technologist_technique: Optional[str]

Imaging technique description

StudiesExternal

Create an external study
auto_scribe.studies.external.create(ExternalCreateParams**kwargs) -> ExternalCreateResponse
POST/v1/autoScribe/studies/external
Delete an external study
auto_scribe.studies.external.delete(ExternalDeleteParams**kwargs) -> ExternalDeleteResponse
POST/v1/autoScribe/studies/external/delete
ModelsExpand Collapse
class ExternalCreateResponse: …

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 study date (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: HeightUnit

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

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

procedure: Optional[str]

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

referring_physician_name: Optional[str]

Name of the physician who referred the patient for this scan

sex: Optional[Sex]

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:
"male"
"female"
"other"
study_date: Optional[str]

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

study_time: Optional[str]

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

weight: Optional[Weight]

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

unit: WeightUnit

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

One of the following:
"lbs"
"kg"
value: float
minimum0
severity: Severity

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

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: 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.

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[UserReference]

A reference to a user with basic identifying information

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

clinical_history: Optional[str]

Relevant clinical history for the study

clinical_indication: Optional[str]

Clinical indication for the study

created_by_api_key: Optional[APIKeyReference]

A reference to an API key with basic identifying information

api_key_id: str

Unique API key identifier (UUIDv4 format)

formatuuid
description: str

Human-readable description of the API key

minLength1
is_clinical_context_enrichment_enabled: Optional[bool]

Whether this API key has a clinical-context enrichment webhook configured

is_viewer_enabled: Optional[bool]

Whether this API key has access to the Viewer product

created_by_user: Optional[UserReference]

A reference to a user with basic identifying information

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

express_customer: Optional[ExpressCustomerReference]

A reference to an Express customer with basic identifying information

express_customer_id: str

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

express_customer_name: str

Name of the Express customer

minLength1
external_patient_id: Optional[str]

Integrator-provided stable patient identifier for linking studies

external_report_id: Optional[str]

External report identifier when this study has an attached archive report. Format: ext_{32-hex-chars}

is_critical: Optional[bool]

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

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

modality: Optional[str]

Imaging modality for the study (free text)

prior_reports: Optional[List[PriorReport]]

External prior reports with metadata and text

report_text: str

Full prior report text

minLength1
maxLength50000
external_study_id: Optional[str]

Integrator’s external study identifier

minLength1
maxLength256
modality: Optional[str]

Imaging modality for the prior study

minLength1
maxLength100
study_date: Optional[str]

Prior study date (YYYY-MM-DD)

study_description: Optional[str]

Description of the prior study

minLength1
maxLength1000
report_ids: Optional[List[ReportIDWithStatus]]

Array of report IDs associated with this study, including addendums

is_critical: Optional[bool]

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

report_id: str

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

status: ReportStatus

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

One of the following:
"in_progress"
"completed"
study_type: Optional[StudyType]

Kind of study. ‘standard’ is a live AutoScribe reading-workflow study. ‘external’ is an imported archive study.

One of the following:
"standard"
"external"
technologist_notes: Optional[List[str]]

Technologist notes for the study

technologist_technique: Optional[str]

Imaging technique description

class ExternalDeleteResponse: …

Result of deleting an external study

success: bool
message: Optional[str]

StudiesExternalReports

Attach an external report
auto_scribe.studies.external.reports.create(ReportCreateParams**kwargs) -> ReportCreateResponse
POST/v1/autoScribe/studies/external/reports
List external reports
auto_scribe.studies.external.reports.list(ReportListParams**kwargs) -> SyncCursorExternalReports[ReportListResponse]
GET/v1/autoScribe/studies/external/reports
Retrieve an external report
auto_scribe.studies.external.reports.retrieve(strexternal_report_id) -> ReportRetrieveResponse
GET/v1/autoScribe/studies/external/reports/{externalReportId}
ModelsExpand Collapse
class ReportCreateResponse: …

Created or updated external report identifiers

external_report_id: str
study_id: str
study_instance_uid: str
minLength1
class ReportListResponse: …
created_at: Optional[datetime]
formatdate-time
external_report_id: str
has_report_text: bool
report_pdf_present: bool
study_id: str
study_instance_uid: str
minLength1
reader_name: Optional[str]
signed_at: Optional[str]
class ReportRetrieveResponse: …

External report snapshot including text and/or a presigned file URL

created_at: Optional[datetime]
formatdate-time
external_report_id: str
study_id: str
study_instance_uid: str
minLength1
presigned_url: Optional[str]

Short-lived download URL for the attached PDF or image. Not used for AI tooling; the reader can still access it.

reader_name: Optional[str]
report_text: Optional[str]

When this study is used as a prior, report AI tools leverage this text directly.

signed_at: Optional[str]
snapshot_metadata: Optional[StudyReportMetadata]

Patient demographics and scan information for report generation

age: Optional[str]

Patient’s age at study date (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: HeightUnit

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

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

procedure: Optional[str]

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

referring_physician_name: Optional[str]

Name of the physician who referred the patient for this scan

sex: Optional[Sex]

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:
"male"
"female"
"other"
study_date: Optional[str]

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

study_time: Optional[str]

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

weight: Optional[Weight]

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

unit: WeightUnit

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

One of the following:
"lbs"
"kg"
value: float
minimum0