Auto Scribe

ModelsExpand Collapse

enum ClinicalReferenceType:

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

FACILITY("facility")

REFERRING_PROVIDER("referring_provider")

STUDY_DESCRIPTION("study_description")

PROCEDURE("procedure")

enum HeightUnit:

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

IN("in")

CM("cm")

enum ReportStatus:

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

IN_PROGRESS("in_progress")

COMPLETED("completed")

enum Sex:

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

MALE("male")

FEMALE("female")

OTHER("other")

class StudyReportMetadata:

Patient demographics and scan information for report generation

Optional<String> age

Patient’s age at study date (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’})

HeightUnit unit

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

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> procedure

Procedure or study type (e.g., ‘MRI Brain with Contrast’). Maps to database scan_type and dictation report_header.scan_type.

Optional<String> referringPhysicianName

Name of the physician who referred the patient for this scan

Optional<Sex> sex

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

One of the following:

MALE("male")

FEMALE("female")

OTHER("other")

Optional<String> studyDate

Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.

Optional<String> studyTime

Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.

Optional<Weight> weight

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

WeightUnit unit

Unit of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

One of the following:

LBS("lbs")

KG("kg")

double value

minimum0

enum 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.

UNASSIGNED("unassigned")

ASSIGNED("assigned")

IN_PROGRESS("in_progress")

COMPLETED("completed")

ADDENDUM_ACTIVE("addendum_active")

enum StudyType:

Kind of study. ‘standard’ is a live AutoScribe reading-workflow study. ‘external’ is an imported archive study.

STANDARD("standard")

EXTERNAL("external")

enum WeightUnit:

Unit of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

LBS("lbs")

KG("kg")

Auto ScribeClinical References

Create a clinical reference

ClinicalReference autoScribe().clinicalReferences().create(, )

POST/v1/autoScribe/clinicalReferences

List clinical references

ClinicalReferenceListPage autoScribe().clinicalReferences().list(, )

GET/v1/autoScribe/clinicalReferences

Retrieve a clinical reference by ID

ClinicalReference autoScribe().clinicalReferences().retrieve(, )

GET/v1/autoScribe/clinicalReferences/{clinicalReferenceId}

Retrieve a clinical reference by external reference ID

ClinicalReference autoScribe().clinicalReferences().retrieveByExternalReferenceId(, )

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

Update a clinical reference

ClinicalReference autoScribe().clinicalReferences().update(, )

PATCH/v1/autoScribe/clinicalReferences/{clinicalReferenceId}

Delete a clinical reference

ClinicalReference autoScribe().clinicalReferences().delete(, )

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

ModelsExpand Collapse

class ClinicalReference:

A canonical clinical reference value for study workflow pickers and normalization

String clinicalReferenceId

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

Optional<LocalDateTime> createdAt

Timestamp when the clinical reference was created

formatdate-time

boolean isActive

Whether this reference is active and available for pickers

String name

Canonical display name for this reference value

minLength1

ClinicalReferenceType type

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

One of the following:

FACILITY("facility")

REFERRING_PROVIDER("referring_provider")

STUDY_DESCRIPTION("study_description")

PROCEDURE("procedure")

Optional<LocalDateTime> updatedAt

Timestamp when the clinical reference was last updated

formatdate-time

Optional<ExpressCustomerReference> expressCustomer

A reference to an Express customer with basic identifying information

String expressCustomerId

Unique Express customer identifier. Format: cus_{32-hex-chars}

String expressCustomerName

Name of the Express customer

minLength1

Optional<String> externalReferenceId

Integrator-provided stable identifier for mapping inbound data

Optional<Metadata> metadata

Optional key-value metadata. Maximum 50 pairs

Auto ScribeEphemeral Sessions

Create an ephemeral AutoScribe viewer session

EphemeralSessionCreateResponse autoScribe().ephemeralSessions().create(, )

POST/v1/autoScribe/ephemeral-sessions

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 PriorReport:

External prior report metadata and text stored on a study

String reportText

Full prior report text

minLength1

maxLength50000

Optional<String> externalStudyId

Integrator’s external study identifier

minLength1

maxLength256

Optional<String> modality

Imaging modality for the prior study

minLength1

maxLength100

Optional<String> studyDate

Prior study date (YYYY-MM-DD)

Optional<String> studyDescription

Description of the prior study

minLength1

maxLength1000

class ReportIdWithStatus:

A report ID paired with its current status

Optional<Boolean> isCritical

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

String reportId

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

ReportStatus status

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

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

Auto ScribeStudiesExternal

Create an external study

ExternalCreateResponse autoScribe().studies().external().create(, )

POST/v1/autoScribe/studies/external

Delete an external study

ExternalDeleteResponse autoScribe().studies().external().delete(, )

POST/v1/autoScribe/studies/external/delete

Auto ScribeStudiesExternalReports

Attach an external report

ReportCreateResponse autoScribe().studies().external().reports().create(, )

POST/v1/autoScribe/studies/external/reports

List external reports

ReportListPage autoScribe().studies().external().reports().list(, )

GET/v1/autoScribe/studies/external/reports

Retrieve an external report

ReportRetrieveResponse autoScribe().studies().external().reports().retrieve(, )

GET/v1/autoScribe/studies/external/reports/{externalReportId}

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

ModelsExpand Collapse

class Report:

A radiology report in the AutoScribe system

Optional<LocalDateTime> createdAt

Timestamp when the report was created

formatdate-time

boolean isAddendum

Whether this report is an addendum to a previous report

Optional<Boolean> isCritical

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

String reportId

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

Optional<LocalDateTime> signedAt

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

formatdate-time

StudyReportMetadata snapshotMetadata

Patient demographics and scan information for report generation

Optional<String> age

Patient’s age at study date (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’})

HeightUnit unit

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

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> procedure

Procedure or study type (e.g., ‘MRI Brain with Contrast’). Maps to database scan_type and dictation report_header.scan_type.

Optional<String> referringPhysicianName

Name of the physician who referred the patient for this scan

Optional<Sex> sex

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

One of the following:

MALE("male")

FEMALE("female")

OTHER("other")

Optional<String> studyDate

Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.

Optional<String> studyTime

Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.

Optional<Weight> weight

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

WeightUnit unit

Unit of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

One of the following:

LBS("lbs")

KG("kg")

double value

minimum0

ReportStatus status

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

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

String studyId

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

Optional<LocalDateTime> updatedAt

Timestamp when the report was last updated

formatdate-time

String userId

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

Optional<String> reportPlainText

Plain text content of the report

class ReportPdfItem:

A report with its PDF download URL

Optional<Boolean> isCritical

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

String presignedUrl

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

String reportId

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

StudyReportMetadata snapshotMetadata

Patient demographics and scan information for report generation

Optional<String> age

Patient’s age at study date (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’})

HeightUnit unit

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

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> procedure

Procedure or study type (e.g., ‘MRI Brain with Contrast’). Maps to database scan_type and dictation report_header.scan_type.

Optional<String> referringPhysicianName

Name of the physician who referred the patient for this scan

Optional<Sex> sex

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

One of the following:

MALE("male")

FEMALE("female")

OTHER("other")

Optional<String> studyDate

Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.

Optional<String> studyTime

Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.

Optional<Weight> weight

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

WeightUnit unit

Unit of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

One of the following:

LBS("lbs")

KG("kg")

double value

minimum0

String studyId

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

String studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., ‘1.2.840.10008.5.1.4.1.1.2’)

minLength1

class ReportTextItem:

A report with its plain text content

Optional<Boolean> isCritical

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

String reportId

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

StudyReportMetadata snapshotMetadata

Patient demographics and scan information for report generation

Optional<String> age

Patient’s age at study date (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’})

HeightUnit unit

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

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> procedure

Procedure or study type (e.g., ‘MRI Brain with Contrast’). Maps to database scan_type and dictation report_header.scan_type.

Optional<String> referringPhysicianName

Name of the physician who referred the patient for this scan

Optional<Sex> sex

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

One of the following:

MALE("male")

FEMALE("female")

OTHER("other")

Optional<String> studyDate

Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.

Optional<String> studyTime

Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.

Optional<Weight> weight

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

WeightUnit unit

Unit of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

One of the following:

LBS("lbs")

KG("kg")

double value

minimum0

String studyId

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

String studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., ‘1.2.840.10008.5.1.4.1.1.2’)

minLength1

Optional<String> plainText

Plain text content of the report