Reports

List reports for a study

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

GET/v1/autoScribe/reports

Retrieve report text

client.autoScribe.reports.text(?, ?): ReportTextResponse

GET/v1/autoScribe/reports/text

Retrieve report PDF URL

client.autoScribe.reports.pdf(?, ?): ReportPdfResponse

GET/v1/autoScribe/reports/pdf

Create a report addendum

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

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

Cancel a report addendum

client.autoScribe.reports.cancelAddendum(, ?): 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