Auto Scribe
ModelsExpand Collapse
HeightUnit = "in" or "cm"Unit of measure for a height value. 'in' = inches, 'cm' = centimeters.
Unit of measure for a height value. 'in' = inches, 'cm' = centimeters.
ReportStatus = "in_progress" or "completed"Status of an individual report. 'in_progress' = actively being dictated, 'completed' = signed.
Status of an individual report. 'in_progress' = actively being dictated, 'completed' = signed.
Sex = "male" or "female" or "other"Patient's biological sex. Options: 'male', 'female', 'other'
Patient's biological sex. Options: 'male', 'female', 'other'
StudyReportMetadata = object { age, dateOfBirth, facilityName, 9 more } Patient demographics and scan information for report generation
Patient demographics and scan information for report generation
Patient's age at study date (e.g., '34.5 years', '2 months')
Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20')
Name of the medical facility where the scan was performed
height: optional object { unit, value } Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'})
Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'})
Unit of measure for a height value. 'in' = inches, 'cm' = centimeters.
Unit of measure for a height value. 'in' = inches, 'cm' = centimeters.
Medical Record Number - unique patient identifier
Full name of the patient
Procedure or study type (e.g., 'MRI Brain with Contrast'). Maps to database scan_type and dictation report_header.scan_type.
Name of the physician who referred the patient for this scan
Patient's biological sex. Options: 'male', 'female', 'other'
Patient's biological sex. Options: 'male', 'female', 'other'
Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.
Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.
weight: optional object { unit, value } Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'})
Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'})
Unit of measure for a weight value. 'lbs' = pounds, 'kg' = kilograms.
Unit of measure for a weight value. 'lbs' = pounds, 'kg' = kilograms.
StudyReportStatus = "unassigned" or "assigned" or "in_progress" or 2 moreAutoScribe 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.
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.
WeightUnit = "lbs" or "kg"Unit of measure for a weight value. 'lbs' = pounds, 'kg' = kilograms.
Unit of measure for a weight value. 'lbs' = pounds, 'kg' = kilograms.
Auto ScribeStudies
Create a new study
List studies with pagination
Retrieve a study by ID
Update a study
Cancel a study
Uncancel a study
Generate a reroute URL with viewer and dictation
Generate a viewer-only reroute URL
Retrieve a study by DICOM UID
ModelsExpand Collapse
PriorReport = object { reportText, externalStudyId, modality, 2 more } External prior report metadata and text stored on a study
External prior report metadata and text stored on a study
Full prior report text
Integrator's external study identifier
Imaging modality for the prior study
Prior study date (YYYY-MM-DD)
Description of the prior study
ReportIDWithStatus = object { isCritical, reportId, status } A report ID paired with its current status
A report ID paired with its current status
Whether the report was marked critical at sign-off. null when the report is not yet completed; true/false once completed.
Unique report identifier. Format: rep_{32-hex-chars}
Status of an individual report. 'in_progress' = actively being dictated, 'completed' = signed.
Status of an individual report. 'in_progress' = actively being dictated, 'completed' = signed.
Auto ScribeUsers
Create and invite a new user
List users with pagination
Retrieve a user by ID
Update a user
Revoke user access
Reactivate a user
Auto ScribeUsersInvitations
List user invitations
Retrieve an invitation by ID
Update an invitation
Revoke an invitation
Auto ScribeReports
List reports for a study
Retrieve report text
Retrieve report PDF URL
Create a report addendum
Cancel a report addendum
ModelsExpand Collapse
Report = object { createdAt, isAddendum, isCritical, 8 more } A radiology report in the AutoScribe system
A radiology report in the AutoScribe system
Timestamp when the report was created
Whether this report is an addendum to a previous report
Whether the report was marked critical at sign-off. null when the report is not yet completed; true/false once completed.
Unique report identifier. Format: rep_{32-hex-chars}
Timestamp when the report was signed, null if not yet signed
Patient demographics and scan information for report generation
Patient demographics and scan information for report generation
Patient's age at study date (e.g., '34.5 years', '2 months')
Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20')
Name of the medical facility where the scan was performed
height: optional object { unit, value } Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'})
Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'})
Unit of measure for a height value. 'in' = inches, 'cm' = centimeters.
Unit of measure for a height value. 'in' = inches, 'cm' = centimeters.
Medical Record Number - unique patient identifier
Full name of the patient
Procedure or study type (e.g., 'MRI Brain with Contrast'). Maps to database scan_type and dictation report_header.scan_type.
Name of the physician who referred the patient for this scan
Patient's biological sex. Options: 'male', 'female', 'other'
Patient's biological sex. Options: 'male', 'female', 'other'
Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.
Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.
weight: optional object { unit, value } Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'})
Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'})
Unit of measure for a weight value. 'lbs' = pounds, 'kg' = kilograms.
Unit of measure for a weight value. 'lbs' = pounds, 'kg' = kilograms.
Status of an individual report. 'in_progress' = actively being dictated, 'completed' = signed.
Status of an individual report. 'in_progress' = actively being dictated, 'completed' = signed.
Study ID this report belongs to. Format: stu_{32-hex-chars}
Timestamp when the report was last updated
User ID of the radiologist who created/signed this report. Format: usr_{32-hex-chars}
Plain text content of the report
ReportPdfItem = object { isCritical, presignedUrl, reportId, 3 more } A report with its PDF download URL
A report with its PDF download URL
Whether the report was marked critical at sign-off. null when the report is not yet completed; true/false once completed.
Time-limited presigned URL to download the PDF (expires after 1 hour)
Unique report identifier. Format: rep_{32-hex-chars}
Patient demographics and scan information for report generation
Patient demographics and scan information for report generation
Patient's age at study date (e.g., '34.5 years', '2 months')
Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20')
Name of the medical facility where the scan was performed
height: optional object { unit, value } Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'})
Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'})
Unit of measure for a height value. 'in' = inches, 'cm' = centimeters.
Unit of measure for a height value. 'in' = inches, 'cm' = centimeters.
Medical Record Number - unique patient identifier
Full name of the patient
Procedure or study type (e.g., 'MRI Brain with Contrast'). Maps to database scan_type and dictation report_header.scan_type.
Name of the physician who referred the patient for this scan
Patient's biological sex. Options: 'male', 'female', 'other'
Patient's biological sex. Options: 'male', 'female', 'other'
Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.
Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.
weight: optional object { unit, value } Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'})
Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'})
Unit of measure for a weight value. 'lbs' = pounds, 'kg' = kilograms.
Unit of measure for a weight value. 'lbs' = pounds, 'kg' = kilograms.
Study ID this report belongs to. Format: stu_{32-hex-chars}
DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')
ReportTextItem = object { isCritical, reportId, snapshotMetadata, 3 more } A report with its plain text content
A report with its plain text content
Whether the report was marked critical at sign-off. null when the report is not yet completed; true/false once completed.
Unique report identifier. Format: rep_{32-hex-chars}
Patient demographics and scan information for report generation
Patient demographics and scan information for report generation
Patient's age at study date (e.g., '34.5 years', '2 months')
Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20')
Name of the medical facility where the scan was performed
height: optional object { unit, value } Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'})
Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'})
Unit of measure for a height value. 'in' = inches, 'cm' = centimeters.
Unit of measure for a height value. 'in' = inches, 'cm' = centimeters.
Medical Record Number - unique patient identifier
Full name of the patient
Procedure or study type (e.g., 'MRI Brain with Contrast'). Maps to database scan_type and dictation report_header.scan_type.
Name of the physician who referred the patient for this scan
Patient's biological sex. Options: 'male', 'female', 'other'
Patient's biological sex. Options: 'male', 'female', 'other'
Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.
Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.
weight: optional object { unit, value } Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'})
Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'})
Unit of measure for a weight value. 'lbs' = pounds, 'kg' = kilograms.
Unit of measure for a weight value. 'lbs' = pounds, 'kg' = kilograms.
Study ID this report belongs to. Format: stu_{32-hex-chars}
DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')
Plain text content of the report