Auto Scribe

ModelsExpand Collapse

class StudyReportMetadata:

Patient demographics and scan information for report generation

Optional<String> age

Patient's age at time of scan (e.g., '34.5 years', '2 months')

Optional<String> dateOfBirth

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

Optional<String> facilityName

Name of the medical facility where the scan was performed

Optional<Height> height

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

Unit unit

Accepts one of the following:

IN("in")

CM("cm")

double value

minimum0

Optional<String> mrn

Medical Record Number - unique patient identifier

Optional<String> patientName

Full name of the patient

Optional<String> referringPhysicianName

Name of the physician who referred the patient for this scan

Optional<String> scanDate

Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15')

Optional<String> scanTime

Time the scan was performed. Format: HH:MM (e.g., '14:30')

Optional<String> scanType

Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound')

Optional<Sex> sex

Patient's biological sex. Options: 'male', 'female', 'other'

Accepts one of the following:

MALE("male")

FEMALE("female")

OTHER("other")

Optional<Weight> weight

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

Unit unit

Accepts one of the following:

LBS("lbs")

KG("kg")

double value

minimum0

Auto ScribeStudies

Create a new study

StudyCreateResponse autoScribe().studies().create(, )

post/v1/autoScribe/studies

List studies with pagination

StudyListPage autoScribe().studies().list(, )

get/v1/autoScribe/studies

Retrieve a study by ID

StudyRetrieveResponse autoScribe().studies().retrieve(, )

get/v1/autoScribe/studies/{studyId}

Update a study

StudyUpdateResponse autoScribe().studies().update(, )

patch/v1/autoScribe/studies/{studyId}

Cancel a study

StudyCancelResponse autoScribe().studies().cancel(, )

post/v1/autoScribe/studies/cancel

Uncancel a study

StudyUncancelResponse autoScribe().studies().uncancel(, )

post/v1/autoScribe/studies/uncancel

Generate a reroute URL with viewer and dictation

StudyRerouteUrlResponse autoScribe().studies().rerouteUrl(, )

post/v1/autoScribe/studies/reroute-url

Generate a viewer-only reroute URL

StudyViewerOnlyRerouteUrlResponse autoScribe().studies().viewerOnlyRerouteUrl(, )

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

Retrieve a study by DICOM UID

StudyRetrieveByUidResponse autoScribe().studies().retrieveByUid(, )

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

ModelsExpand Collapse

class ReportIdWithStatus:

A report ID paired with its current status

String reportId

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

Status status

Current status of the report

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

Auto ScribeUsers

Create and invite a new user

UserInviteResponse autoScribe().users().invite(, )

post/v1/autoScribe/users

List users with pagination

UserListPage autoScribe().users().list(, )

get/v1/autoScribe/users

Retrieve a user by ID

UserRetrieveResponse autoScribe().users().retrieve(, )

get/v1/autoScribe/users/{userId}

Update a user

UserUpdateResponse autoScribe().users().update(, )

patch/v1/autoScribe/users/{userId}

Revoke user access

UserRevokeAccessResponse autoScribe().users().revokeAccess(, )

post/v1/autoScribe/users/revoke-access

Reactivate a user

UserReactivateResponse autoScribe().users().reactivate(, )

post/v1/autoScribe/users/reactivate

Auto ScribeUsersInvitations

List user invitations

InvitationListPage autoScribe().users().invitations().list(, )

get/v1/autoScribe/users/invitations

Retrieve an invitation by ID

InvitationRetrieveResponse autoScribe().users().invitations().retrieve(, )

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

Update an invitation

InvitationUpdateResponse autoScribe().users().invitations().update(, )

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

Revoke an invitation

InvitationRevokeResponse autoScribe().users().invitations().revoke(, )

post/v1/autoScribe/users/invitations/revoke

Auto ScribeReports

List reports for a study

ReportListResponse autoScribe().reports().list(, )

get/v1/autoScribe/reports

Retrieve report text

ReportTextResponse autoScribe().reports().text(, )

get/v1/autoScribe/reports/text

Retrieve report PDF URL

ReportPdfResponse autoScribe().reports().pdf(, )

get/v1/autoScribe/reports/pdf

Create a report addendum

ReportAddendumResponse autoScribe().reports().addendum(, )

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

Cancel a report addendum

ReportCancelAddendumResponse autoScribe().reports().cancelAddendum(, )

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