Skip to content
Get started

Studies

Create a new study
auto_scribe.studies.create(StudyCreateParams**kwargs) -> StudyCreateResponse
POST/v1/autoScribe/studies
List studies with pagination
auto_scribe.studies.list(StudyListParams**kwargs) -> SyncCursorStudies[StudyListResponse]
GET/v1/autoScribe/studies
Retrieve a study by ID
auto_scribe.studies.retrieve(strstudy_id) -> StudyRetrieveResponse
GET/v1/autoScribe/studies/{studyId}
Update a study
auto_scribe.studies.update(strstudy_id, StudyUpdateParams**kwargs) -> StudyUpdateResponse
PATCH/v1/autoScribe/studies/{studyId}
Cancel a study
auto_scribe.studies.cancel(StudyCancelParams**kwargs) -> StudyCancelResponse
POST/v1/autoScribe/studies/cancel
Uncancel a study
auto_scribe.studies.uncancel(StudyUncancelParams**kwargs) -> StudyUncancelResponse
POST/v1/autoScribe/studies/uncancel
Generate a reroute URL with viewer and dictation
auto_scribe.studies.reroute_url(StudyRerouteURLParams**kwargs) -> StudyRerouteURLResponse
POST/v1/autoScribe/studies/reroute-url
Generate a viewer-only reroute URL
auto_scribe.studies.viewer_only_reroute_url(StudyViewerOnlyRerouteURLParams**kwargs) -> StudyViewerOnlyRerouteURLResponse
POST/v1/autoScribe/studies/viewer-only-reroute-url
Retrieve a study by DICOM UID
auto_scribe.studies.retrieve_by_uid(strstudy_instance_uid) -> StudyRetrieveByUidResponse
GET/v1/autoScribe/studies/by-uid/{studyInstanceUid}
ModelsExpand Collapse
class PriorReport:

External prior report metadata and text stored on a study

report_text: str

Full prior report text

minLength1
maxLength50000
external_study_id: Optional[str]

Integrator's external study identifier

minLength1
maxLength256
modality: Optional[str]

Imaging modality for the prior study

minLength1
maxLength100
study_date: Optional[str]

Prior study date (YYYY-MM-DD)

study_description: Optional[str]

Description of the prior study

minLength1
maxLength1000
class ReportIDWithStatus:

A report ID paired with its current status

is_critical: Optional[bool]

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

report_id: str

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

status: ReportStatus

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

Accepts one of the following:
"in_progress"
"completed"