# Auto Scribe ## Domain Types ### Study Report Metadata - `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` - `"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` # 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` # Users ## Invite `UserInviteResponse AutoScribe.Users.Invite(UserInviteParamsparameters, CancellationTokencancellationToken = default)` **post** `/v1/autoScribe/users` Creates a new user in the AutoScribe system and sends them an invitation email. The user will have the specified permissions including report creation and study management capabilities. NPI number is required for users who can create reports. ### Parameters - `UserInviteParams parameters` - `required Boolean canCreateReports` - `required Boolean canManageStudies` - `required ClinicRole clinicRole` User's clinical or organizational role - `"Radiologist"Radiologist` - `"Cardiologist"Cardiologist` - `"Neurologist"Neurologist` - `"Urologist"Urologist` - `"Gynecologist"Gynecologist` - `"Endocrinologist"Endocrinologist` - `"Doctor"Doctor` - `"Surgeon"Surgeon` - `"Physician"Physician` - `"Physician Assistant"PhysicianAssistant` - `"Nurse Practitioner"NursePractitioner` - `"Registered Nurse"RegisteredNurse` - `"Patient Care Coordinator"PatientCareCoordinator` - `"Front Desk Operator"FrontDeskOperator` - `"Imaging Technologist"ImagingTechnologist` - `"PACS Administrator"PacsAdministrator` - `"Software Engineer"SoftwareEngineer` - `"Revenue Cycle Manager"RevenueCycleManager` - `"Administrative Director"AdministrativeDirector` - `"Administrative Assistant"AdministrativeAssistant` - `"Other"Other` - `required string email` User's email address for login and notifications - `required string firstName` User's first name - `required Boolean hasDashboardAccess` - `required string lastName` User's last name - `required Level level` - `"admin"Admin` - `"member"Member` - `string middleName` User's middle name (optional) - `string npiNumber` - `string phoneNumber` User's phone number (10-15 digits, optional) - `string suffix1` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `string suffix2` Additional name suffix (optional) ### Returns - `class UserInviteResponse:` Response for inviting a user to AutoScribe. Level is restricted to admin/member since owners cannot be invited via API. - `required Boolean CanCreateReports` Whether the user can generate and sign radiology reports. Requires NPI number - `required Boolean CanManageStudies` Whether the user has permission to create, update, and manage studies - `required ClinicRole ClinicRole` User's clinical or organizational role - `"Radiologist"Radiologist` - `"Cardiologist"Cardiologist` - `"Neurologist"Neurologist` - `"Urologist"Urologist` - `"Gynecologist"Gynecologist` - `"Endocrinologist"Endocrinologist` - `"Doctor"Doctor` - `"Surgeon"Surgeon` - `"Physician"Physician` - `"Physician Assistant"PhysicianAssistant` - `"Nurse Practitioner"NursePractitioner` - `"Registered Nurse"RegisteredNurse` - `"Patient Care Coordinator"PatientCareCoordinator` - `"Front Desk Operator"FrontDeskOperator` - `"Imaging Technologist"ImagingTechnologist` - `"PACS Administrator"PacsAdministrator` - `"Software Engineer"SoftwareEngineer` - `"Revenue Cycle Manager"RevenueCycleManager` - `"Administrative Director"AdministrativeDirector` - `"Administrative Assistant"AdministrativeAssistant` - `"Other"Other` - `required DateTimeOffset? CreatedAt` Timestamp when the user was created - `required string Email` User's email address for login and notifications - `required string FirstName` User's first name - `required Boolean HasDashboardAccess` Whether the user can access the dashboard interface. Required for admin users - `required InvitedSource InvitedSource` How the user was invited - via dashboard UI or API - `"dashboard"Dashboard` - `"api"Api` - `required DateTimeOffset? LastLoginAt` Timestamp of user's last login, null if never logged in - `required string LastName` User's last name - `required Level Level` User access level. 'admin' can manage users/settings, 'member' has standard access - `"admin"Admin` - `"member"Member` - `required string UserID` Unique user identifier. Format: usr_{32-hex-chars} - `string MiddleName` User's middle name (optional) - `string NpiNumber` National Provider Identifier - required for users who can create reports (10-digit number) - `string PhoneNumber` User's phone number (10-15 digits, optional) - `string Suffix1` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `string Suffix2` Additional name suffix (optional) ### Example ```csharp UserInviteParams parameters = new() { CanCreateReports = true, CanManageStudies = true, ClinicRole = ClinicRole.Radiologist, Email = "dr.johnson@hospital.org", FirstName = "Sarah", HasDashboardAccess = true, LastName = "Johnson", Level = Level.Member, }; var response = await client.AutoScribe.Users.Invite(parameters); Console.WriteLine(response); ``` ## List `UserListPageResponse AutoScribe.Users.List(UserListParams?parameters, CancellationTokencancellationToken = default)` **get** `/v1/autoScribe/users` Retrieves a paginated list of users with optional filtering by access level, email, name, invitation source, and report creation capability. Returns up to 100 users per request. ### Parameters - `UserListParams parameters` - `Boolean? canCreateReports` Filter by canCreateReports permission (AutoScribe-specific) - `string cursor` Base64 encoded cursor from previous response - `string email` Filter by exact email match - `string firstName` Filter by first name (contains match) - `InvitedSource invitedSource` Filter by invitation source - `"dashboard"Dashboard` - `"api"Api` - `string lastName` Filter by last name (contains match) - `Level level` Filter by user level - `"owner"Owner` - `"admin"Admin` - `"member"Member` - `Double limit` Number of results to return (1-100) ### Returns - `class UserListPageResponse:` Paginated list of AutoScribe users - `required Boolean HasMore` - `required IReadOnlyList Users` - `required Boolean CanCreateReports` Whether the user can generate and sign radiology reports. Requires NPI number - `required Boolean CanManageStudies` Whether the user has permission to create, update, and manage studies - `required ClinicRole ClinicRole` User's clinical or organizational role - `"Radiologist"Radiologist` - `"Cardiologist"Cardiologist` - `"Neurologist"Neurologist` - `"Urologist"Urologist` - `"Gynecologist"Gynecologist` - `"Endocrinologist"Endocrinologist` - `"Doctor"Doctor` - `"Surgeon"Surgeon` - `"Physician"Physician` - `"Physician Assistant"PhysicianAssistant` - `"Nurse Practitioner"NursePractitioner` - `"Registered Nurse"RegisteredNurse` - `"Patient Care Coordinator"PatientCareCoordinator` - `"Front Desk Operator"FrontDeskOperator` - `"Imaging Technologist"ImagingTechnologist` - `"PACS Administrator"PacsAdministrator` - `"Software Engineer"SoftwareEngineer` - `"Revenue Cycle Manager"RevenueCycleManager` - `"Administrative Director"AdministrativeDirector` - `"Administrative Assistant"AdministrativeAssistant` - `"Other"Other` - `required DateTimeOffset? CreatedAt` Timestamp when the user was created - `required string Email` User's email address for login and notifications - `required string FirstName` User's first name - `required Boolean HasDashboardAccess` Whether the user can access the dashboard interface. Required for admin users - `required InvitedSource InvitedSource` How the user was invited - via dashboard UI or API - `"dashboard"Dashboard` - `"api"Api` - `required DateTimeOffset? LastLoginAt` Timestamp of user's last login, null if never logged in - `required string LastName` User's last name - `required Level Level` User access level. 'owner' has full control, 'admin' can manage users/settings, 'member' has standard access - `"owner"Owner` - `"admin"Admin` - `"member"Member` - `required string UserID` Unique user identifier. Format: usr_{32-hex-chars} - `string MiddleName` User's middle name (optional) - `string NpiNumber` National Provider Identifier - required for users who can create reports (10-digit number) - `string PhoneNumber` User's phone number (10-15 digits, optional) - `string Suffix1` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `string Suffix2` Additional name suffix (optional) - `string Cursor` ### Example ```csharp UserListParams parameters = new(); var page = await client.AutoScribe.Users.List(parameters); await foreach (var item in page.Paginate()) { Console.WriteLine(item); } ``` ## Retrieve `UserRetrieveResponse AutoScribe.Users.Retrieve(UserRetrieveParamsparameters, CancellationTokencancellationToken = default)` **get** `/v1/autoScribe/users/{userId}` Retrieves a single user by their unique user ID. Returns the complete user object with all profile information, permissions, AutoScribe-specific settings, and status. ### Parameters - `UserRetrieveParams parameters` - `required string userID` Unique user identifier. Format: usr_{32-hex-chars} ### Returns - `class UserRetrieveResponse:` A user in the AutoScribe system with report creation permissions - `required Boolean CanCreateReports` Whether the user can generate and sign radiology reports. Requires NPI number - `required Boolean CanManageStudies` Whether the user has permission to create, update, and manage studies - `required ClinicRole ClinicRole` User's clinical or organizational role - `"Radiologist"Radiologist` - `"Cardiologist"Cardiologist` - `"Neurologist"Neurologist` - `"Urologist"Urologist` - `"Gynecologist"Gynecologist` - `"Endocrinologist"Endocrinologist` - `"Doctor"Doctor` - `"Surgeon"Surgeon` - `"Physician"Physician` - `"Physician Assistant"PhysicianAssistant` - `"Nurse Practitioner"NursePractitioner` - `"Registered Nurse"RegisteredNurse` - `"Patient Care Coordinator"PatientCareCoordinator` - `"Front Desk Operator"FrontDeskOperator` - `"Imaging Technologist"ImagingTechnologist` - `"PACS Administrator"PacsAdministrator` - `"Software Engineer"SoftwareEngineer` - `"Revenue Cycle Manager"RevenueCycleManager` - `"Administrative Director"AdministrativeDirector` - `"Administrative Assistant"AdministrativeAssistant` - `"Other"Other` - `required DateTimeOffset? CreatedAt` Timestamp when the user was created - `required string Email` User's email address for login and notifications - `required string FirstName` User's first name - `required Boolean HasDashboardAccess` Whether the user can access the dashboard interface. Required for admin users - `required InvitedSource InvitedSource` How the user was invited - via dashboard UI or API - `"dashboard"Dashboard` - `"api"Api` - `required DateTimeOffset? LastLoginAt` Timestamp of user's last login, null if never logged in - `required string LastName` User's last name - `required Level Level` User access level. 'owner' has full control, 'admin' can manage users/settings, 'member' has standard access - `"owner"Owner` - `"admin"Admin` - `"member"Member` - `required string UserID` Unique user identifier. Format: usr_{32-hex-chars} - `string MiddleName` User's middle name (optional) - `string NpiNumber` National Provider Identifier - required for users who can create reports (10-digit number) - `string PhoneNumber` User's phone number (10-15 digits, optional) - `string Suffix1` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `string Suffix2` Additional name suffix (optional) ### Example ```csharp UserRetrieveParams parameters = new() { UserID = "usr_1234567890abcdef1234567890abcdef" }; var user = await client.AutoScribe.Users.Retrieve(parameters); Console.WriteLine(user); ``` ## Update `UserUpdateResponse AutoScribe.Users.Update(UserUpdateParamsparameters, CancellationTokencancellationToken = default)` **patch** `/v1/autoScribe/users/{userId}` Updates a user's profile information, permissions, and AutoScribe-specific settings. All fields are optional - only provided fields will be updated. Email cannot be changed via API. NPI number is required if enabling report creation capability. ### Parameters - `UserUpdateParams parameters` - `required string userID` Unique user identifier. Format: usr_{32-hex-chars} - `Boolean canCreateReports` - `Boolean canManageStudies` - `ClinicRole? clinicRole` - `"Radiologist"Radiologist` - `"Cardiologist"Cardiologist` - `"Neurologist"Neurologist` - `"Urologist"Urologist` - `"Gynecologist"Gynecologist` - `"Endocrinologist"Endocrinologist` - `"Doctor"Doctor` - `"Surgeon"Surgeon` - `"Physician"Physician` - `"Physician Assistant"PhysicianAssistant` - `"Nurse Practitioner"NursePractitioner` - `"Registered Nurse"RegisteredNurse` - `"Patient Care Coordinator"PatientCareCoordinator` - `"Front Desk Operator"FrontDeskOperator` - `"Imaging Technologist"ImagingTechnologist` - `"PACS Administrator"PacsAdministrator` - `"Software Engineer"SoftwareEngineer` - `"Revenue Cycle Manager"RevenueCycleManager` - `"Administrative Director"AdministrativeDirector` - `"Administrative Assistant"AdministrativeAssistant` - `"Other"Other` - `string firstName` User's first name - `Boolean hasDashboardAccess` Whether the user can access the dashboard interface. Required for admin users - `string lastName` User's last name - `Level level` - `"admin"Admin` - `"member"Member` - `string? middleName` - `string? npiNumber` - `string? phoneNumber` - `string? suffix1` - `string? suffix2` ### Returns - `class UserUpdateResponse:` A user in the AutoScribe system with report creation permissions - `required Boolean CanCreateReports` Whether the user can generate and sign radiology reports. Requires NPI number - `required Boolean CanManageStudies` Whether the user has permission to create, update, and manage studies - `required ClinicRole ClinicRole` User's clinical or organizational role - `"Radiologist"Radiologist` - `"Cardiologist"Cardiologist` - `"Neurologist"Neurologist` - `"Urologist"Urologist` - `"Gynecologist"Gynecologist` - `"Endocrinologist"Endocrinologist` - `"Doctor"Doctor` - `"Surgeon"Surgeon` - `"Physician"Physician` - `"Physician Assistant"PhysicianAssistant` - `"Nurse Practitioner"NursePractitioner` - `"Registered Nurse"RegisteredNurse` - `"Patient Care Coordinator"PatientCareCoordinator` - `"Front Desk Operator"FrontDeskOperator` - `"Imaging Technologist"ImagingTechnologist` - `"PACS Administrator"PacsAdministrator` - `"Software Engineer"SoftwareEngineer` - `"Revenue Cycle Manager"RevenueCycleManager` - `"Administrative Director"AdministrativeDirector` - `"Administrative Assistant"AdministrativeAssistant` - `"Other"Other` - `required DateTimeOffset? CreatedAt` Timestamp when the user was created - `required string Email` User's email address for login and notifications - `required string FirstName` User's first name - `required Boolean HasDashboardAccess` Whether the user can access the dashboard interface. Required for admin users - `required InvitedSource InvitedSource` How the user was invited - via dashboard UI or API - `"dashboard"Dashboard` - `"api"Api` - `required DateTimeOffset? LastLoginAt` Timestamp of user's last login, null if never logged in - `required string LastName` User's last name - `required Level Level` User access level. 'owner' has full control, 'admin' can manage users/settings, 'member' has standard access - `"owner"Owner` - `"admin"Admin` - `"member"Member` - `required string UserID` Unique user identifier. Format: usr_{32-hex-chars} - `string MiddleName` User's middle name (optional) - `string NpiNumber` National Provider Identifier - required for users who can create reports (10-digit number) - `string PhoneNumber` User's phone number (10-15 digits, optional) - `string Suffix1` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `string Suffix2` Additional name suffix (optional) ### Example ```csharp UserUpdateParams parameters = new() { UserID = "usr_1234567890abcdef1234567890abcdef" }; var user = await client.AutoScribe.Users.Update(parameters); Console.WriteLine(user); ``` ## Revoke Access `UserRevokeAccessResponse AutoScribe.Users.RevokeAccess(UserRevokeAccessParamsparameters, CancellationTokencancellationToken = default)` **post** `/v1/autoScribe/users/revoke-access` Deactivates a user's access to the system. The user will no longer be able to log in, create reports, or access studies. User data is preserved and can be reactivated later. ### Parameters - `UserRevokeAccessParams parameters` - `required string userID` User ID to revoke access for. Format: usr_{32-hex-chars} ### Returns - `class UserRevokeAccessResponse:` Response for revoking user access in AutoScribe - `required Boolean Success` - `string Message` ### Example ```csharp UserRevokeAccessParams parameters = new() { UserID = "usr_1234567890abcdef1234567890abcdef" }; var response = await client.AutoScribe.Users.RevokeAccess(parameters); Console.WriteLine(response); ``` ## Reactivate `UserReactivateResponse AutoScribe.Users.Reactivate(UserReactivateParamsparameters, CancellationTokencancellationToken = default)` **post** `/v1/autoScribe/users/reactivate` Restores access for a previously deactivated user. The user will regain their original permissions including report creation and study management capabilities. ### Parameters - `UserReactivateParams parameters` - `required string userID` User ID to reactivate. Format: usr_{32-hex-chars} ### Returns - `class UserReactivateResponse:` Response for reactivating a user in AutoScribe - `required Boolean Success` - `string Message` ### Example ```csharp UserReactivateParams parameters = new() { UserID = "usr_1234567890abcdef1234567890abcdef" }; var response = await client.AutoScribe.Users.Reactivate(parameters); Console.WriteLine(response); ``` # Invitations ## List `InvitationListPageResponse AutoScribe.Users.Invitations.List(InvitationListParams?parameters, CancellationTokencancellationToken = default)` **get** `/v1/autoScribe/users/invitations` Retrieves a paginated list of user invitations with optional filtering by status, expiration, date range, and user ID. Returns up to 100 invitations per request. ### Parameters - `InvitationListParams parameters` - `string cursor` Base64 encoded cursor from previous response - `string endDate` Filter invitations created on or before this date (YYYY-MM-DD) - `Expired expired` Filter by expiration status - `"all"All` - `"expired"Expired` - `"not-expired"NotExpired` - `Double limit` Number of results to return (1-100) - `string startDate` Filter invitations created on or after this date (YYYY-MM-DD) - `IReadOnlyList status` Filter by invitation status(es) - `"sent"Sent` - `"accepted"Accepted` - `"rejected"Rejected` - `"revoked"Revoked` - `string userID` Filter by user ID. Format: usr_{32-hex-chars} ### Returns - `class InvitationListPageResponse:` Paginated list of AutoScribe invitations - `required Boolean HasMore` - `required IReadOnlyList Invitations` - `required Boolean CanCreateReports` Whether the invited user can generate and sign radiology reports. Requires NPI number - `required Boolean CanManageStudies` Whether the invited user will have permission to create, update, and manage studies - `required string ClinicID` UUID of the clinic this invitation belongs to - `required ClinicRole ClinicRole` Clinical or organizational role for the invited user - `"Radiologist"Radiologist` - `"Cardiologist"Cardiologist` - `"Neurologist"Neurologist` - `"Urologist"Urologist` - `"Gynecologist"Gynecologist` - `"Endocrinologist"Endocrinologist` - `"Doctor"Doctor` - `"Surgeon"Surgeon` - `"Physician"Physician` - `"Physician Assistant"PhysicianAssistant` - `"Nurse Practitioner"NursePractitioner` - `"Registered Nurse"RegisteredNurse` - `"Patient Care Coordinator"PatientCareCoordinator` - `"Front Desk Operator"FrontDeskOperator` - `"Imaging Technologist"ImagingTechnologist` - `"PACS Administrator"PacsAdministrator` - `"Software Engineer"SoftwareEngineer` - `"Revenue Cycle Manager"RevenueCycleManager` - `"Administrative Director"AdministrativeDirector` - `"Administrative Assistant"AdministrativeAssistant` - `"Other"Other` - `required DateTimeOffset? CreatedAt` Timestamp when the invitation was created - `required string Email` Email address the invitation was sent to - `required DateTimeOffset? Expiry` When the invitation expires, null if no expiration - `required string FirstName` Invited user's first name - `required Boolean HasDashboardAccess` Whether the invited user will have dashboard access - `required string InvitationID` Unique invitation identifier. Format: inv_{32-hex-chars} - `required InvitedSource InvitedSource` How the invitation was created - 'dashboard' or 'api' - `"dashboard"Dashboard` - `"api"Api` - `required string InviterID` User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API - `required string LastName` Invited user's last name - `required Level Level` Access level for the invited user. 'admin' or 'member' when created via API - `"owner"Owner` - `"admin"Admin` - `"member"Member` - `required Status Status` Invitation status: 'sent', 'accepted', 'rejected', or 'revoked' - `"sent"Sent` - `"accepted"Accepted` - `"rejected"Rejected` - `"revoked"Revoked` - `required DateTimeOffset? UpdatedAt` Timestamp when the invitation was last updated - `required string UserID` Pre-generated user ID for this invitation. Format: usr_{32-hex-chars}. This ID is assigned at invitation creation and will become the user's permanent ID upon acceptance - `string InvitedByApiKeyID` UUID of the API key used to send this invitation. Null if sent via dashboard - `string? MiddleName` Invited user's middle name (optional) - `string NpiNumber` National Provider Identifier - required for users who can create reports (10-digit number) - `string? PhoneNumber` Invited user's phone number (optional) - `string? Suffix1` Name suffix (e.g., 'Jr.', 'MD') - optional - `string? Suffix2` Additional name suffix - optional - `string Cursor` ### Example ```csharp InvitationListParams parameters = new(); var page = await client.AutoScribe.Users.Invitations.List(parameters); await foreach (var item in page.Paginate()) { Console.WriteLine(item); } ``` ## Retrieve `InvitationRetrieveResponse AutoScribe.Users.Invitations.Retrieve(InvitationRetrieveParamsparameters, CancellationTokencancellationToken = default)` **get** `/v1/autoScribe/users/invitations/{invitationId}` Retrieves a single invitation by its unique invitation ID. Returns the complete invitation details including status, expiration, associated user information, and AutoScribe-specific permissions. ### Parameters - `InvitationRetrieveParams parameters` - `required string invitationID` Unique invitation identifier. Format: inv_{32-hex-chars} ### Returns - `class InvitationRetrieveResponse:` A pending user invitation in the AutoScribe system - `required Boolean CanCreateReports` Whether the invited user can generate and sign radiology reports. Requires NPI number - `required Boolean CanManageStudies` Whether the invited user will have permission to create, update, and manage studies - `required string ClinicID` UUID of the clinic this invitation belongs to - `required ClinicRole ClinicRole` Clinical or organizational role for the invited user - `"Radiologist"Radiologist` - `"Cardiologist"Cardiologist` - `"Neurologist"Neurologist` - `"Urologist"Urologist` - `"Gynecologist"Gynecologist` - `"Endocrinologist"Endocrinologist` - `"Doctor"Doctor` - `"Surgeon"Surgeon` - `"Physician"Physician` - `"Physician Assistant"PhysicianAssistant` - `"Nurse Practitioner"NursePractitioner` - `"Registered Nurse"RegisteredNurse` - `"Patient Care Coordinator"PatientCareCoordinator` - `"Front Desk Operator"FrontDeskOperator` - `"Imaging Technologist"ImagingTechnologist` - `"PACS Administrator"PacsAdministrator` - `"Software Engineer"SoftwareEngineer` - `"Revenue Cycle Manager"RevenueCycleManager` - `"Administrative Director"AdministrativeDirector` - `"Administrative Assistant"AdministrativeAssistant` - `"Other"Other` - `required DateTimeOffset? CreatedAt` Timestamp when the invitation was created - `required string Email` Email address the invitation was sent to - `required DateTimeOffset? Expiry` When the invitation expires, null if no expiration - `required string FirstName` Invited user's first name - `required Boolean HasDashboardAccess` Whether the invited user will have dashboard access - `required string InvitationID` Unique invitation identifier. Format: inv_{32-hex-chars} - `required InvitedSource InvitedSource` How the invitation was created - 'dashboard' or 'api' - `"dashboard"Dashboard` - `"api"Api` - `required string InviterID` User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API - `required string LastName` Invited user's last name - `required Level Level` Access level for the invited user. 'admin' or 'member' when created via API - `"owner"Owner` - `"admin"Admin` - `"member"Member` - `required Status Status` Invitation status: 'sent', 'accepted', 'rejected', or 'revoked' - `"sent"Sent` - `"accepted"Accepted` - `"rejected"Rejected` - `"revoked"Revoked` - `required DateTimeOffset? UpdatedAt` Timestamp when the invitation was last updated - `required string UserID` Pre-generated user ID for this invitation. Format: usr_{32-hex-chars}. This ID is assigned at invitation creation and will become the user's permanent ID upon acceptance - `string InvitedByApiKeyID` UUID of the API key used to send this invitation. Null if sent via dashboard - `string? MiddleName` Invited user's middle name (optional) - `string NpiNumber` National Provider Identifier - required for users who can create reports (10-digit number) - `string? PhoneNumber` Invited user's phone number (optional) - `string? Suffix1` Name suffix (e.g., 'Jr.', 'MD') - optional - `string? Suffix2` Additional name suffix - optional ### Example ```csharp InvitationRetrieveParams parameters = new() { InvitationID = "inv_1234567890abcdef1234567890abcdef" }; var invitation = await client.AutoScribe.Users.Invitations.Retrieve(parameters); Console.WriteLine(invitation); ``` ## Update `InvitationUpdateResponse AutoScribe.Users.Invitations.Update(InvitationUpdateParamsparameters, CancellationTokencancellationToken = default)` **patch** `/v1/autoScribe/users/invitations/{invitationId}` Updates a pending invitation's user details, permissions, and AutoScribe-specific settings before it is accepted. Only valid for invitations that have not expired or been processed. NPI number is required if enabling report creation. ### Parameters - `InvitationUpdateParams parameters` - `required string invitationID` Unique invitation identifier. Format: inv_{32-hex-chars} - `Boolean canCreateReports` Whether the invited user can generate and sign radiology reports. Requires NPI number - `Boolean canManageStudies` Whether the invited user will have permission to create, update, and manage studies - `ClinicRole? clinicRole` - `"Radiologist"Radiologist` - `"Cardiologist"Cardiologist` - `"Neurologist"Neurologist` - `"Urologist"Urologist` - `"Gynecologist"Gynecologist` - `"Endocrinologist"Endocrinologist` - `"Doctor"Doctor` - `"Surgeon"Surgeon` - `"Physician"Physician` - `"Physician Assistant"PhysicianAssistant` - `"Nurse Practitioner"NursePractitioner` - `"Registered Nurse"RegisteredNurse` - `"Patient Care Coordinator"PatientCareCoordinator` - `"Front Desk Operator"FrontDeskOperator` - `"Imaging Technologist"ImagingTechnologist` - `"PACS Administrator"PacsAdministrator` - `"Software Engineer"SoftwareEngineer` - `"Revenue Cycle Manager"RevenueCycleManager` - `"Administrative Director"AdministrativeDirector` - `"Administrative Assistant"AdministrativeAssistant` - `"Other"Other` - `string firstName` Invited user's first name - `Boolean hasDashboardAccess` Whether the invited user will have dashboard access - `string lastName` Invited user's last name - `Level level` - `"admin"Admin` - `"member"Member` - `string? middleName` - `string? npiNumber` - `string? phoneNumber` - `string? suffix1` - `string? suffix2` ### Returns - `class InvitationUpdateResponse:` A pending user invitation in the AutoScribe system - `required Boolean CanCreateReports` Whether the invited user can generate and sign radiology reports. Requires NPI number - `required Boolean CanManageStudies` Whether the invited user will have permission to create, update, and manage studies - `required string ClinicID` UUID of the clinic this invitation belongs to - `required ClinicRole ClinicRole` Clinical or organizational role for the invited user - `"Radiologist"Radiologist` - `"Cardiologist"Cardiologist` - `"Neurologist"Neurologist` - `"Urologist"Urologist` - `"Gynecologist"Gynecologist` - `"Endocrinologist"Endocrinologist` - `"Doctor"Doctor` - `"Surgeon"Surgeon` - `"Physician"Physician` - `"Physician Assistant"PhysicianAssistant` - `"Nurse Practitioner"NursePractitioner` - `"Registered Nurse"RegisteredNurse` - `"Patient Care Coordinator"PatientCareCoordinator` - `"Front Desk Operator"FrontDeskOperator` - `"Imaging Technologist"ImagingTechnologist` - `"PACS Administrator"PacsAdministrator` - `"Software Engineer"SoftwareEngineer` - `"Revenue Cycle Manager"RevenueCycleManager` - `"Administrative Director"AdministrativeDirector` - `"Administrative Assistant"AdministrativeAssistant` - `"Other"Other` - `required DateTimeOffset? CreatedAt` Timestamp when the invitation was created - `required string Email` Email address the invitation was sent to - `required DateTimeOffset? Expiry` When the invitation expires, null if no expiration - `required string FirstName` Invited user's first name - `required Boolean HasDashboardAccess` Whether the invited user will have dashboard access - `required string InvitationID` Unique invitation identifier. Format: inv_{32-hex-chars} - `required InvitedSource InvitedSource` How the invitation was created - 'dashboard' or 'api' - `"dashboard"Dashboard` - `"api"Api` - `required string InviterID` User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API - `required string LastName` Invited user's last name - `required Level Level` Access level for the invited user. 'admin' or 'member' when created via API - `"owner"Owner` - `"admin"Admin` - `"member"Member` - `required Status Status` Invitation status: 'sent', 'accepted', 'rejected', or 'revoked' - `"sent"Sent` - `"accepted"Accepted` - `"rejected"Rejected` - `"revoked"Revoked` - `required DateTimeOffset? UpdatedAt` Timestamp when the invitation was last updated - `required string UserID` Pre-generated user ID for this invitation. Format: usr_{32-hex-chars}. This ID is assigned at invitation creation and will become the user's permanent ID upon acceptance - `string InvitedByApiKeyID` UUID of the API key used to send this invitation. Null if sent via dashboard - `string? MiddleName` Invited user's middle name (optional) - `string NpiNumber` National Provider Identifier - required for users who can create reports (10-digit number) - `string? PhoneNumber` Invited user's phone number (optional) - `string? Suffix1` Name suffix (e.g., 'Jr.', 'MD') - optional - `string? Suffix2` Additional name suffix - optional ### Example ```csharp InvitationUpdateParams parameters = new() { InvitationID = "inv_1234567890abcdef1234567890abcdef" }; var invitation = await client.AutoScribe.Users.Invitations.Update(parameters); Console.WriteLine(invitation); ``` ## Revoke `InvitationRevokeResponse AutoScribe.Users.Invitations.Revoke(InvitationRevokeParams?parameters, CancellationTokencancellationToken = default)` **post** `/v1/autoScribe/users/invitations/revoke` Revokes a pending invitation, preventing it from being accepted. Can revoke by invitation ID, user ID, or both. Useful for cancelling invitations sent in error. ### Parameters - `InvitationRevokeParams parameters` - `string invitationID` Invitation ID to revoke. Format: inv_{32-hex-chars} - `string userID` User ID whose pending invitation to revoke. Format: usr_{32-hex-chars} ### Returns - `class InvitationRevokeResponse:` Response for revoking an invitation in AutoScribe - `required Boolean Success` - `string Message` ### Example ```csharp InvitationRevokeParams parameters = new(); var response = await client.AutoScribe.Users.Invitations.Revoke(parameters); Console.WriteLine(response); ``` # Reports ## List `ReportListResponse AutoScribe.Reports.List(ReportListParams?parameters, CancellationTokencancellationToken = default)` **get** `/v1/autoScribe/reports` Retrieves all reports (including versions and addendums) for a specific study. Must provide either study ID or DICOM Study Instance UID. Returns report metadata including status, version, and timestamps. ### Parameters - `ReportListParams 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 ReportListResponse:` Response containing a list of reports for a study - `required IReadOnlyList Reports` Array of report objects with full details - `required DateTimeOffset? CreatedAt` Timestamp when the report was created - `required Boolean IsAddendum` Whether this report is an addendum to a previous report - `required string ReportID` Unique report identifier. Format: rep_{32-hex-chars} - `required DateTimeOffset? SignedAt` Timestamp when the report was signed, null if not yet signed - `required StudyReportMetadata SnapshotMetadata` 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 Status Status` Report status: 'in_progress' or 'completed' - `"in_progress"InProgress` - `"completed"Completed` - `required string StudyID` Study ID this report belongs to. Format: stu_{32-hex-chars} - `required DateTimeOffset? UpdatedAt` Timestamp when the report was last updated - `required string UserID` User ID of the radiologist who created/signed this report. Format: usr_{32-hex-chars} - `string ReportPlainText` Plain text content of the report - `required string StudyID` Study ID the reports belong to. 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') ### Example ```csharp ReportListParams parameters = new(); var reports = await client.AutoScribe.Reports.List(parameters); Console.WriteLine(reports); ``` ## Text `ReportTextResponse AutoScribe.Reports.Text(ReportTextParams?parameters, CancellationTokencancellationToken = default)` **get** `/v1/autoScribe/reports/text` Retrieves the text content of a report. Can fetch a single report by report ID, or all reports for a study by study ID/DICOM UID. Returns plain text report content. ### Parameters - `ReportTextParams parameters` - `string reportID` Unique report identifier. Format: rep_{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 ReportTextResponse: A class that can be one of several variants.union` Response containing a single report with its plain text - `SingleReportTextResponse` - `required string ReportID` Unique report identifier. Format: rep_{32-hex-chars} - `required StudyReportMetadata SnapshotMetadata` 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 string StudyID` Study ID this report belongs to. 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') - `string PlainText` Plain text content of the report - `ListReportsTextResponse` - `required IReadOnlyList Reports` Array of report text items - `required string ReportID` Unique report identifier. Format: rep_{32-hex-chars} - `required StudyReportMetadata SnapshotMetadata` 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 string StudyID` Study ID this report belongs to. 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') - `string PlainText` Plain text content of the report - `required string StudyID` Study ID the reports belong to. 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') ### Example ```csharp ReportTextParams parameters = new(); var response = await client.AutoScribe.Reports.Text(parameters); Console.WriteLine(response); ``` ## Pdf `ReportPdfResponse AutoScribe.Reports.Pdf(ReportPdfParams?parameters, CancellationTokencancellationToken = default)` **get** `/v1/autoScribe/reports/pdf` Retrieves presigned URLs for accessing report PDFs. Can fetch a single report by report ID, or all reports for a study by study ID/DICOM UID. URLs are time-limited for security. ### Parameters - `ReportPdfParams parameters` - `string reportID` Unique report identifier. Format: rep_{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 ReportPdfResponse: A class that can be one of several variants.union` Response containing a single report with its PDF download URL - `SingleReportPdfResponse` - `required string PresignedUrl` Time-limited presigned URL to download the PDF (expires after 1 hour) - `required string ReportID` Unique report identifier. Format: rep_{32-hex-chars} - `required StudyReportMetadata SnapshotMetadata` 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 string StudyID` Study ID this report belongs to. 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') - `ListReportsPdfResponse` - `required IReadOnlyList Reports` Array of report PDF items with download URLs - `required string PresignedUrl` Time-limited presigned URL to download the PDF (expires after 1 hour) - `required string ReportID` Unique report identifier. Format: rep_{32-hex-chars} - `required StudyReportMetadata SnapshotMetadata` 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 string StudyID` Study ID this report belongs to. 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 string StudyID` Study ID the reports belong to. 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') ### Example ```csharp ReportPdfParams parameters = new(); var response = await client.AutoScribe.Reports.Pdf(parameters); Console.WriteLine(response); ``` ## Addendum `ReportAddendumResponse AutoScribe.Reports.Addendum(ReportAddendumParamsparameters, CancellationTokencancellationToken = default)` **post** `/v1/autoScribe/reports/{reportId}/addendum` Initiates the creation of an addendum to an existing completed report. The study status will change to 'addendum_active' allowing the radiologist to dictate additional findings. ### Parameters - `ReportAddendumParams parameters` - `required string reportID` Unique report identifier. Format: rep_{32-hex-chars} ### Returns - `class ReportAddendumResponse:` Response for creating a report addendum - `required Boolean Success` - `string Message` ### Example ```csharp ReportAddendumParams parameters = new() { ReportID = "rep_1234567890abcdef1234567890abcdef" }; var response = await client.AutoScribe.Reports.Addendum(parameters); Console.WriteLine(response); ``` ## Cancel Addendum `ReportCancelAddendumResponse AutoScribe.Reports.CancelAddendum(ReportCancelAddendumParamsparameters, CancellationTokencancellationToken = default)` **post** `/v1/autoScribe/reports/{reportId}/cancel-addendum` Cancels an in-progress addendum and reverts the study status to 'completed'. The original report remains unchanged. Only valid for active addendums. ### Parameters - `ReportCancelAddendumParams parameters` - `required string reportID` Unique report identifier. Format: rep_{32-hex-chars} ### Returns - `class ReportCancelAddendumResponse:` Response for cancelling a report addendum - `required Boolean Success` - `string Message` ### Example ```csharp ReportCancelAddendumParams parameters = new() { ReportID = "rep_1234567890abcdef1234567890abcdef" }; var response = await client.AutoScribe.Reports.CancelAddendum(parameters); Console.WriteLine(response); ```