Auto Scribe

ModelsExpand Collapse

class StudyReportMetadata:

Patient demographics and scan information for report generation

string Age

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

string DateOfBirth

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

string FacilityName

Name of the medical facility where the scan was performed

Height Height

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

required Unit Unit

Accepts one of the following:

required Double Value

minimum0

string Mrn

Medical Record Number - unique patient identifier

string PatientName

Full name of the patient

string ReferringPhysicianName

Name of the physician who referred the patient for this scan

string ScanDate

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

string ScanTime

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

string ScanType

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

Sex Sex

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

Accepts one of the following:

Weight Weight

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

required Unit Unit

Accepts one of the following:

required Double Value

minimum0

Auto ScribeStudies

Create a new study

StudyCreateResponse AutoScribe.Studies.Create(, )

POST/v1/autoScribe/studies

List studies with pagination

StudyListPageResponse 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

required string ReportID

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

required Status Status

Current status of the report

Accepts one of the following:

Auto ScribeUsers

Create and invite a new user

UserInviteResponse AutoScribe.Users.Invite(, )

POST/v1/autoScribe/users

List users with pagination

UserListPageResponse 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

InvitationListPageResponse 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