Skip to content
Get started

Auto Scribe

ModelsExpand Collapse
Literal["facility", "referring_provider", "study_description", "procedure"]

Category of canonical clinical reference value used for study workflow pickers and normalization.

One of the following:
"facility"
"referring_provider"
"study_description"
"procedure"
Literal["in", "cm"]

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

One of the following:
"in"
"cm"
Literal["in_progress", "completed"]

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

One of the following:
"in_progress"
"completed"
Literal["male", "female", "other"]

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

One of the following:
"male"
"female"
"other"
class 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 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 of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

One of the following:
"lbs"
"kg"
value: float
minimum0
Literal["unassigned", "assigned", "in_progress", 2 more]

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"
Literal["standard", "external"]

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

One of the following:
"standard"
"external"
Literal["lbs", "kg"]

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

One of the following:
"lbs"
"kg"

Auto ScribeClinical References

Create a clinical reference
auto_scribe.clinical_references.create(ClinicalReferenceCreateParams**kwargs) -> ClinicalReference
POST/v1/autoScribe/clinicalReferences
List clinical references
auto_scribe.clinical_references.list(ClinicalReferenceListParams**kwargs) -> SyncCursorClinicalReferences[ClinicalReference]
GET/v1/autoScribe/clinicalReferences
Retrieve a clinical reference by ID
auto_scribe.clinical_references.retrieve(strclinical_reference_id) -> ClinicalReference
GET/v1/autoScribe/clinicalReferences/{clinicalReferenceId}
Retrieve a clinical reference by external reference ID
auto_scribe.clinical_references.retrieve_by_external_reference_id(strexternal_reference_id) -> ClinicalReference
GET/v1/autoScribe/clinicalReferences/byExternalReferenceId/{externalReferenceId}
Update a clinical reference
auto_scribe.clinical_references.update(strclinical_reference_id, ClinicalReferenceUpdateParams**kwargs) -> ClinicalReference
PATCH/v1/autoScribe/clinicalReferences/{clinicalReferenceId}
Delete a clinical reference
auto_scribe.clinical_references.delete(strclinical_reference_id) -> ClinicalReference
POST/v1/autoScribe/clinicalReferences/{clinicalReferenceId}/delete
ModelsExpand Collapse
class ClinicalReference:

A canonical clinical reference value for study workflow pickers and normalization

clinical_reference_id: str

Unique clinical reference identifier. Format: ref_{32-hex-chars}

created_at: Optional[datetime]

Timestamp when the clinical reference was created

formatdate-time
is_active: bool

Whether this reference is active and available for pickers

name: str

Canonical display name for this reference value

minLength1

Category of canonical clinical reference value used for study workflow pickers and normalization.

One of the following:
"facility"
"referring_provider"
"study_description"
"procedure"
updated_at: Optional[datetime]

Timestamp when the clinical reference was last updated

formatdate-time
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_reference_id: Optional[str]

Integrator-provided stable identifier for mapping inbound data

metadata: Optional[Dict[str, str]]

Optional key-value metadata. Maximum 50 pairs

Auto ScribeEphemeral Sessions

Create an ephemeral AutoScribe viewer session
auto_scribe.ephemeral_sessions.create(EphemeralSessionCreateParams**kwargs) -> EphemeralSessionCreateResponse
POST/v1/autoScribe/ephemeral-sessions
ModelsExpand Collapse
class EphemeralSessionCreateResponse:

Tokenized landing URL for an ephemeral AutoScribe viewer session (30-second token).

url: str

Auto ScribeStudies

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

Auto ScribeStudiesExternal

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

Auto ScribeStudiesExternalReports

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 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 of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

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

Auto ScribeUsers

Create and invite a new user
auto_scribe.users.invite(UserInviteParams**kwargs) -> UserInviteResponse
POST/v1/autoScribe/users
List users with pagination
auto_scribe.users.list(UserListParams**kwargs) -> SyncCursorUsers[UserListResponse]
GET/v1/autoScribe/users
Retrieve a user by ID
auto_scribe.users.retrieve(struser_id) -> UserRetrieveResponse
GET/v1/autoScribe/users/{userId}
Update a user
auto_scribe.users.update(struser_id, UserUpdateParams**kwargs) -> UserUpdateResponse
PATCH/v1/autoScribe/users/{userId}
Revoke user access
auto_scribe.users.revoke_access(UserRevokeAccessParams**kwargs) -> UserRevokeAccessResponse
POST/v1/autoScribe/users/revoke-access
Reactivate a user
auto_scribe.users.reactivate(UserReactivateParams**kwargs) -> UserReactivateResponse
POST/v1/autoScribe/users/reactivate
ModelsExpand Collapse
class UserInviteResponse:

Response for inviting a user to AutoScribe. Level is restricted to admin/member since owners cannot be invited via API.

can_create_reports: bool

Whether the user can generate and sign radiology reports. Requires NPI number

can_manage_studies: bool

Whether the user has permission to create, update, and manage studies

clinic_role: ClinicRole

A user’s clinical or organizational role within the clinic.

One of the following:
"Doctor"
"Physician"
"Surgeon"
"Radiologist"
"Cardiologist"
"Neurologist"
"Urologist"
"Gynecologist"
"Endocrinologist"
"Oncologist"
"Radiation Oncologist"
"Hematologist"
"Gastroenterologist"
"Pulmonologist"
"Nephrologist"
"Rheumatologist"
"Dermatologist"
"Ophthalmologist"
"Otolaryngologist"
"Pediatrician"
"Obstetrician"
"Psychiatrist"
"Anesthesiologist"
"Emergency Medicine Physician"
"Family Medicine Physician"
"Internal Medicine Physician"
"Pathologist"
"Nuclear Medicine Physician"
"Pain Management Specialist"
"Infectious Disease Specialist"
"Immunologist"
"Physician Assistant"
"Nurse Practitioner"
"Certified Registered Nurse Anesthetist"
"Psychologist"
"Medical Assistant"
"Scribe"
"Registered Nurse"
"Nurse Manager"
"Patient Care Coordinator"
"Imaging Technologist"
"Laboratory Technician"
"Medical Laboratory Scientist"
"Pathologists' Assistant"
"Phlebotomist"
"Pharmacist"
"Pharmacy Technician"
"Physical Therapist"
"Occupational Therapist"
"Speech-Language Pathologist"
"Respiratory Therapist"
"Nutritionist"
"Front Desk Operator"
"Revenue Cycle Manager"
"Administrative Director"
"Administrative Assistant"
"Legal Administrator"
"IT Administrator"
"IT Support"
"Software Engineer"
"Other"
created_at: Optional[datetime]

Timestamp when the user was created

formatdate-time
email: str

User’s email address for login and notifications

first_name: str

User’s first name

minLength1
has_dashboard_access: bool

Whether the user can access the dashboard interface. Required for admin users

invited_source: InvitedSource

How a user/invitation was created - via the dashboard UI (‘dashboard’) or the API (‘api’).

One of the following:
"dashboard"
"api"
last_login_at: Optional[datetime]

Timestamp of user’s last login, null if never logged in

formatdate-time
last_name: str

User’s last name

minLength1

User access level assignable via the API. ‘admin’ can manage users/settings, ‘member’ has standard access. ‘owner’ is dashboard-only and cannot be assigned via the API.

One of the following:
"admin"
"member"
user_id: str

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

middle_name: Optional[str]

User’s middle name (optional)

minLength1
npi_number: Optional[str]

National Provider Identifier - required for users who can create reports (10-digit number)

minLength10
maxLength10
phone_number: Optional[str]

User’s phone number (10-15 digits, optional)

suffix1: Optional[str]

Name suffix (e.g., ‘Jr.’, ‘Sr.’, ‘III’) - optional

minLength1
suffix2: Optional[str]

Additional name suffix (optional)

minLength1
class UserListResponse:

A user in the AutoScribe system with report creation permissions

can_create_reports: bool

Whether the user can generate and sign radiology reports. Requires NPI number

can_manage_studies: bool

Whether the user has permission to create, update, and manage studies

clinic_role: ClinicRole

A user’s clinical or organizational role within the clinic.

One of the following:
"Doctor"
"Physician"
"Surgeon"
"Radiologist"
"Cardiologist"
"Neurologist"
"Urologist"
"Gynecologist"
"Endocrinologist"
"Oncologist"
"Radiation Oncologist"
"Hematologist"
"Gastroenterologist"
"Pulmonologist"
"Nephrologist"
"Rheumatologist"
"Dermatologist"
"Ophthalmologist"
"Otolaryngologist"
"Pediatrician"
"Obstetrician"
"Psychiatrist"
"Anesthesiologist"
"Emergency Medicine Physician"
"Family Medicine Physician"
"Internal Medicine Physician"
"Pathologist"
"Nuclear Medicine Physician"
"Pain Management Specialist"
"Infectious Disease Specialist"
"Immunologist"
"Physician Assistant"
"Nurse Practitioner"
"Certified Registered Nurse Anesthetist"
"Psychologist"
"Medical Assistant"
"Scribe"
"Registered Nurse"
"Nurse Manager"
"Patient Care Coordinator"
"Imaging Technologist"
"Laboratory Technician"
"Medical Laboratory Scientist"
"Pathologists' Assistant"
"Phlebotomist"
"Pharmacist"
"Pharmacy Technician"
"Physical Therapist"
"Occupational Therapist"
"Speech-Language Pathologist"
"Respiratory Therapist"
"Nutritionist"
"Front Desk Operator"
"Revenue Cycle Manager"
"Administrative Director"
"Administrative Assistant"
"Legal Administrator"
"IT Administrator"
"IT Support"
"Software Engineer"
"Other"
created_at: Optional[datetime]

Timestamp when the user was created

formatdate-time
email: str

User’s email address for login and notifications

first_name: str

User’s first name

minLength1
has_dashboard_access: bool

Whether the user can access the dashboard interface. Required for admin users

invited_source: InvitedSource

How a user/invitation was created - via the dashboard UI (‘dashboard’) or the API (‘api’).

One of the following:
"dashboard"
"api"
last_login_at: Optional[datetime]

Timestamp of user’s last login, null if never logged in

formatdate-time
last_name: str

User’s last name

minLength1
level: UserLevel

User access level. ‘owner’ has full control (dashboard-only, not assignable via API), ‘admin’ can manage users/settings, ‘member’ has standard access.

One of the following:
"owner"
"admin"
"member"
user_id: str

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

middle_name: Optional[str]

User’s middle name (optional)

minLength1
npi_number: Optional[str]

National Provider Identifier - required for users who can create reports (10-digit number)

minLength10
maxLength10
phone_number: Optional[str]

User’s phone number (10-15 digits, optional)

suffix1: Optional[str]

Name suffix (e.g., ‘Jr.’, ‘Sr.’, ‘III’) - optional

minLength1
suffix2: Optional[str]

Additional name suffix (optional)

minLength1
class UserRetrieveResponse:

A user in the AutoScribe system with report creation permissions

can_create_reports: bool

Whether the user can generate and sign radiology reports. Requires NPI number

can_manage_studies: bool

Whether the user has permission to create, update, and manage studies

clinic_role: ClinicRole

A user’s clinical or organizational role within the clinic.

One of the following:
"Doctor"
"Physician"
"Surgeon"
"Radiologist"
"Cardiologist"
"Neurologist"
"Urologist"
"Gynecologist"
"Endocrinologist"
"Oncologist"
"Radiation Oncologist"
"Hematologist"
"Gastroenterologist"
"Pulmonologist"
"Nephrologist"
"Rheumatologist"
"Dermatologist"
"Ophthalmologist"
"Otolaryngologist"
"Pediatrician"
"Obstetrician"
"Psychiatrist"
"Anesthesiologist"
"Emergency Medicine Physician"
"Family Medicine Physician"
"Internal Medicine Physician"
"Pathologist"
"Nuclear Medicine Physician"
"Pain Management Specialist"
"Infectious Disease Specialist"
"Immunologist"
"Physician Assistant"
"Nurse Practitioner"
"Certified Registered Nurse Anesthetist"
"Psychologist"
"Medical Assistant"
"Scribe"
"Registered Nurse"
"Nurse Manager"
"Patient Care Coordinator"
"Imaging Technologist"
"Laboratory Technician"
"Medical Laboratory Scientist"
"Pathologists' Assistant"
"Phlebotomist"
"Pharmacist"
"Pharmacy Technician"
"Physical Therapist"
"Occupational Therapist"
"Speech-Language Pathologist"
"Respiratory Therapist"
"Nutritionist"
"Front Desk Operator"
"Revenue Cycle Manager"
"Administrative Director"
"Administrative Assistant"
"Legal Administrator"
"IT Administrator"
"IT Support"
"Software Engineer"
"Other"
created_at: Optional[datetime]

Timestamp when the user was created

formatdate-time
email: str

User’s email address for login and notifications

first_name: str

User’s first name

minLength1
has_dashboard_access: bool

Whether the user can access the dashboard interface. Required for admin users

invited_source: InvitedSource

How a user/invitation was created - via the dashboard UI (‘dashboard’) or the API (‘api’).

One of the following:
"dashboard"
"api"
last_login_at: Optional[datetime]

Timestamp of user’s last login, null if never logged in

formatdate-time
last_name: str

User’s last name

minLength1
level: UserLevel

User access level. ‘owner’ has full control (dashboard-only, not assignable via API), ‘admin’ can manage users/settings, ‘member’ has standard access.

One of the following:
"owner"
"admin"
"member"
user_id: str

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

middle_name: Optional[str]

User’s middle name (optional)

minLength1
npi_number: Optional[str]

National Provider Identifier - required for users who can create reports (10-digit number)

minLength10
maxLength10
phone_number: Optional[str]

User’s phone number (10-15 digits, optional)

suffix1: Optional[str]

Name suffix (e.g., ‘Jr.’, ‘Sr.’, ‘III’) - optional

minLength1
suffix2: Optional[str]

Additional name suffix (optional)

minLength1
class UserUpdateResponse:

A user in the AutoScribe system with report creation permissions

can_create_reports: bool

Whether the user can generate and sign radiology reports. Requires NPI number

can_manage_studies: bool

Whether the user has permission to create, update, and manage studies

clinic_role: ClinicRole

A user’s clinical or organizational role within the clinic.

One of the following:
"Doctor"
"Physician"
"Surgeon"
"Radiologist"
"Cardiologist"
"Neurologist"
"Urologist"
"Gynecologist"
"Endocrinologist"
"Oncologist"
"Radiation Oncologist"
"Hematologist"
"Gastroenterologist"
"Pulmonologist"
"Nephrologist"
"Rheumatologist"
"Dermatologist"
"Ophthalmologist"
"Otolaryngologist"
"Pediatrician"
"Obstetrician"
"Psychiatrist"
"Anesthesiologist"
"Emergency Medicine Physician"
"Family Medicine Physician"
"Internal Medicine Physician"
"Pathologist"
"Nuclear Medicine Physician"
"Pain Management Specialist"
"Infectious Disease Specialist"
"Immunologist"
"Physician Assistant"
"Nurse Practitioner"
"Certified Registered Nurse Anesthetist"
"Psychologist"
"Medical Assistant"
"Scribe"
"Registered Nurse"
"Nurse Manager"
"Patient Care Coordinator"
"Imaging Technologist"
"Laboratory Technician"
"Medical Laboratory Scientist"
"Pathologists' Assistant"
"Phlebotomist"
"Pharmacist"
"Pharmacy Technician"
"Physical Therapist"
"Occupational Therapist"
"Speech-Language Pathologist"
"Respiratory Therapist"
"Nutritionist"
"Front Desk Operator"
"Revenue Cycle Manager"
"Administrative Director"
"Administrative Assistant"
"Legal Administrator"
"IT Administrator"
"IT Support"
"Software Engineer"
"Other"
created_at: Optional[datetime]

Timestamp when the user was created

formatdate-time
email: str

User’s email address for login and notifications

first_name: str

User’s first name

minLength1
has_dashboard_access: bool

Whether the user can access the dashboard interface. Required for admin users

invited_source: InvitedSource

How a user/invitation was created - via the dashboard UI (‘dashboard’) or the API (‘api’).

One of the following:
"dashboard"
"api"
last_login_at: Optional[datetime]

Timestamp of user’s last login, null if never logged in

formatdate-time
last_name: str

User’s last name

minLength1
level: UserLevel

User access level. ‘owner’ has full control (dashboard-only, not assignable via API), ‘admin’ can manage users/settings, ‘member’ has standard access.

One of the following:
"owner"
"admin"
"member"
user_id: str

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

middle_name: Optional[str]

User’s middle name (optional)

minLength1
npi_number: Optional[str]

National Provider Identifier - required for users who can create reports (10-digit number)

minLength10
maxLength10
phone_number: Optional[str]

User’s phone number (10-15 digits, optional)

suffix1: Optional[str]

Name suffix (e.g., ‘Jr.’, ‘Sr.’, ‘III’) - optional

minLength1
suffix2: Optional[str]

Additional name suffix (optional)

minLength1
class UserRevokeAccessResponse:

Response for revoking user access in AutoScribe

success: bool
message: Optional[str]
class UserReactivateResponse:

Response for reactivating a user in AutoScribe

success: bool
message: Optional[str]

Auto ScribeUsersInvitations

List user invitations
auto_scribe.users.invitations.list(InvitationListParams**kwargs) -> SyncCursorInvitations[InvitationListResponse]
GET/v1/autoScribe/users/invitations
Retrieve an invitation by ID
auto_scribe.users.invitations.retrieve(strinvitation_id) -> InvitationRetrieveResponse
GET/v1/autoScribe/users/invitations/{invitationId}
Update an invitation
auto_scribe.users.invitations.update(strinvitation_id, InvitationUpdateParams**kwargs) -> InvitationUpdateResponse
PATCH/v1/autoScribe/users/invitations/{invitationId}
Revoke an invitation
auto_scribe.users.invitations.revoke(InvitationRevokeParams**kwargs) -> InvitationRevokeResponse
POST/v1/autoScribe/users/invitations/revoke
ModelsExpand Collapse
class InvitationListResponse:

A pending user invitation in the AutoScribe system

can_create_reports: bool

Whether the invited user can generate and sign radiology reports. Requires NPI number

can_manage_studies: bool

Whether the invited user will have permission to create, update, and manage studies

clinic_id: str

UUID of the clinic this invitation belongs to

formatuuid
clinic_role: ClinicRole

A user’s clinical or organizational role within the clinic.

One of the following:
"Doctor"
"Physician"
"Surgeon"
"Radiologist"
"Cardiologist"
"Neurologist"
"Urologist"
"Gynecologist"
"Endocrinologist"
"Oncologist"
"Radiation Oncologist"
"Hematologist"
"Gastroenterologist"
"Pulmonologist"
"Nephrologist"
"Rheumatologist"
"Dermatologist"
"Ophthalmologist"
"Otolaryngologist"
"Pediatrician"
"Obstetrician"
"Psychiatrist"
"Anesthesiologist"
"Emergency Medicine Physician"
"Family Medicine Physician"
"Internal Medicine Physician"
"Pathologist"
"Nuclear Medicine Physician"
"Pain Management Specialist"
"Infectious Disease Specialist"
"Immunologist"
"Physician Assistant"
"Nurse Practitioner"
"Certified Registered Nurse Anesthetist"
"Psychologist"
"Medical Assistant"
"Scribe"
"Registered Nurse"
"Nurse Manager"
"Patient Care Coordinator"
"Imaging Technologist"
"Laboratory Technician"
"Medical Laboratory Scientist"
"Pathologists' Assistant"
"Phlebotomist"
"Pharmacist"
"Pharmacy Technician"
"Physical Therapist"
"Occupational Therapist"
"Speech-Language Pathologist"
"Respiratory Therapist"
"Nutritionist"
"Front Desk Operator"
"Revenue Cycle Manager"
"Administrative Director"
"Administrative Assistant"
"Legal Administrator"
"IT Administrator"
"IT Support"
"Software Engineer"
"Other"
created_at: Optional[datetime]

Timestamp when the invitation was created

formatdate-time
email: str

Email address the invitation was sent to

expiry: Optional[datetime]

When the invitation expires, null if no expiration

formatdate-time
first_name: str

Invited user’s first name

minLength1
has_dashboard_access: bool

Whether the invited user will have dashboard access

invitation_id: str

Unique invitation identifier. Format: inv_{32-hex-chars}

invited_source: InvitedSource

How a user/invitation was created - via the dashboard UI (‘dashboard’) or the API (‘api’).

One of the following:
"dashboard"
"api"
inviter_id: str

User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API

last_name: str

Invited user’s last name

minLength1
level: UserLevel

User access level. ‘owner’ has full control (dashboard-only, not assignable via API), ‘admin’ can manage users/settings, ‘member’ has standard access.

One of the following:
"owner"
"admin"
"member"

Lifecycle status of an invitation: ‘sent’, ‘accepted’, ‘rejected’, or ‘revoked’.

One of the following:
"sent"
"accepted"
"rejected"
"revoked"
updated_at: Optional[datetime]

Timestamp when the invitation was last updated

formatdate-time
user_id: str

Pre-generated user ID for this invitation. Format: usr_{32-hex-chars}. This ID is assigned at invitation creation and will become the user’s permanent ID upon acceptance

invited_by_api_key_id: Optional[str]

UUID of the API key used to send this invitation. Null if sent via dashboard

formatuuid
middle_name: Optional[str]

Invited user’s middle name (optional)

minLength1
npi_number: Optional[str]

National Provider Identifier - required for users who can create reports (10-digit number)

minLength10
maxLength10
phone_number: Optional[str]

Invited user’s phone number (optional)

suffix1: Optional[str]

Name suffix (e.g., ‘Jr.’, ‘MD’) - optional

minLength1
suffix2: Optional[str]

Additional name suffix - optional

minLength1
class InvitationRetrieveResponse:

A pending user invitation in the AutoScribe system

can_create_reports: bool

Whether the invited user can generate and sign radiology reports. Requires NPI number

can_manage_studies: bool

Whether the invited user will have permission to create, update, and manage studies

clinic_id: str

UUID of the clinic this invitation belongs to

formatuuid
clinic_role: ClinicRole

A user’s clinical or organizational role within the clinic.

One of the following:
"Doctor"
"Physician"
"Surgeon"
"Radiologist"
"Cardiologist"
"Neurologist"
"Urologist"
"Gynecologist"
"Endocrinologist"
"Oncologist"
"Radiation Oncologist"
"Hematologist"
"Gastroenterologist"
"Pulmonologist"
"Nephrologist"
"Rheumatologist"
"Dermatologist"
"Ophthalmologist"
"Otolaryngologist"
"Pediatrician"
"Obstetrician"
"Psychiatrist"
"Anesthesiologist"
"Emergency Medicine Physician"
"Family Medicine Physician"
"Internal Medicine Physician"
"Pathologist"
"Nuclear Medicine Physician"
"Pain Management Specialist"
"Infectious Disease Specialist"
"Immunologist"
"Physician Assistant"
"Nurse Practitioner"
"Certified Registered Nurse Anesthetist"
"Psychologist"
"Medical Assistant"
"Scribe"
"Registered Nurse"
"Nurse Manager"
"Patient Care Coordinator"
"Imaging Technologist"
"Laboratory Technician"
"Medical Laboratory Scientist"
"Pathologists' Assistant"
"Phlebotomist"
"Pharmacist"
"Pharmacy Technician"
"Physical Therapist"
"Occupational Therapist"
"Speech-Language Pathologist"
"Respiratory Therapist"
"Nutritionist"
"Front Desk Operator"
"Revenue Cycle Manager"
"Administrative Director"
"Administrative Assistant"
"Legal Administrator"
"IT Administrator"
"IT Support"
"Software Engineer"
"Other"
created_at: Optional[datetime]

Timestamp when the invitation was created

formatdate-time
email: str

Email address the invitation was sent to

expiry: Optional[datetime]

When the invitation expires, null if no expiration

formatdate-time
first_name: str

Invited user’s first name

minLength1
has_dashboard_access: bool

Whether the invited user will have dashboard access

invitation_id: str

Unique invitation identifier. Format: inv_{32-hex-chars}

invited_source: InvitedSource

How a user/invitation was created - via the dashboard UI (‘dashboard’) or the API (‘api’).

One of the following:
"dashboard"
"api"
inviter_id: str

User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API

last_name: str

Invited user’s last name

minLength1
level: UserLevel

User access level. ‘owner’ has full control (dashboard-only, not assignable via API), ‘admin’ can manage users/settings, ‘member’ has standard access.

One of the following:
"owner"
"admin"
"member"

Lifecycle status of an invitation: ‘sent’, ‘accepted’, ‘rejected’, or ‘revoked’.

One of the following:
"sent"
"accepted"
"rejected"
"revoked"
updated_at: Optional[datetime]

Timestamp when the invitation was last updated

formatdate-time
user_id: str

Pre-generated user ID for this invitation. Format: usr_{32-hex-chars}. This ID is assigned at invitation creation and will become the user’s permanent ID upon acceptance

invited_by_api_key_id: Optional[str]

UUID of the API key used to send this invitation. Null if sent via dashboard

formatuuid
middle_name: Optional[str]

Invited user’s middle name (optional)

minLength1
npi_number: Optional[str]

National Provider Identifier - required for users who can create reports (10-digit number)

minLength10
maxLength10
phone_number: Optional[str]

Invited user’s phone number (optional)

suffix1: Optional[str]

Name suffix (e.g., ‘Jr.’, ‘MD’) - optional

minLength1
suffix2: Optional[str]

Additional name suffix - optional

minLength1
class InvitationUpdateResponse:

A pending user invitation in the AutoScribe system

can_create_reports: bool

Whether the invited user can generate and sign radiology reports. Requires NPI number

can_manage_studies: bool

Whether the invited user will have permission to create, update, and manage studies

clinic_id: str

UUID of the clinic this invitation belongs to

formatuuid
clinic_role: ClinicRole

A user’s clinical or organizational role within the clinic.

One of the following:
"Doctor"
"Physician"
"Surgeon"
"Radiologist"
"Cardiologist"
"Neurologist"
"Urologist"
"Gynecologist"
"Endocrinologist"
"Oncologist"
"Radiation Oncologist"
"Hematologist"
"Gastroenterologist"
"Pulmonologist"
"Nephrologist"
"Rheumatologist"
"Dermatologist"
"Ophthalmologist"
"Otolaryngologist"
"Pediatrician"
"Obstetrician"
"Psychiatrist"
"Anesthesiologist"
"Emergency Medicine Physician"
"Family Medicine Physician"
"Internal Medicine Physician"
"Pathologist"
"Nuclear Medicine Physician"
"Pain Management Specialist"
"Infectious Disease Specialist"
"Immunologist"
"Physician Assistant"
"Nurse Practitioner"
"Certified Registered Nurse Anesthetist"
"Psychologist"
"Medical Assistant"
"Scribe"
"Registered Nurse"
"Nurse Manager"
"Patient Care Coordinator"
"Imaging Technologist"
"Laboratory Technician"
"Medical Laboratory Scientist"
"Pathologists' Assistant"
"Phlebotomist"
"Pharmacist"
"Pharmacy Technician"
"Physical Therapist"
"Occupational Therapist"
"Speech-Language Pathologist"
"Respiratory Therapist"
"Nutritionist"
"Front Desk Operator"
"Revenue Cycle Manager"
"Administrative Director"
"Administrative Assistant"
"Legal Administrator"
"IT Administrator"
"IT Support"
"Software Engineer"
"Other"
created_at: Optional[datetime]

Timestamp when the invitation was created

formatdate-time
email: str

Email address the invitation was sent to

expiry: Optional[datetime]

When the invitation expires, null if no expiration

formatdate-time
first_name: str

Invited user’s first name

minLength1
has_dashboard_access: bool

Whether the invited user will have dashboard access

invitation_id: str

Unique invitation identifier. Format: inv_{32-hex-chars}

invited_source: InvitedSource

How a user/invitation was created - via the dashboard UI (‘dashboard’) or the API (‘api’).

One of the following:
"dashboard"
"api"
inviter_id: str

User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API

last_name: str

Invited user’s last name

minLength1
level: UserLevel

User access level. ‘owner’ has full control (dashboard-only, not assignable via API), ‘admin’ can manage users/settings, ‘member’ has standard access.

One of the following:
"owner"
"admin"
"member"

Lifecycle status of an invitation: ‘sent’, ‘accepted’, ‘rejected’, or ‘revoked’.

One of the following:
"sent"
"accepted"
"rejected"
"revoked"
updated_at: Optional[datetime]

Timestamp when the invitation was last updated

formatdate-time
user_id: str

Pre-generated user ID for this invitation. Format: usr_{32-hex-chars}. This ID is assigned at invitation creation and will become the user’s permanent ID upon acceptance

invited_by_api_key_id: Optional[str]

UUID of the API key used to send this invitation. Null if sent via dashboard

formatuuid
middle_name: Optional[str]

Invited user’s middle name (optional)

minLength1
npi_number: Optional[str]

National Provider Identifier - required for users who can create reports (10-digit number)

minLength10
maxLength10
phone_number: Optional[str]

Invited user’s phone number (optional)

suffix1: Optional[str]

Name suffix (e.g., ‘Jr.’, ‘MD’) - optional

minLength1
suffix2: Optional[str]

Additional name suffix - optional

minLength1
class InvitationRevokeResponse:

Response for revoking an invitation in AutoScribe

success: bool
message: Optional[str]

Auto ScribeReports

List reports for a study
auto_scribe.reports.list(ReportListParams**kwargs) -> ReportListResponse
GET/v1/autoScribe/reports
Retrieve report text
auto_scribe.reports.text(ReportTextParams**kwargs) -> ReportTextResponse
GET/v1/autoScribe/reports/text
Retrieve report PDF URL
auto_scribe.reports.pdf(ReportPdfParams**kwargs) -> ReportPdfResponse
GET/v1/autoScribe/reports/pdf
Create a report addendum
auto_scribe.reports.addendum(strreport_id) -> ReportAddendumResponse
POST/v1/autoScribe/reports/{reportId}/addendum
Cancel a report addendum
auto_scribe.reports.cancel_addendum(strreport_id) -> ReportCancelAddendumResponse
POST/v1/autoScribe/reports/{reportId}/cancel-addendum
ModelsExpand Collapse
class Report:

A radiology report in the AutoScribe system

created_at: Optional[datetime]

Timestamp when the report was created

formatdate-time
is_addendum: bool

Whether this report is an addendum to a previous report

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}

signed_at: Optional[datetime]

Timestamp when the report was signed, null if not yet signed

formatdate-time
snapshot_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 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 of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

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

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

One of the following:
"in_progress"
"completed"
study_id: str

Study ID this report belongs to. Format: stu_{32-hex-chars}

updated_at: Optional[datetime]

Timestamp when the report was last updated

formatdate-time
user_id: str

User ID of the radiologist who created/signed this report. Format: usr_{32-hex-chars}

report_plain_text: Optional[str]

Plain text content of the report

class ReportPdfItem:

A report with its PDF download URL

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.

presigned_url: str

Time-limited presigned URL to download the PDF (expires after 1 hour)

report_id: str

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

snapshot_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 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 of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

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

Study ID this report belongs to. 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
class ReportTextItem:

A report with its plain text content

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}

snapshot_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 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 of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

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

Study ID this report belongs to. 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
plain_text: Optional[str]

Plain text content of the report

class ReportListResponse:

Response containing a list of reports for a study

reports: List[Report]

Array of report objects with full details

created_at: Optional[datetime]

Timestamp when the report was created

formatdate-time
is_addendum: bool

Whether this report is an addendum to a previous report

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}

signed_at: Optional[datetime]

Timestamp when the report was signed, null if not yet signed

formatdate-time
snapshot_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 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 of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

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

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

One of the following:
"in_progress"
"completed"
study_id: str

Study ID this report belongs to. Format: stu_{32-hex-chars}

updated_at: Optional[datetime]

Timestamp when the report was last updated

formatdate-time
user_id: str

User ID of the radiologist who created/signed this report. Format: usr_{32-hex-chars}

report_plain_text: Optional[str]

Plain text content of the report

study_id: str

Study ID the reports belong to. 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

Response containing a single report with its plain text

One of the following:
class SingleReportTextResponse:

Response containing a single report with its plain text

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}

snapshot_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 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 of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

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

Study ID this report belongs to. 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
plain_text: Optional[str]

Plain text content of the report

class ListReportsTextResponse:

Response containing a list of reports with their plain text

reports: List[ReportTextItem]

Array of report text items

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}

snapshot_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 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 of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

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

Study ID this report belongs to. 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
plain_text: Optional[str]

Plain text content of the report

study_id: str

Study ID the reports belong to. 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

Response containing a single report with its PDF download URL

One of the following:
class SingleReportPdfResponse:

Response containing a single report with its PDF download URL

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.

presigned_url: str

Time-limited presigned URL to download the PDF (expires after 1 hour)

report_id: str

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

snapshot_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 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 of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

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

Study ID this report belongs to. 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
class ListReportsPdfResponse:

Response containing a list of reports with their PDF download URLs

reports: List[ReportPdfItem]

Array of report PDF items with download URLs

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.

presigned_url: str

Time-limited presigned URL to download the PDF (expires after 1 hour)

report_id: str

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

snapshot_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 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 of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

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

Study ID this report belongs to. 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_id: str

Study ID the reports belong to. 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
class ReportAddendumResponse:

Response for creating a report addendum

success: bool
message: Optional[str]
class ReportCancelAddendumResponse:

Response for cancelling a report addendum

success: bool
message: Optional[str]