API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Auto Scribe

ModelsExpand Collapse

ClinicalReferenceType = "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"

HeightUnit = "in" | "cm"

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

One of the following:

"in"

"cm"

ReportStatus = "in_progress" | "completed"

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

One of the following:

"in_progress"

"completed"

Sex = "male" | "female" | "other"

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

One of the following:

"male"

"female"

"other"

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

StudyReportStatus = "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"

StudyType = "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"

WeightUnit = "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

client.autoScribe.clinicalReferences.create(ClinicalReferenceCreateParams { name, type, expressCustomerId, 2 more } body, RequestOptionsoptions?): ClinicalReference { clinicalReferenceId, createdAt, isActive, 6 more }

POST/v1/autoScribe/clinicalReferences

List clinical references

client.autoScribe.clinicalReferences.list(ClinicalReferenceListParams { cursor, expressCustomerId, isActive, 2 more } query?, RequestOptionsoptions?): CursorClinicalReferences<ClinicalReference { clinicalReferenceId, createdAt, isActive, 6 more } >

GET/v1/autoScribe/clinicalReferences

Retrieve a clinical reference by ID

client.autoScribe.clinicalReferences.retrieve(stringclinicalReferenceID, RequestOptionsoptions?): ClinicalReference { clinicalReferenceId, createdAt, isActive, 6 more }

GET/v1/autoScribe/clinicalReferences/{clinicalReferenceId}

Retrieve a clinical reference by external reference ID

client.autoScribe.clinicalReferences.retrieveByExternalReferenceID(stringexternalReferenceID, RequestOptionsoptions?): ClinicalReference { clinicalReferenceId, createdAt, isActive, 6 more }

GET/v1/autoScribe/clinicalReferences/byExternalReferenceId/{externalReferenceId}

Update a clinical reference

client.autoScribe.clinicalReferences.update(stringclinicalReferenceID, ClinicalReferenceUpdateParams { expressCustomerId, metadata, name } body?, RequestOptionsoptions?): ClinicalReference { clinicalReferenceId, createdAt, isActive, 6 more }

PATCH/v1/autoScribe/clinicalReferences/{clinicalReferenceId}

Delete a clinical reference

client.autoScribe.clinicalReferences.delete(stringclinicalReferenceID, RequestOptionsoptions?): ClinicalReference { clinicalReferenceId, createdAt, isActive, 6 more }

POST/v1/autoScribe/clinicalReferences/{clinicalReferenceId}/delete

ModelsExpand Collapse

ClinicalReference { clinicalReferenceId, createdAt, isActive, 6 more }

A canonical clinical reference value for study workflow pickers and normalization

clinicalReferenceId: string

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

createdAt: string | null

Timestamp when the clinical reference was created

formatdate-time

isActive: boolean

Whether this reference is active and available for pickers

name: string

Canonical display name for this reference value

minLength1

type: ClinicalReferenceType

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

One of the following:

"facility"

"referring_provider"

"study_description"

"procedure"

updatedAt: string | null

Timestamp when the clinical reference was last updated

formatdate-time

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

externalReferenceId?: string | null

Integrator-provided stable identifier for mapping inbound data

metadata?: Record<string, string>

Optional key-value metadata. Maximum 50 pairs

Auto ScribeEphemeral Sessions

Create an ephemeral AutoScribe viewer session

client.autoScribe.ephemeralSessions.create(EphemeralSessionCreateParams { retrievalId, hangingProtocol, options } body, RequestOptionsoptions?): EphemeralSessionCreateResponse { url }

POST/v1/autoScribe/ephemeral-sessions

ModelsExpand Collapse

EphemeralSessionCreateResponse { url }

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

url: string

Auto ScribeStudies

Create a new study

client.autoScribe.studies.create(StudyCreateParams { reportMetadata, severity, studyDescription, 11 more } body, RequestOptionsoptions?): StudyCreateResponse { cancelledAt, createdAt, isCancelled, 23 more }

POST/v1/autoScribe/studies

List studies with pagination

client.autoScribe.studies.list(StudyListParams { assignedTo, cursor, expressCustomerId, 6 more } query?, RequestOptionsoptions?): CursorStudies<StudyListResponse { cancelledAt, createdAt, isCancelled, 23 more } >

GET/v1/autoScribe/studies

Retrieve a study by ID

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

GET/v1/autoScribe/studies/{studyId}

Update a study

client.autoScribe.studies.update(stringstudyID, StudyUpdateParams { assignedTo, clinicalHistory, clinicalIndication, 10 more } body?, RequestOptionsoptions?): StudyUpdateResponse { cancelledAt, createdAt, isCancelled, 23 more }

PATCH/v1/autoScribe/studies/{studyId}

Cancel a study

client.autoScribe.studies.cancel(StudyCancelParams { studyId, studyInstanceUid } body?, RequestOptionsoptions?): StudyCancelResponse { success, message }

POST/v1/autoScribe/studies/cancel

Uncancel a study

client.autoScribe.studies.uncancel(StudyUncancelParams { studyId, studyInstanceUid } body?, RequestOptionsoptions?): StudyUncancelResponse { success, message }

POST/v1/autoScribe/studies/uncancel

Generate a reroute URL with viewer and dictation

client.autoScribe.studies.rerouteURL(StudyRerouteURLParams { assignedToUserId, studyId, studyInstanceUid } body, RequestOptionsoptions?): StudyRerouteURLResponse { url }

POST/v1/autoScribe/studies/reroute-url

Generate a viewer-only reroute URL

client.autoScribe.studies.viewerOnlyRerouteURL(StudyViewerOnlyRerouteURLParams { studyId, studyInstanceUid, userId } body?, RequestOptionsoptions?): StudyViewerOnlyRerouteURLResponse { url }

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

Retrieve a study by DICOM UID

client.autoScribe.studies.retrieveByUid(stringstudyInstanceUid, RequestOptionsoptions?): 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

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

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

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

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

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

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

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

Auto ScribeStudiesExternal

Create an external study

client.autoScribe.studies.external.create(ExternalCreateParams { reportMetadata, severity, studyDescription, 10 more } body, RequestOptionsoptions?): ExternalCreateResponse { cancelledAt, createdAt, isCancelled, 23 more }

POST/v1/autoScribe/studies/external

Delete an external study

client.autoScribe.studies.external.delete(ExternalDeleteParams { studyId, studyInstanceUid } body?, RequestOptionsoptions?): 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

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

ExternalDeleteResponse { success, message }

Result of deleting an external study

success: boolean

message?: string

Auto ScribeStudiesExternalReports

Attach an external report

client.autoScribe.studies.external.reports.create(ReportCreateParams { readerName, reportFileName, reportFileUrl, 4 more } body?, RequestOptionsoptions?): ReportCreateResponse { externalReportId, studyId, studyInstanceUid }

POST/v1/autoScribe/studies/external/reports

List external reports

client.autoScribe.studies.external.reports.list(ReportListParams { cursor, limit, studyId } query?, RequestOptionsoptions?): CursorExternalReports<ReportListResponse { createdAt, externalReportId, hasReportText, 5 more } >

GET/v1/autoScribe/studies/external/reports

Retrieve an external report

client.autoScribe.studies.external.reports.retrieve(stringexternalReportID, RequestOptionsoptions?): 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

Auto ScribeUsers

Create and invite a new user

client.autoScribe.users.invite(UserInviteParams { canCreateReports, canManageStudies, clinicRole, 10 more } body, RequestOptionsoptions?): UserInviteResponse { canCreateReports, canManageStudies, clinicRole, 14 more }

POST/v1/autoScribe/users

List users with pagination

client.autoScribe.users.list(UserListParams { canCreateReports, cursor, email, 5 more } query?, RequestOptionsoptions?): CursorUsers<UserListResponse { canCreateReports, canManageStudies, clinicRole, 14 more } >

GET/v1/autoScribe/users

Retrieve a user by ID

client.autoScribe.users.retrieve(stringuserID, RequestOptionsoptions?): UserRetrieveResponse { canCreateReports, canManageStudies, clinicRole, 14 more }

GET/v1/autoScribe/users/{userId}

Update a user

client.autoScribe.users.update(stringuserID, UserUpdateParams { canCreateReports, canManageStudies, clinicRole, 9 more } body?, RequestOptionsoptions?): UserUpdateResponse { canCreateReports, canManageStudies, clinicRole, 14 more }

PATCH/v1/autoScribe/users/{userId}

Revoke user access

client.autoScribe.users.revokeAccess(UserRevokeAccessParams { userId } body, RequestOptionsoptions?): UserRevokeAccessResponse { success, message }

POST/v1/autoScribe/users/revoke-access

Reactivate a user

client.autoScribe.users.reactivate(UserReactivateParams { userId } body, RequestOptionsoptions?): UserReactivateResponse { success, message }

POST/v1/autoScribe/users/reactivate

ModelsExpand Collapse

UserInviteResponse { canCreateReports, canManageStudies, clinicRole, 14 more }

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

canCreateReports: boolean

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

canManageStudies: boolean

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

clinicRole: 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"

createdAt: string | null

Timestamp when the user was created

formatdate-time

email: string

User’s email address for login and notifications

firstName: string

User’s first name

minLength1

hasDashboardAccess: boolean

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

invitedSource: InvitedSource

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

One of the following:

"dashboard"

"api"

lastLoginAt: string | null

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

formatdate-time

lastName: string

User’s last name

minLength1

level: AssignableUserLevel

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"

userId: string

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

middleName?: string

User’s middle name (optional)

minLength1

npiNumber?: string

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

minLength10

maxLength10

phoneNumber?: string

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

suffix1?: string

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

minLength1

suffix2?: string

Additional name suffix (optional)

minLength1

UserListResponse { canCreateReports, canManageStudies, clinicRole, 14 more }

A user in the AutoScribe system with report creation permissions

canCreateReports: boolean

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

canManageStudies: boolean

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

clinicRole: 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"

createdAt: string | null

Timestamp when the user was created

formatdate-time

email: string

User’s email address for login and notifications

firstName: string

User’s first name

minLength1

hasDashboardAccess: boolean

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

invitedSource: InvitedSource

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

One of the following:

"dashboard"

"api"

lastLoginAt: string | null

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

formatdate-time

lastName: string

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"

userId: string

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

middleName?: string

User’s middle name (optional)

minLength1

npiNumber?: string

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

minLength10

maxLength10

phoneNumber?: string

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

suffix1?: string

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

minLength1

suffix2?: string

Additional name suffix (optional)

minLength1

UserRetrieveResponse { canCreateReports, canManageStudies, clinicRole, 14 more }

A user in the AutoScribe system with report creation permissions

canCreateReports: boolean

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

canManageStudies: boolean

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

clinicRole: 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"

createdAt: string | null

Timestamp when the user was created

formatdate-time

email: string

User’s email address for login and notifications

firstName: string

User’s first name

minLength1

hasDashboardAccess: boolean

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

invitedSource: InvitedSource

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

One of the following:

"dashboard"

"api"

lastLoginAt: string | null

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

formatdate-time

lastName: string

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"

userId: string

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

middleName?: string

User’s middle name (optional)

minLength1

npiNumber?: string

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

minLength10

maxLength10

phoneNumber?: string

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

suffix1?: string

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

minLength1

suffix2?: string

Additional name suffix (optional)

minLength1

UserUpdateResponse { canCreateReports, canManageStudies, clinicRole, 14 more }

A user in the AutoScribe system with report creation permissions

canCreateReports: boolean

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

canManageStudies: boolean

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

clinicRole: 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"

createdAt: string | null

Timestamp when the user was created

formatdate-time

email: string

User’s email address for login and notifications

firstName: string

User’s first name

minLength1

hasDashboardAccess: boolean

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

invitedSource: InvitedSource

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

One of the following:

"dashboard"

"api"

lastLoginAt: string | null

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

formatdate-time

lastName: string

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"

userId: string

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

middleName?: string

User’s middle name (optional)

minLength1

npiNumber?: string

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

minLength10

maxLength10

phoneNumber?: string

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

suffix1?: string

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

minLength1

suffix2?: string

Additional name suffix (optional)

minLength1

UserRevokeAccessResponse { success, message }

Response for revoking user access in AutoScribe

success: boolean

message?: string

UserReactivateResponse { success, message }

Response for reactivating a user in AutoScribe

success: boolean

message?: string

Auto ScribeUsersInvitations

List user invitations

client.autoScribe.users.invitations.list(InvitationListParams { cursor, endDate, expired, 4 more } query?, RequestOptionsoptions?): CursorInvitations<InvitationListResponse { canCreateReports, canManageStudies, clinicId, 20 more } >

GET/v1/autoScribe/users/invitations

Retrieve an invitation by ID

client.autoScribe.users.invitations.retrieve(stringinvitationID, RequestOptionsoptions?): InvitationRetrieveResponse { canCreateReports, canManageStudies, clinicId, 20 more }

GET/v1/autoScribe/users/invitations/{invitationId}

Update an invitation

client.autoScribe.users.invitations.update(stringinvitationID, InvitationUpdateParams { canCreateReports, canManageStudies, clinicRole, 9 more } body?, RequestOptionsoptions?): InvitationUpdateResponse { canCreateReports, canManageStudies, clinicId, 20 more }

PATCH/v1/autoScribe/users/invitations/{invitationId}

Revoke an invitation

client.autoScribe.users.invitations.revoke(InvitationRevokeParams { invitationId, userId } body?, RequestOptionsoptions?): InvitationRevokeResponse { success, message }

POST/v1/autoScribe/users/invitations/revoke

ModelsExpand Collapse

InvitationListResponse { canCreateReports, canManageStudies, clinicId, 20 more }

A pending user invitation in the AutoScribe system

canCreateReports: boolean

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

canManageStudies: boolean

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

clinicId: string

UUID of the clinic this invitation belongs to

formatuuid

clinicRole: 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"

createdAt: string | null

Timestamp when the invitation was created

formatdate-time

email: string

Email address the invitation was sent to

expiry: string | null

When the invitation expires, null if no expiration

formatdate-time

firstName: string

Invited user’s first name

minLength1

hasDashboardAccess: boolean

Whether the invited user will have dashboard access

invitationId: string

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

invitedSource: InvitedSource

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

One of the following:

"dashboard"

"api"

inviterId: string

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

lastName: string

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"

status: InvitationStatus

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

One of the following:

"sent"

"accepted"

"rejected"

"revoked"

updatedAt: string | null

Timestamp when the invitation was last updated

formatdate-time

userId: string

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

invitedByApiKeyId?: string

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

formatuuid

middleName?: string | null

Invited user’s middle name (optional)

minLength1

npiNumber?: string

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

minLength10

maxLength10

phoneNumber?: string | null

Invited user’s phone number (optional)

suffix1?: string | null

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

minLength1

suffix2?: string | null

Additional name suffix - optional

minLength1

InvitationRetrieveResponse { canCreateReports, canManageStudies, clinicId, 20 more }

A pending user invitation in the AutoScribe system

canCreateReports: boolean

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

canManageStudies: boolean

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

clinicId: string

UUID of the clinic this invitation belongs to

formatuuid

clinicRole: 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"

createdAt: string | null

Timestamp when the invitation was created

formatdate-time

email: string

Email address the invitation was sent to

expiry: string | null

When the invitation expires, null if no expiration

formatdate-time

firstName: string

Invited user’s first name

minLength1

hasDashboardAccess: boolean

Whether the invited user will have dashboard access

invitationId: string

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

invitedSource: InvitedSource

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

One of the following:

"dashboard"

"api"

inviterId: string

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

lastName: string

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"

status: InvitationStatus

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

One of the following:

"sent"

"accepted"

"rejected"

"revoked"

updatedAt: string | null

Timestamp when the invitation was last updated

formatdate-time

userId: string

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

invitedByApiKeyId?: string

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

formatuuid

middleName?: string | null

Invited user’s middle name (optional)

minLength1

npiNumber?: string

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

minLength10

maxLength10

phoneNumber?: string | null

Invited user’s phone number (optional)

suffix1?: string | null

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

minLength1

suffix2?: string | null

Additional name suffix - optional

minLength1

InvitationUpdateResponse { canCreateReports, canManageStudies, clinicId, 20 more }

A pending user invitation in the AutoScribe system

canCreateReports: boolean

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

canManageStudies: boolean

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

clinicId: string

UUID of the clinic this invitation belongs to

formatuuid

clinicRole: 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"

createdAt: string | null

Timestamp when the invitation was created

formatdate-time

email: string

Email address the invitation was sent to

expiry: string | null

When the invitation expires, null if no expiration

formatdate-time

firstName: string

Invited user’s first name

minLength1

hasDashboardAccess: boolean

Whether the invited user will have dashboard access

invitationId: string

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

invitedSource: InvitedSource

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

One of the following:

"dashboard"

"api"

inviterId: string

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

lastName: string

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"

status: InvitationStatus

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

One of the following:

"sent"

"accepted"

"rejected"

"revoked"

updatedAt: string | null

Timestamp when the invitation was last updated

formatdate-time

userId: string

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

invitedByApiKeyId?: string

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

formatuuid

middleName?: string | null

Invited user’s middle name (optional)

minLength1

npiNumber?: string

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

minLength10

maxLength10

phoneNumber?: string | null

Invited user’s phone number (optional)

suffix1?: string | null

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

minLength1

suffix2?: string | null

Additional name suffix - optional

minLength1

InvitationRevokeResponse { success, message }

Response for revoking an invitation in AutoScribe

success: boolean

message?: string

Auto ScribeReports

List reports for a study

client.autoScribe.reports.list(ReportListParams { studyId, studyInstanceUid } query?, RequestOptionsoptions?): ReportListResponse { reports, studyId, studyInstanceUid }

GET/v1/autoScribe/reports

Retrieve report text

client.autoScribe.reports.text(ReportTextParams { reportId, studyId, studyInstanceUid } query?, RequestOptionsoptions?): ReportTextResponse

GET/v1/autoScribe/reports/text

Retrieve report PDF URL

client.autoScribe.reports.pdf(ReportPdfParams { reportId, studyId, studyInstanceUid } query?, RequestOptionsoptions?): ReportPdfResponse

GET/v1/autoScribe/reports/pdf

Create a report addendum

client.autoScribe.reports.addendum(stringreportID, RequestOptionsoptions?): ReportAddendumResponse { success, message }

POST/v1/autoScribe/reports/{reportId}/addendum

Cancel a report addendum

client.autoScribe.reports.cancelAddendum(stringreportID, RequestOptionsoptions?): ReportCancelAddendumResponse { success, message }

POST/v1/autoScribe/reports/{reportId}/cancel-addendum

ModelsExpand Collapse

Report { createdAt, isAddendum, isCritical, 8 more }

A radiology report in the AutoScribe system

createdAt: string | null

Timestamp when the report was created

formatdate-time

isAddendum: boolean

Whether this report is an addendum to a previous report

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}

signedAt: string | null

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

formatdate-time

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

status: ReportStatus

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

One of the following:

"in_progress"

"completed"

studyId: string

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

updatedAt: string | null

Timestamp when the report was last updated

formatdate-time

userId: string

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

reportPlainText?: string

Plain text content of the report

ReportPdfItem { isCritical, presignedUrl, reportId, 3 more }

A report with its PDF download URL

isCritical: boolean | null

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

presignedUrl: string

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

reportId: string

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

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

studyId: string

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

ReportTextItem { isCritical, reportId, snapshotMetadata, 3 more }

A report with its plain text content

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}

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

studyId: string

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

plainText?: string

Plain text content of the report

ReportListResponse { reports, studyId, studyInstanceUid }

Response containing a list of reports for a study

reports: Array<Report { createdAt, isAddendum, isCritical, 8 more } >

Array of report objects with full details

createdAt: string | null

Timestamp when the report was created

formatdate-time

isAddendum: boolean

Whether this report is an addendum to a previous report

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}

signedAt: string | null

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

formatdate-time

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

status: ReportStatus

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

One of the following:

"in_progress"

"completed"

studyId: string

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

updatedAt: string | null

Timestamp when the report was last updated

formatdate-time

userId: string

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

reportPlainText?: string

Plain text content of the report

studyId: string

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

ReportTextResponse = SingleReportTextResponse { isCritical, reportId, snapshotMetadata, 3 more } | ListReportsTextResponse { reports, studyId, studyInstanceUid }

Response containing a single report with its plain text

One of the following:

SingleReportTextResponse { isCritical, reportId, snapshotMetadata, 3 more }

Response containing a single report with its plain text

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}

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

studyId: string

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

plainText?: string

Plain text content of the report

ListReportsTextResponse { reports, studyId, studyInstanceUid }

Response containing a list of reports with their plain text

reports: Array<ReportTextItem { isCritical, reportId, snapshotMetadata, 3 more } >

Array of report text items

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}

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

studyId: string

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

plainText?: string

Plain text content of the report

studyId: string

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

ReportPdfResponse = SingleReportPdfResponse { isCritical, presignedUrl, reportId, 3 more } | ListReportsPdfResponse { reports, studyId, studyInstanceUid }

Response containing a single report with its PDF download URL

One of the following:

SingleReportPdfResponse { isCritical, presignedUrl, reportId, 3 more }

Response containing a single report with its PDF download URL

isCritical: boolean | null

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

presignedUrl: string

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

reportId: string

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

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

studyId: string

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

ListReportsPdfResponse { reports, studyId, studyInstanceUid }

Response containing a list of reports with their PDF download URLs

reports: Array<ReportPdfItem { isCritical, presignedUrl, reportId, 3 more } >

Array of report PDF items with download URLs

isCritical: boolean | null

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

presignedUrl: string

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

reportId: string

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

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

studyId: string

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

studyId: string

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

ReportAddendumResponse { success, message }

Response for creating a report addendum

success: boolean

message?: string

ReportCancelAddendumResponse { success, message }

Response for cancelling a report addendum

success: boolean

message?: string