Studies

Create a new study

client.autoScribe.studies.create(, ?): StudyCreateResponse { cancelledAt, createdAt, isCancelled, 23 more }

POST/v1/autoScribe/studies

List studies with pagination

client.autoScribe.studies.list(?, ?): CursorStudies<StudyListResponse { cancelledAt, createdAt, isCancelled, 23 more } >

GET/v1/autoScribe/studies

Retrieve a study by ID

client.autoScribe.studies.retrieve(, ?): StudyRetrieveResponse { cancelledAt, createdAt, isCancelled, 23 more }

GET/v1/autoScribe/studies/{studyId}

Update a study

client.autoScribe.studies.update(, ?, ?): StudyUpdateResponse { cancelledAt, createdAt, isCancelled, 23 more }

PATCH/v1/autoScribe/studies/{studyId}

Cancel a study

client.autoScribe.studies.cancel(?, ?): StudyCancelResponse { success, message }

POST/v1/autoScribe/studies/cancel

Uncancel a study

client.autoScribe.studies.uncancel(?, ?): StudyUncancelResponse { success, message }

POST/v1/autoScribe/studies/uncancel

Generate a reroute URL with viewer and dictation

client.autoScribe.studies.rerouteURL(, ?): StudyRerouteURLResponse { url }

POST/v1/autoScribe/studies/reroute-url

Generate a viewer-only reroute URL

client.autoScribe.studies.viewerOnlyRerouteURL(?, ?): StudyViewerOnlyRerouteURLResponse { url }

POST/v1/autoScribe/studies/viewer-only-reroute-url

Retrieve a study by DICOM UID

client.autoScribe.studies.retrieveByUid(, ?): StudyRetrieveByUidResponse { cancelledAt, createdAt, isCancelled, 23 more }

GET/v1/autoScribe/studies/by-uid/{studyInstanceUid}

ModelsExpand Collapse

PriorReport { reportText, externalStudyId, modality, 2 more }

External prior report metadata and text stored on a study

reportText: string

Full prior report text

minLength1

maxLength50000

externalStudyId?: string

Integrator’s external study identifier

minLength1

maxLength256

modality?: string

Imaging modality for the prior study

minLength1

maxLength100

studyDate?: string

Prior study date (YYYY-MM-DD)

studyDescription?: string

Description of the prior study

minLength1

maxLength1000

ReportIDWithStatus { isCritical, reportId, status }

A report ID paired with its current status

isCritical: boolean | null

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

reportId: string

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"

StudyCreateResponse { cancelledAt, createdAt, isCancelled, 23 more }

A study entity in the AutoScribe system with report workflow status

cancelledAt: string | null

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

createdAt: string | null

Timestamp when the study was created

formatdate-time

isCancelled: boolean

Whether the study has been cancelled

reportMetadata: StudyReportMetadata { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age?: string

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

dateOfBirth?: string

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

facilityName?: string

Name of the medical facility where the scan was performed

height?: Height { unit, value }

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

unit: HeightUnit

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

One of the following:

"in"

"cm"

value: number

minimum0

mrn?: string

Medical Record Number - unique patient identifier

patientName?: string

Full name of the patient

procedure?: string

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

referringPhysicianName?: string

Name of the physician who referred the patient for this scan

sex?: Sex

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

One of the following:

"male"

"female"

"other"

studyDate?: string

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

studyTime?: string

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

weight?: Weight { unit, value }

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

unit: WeightUnit

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

One of the following:

"lbs"

"kg"

value: number

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"

studyDescription: string

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

minLength1

studyId: string

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

studyInstanceUid: string

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

minLength1

studyReportStatus: StudyReportStatus

AutoScribe report workflow status for a study. ‘unassigned’ = no radiologist assigned, ‘assigned’ = assigned but not started, ‘in_progress’ = actively being dictated, ‘completed’ = report signed, ‘addendum_active’ = addendum in progress.

One of the following:

"unassigned"

"assigned"

"in_progress"

"completed"

"addendum_active"

updatedAt: string | null

Timestamp when the study was last updated

formatdate-time

assignedTo?: UserReference { email, userId, firstName, 4 more } | null

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

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

firstName?: string

User’s first name

lastName?: string

User’s last name

middleName?: string

User’s middle name

suffix1?: string

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

suffix2?: string

Additional name suffix

clinicalHistory?: string | null

Relevant clinical history for the study

clinicalIndication?: string | null

Clinical indication for the study

createdByApiKey?: APIKeyReference { apiKeyId, description, isClinicalContextEnrichmentEnabled, isViewerEnabled } | null

A reference to an API key with basic identifying information

apiKeyId: string

Unique API key identifier (UUIDv4 format)

formatuuid

description: string

Human-readable description of the API key

minLength1

isClinicalContextEnrichmentEnabled?: boolean

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

isViewerEnabled?: boolean

Whether this API key has access to the Viewer product

createdByUser?: UserReference { email, userId, firstName, 4 more } | null

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

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

firstName?: string

User’s first name

lastName?: string

User’s last name

middleName?: string

User’s middle name

suffix1?: string

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

suffix2?: string

Additional name suffix

expressCustomer?: ExpressCustomerReference { expressCustomerId, expressCustomerName } | null

A reference to an Express customer with basic identifying information

expressCustomerId: string

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

expressCustomerName: string

Name of the Express customer

minLength1

externalPatientId?: string | null

Integrator-provided stable patient identifier for linking studies

externalReportId?: string

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

isCritical?: boolean

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

metadata?: Record<string, string>

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

modality?: string | null

Imaging modality for the study (free text)

priorReports?: Array<PriorReport { reportText, externalStudyId, modality, 2 more } >

External prior reports with metadata and text

reportText: string

Full prior report text

minLength1

maxLength50000

externalStudyId?: string

Integrator’s external study identifier

minLength1

maxLength256

modality?: string

Imaging modality for the prior study

minLength1

maxLength100

studyDate?: string

Prior study date (YYYY-MM-DD)

studyDescription?: string

Description of the prior study

minLength1

maxLength1000

reportIds?: Array<ReportIDWithStatus { isCritical, reportId, status } >

Array of report IDs associated with this study, including addendums

isCritical: boolean | null

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

reportId: string

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"

studyType?: StudyType

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

One of the following:

"standard"

"external"

technologistNotes?: Array<string>

Technologist notes for the study

technologistTechnique?: string | null

Imaging technique description

StudyListResponse { cancelledAt, createdAt, isCancelled, 23 more }

A study entity in the AutoScribe system with report workflow status

cancelledAt: string | null

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

createdAt: string | null

Timestamp when the study was created

formatdate-time

isCancelled: boolean

Whether the study has been cancelled

reportMetadata: StudyReportMetadata { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age?: string

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

dateOfBirth?: string

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

facilityName?: string

Name of the medical facility where the scan was performed

height?: Height { unit, value }

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

unit: HeightUnit

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

One of the following:

"in"

"cm"

value: number

minimum0

mrn?: string

Medical Record Number - unique patient identifier

patientName?: string

Full name of the patient

procedure?: string

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

referringPhysicianName?: string

Name of the physician who referred the patient for this scan

sex?: Sex

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

One of the following:

"male"

"female"

"other"

studyDate?: string

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

studyTime?: string

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

weight?: Weight { unit, value }

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

unit: WeightUnit

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

One of the following:

"lbs"

"kg"

value: number

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"

studyDescription: string

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

minLength1

studyId: string

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

studyInstanceUid: string

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

minLength1

studyReportStatus: StudyReportStatus

One of the following:

"unassigned"

"assigned"

"in_progress"

"completed"

"addendum_active"

updatedAt: string | null

Timestamp when the study was last updated

formatdate-time

assignedTo?: UserReference { email, userId, firstName, 4 more } | null

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

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

firstName?: string

User’s first name

lastName?: string

User’s last name

middleName?: string

User’s middle name

suffix1?: string

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

suffix2?: string

Additional name suffix

clinicalHistory?: string | null

Relevant clinical history for the study

clinicalIndication?: string | null

Clinical indication for the study

createdByApiKey?: APIKeyReference { apiKeyId, description, isClinicalContextEnrichmentEnabled, isViewerEnabled } | null

A reference to an API key with basic identifying information

apiKeyId: string

Unique API key identifier (UUIDv4 format)

formatuuid

description: string

Human-readable description of the API key

minLength1

isClinicalContextEnrichmentEnabled?: boolean

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

isViewerEnabled?: boolean

Whether this API key has access to the Viewer product

createdByUser?: UserReference { email, userId, firstName, 4 more } | null

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

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

firstName?: string

User’s first name

lastName?: string

User’s last name

middleName?: string

User’s middle name

suffix1?: string

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

suffix2?: string

Additional name suffix

expressCustomer?: ExpressCustomerReference { expressCustomerId, expressCustomerName } | null

A reference to an Express customer with basic identifying information

expressCustomerId: string

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

expressCustomerName: string

Name of the Express customer

minLength1

externalPatientId?: string | null

Integrator-provided stable patient identifier for linking studies

externalReportId?: string

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

isCritical?: boolean

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

metadata?: Record<string, string>

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

modality?: string | null

Imaging modality for the study (free text)

priorReports?: Array<PriorReport { reportText, externalStudyId, modality, 2 more } >

External prior reports with metadata and text

reportText: string

Full prior report text

minLength1

maxLength50000

externalStudyId?: string

Integrator’s external study identifier

minLength1

maxLength256

modality?: string

Imaging modality for the prior study

minLength1

maxLength100

studyDate?: string

Prior study date (YYYY-MM-DD)

studyDescription?: string

Description of the prior study

minLength1

maxLength1000

reportIds?: Array<ReportIDWithStatus { isCritical, reportId, status } >

Array of report IDs associated with this study, including addendums

isCritical: boolean | null

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

reportId: string

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"

studyType?: StudyType

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

One of the following:

"standard"

"external"

technologistNotes?: Array<string>

Technologist notes for the study

technologistTechnique?: string | null

Imaging technique description

StudyRetrieveResponse { cancelledAt, createdAt, isCancelled, 23 more }

A study entity in the AutoScribe system with report workflow status

cancelledAt: string | null

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

createdAt: string | null

Timestamp when the study was created

formatdate-time

isCancelled: boolean

Whether the study has been cancelled

reportMetadata: StudyReportMetadata { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age?: string

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

dateOfBirth?: string

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

facilityName?: string

Name of the medical facility where the scan was performed

height?: Height { unit, value }

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

unit: HeightUnit

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

One of the following:

"in"

"cm"

value: number

minimum0

mrn?: string

Medical Record Number - unique patient identifier

patientName?: string

Full name of the patient

procedure?: string

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

referringPhysicianName?: string

Name of the physician who referred the patient for this scan

sex?: Sex

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

One of the following:

"male"

"female"

"other"

studyDate?: string

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

studyTime?: string

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

weight?: Weight { unit, value }

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

unit: WeightUnit

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

One of the following:

"lbs"

"kg"

value: number

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"

studyDescription: string

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

minLength1

studyId: string

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

studyInstanceUid: string

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

minLength1

studyReportStatus: StudyReportStatus

One of the following:

"unassigned"

"assigned"

"in_progress"

"completed"

"addendum_active"

updatedAt: string | null

Timestamp when the study was last updated

formatdate-time

assignedTo?: UserReference { email, userId, firstName, 4 more } | null

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

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

firstName?: string

User’s first name

lastName?: string

User’s last name

middleName?: string

User’s middle name

suffix1?: string

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

suffix2?: string

Additional name suffix

clinicalHistory?: string | null

Relevant clinical history for the study

clinicalIndication?: string | null

Clinical indication for the study

createdByApiKey?: APIKeyReference { apiKeyId, description, isClinicalContextEnrichmentEnabled, isViewerEnabled } | null

A reference to an API key with basic identifying information

apiKeyId: string

Unique API key identifier (UUIDv4 format)

formatuuid

description: string

Human-readable description of the API key

minLength1

isClinicalContextEnrichmentEnabled?: boolean

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

isViewerEnabled?: boolean

Whether this API key has access to the Viewer product

createdByUser?: UserReference { email, userId, firstName, 4 more } | null

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

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

firstName?: string

User’s first name

lastName?: string

User’s last name

middleName?: string

User’s middle name

suffix1?: string

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

suffix2?: string

Additional name suffix

expressCustomer?: ExpressCustomerReference { expressCustomerId, expressCustomerName } | null

A reference to an Express customer with basic identifying information

expressCustomerId: string

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

expressCustomerName: string

Name of the Express customer

minLength1

externalPatientId?: string | null

Integrator-provided stable patient identifier for linking studies

externalReportId?: string

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

isCritical?: boolean

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

metadata?: Record<string, string>

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

modality?: string | null

Imaging modality for the study (free text)

priorReports?: Array<PriorReport { reportText, externalStudyId, modality, 2 more } >

External prior reports with metadata and text

reportText: string

Full prior report text

minLength1

maxLength50000

externalStudyId?: string

Integrator’s external study identifier

minLength1

maxLength256

modality?: string

Imaging modality for the prior study

minLength1

maxLength100

studyDate?: string

Prior study date (YYYY-MM-DD)

studyDescription?: string

Description of the prior study

minLength1

maxLength1000

reportIds?: Array<ReportIDWithStatus { isCritical, reportId, status } >

Array of report IDs associated with this study, including addendums

isCritical: boolean | null

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

reportId: string

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"

studyType?: StudyType

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

One of the following:

"standard"

"external"

technologistNotes?: Array<string>

Technologist notes for the study

technologistTechnique?: string | null

Imaging technique description

StudyUpdateResponse { cancelledAt, createdAt, isCancelled, 23 more }

A study entity in the AutoScribe system with report workflow status

cancelledAt: string | null

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

createdAt: string | null

Timestamp when the study was created

formatdate-time

isCancelled: boolean

Whether the study has been cancelled

reportMetadata: StudyReportMetadata { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age?: string

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

dateOfBirth?: string

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

facilityName?: string

Name of the medical facility where the scan was performed

height?: Height { unit, value }

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

unit: HeightUnit

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

One of the following:

"in"

"cm"

value: number

minimum0

mrn?: string

Medical Record Number - unique patient identifier

patientName?: string

Full name of the patient

procedure?: string

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

referringPhysicianName?: string

Name of the physician who referred the patient for this scan

sex?: Sex

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

One of the following:

"male"

"female"

"other"

studyDate?: string

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

studyTime?: string

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

weight?: Weight { unit, value }

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

unit: WeightUnit

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

One of the following:

"lbs"

"kg"

value: number

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"

studyDescription: string

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

minLength1

studyId: string

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

studyInstanceUid: string

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

minLength1

studyReportStatus: StudyReportStatus

One of the following:

"unassigned"

"assigned"

"in_progress"

"completed"

"addendum_active"

updatedAt: string | null

Timestamp when the study was last updated

formatdate-time

assignedTo?: UserReference { email, userId, firstName, 4 more } | null

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

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

firstName?: string

User’s first name

lastName?: string

User’s last name

middleName?: string

User’s middle name

suffix1?: string

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

suffix2?: string

Additional name suffix

clinicalHistory?: string | null

Relevant clinical history for the study

clinicalIndication?: string | null

Clinical indication for the study

createdByApiKey?: APIKeyReference { apiKeyId, description, isClinicalContextEnrichmentEnabled, isViewerEnabled } | null

A reference to an API key with basic identifying information

apiKeyId: string

Unique API key identifier (UUIDv4 format)

formatuuid

description: string

Human-readable description of the API key

minLength1

isClinicalContextEnrichmentEnabled?: boolean

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

isViewerEnabled?: boolean

Whether this API key has access to the Viewer product

createdByUser?: UserReference { email, userId, firstName, 4 more } | null

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

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

firstName?: string

User’s first name

lastName?: string

User’s last name

middleName?: string

User’s middle name

suffix1?: string

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

suffix2?: string

Additional name suffix

expressCustomer?: ExpressCustomerReference { expressCustomerId, expressCustomerName } | null

A reference to an Express customer with basic identifying information

expressCustomerId: string

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

expressCustomerName: string

Name of the Express customer

minLength1

externalPatientId?: string | null

Integrator-provided stable patient identifier for linking studies

externalReportId?: string

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

isCritical?: boolean

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

metadata?: Record<string, string>

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

modality?: string | null

Imaging modality for the study (free text)

priorReports?: Array<PriorReport { reportText, externalStudyId, modality, 2 more } >

External prior reports with metadata and text

reportText: string

Full prior report text

minLength1

maxLength50000

externalStudyId?: string

Integrator’s external study identifier

minLength1

maxLength256

modality?: string

Imaging modality for the prior study

minLength1

maxLength100

studyDate?: string

Prior study date (YYYY-MM-DD)

studyDescription?: string

Description of the prior study

minLength1

maxLength1000

reportIds?: Array<ReportIDWithStatus { isCritical, reportId, status } >

Array of report IDs associated with this study, including addendums

isCritical: boolean | null

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

reportId: string

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"

studyType?: StudyType

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

One of the following:

"standard"

"external"

technologistNotes?: Array<string>

Technologist notes for the study

technologistTechnique?: string | null

Imaging technique description

StudyCancelResponse { success, message }

Response for cancelling a study in AutoScribe

success: boolean

message?: string

StudyUncancelResponse { success, message }

Response for uncancelling a study in AutoScribe

success: boolean

message?: string

StudyRerouteURLResponse { url }

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

url: string

StudyViewerOnlyRerouteURLResponse { url }

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

url: string

StudyRetrieveByUidResponse { cancelledAt, createdAt, isCancelled, 23 more }

A study entity in the AutoScribe system with report workflow status

cancelledAt: string | null

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

createdAt: string | null

Timestamp when the study was created

formatdate-time

isCancelled: boolean

Whether the study has been cancelled

reportMetadata: StudyReportMetadata { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age?: string

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

dateOfBirth?: string

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

facilityName?: string

Name of the medical facility where the scan was performed

height?: Height { unit, value }

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

unit: HeightUnit

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

One of the following:

"in"

"cm"

value: number

minimum0

mrn?: string

Medical Record Number - unique patient identifier

patientName?: string

Full name of the patient

procedure?: string

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

referringPhysicianName?: string

Name of the physician who referred the patient for this scan

sex?: Sex

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

One of the following:

"male"

"female"

"other"

studyDate?: string

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

studyTime?: string

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

weight?: Weight { unit, value }

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

unit: WeightUnit

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

One of the following:

"lbs"

"kg"

value: number

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"

studyDescription: string

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

minLength1

studyId: string

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

studyInstanceUid: string

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

minLength1

studyReportStatus: StudyReportStatus

One of the following:

"unassigned"

"assigned"

"in_progress"

"completed"

"addendum_active"

updatedAt: string | null

Timestamp when the study was last updated

formatdate-time

assignedTo?: UserReference { email, userId, firstName, 4 more } | null

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

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

firstName?: string

User’s first name

lastName?: string

User’s last name

middleName?: string

User’s middle name

suffix1?: string

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

suffix2?: string

Additional name suffix

clinicalHistory?: string | null

Relevant clinical history for the study

clinicalIndication?: string | null

Clinical indication for the study

createdByApiKey?: APIKeyReference { apiKeyId, description, isClinicalContextEnrichmentEnabled, isViewerEnabled } | null

A reference to an API key with basic identifying information

apiKeyId: string

Unique API key identifier (UUIDv4 format)

formatuuid

description: string

Human-readable description of the API key

minLength1

isClinicalContextEnrichmentEnabled?: boolean

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

isViewerEnabled?: boolean

Whether this API key has access to the Viewer product

createdByUser?: UserReference { email, userId, firstName, 4 more } | null

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

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

firstName?: string

User’s first name

lastName?: string

User’s last name

middleName?: string

User’s middle name

suffix1?: string

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

suffix2?: string

Additional name suffix

expressCustomer?: ExpressCustomerReference { expressCustomerId, expressCustomerName } | null

A reference to an Express customer with basic identifying information

expressCustomerId: string

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

expressCustomerName: string

Name of the Express customer

minLength1

externalPatientId?: string | null

Integrator-provided stable patient identifier for linking studies

externalReportId?: string

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

isCritical?: boolean

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

metadata?: Record<string, string>

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

modality?: string | null

Imaging modality for the study (free text)

priorReports?: Array<PriorReport { reportText, externalStudyId, modality, 2 more } >

External prior reports with metadata and text

reportText: string

Full prior report text

minLength1

maxLength50000

externalStudyId?: string

Integrator’s external study identifier

minLength1

maxLength256

modality?: string

Imaging modality for the prior study

minLength1

maxLength100

studyDate?: string

Prior study date (YYYY-MM-DD)

studyDescription?: string

Description of the prior study

minLength1

maxLength1000

reportIds?: Array<ReportIDWithStatus { isCritical, reportId, status } >

Array of report IDs associated with this study, including addendums

isCritical: boolean | null

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

reportId: string

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"

studyType?: StudyType

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

One of the following:

"standard"

"external"

technologistNotes?: Array<string>

Technologist notes for the study

technologistTechnique?: string | null

Imaging technique description

StudiesExternal

Create an external study

client.autoScribe.studies.external.create(, ?): ExternalCreateResponse { cancelledAt, createdAt, isCancelled, 23 more }

POST/v1/autoScribe/studies/external

Delete an external study

client.autoScribe.studies.external.delete(?, ?): ExternalDeleteResponse { success, message }

POST/v1/autoScribe/studies/external/delete

ModelsExpand Collapse

ExternalCreateResponse { cancelledAt, createdAt, isCancelled, 23 more }

A study entity in the AutoScribe system with report workflow status

cancelledAt: string | null

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

createdAt: string | null

Timestamp when the study was created

formatdate-time

isCancelled: boolean

Whether the study has been cancelled

reportMetadata: StudyReportMetadata { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age?: string

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

dateOfBirth?: string

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

facilityName?: string

Name of the medical facility where the scan was performed

height?: Height { unit, value }

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

unit: HeightUnit

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

One of the following:

"in"

"cm"

value: number

minimum0

mrn?: string

Medical Record Number - unique patient identifier

patientName?: string

Full name of the patient

procedure?: string

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

referringPhysicianName?: string

Name of the physician who referred the patient for this scan

sex?: Sex

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

One of the following:

"male"

"female"

"other"

studyDate?: string

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

studyTime?: string

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

weight?: Weight { unit, value }

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

unit: WeightUnit

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

One of the following:

"lbs"

"kg"

value: number

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"

studyDescription: string

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

minLength1

studyId: string

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

studyInstanceUid: string

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

minLength1

studyReportStatus: StudyReportStatus

One of the following:

"unassigned"

"assigned"

"in_progress"

"completed"

"addendum_active"

updatedAt: string | null

Timestamp when the study was last updated

formatdate-time

assignedTo?: UserReference { email, userId, firstName, 4 more } | null

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

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

firstName?: string

User’s first name

lastName?: string

User’s last name

middleName?: string

User’s middle name

suffix1?: string

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

suffix2?: string

Additional name suffix

clinicalHistory?: string | null

Relevant clinical history for the study

clinicalIndication?: string | null

Clinical indication for the study

createdByApiKey?: APIKeyReference { apiKeyId, description, isClinicalContextEnrichmentEnabled, isViewerEnabled } | null

A reference to an API key with basic identifying information

apiKeyId: string

Unique API key identifier (UUIDv4 format)

formatuuid

description: string

Human-readable description of the API key

minLength1

isClinicalContextEnrichmentEnabled?: boolean

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

isViewerEnabled?: boolean

Whether this API key has access to the Viewer product

createdByUser?: UserReference { email, userId, firstName, 4 more } | null

A reference to a user with basic identifying information

email: string

User’s email address

userId: string

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

firstName?: string

User’s first name

lastName?: string

User’s last name

middleName?: string

User’s middle name

suffix1?: string

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

suffix2?: string

Additional name suffix

expressCustomer?: ExpressCustomerReference { expressCustomerId, expressCustomerName } | null

A reference to an Express customer with basic identifying information

expressCustomerId: string

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

expressCustomerName: string

Name of the Express customer

minLength1

externalPatientId?: string | null

Integrator-provided stable patient identifier for linking studies

externalReportId?: string

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

isCritical?: boolean

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

metadata?: Record<string, string>

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

modality?: string | null

Imaging modality for the study (free text)

priorReports?: Array<PriorReport { reportText, externalStudyId, modality, 2 more } >

External prior reports with metadata and text

reportText: string

Full prior report text

minLength1

maxLength50000

externalStudyId?: string

Integrator’s external study identifier

minLength1

maxLength256

modality?: string

Imaging modality for the prior study

minLength1

maxLength100

studyDate?: string

Prior study date (YYYY-MM-DD)

studyDescription?: string

Description of the prior study

minLength1

maxLength1000

reportIds?: Array<ReportIDWithStatus { isCritical, reportId, status } >

Array of report IDs associated with this study, including addendums

isCritical: boolean | null

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

reportId: string

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"

studyType?: StudyType

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

One of the following:

"standard"

"external"

technologistNotes?: Array<string>

Technologist notes for the study

technologistTechnique?: string | null

Imaging technique description

ExternalDeleteResponse { success, message }

Result of deleting an external study

success: boolean

message?: string

StudiesExternalReports

Attach an external report

client.autoScribe.studies.external.reports.create(?, ?): ReportCreateResponse { externalReportId, studyId, studyInstanceUid }

POST/v1/autoScribe/studies/external/reports

List external reports

client.autoScribe.studies.external.reports.list(?, ?): CursorExternalReports<ReportListResponse { createdAt, externalReportId, hasReportText, 5 more } >

GET/v1/autoScribe/studies/external/reports

Retrieve an external report

client.autoScribe.studies.external.reports.retrieve(, ?): ReportRetrieveResponse { createdAt, externalReportId, studyId, 6 more }

GET/v1/autoScribe/studies/external/reports/{externalReportId}

ModelsExpand Collapse

ReportCreateResponse { externalReportId, studyId, studyInstanceUid }

Created or updated external report identifiers

externalReportId: string

studyId: string

studyInstanceUid: string

minLength1

ReportListResponse { createdAt, externalReportId, hasReportText, 5 more }

createdAt: string | null

formatdate-time

externalReportId: string

hasReportText: boolean

reportPdfPresent: boolean

studyId: string

studyInstanceUid: string

minLength1

readerName?: string | null

signedAt?: string | null

ReportRetrieveResponse { createdAt, externalReportId, studyId, 6 more }

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

createdAt: string | null

formatdate-time

externalReportId: string

studyId: string

studyInstanceUid: string

minLength1

presignedUrl?: string | null

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

readerName?: string | null

reportText?: string | null

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

signedAt?: string | null

snapshotMetadata?: StudyReportMetadata { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age?: string

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

dateOfBirth?: string

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

facilityName?: string

Name of the medical facility where the scan was performed

height?: Height { unit, value }

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

unit: HeightUnit

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

One of the following:

"in"

"cm"

value: number

minimum0

mrn?: string

Medical Record Number - unique patient identifier

patientName?: string

Full name of the patient

procedure?: string

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

referringPhysicianName?: string

Name of the physician who referred the patient for this scan

sex?: Sex

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

One of the following:

"male"

"female"

"other"

studyDate?: string

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

studyTime?: string

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

weight?: Weight { unit, value }

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

unit: WeightUnit

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

One of the following:

"lbs"

"kg"

value: number

minimum0