# Studies ## Create `StudyCreateResponse AutoScribe.Studies.Create(StudyCreateParamsparameters, CancellationTokencancellationToken = default)` **post** `/v1/autoScribe/studies` Creates a new study in the AutoScribe system with DICOM metadata and report generation information. The study can include patient demographics, scan details, and references to prior studies/reports for context. ### Parameters - `StudyCreateParams parameters` - `required StudyReportMetadata reportMetadata` Patient demographics and scan information for report generation - `required Severity severity` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"Normal` - `"high"High` - `"stat"Stat` - `required string studyDescription` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `required 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') - `string assignedTo` User ID to assign the study to. Format: usr_{32-hex-chars} - `string expressCustomerID` Express customer ID for the study. Format: cus_{32-hex-chars} - `IReadOnlyDictionary metadata` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `IReadOnlyList priorReportTexts` - `IReadOnlyList priorStudyIds` ### Returns - `class StudyCreateResponse:` A study entity in the AutoScribe system with report workflow status - `required DateTimeOffset? CancelledAt` Timestamp when the study was cancelled, null if not cancelled - `required DateTimeOffset? CreatedAt` Timestamp when the study was created - `required Boolean IsCancelled` Whether the study has been cancelled - `required StudyReportMetadata ReportMetadata` 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` - `"in"In` - `"cm"Cm` - `required Double Value` - `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' - `"male"Male` - `"female"Female` - `"other"Other` - `Weight Weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `required Unit Unit` - `"lbs"Lbs` - `"kg"Kg` - `required Double Value` - `required Severity Severity` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"Normal` - `"high"High` - `"stat"Stat` - `required string StudyDescription` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `required string StudyID` Unique study identifier. Format: stu_{32-hex-chars} - `required 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') - `required StudyReportStatus StudyReportStatus` Report workflow status. '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"InProgress` - `"completed"Completed` - `"addendum_active"AddendumActive` - `required DateTimeOffset? UpdatedAt` Timestamp when the study was last updated - `AssignedTo? AssignedTo` Reference to the assigned radiologist, null if unassigned - `required string Email` User's email address - `required string UserID` Unique user identifier. Format: usr_{32-hex-chars} - `string FirstName` User's first name - `string LastName` User's last name - `string MiddleName` User's middle name - `string Suffix1` Name suffix (e.g., 'MD', 'Jr.') - `string Suffix2` Additional name suffix - `CreatedByApiKey? CreatedByApiKey` Reference to the API key used to create this study - `required string ApiKeyID` Unique API key identifier (UUIDv4 format) - `required string Description` Human-readable description of the API key - `Boolean IsViewerEnabled` Whether this API key has access to the Viewer product - `CreatedByUser? CreatedByUser` Reference to the user who created this study via dashboard - `required string Email` User's email address - `required string UserID` Unique user identifier. Format: usr_{32-hex-chars} - `string FirstName` User's first name - `string LastName` User's last name - `string MiddleName` User's middle name - `string Suffix1` Name suffix (e.g., 'MD', 'Jr.') - `string Suffix2` Additional name suffix - `ExpressCustomer? ExpressCustomer` Reference to the Express customer this study belongs to - `required string ExpressCustomerID` Unique Express customer identifier. Format: cus_{32-hex-chars} - `required string ExpressCustomerName` Name of the Express customer - `IReadOnlyDictionary Metadata` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `IReadOnlyList PriorReportTexts` Array of prior report texts to provide clinical context - `IReadOnlyList PriorStudyIds` Array of prior study IDs for comparison context (format: stu_{32-hex-chars}) - `IReadOnlyList ReportIds` Array of report IDs associated with this study, including addendums - `required string ReportID` Unique report identifier. Format: rep_{32-hex-chars} - `required Status Status` Current status of the report - `"in_progress"InProgress` - `"completed"Completed` ### Example ```csharp StudyCreateParams parameters = new() { ReportMetadata = new() { Age = "38 years", DateOfBirth = "1985-07-20", FacilityName = "City Medical Center", Height = new() { Unit = Unit.Cm, Value = 165, }, Mrn = "MRN-2024-001234", PatientName = "Jane Doe", ReferringPhysicianName = "Dr. Michael Chen", ScanDate = "2024-03-15", ScanTime = "14:30", ScanType = "MRI Brain with Contrast", Sex = Sex.Female, Weight = new() { Unit = Unit.Kg, Value = 62, }, }, Severity = Severity.Normal, StudyDescription = "Brain MRI with Contrast", StudyInstanceUid = "1.2.840.113619.2.55.3.604688119.868.1234567890.123", }; var study = await client.AutoScribe.Studies.Create(parameters); Console.WriteLine(study); ``` ## List `StudyListPageResponse AutoScribe.Studies.List(StudyListParams?parameters, CancellationTokencancellationToken = default)` **get** `/v1/autoScribe/studies` Retrieves a paginated list of studies with optional filtering by assignment, severity, description, cancellation status, and report status. Returns up to 100 studies per request. ### Parameters - `StudyListParams parameters` - `string? assignedTo` Filter by assigned user ID (null = explicitly unassigned). Format: usr_<32-hex-chars> - `string cursor` Base64 encoded cursor from previous response - `string? expressCustomerID` Filter by Express customer ID (null = studies with no customer). Format: cus_{32-hex-chars} - `Boolean? isCancelled` Filter by cancellation status - `Double limit` Number of results to return (1-100) - `Severity severity` Filter by study severity - `"normal"Normal` - `"high"High` - `"stat"Stat` - `string studyDescription` Filter by study description (contains match) - `IReadOnlyList studyReportStatus` Filter by report status(es) - `"unassigned"Unassigned` - `"assigned"Assigned` - `"in_progress"InProgress` - `"completed"Completed` - `"addendum_active"AddendumActive` ### Returns - `class StudyListPageResponse:` Paginated list of AutoScribe studies - `required Boolean HasMore` - `required IReadOnlyList Studies` - `required DateTimeOffset? CancelledAt` Timestamp when the study was cancelled, null if not cancelled - `required DateTimeOffset? CreatedAt` Timestamp when the study was created - `required Boolean IsCancelled` Whether the study has been cancelled - `required StudyReportMetadata ReportMetadata` 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` - `"in"In` - `"cm"Cm` - `required Double Value` - `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' - `"male"Male` - `"female"Female` - `"other"Other` - `Weight Weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `required Unit Unit` - `"lbs"Lbs` - `"kg"Kg` - `required Double Value` - `required Severity Severity` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"Normal` - `"high"High` - `"stat"Stat` - `required string StudyDescription` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `required string StudyID` Unique study identifier. Format: stu_{32-hex-chars} - `required 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') - `required StudyReportStatus StudyReportStatus` Report workflow status. '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"InProgress` - `"completed"Completed` - `"addendum_active"AddendumActive` - `required DateTimeOffset? UpdatedAt` Timestamp when the study was last updated - `AssignedTo? AssignedTo` Reference to the assigned radiologist, null if unassigned - `required string Email` User's email address - `required string UserID` Unique user identifier. Format: usr_{32-hex-chars} - `string FirstName` User's first name - `string LastName` User's last name - `string MiddleName` User's middle name - `string Suffix1` Name suffix (e.g., 'MD', 'Jr.') - `string Suffix2` Additional name suffix - `CreatedByApiKey? CreatedByApiKey` Reference to the API key used to create this study - `required string ApiKeyID` Unique API key identifier (UUIDv4 format) - `required string Description` Human-readable description of the API key - `Boolean IsViewerEnabled` Whether this API key has access to the Viewer product - `CreatedByUser? CreatedByUser` Reference to the user who created this study via dashboard - `required string Email` User's email address - `required string UserID` Unique user identifier. Format: usr_{32-hex-chars} - `string FirstName` User's first name - `string LastName` User's last name - `string MiddleName` User's middle name - `string Suffix1` Name suffix (e.g., 'MD', 'Jr.') - `string Suffix2` Additional name suffix - `ExpressCustomer? ExpressCustomer` Reference to the Express customer this study belongs to - `required string ExpressCustomerID` Unique Express customer identifier. Format: cus_{32-hex-chars} - `required string ExpressCustomerName` Name of the Express customer - `IReadOnlyDictionary Metadata` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `IReadOnlyList PriorReportTexts` Array of prior report texts to provide clinical context - `IReadOnlyList PriorStudyIds` Array of prior study IDs for comparison context (format: stu_{32-hex-chars}) - `IReadOnlyList ReportIds` Array of report IDs associated with this study, including addendums - `required string ReportID` Unique report identifier. Format: rep_{32-hex-chars} - `required Status Status` Current status of the report - `"in_progress"InProgress` - `"completed"Completed` - `string Cursor` ### Example ```csharp StudyListParams parameters = new(); var page = await client.AutoScribe.Studies.List(parameters); await foreach (var item in page.Paginate()) { Console.WriteLine(item); } ``` ## Retrieve `StudyRetrieveResponse AutoScribe.Studies.Retrieve(StudyRetrieveParamsparameters, CancellationTokencancellationToken = default)` **get** `/v1/autoScribe/studies/{studyId}` Retrieves a single study by its unique study ID. Returns the complete study object with all metadata, report status, and patient information. ### Parameters - `StudyRetrieveParams parameters` - `required string studyID` Unique study identifier. Format: stu_{32-hex-chars} ### Returns - `class StudyRetrieveResponse:` A study entity in the AutoScribe system with report workflow status - `required DateTimeOffset? CancelledAt` Timestamp when the study was cancelled, null if not cancelled - `required DateTimeOffset? CreatedAt` Timestamp when the study was created - `required Boolean IsCancelled` Whether the study has been cancelled - `required StudyReportMetadata ReportMetadata` 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` - `"in"In` - `"cm"Cm` - `required Double Value` - `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' - `"male"Male` - `"female"Female` - `"other"Other` - `Weight Weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `required Unit Unit` - `"lbs"Lbs` - `"kg"Kg` - `required Double Value` - `required Severity Severity` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"Normal` - `"high"High` - `"stat"Stat` - `required string StudyDescription` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `required string StudyID` Unique study identifier. Format: stu_{32-hex-chars} - `required 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') - `required StudyReportStatus StudyReportStatus` Report workflow status. '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"InProgress` - `"completed"Completed` - `"addendum_active"AddendumActive` - `required DateTimeOffset? UpdatedAt` Timestamp when the study was last updated - `AssignedTo? AssignedTo` Reference to the assigned radiologist, null if unassigned - `required string Email` User's email address - `required string UserID` Unique user identifier. Format: usr_{32-hex-chars} - `string FirstName` User's first name - `string LastName` User's last name - `string MiddleName` User's middle name - `string Suffix1` Name suffix (e.g., 'MD', 'Jr.') - `string Suffix2` Additional name suffix - `CreatedByApiKey? CreatedByApiKey` Reference to the API key used to create this study - `required string ApiKeyID` Unique API key identifier (UUIDv4 format) - `required string Description` Human-readable description of the API key - `Boolean IsViewerEnabled` Whether this API key has access to the Viewer product - `CreatedByUser? CreatedByUser` Reference to the user who created this study via dashboard - `required string Email` User's email address - `required string UserID` Unique user identifier. Format: usr_{32-hex-chars} - `string FirstName` User's first name - `string LastName` User's last name - `string MiddleName` User's middle name - `string Suffix1` Name suffix (e.g., 'MD', 'Jr.') - `string Suffix2` Additional name suffix - `ExpressCustomer? ExpressCustomer` Reference to the Express customer this study belongs to - `required string ExpressCustomerID` Unique Express customer identifier. Format: cus_{32-hex-chars} - `required string ExpressCustomerName` Name of the Express customer - `IReadOnlyDictionary Metadata` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `IReadOnlyList PriorReportTexts` Array of prior report texts to provide clinical context - `IReadOnlyList PriorStudyIds` Array of prior study IDs for comparison context (format: stu_{32-hex-chars}) - `IReadOnlyList ReportIds` Array of report IDs associated with this study, including addendums - `required string ReportID` Unique report identifier. Format: rep_{32-hex-chars} - `required Status Status` Current status of the report - `"in_progress"InProgress` - `"completed"Completed` ### Example ```csharp StudyRetrieveParams parameters = new() { StudyID = "stu_1234567890abcdef1234567890abcdef" }; var study = await client.AutoScribe.Studies.Retrieve(parameters); Console.WriteLine(study); ``` ## Update `StudyUpdateResponse AutoScribe.Studies.Update(StudyUpdateParamsparameters, CancellationTokencancellationToken = default)` **patch** `/v1/autoScribe/studies/{studyId}` Updates a study's properties including description, severity, assignment, organization, metadata, and report metadata. All fields are optional - only provided fields will be updated. ### Parameters - `StudyUpdateParams parameters` - `required string studyID` Unique study identifier. Format: stu_{32-hex-chars} - `string assignedTo` User ID to assign the study to, or null to unassign. Format: usr_{32-hex-chars} - `string expressCustomerID` Express Customer ID for the study, or null to remove. Format: cus_{32-hex-chars} - `IReadOnlyDictionary? metadata` - `IReadOnlyList? priorReportTexts` - `IReadOnlyList? priorStudyIds` - `ReportMetadata reportMetadata` - `string? Age` - `string? DateOfBirth` - `string? FacilityName` - `Height? Height` - `required Unit Unit` - `"in"In` - `"cm"Cm` - `required Double Value` - `string? Mrn` - `string? PatientName` - `string? ReferringPhysicianName` - `string? ScanDate` - `string? ScanTime` - `string? ScanType` - `Sex? Sex` - `"male"Male` - `"female"Female` - `"other"Other` - `Weight? Weight` - `required Unit Unit` - `"lbs"Lbs` - `"kg"Kg` - `required Double Value` - `Severity severity` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"Normal` - `"high"High` - `"stat"Stat` - `string studyDescription` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') ### Returns - `class StudyUpdateResponse:` A study entity in the AutoScribe system with report workflow status - `required DateTimeOffset? CancelledAt` Timestamp when the study was cancelled, null if not cancelled - `required DateTimeOffset? CreatedAt` Timestamp when the study was created - `required Boolean IsCancelled` Whether the study has been cancelled - `required StudyReportMetadata ReportMetadata` 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` - `"in"In` - `"cm"Cm` - `required Double Value` - `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' - `"male"Male` - `"female"Female` - `"other"Other` - `Weight Weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `required Unit Unit` - `"lbs"Lbs` - `"kg"Kg` - `required Double Value` - `required Severity Severity` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"Normal` - `"high"High` - `"stat"Stat` - `required string StudyDescription` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `required string StudyID` Unique study identifier. Format: stu_{32-hex-chars} - `required 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') - `required StudyReportStatus StudyReportStatus` Report workflow status. '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"InProgress` - `"completed"Completed` - `"addendum_active"AddendumActive` - `required DateTimeOffset? UpdatedAt` Timestamp when the study was last updated - `AssignedTo? AssignedTo` Reference to the assigned radiologist, null if unassigned - `required string Email` User's email address - `required string UserID` Unique user identifier. Format: usr_{32-hex-chars} - `string FirstName` User's first name - `string LastName` User's last name - `string MiddleName` User's middle name - `string Suffix1` Name suffix (e.g., 'MD', 'Jr.') - `string Suffix2` Additional name suffix - `CreatedByApiKey? CreatedByApiKey` Reference to the API key used to create this study - `required string ApiKeyID` Unique API key identifier (UUIDv4 format) - `required string Description` Human-readable description of the API key - `Boolean IsViewerEnabled` Whether this API key has access to the Viewer product - `CreatedByUser? CreatedByUser` Reference to the user who created this study via dashboard - `required string Email` User's email address - `required string UserID` Unique user identifier. Format: usr_{32-hex-chars} - `string FirstName` User's first name - `string LastName` User's last name - `string MiddleName` User's middle name - `string Suffix1` Name suffix (e.g., 'MD', 'Jr.') - `string Suffix2` Additional name suffix - `ExpressCustomer? ExpressCustomer` Reference to the Express customer this study belongs to - `required string ExpressCustomerID` Unique Express customer identifier. Format: cus_{32-hex-chars} - `required string ExpressCustomerName` Name of the Express customer - `IReadOnlyDictionary Metadata` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `IReadOnlyList PriorReportTexts` Array of prior report texts to provide clinical context - `IReadOnlyList PriorStudyIds` Array of prior study IDs for comparison context (format: stu_{32-hex-chars}) - `IReadOnlyList ReportIds` Array of report IDs associated with this study, including addendums - `required string ReportID` Unique report identifier. Format: rep_{32-hex-chars} - `required Status Status` Current status of the report - `"in_progress"InProgress` - `"completed"Completed` ### Example ```csharp StudyUpdateParams parameters = new() { StudyID = "stu_1234567890abcdef1234567890abcdef" }; var study = await client.AutoScribe.Studies.Update(parameters); Console.WriteLine(study); ``` ## Cancel `StudyCancelResponse AutoScribe.Studies.Cancel(StudyCancelParams?parameters, CancellationTokencancellationToken = default)` **post** `/v1/autoScribe/studies/cancel` Marks a study as cancelled. Cancelled studies are preserved but flagged as inactive. Can be identified by either study ID or DICOM Study Instance UID. ### Parameters - `StudyCancelParams parameters` - `string studyID` Unique study identifier. 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') ### Returns - `class StudyCancelResponse:` Response for cancelling a study in AutoScribe - `required Boolean Success` - `string Message` ### Example ```csharp StudyCancelParams parameters = new(); var response = await client.AutoScribe.Studies.Cancel(parameters); Console.WriteLine(response); ``` ## Uncancel `StudyUncancelResponse AutoScribe.Studies.Uncancel(StudyUncancelParams?parameters, CancellationTokencancellationToken = default)` **post** `/v1/autoScribe/studies/uncancel` Restores a cancelled study to active status. The study must have been previously cancelled. Can be identified by either study ID or DICOM Study Instance UID. ### Parameters - `StudyUncancelParams parameters` - `string studyID` Unique study identifier. 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') ### Returns - `class StudyUncancelResponse:` Response for uncancelling a study in AutoScribe - `required Boolean Success` - `string Message` ### Example ```csharp StudyUncancelParams parameters = new(); var response = await client.AutoScribe.Studies.Uncancel(parameters); Console.WriteLine(response); ``` ## Reroute URL `StudyRerouteUrlResponse AutoScribe.Studies.RerouteUrl(StudyRerouteUrlParamsparameters, CancellationTokencancellationToken = default)` **post** `/v1/autoScribe/studies/reroute-url` Generates a tokenized URL that redirects users to the AutoScribe interface (viewer + dictation) for the specified study and user. The URL includes authentication and is time-limited for security. ### Parameters - `StudyRerouteUrlParams parameters` - `required string assignedToUserID` User ID to assign study to. Format: usr_{32-hex-chars} - `string studyID` Unique study identifier. 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') ### Returns - `class StudyRerouteUrlResponse:` Response containing the generated reroute URL for AutoScribe (viewer + dictation) - `required string Url` ### Example ```csharp StudyRerouteUrlParams parameters = new() { AssignedToUserID = "usr_1234567890abcdef1234567890abcdef" }; var response = await client.AutoScribe.Studies.RerouteUrl(parameters); Console.WriteLine(response); ``` ## Viewer Only Reroute URL `StudyViewerOnlyRerouteUrlResponse AutoScribe.Studies.ViewerOnlyRerouteUrl(StudyViewerOnlyRerouteUrlParams?parameters, CancellationTokencancellationToken = default)` **post** `/v1/autoScribe/studies/viewer-only-reroute-url` Generates a tokenized URL that redirects users to the viewer interface only (no dictation) for the specified study. Useful for read-only access or referring physicians. The URL includes authentication and is time-limited. ### Parameters - `StudyViewerOnlyRerouteUrlParams parameters` - `string studyID` Unique study identifier. 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') - `string userID` Optional user ID for audit tracking. Format: usr_{32-hex-chars} ### Returns - `class StudyViewerOnlyRerouteUrlResponse:` Response containing the generated viewer-only reroute URL. Requires viewer to be configured. - `required string Url` ### Example ```csharp StudyViewerOnlyRerouteUrlParams parameters = new(); var response = await client.AutoScribe.Studies.ViewerOnlyRerouteUrl(parameters); Console.WriteLine(response); ``` ## Retrieve By Uid `StudyRetrieveByUidResponse AutoScribe.Studies.RetrieveByUid(StudyRetrieveByUidParamsparameters, CancellationTokencancellationToken = default)` **get** `/v1/autoScribe/studies/by-uid/{studyInstanceUid}` Retrieves a single study by its DICOM Study Instance UID. This is useful when you have the DICOM UID but not the Avara study ID. ### Parameters - `StudyRetrieveByUidParams parameters` - `required string studyInstanceUid` DICOM Study Instance UID. Format: numbers and dots (e.g., 1.2.840.10008.5.1.4.1.1.2). ### Returns - `class StudyRetrieveByUidResponse:` A study entity in the AutoScribe system with report workflow status - `required DateTimeOffset? CancelledAt` Timestamp when the study was cancelled, null if not cancelled - `required DateTimeOffset? CreatedAt` Timestamp when the study was created - `required Boolean IsCancelled` Whether the study has been cancelled - `required StudyReportMetadata ReportMetadata` 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` - `"in"In` - `"cm"Cm` - `required Double Value` - `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' - `"male"Male` - `"female"Female` - `"other"Other` - `Weight Weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `required Unit Unit` - `"lbs"Lbs` - `"kg"Kg` - `required Double Value` - `required Severity Severity` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"Normal` - `"high"High` - `"stat"Stat` - `required string StudyDescription` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `required string StudyID` Unique study identifier. Format: stu_{32-hex-chars} - `required 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') - `required StudyReportStatus StudyReportStatus` Report workflow status. '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"InProgress` - `"completed"Completed` - `"addendum_active"AddendumActive` - `required DateTimeOffset? UpdatedAt` Timestamp when the study was last updated - `AssignedTo? AssignedTo` Reference to the assigned radiologist, null if unassigned - `required string Email` User's email address - `required string UserID` Unique user identifier. Format: usr_{32-hex-chars} - `string FirstName` User's first name - `string LastName` User's last name - `string MiddleName` User's middle name - `string Suffix1` Name suffix (e.g., 'MD', 'Jr.') - `string Suffix2` Additional name suffix - `CreatedByApiKey? CreatedByApiKey` Reference to the API key used to create this study - `required string ApiKeyID` Unique API key identifier (UUIDv4 format) - `required string Description` Human-readable description of the API key - `Boolean IsViewerEnabled` Whether this API key has access to the Viewer product - `CreatedByUser? CreatedByUser` Reference to the user who created this study via dashboard - `required string Email` User's email address - `required string UserID` Unique user identifier. Format: usr_{32-hex-chars} - `string FirstName` User's first name - `string LastName` User's last name - `string MiddleName` User's middle name - `string Suffix1` Name suffix (e.g., 'MD', 'Jr.') - `string Suffix2` Additional name suffix - `ExpressCustomer? ExpressCustomer` Reference to the Express customer this study belongs to - `required string ExpressCustomerID` Unique Express customer identifier. Format: cus_{32-hex-chars} - `required string ExpressCustomerName` Name of the Express customer - `IReadOnlyDictionary Metadata` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `IReadOnlyList PriorReportTexts` Array of prior report texts to provide clinical context - `IReadOnlyList PriorStudyIds` Array of prior study IDs for comparison context (format: stu_{32-hex-chars}) - `IReadOnlyList ReportIds` Array of report IDs associated with this study, including addendums - `required string ReportID` Unique report identifier. Format: rep_{32-hex-chars} - `required Status Status` Current status of the report - `"in_progress"InProgress` - `"completed"Completed` ### Example ```csharp StudyRetrieveByUidParams parameters = new() { StudyInstanceUid = "1.2.840.10008.5.1.4.1.1.2" }; var response = await client.AutoScribe.Studies.RetrieveByUid(parameters); Console.WriteLine(response); ``` ## Domain Types ### Report ID With Status - `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 - `"in_progress"InProgress` - `"completed"Completed`