Skip to content
Avara
Get started
API Reference
Auto Scribe

Studies

Create a new study
StudyCreateResponse AutoScribe.Studies.Create(StudyCreateParamsparameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/studies
List studies with pagination
StudyListPageResponse AutoScribe.Studies.List(StudyListParams?parameters, CancellationTokencancellationToken = default)
GET/v1/autoScribe/studies
Retrieve a study by ID
StudyRetrieveResponse AutoScribe.Studies.Retrieve(StudyRetrieveParamsparameters, CancellationTokencancellationToken = default)
GET/v1/autoScribe/studies/{studyId}
Update a study
StudyUpdateResponse AutoScribe.Studies.Update(StudyUpdateParamsparameters, CancellationTokencancellationToken = default)
PATCH/v1/autoScribe/studies/{studyId}
Cancel a study
StudyCancelResponse AutoScribe.Studies.Cancel(StudyCancelParams?parameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/studies/cancel
Uncancel a study
StudyUncancelResponse AutoScribe.Studies.Uncancel(StudyUncancelParams?parameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/studies/uncancel
Generate a reroute URL with viewer and dictation
StudyRerouteUrlResponse AutoScribe.Studies.RerouteUrl(StudyRerouteUrlParamsparameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/studies/reroute-url
Generate a viewer-only reroute URL
StudyViewerOnlyRerouteUrlResponse AutoScribe.Studies.ViewerOnlyRerouteUrl(StudyViewerOnlyRerouteUrlParams?parameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/studies/viewer-only-reroute-url
Retrieve a study by DICOM UID
StudyRetrieveByUidResponse AutoScribe.Studies.RetrieveByUid(StudyRetrieveByUidParamsparameters, CancellationTokencancellationToken = default)
GET/v1/autoScribe/studies/by-uid/{studyInstanceUid}
ModelsExpand Collapse
class PriorReport:

External prior report metadata and text stored on a study

required string ReportText

Full prior report text

minLength1
maxLength50000
string ExternalStudyID

Integrator’s external study identifier

minLength1
maxLength256
string Modality

Imaging modality for the prior study

minLength1
maxLength100
string StudyDate

Prior study date (YYYY-MM-DD)

string StudyDescription

Description of the prior study

minLength1
maxLength1000
class ReportIDWithStatus:

A report ID paired with its current status

required Boolean? IsCritical

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

required string ReportID

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

required ReportStatus Status

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

One of the following:
"in_progress"InProgress
"completed"Completed

StudiesExternal

Create an external study
ExternalCreateResponse AutoScribe.Studies.External.Create(ExternalCreateParamsparameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/studies/external
Delete an external study
ExternalDeleteResponse AutoScribe.Studies.External.Delete(ExternalDeleteParams?parameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/studies/external/delete

StudiesExternalReports

Attach an external report
ReportCreateResponse AutoScribe.Studies.External.Reports.Create(ReportCreateParams?parameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/studies/external/reports
List external reports
ReportListPageResponse AutoScribe.Studies.External.Reports.List(ReportListParams?parameters, CancellationTokencancellationToken = default)
GET/v1/autoScribe/studies/external/reports
Retrieve an external report
ReportRetrieveResponse AutoScribe.Studies.External.Reports.Retrieve(ReportRetrieveParamsparameters, CancellationTokencancellationToken = default)
GET/v1/autoScribe/studies/external/reports/{externalReportId}