# Auto Scribe ## Domain Types ### Study Report Metadata - `class StudyReportMetadata:` Patient demographics and scan information for report generation - `Optional age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `double value` # Studies ## Create `StudyCreateResponse autoScribe().studies().create(StudyCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `StudyReportMetadata reportMetadata` Patient demographics and scan information for report generation - `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') - `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') - `Optional assignedTo` User ID to assign the study to. Format: usr_{32-hex-chars} - `Optional expressCustomerId` Express customer ID for the study. Format: cus_{32-hex-chars} - `Optional metadata` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `Optional> priorReportTexts` - `Optional> priorStudyIds` ### Returns - `class StudyCreateResponse:` A study entity in the AutoScribe system with report workflow status - `Optional cancelledAt` Timestamp when the study was cancelled, null if not cancelled - `Optional createdAt` Timestamp when the study was created - `boolean isCancelled` Whether the study has been cancelled - `StudyReportMetadata reportMetadata` Patient demographics and scan information for report generation - `Optional age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `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') - `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') - `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("in_progress")` - `COMPLETED("completed")` - `ADDENDUM_ACTIVE("addendum_active")` - `Optional updatedAt` Timestamp when the study was last updated - `Optional assignedTo` Reference to the assigned radiologist, null if unassigned - `String email` User's email address - `String userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional firstName` User's first name - `Optional lastName` User's last name - `Optional middleName` User's middle name - `Optional suffix1` Name suffix (e.g., 'MD', 'Jr.') - `Optional suffix2` Additional name suffix - `Optional createdByApiKey` Reference to the API key used to create this study - `String apiKeyId` Unique API key identifier (UUIDv4 format) - `String description` Human-readable description of the API key - `Optional isViewerEnabled` Whether this API key has access to the Viewer product - `Optional createdByUser` Reference to the user who created this study via dashboard - `String email` User's email address - `String userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional firstName` User's first name - `Optional lastName` User's last name - `Optional middleName` User's middle name - `Optional suffix1` Name suffix (e.g., 'MD', 'Jr.') - `Optional suffix2` Additional name suffix - `Optional expressCustomer` Reference to the Express customer this study belongs to - `String expressCustomerId` Unique Express customer identifier. Format: cus_{32-hex-chars} - `String expressCustomerName` Name of the Express customer - `Optional metadata` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `Optional> priorReportTexts` Array of prior report texts to provide clinical context - `Optional> priorStudyIds` Array of prior study IDs for comparison context (format: stu_{32-hex-chars}) - `Optional> reportIds` Array of report IDs associated with this study, including addendums - `String reportId` Unique report identifier. Format: rep_{32-hex-chars} - `Status status` Current status of the report - `IN_PROGRESS("in_progress")` - `COMPLETED("completed")` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.StudyReportMetadata; import com.avara.models.autoscribe.studies.StudyCreateParams; import com.avara.models.autoscribe.studies.StudyCreateResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); StudyCreateParams params = StudyCreateParams.builder() .reportMetadata(StudyReportMetadata.builder().build()) .severity(StudyCreateParams.Severity.NORMAL) .studyDescription("Brain MRI with Contrast") .studyInstanceUid("1.2.840.113619.2.55.3.604688119.868.1234567890.123") .build(); StudyCreateResponse study = client.autoScribe().studies().create(params); } } ``` ## List `StudyListPage autoScribe().studies().list(StudyListParamsparams = StudyListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional assignedTo` Filter by assigned user ID (null = explicitly unassigned). Format: usr_<32-hex-chars> - `Optional cursor` Base64 encoded cursor from previous response - `Optional expressCustomerId` Filter by Express customer ID (null = studies with no customer). Format: cus_{32-hex-chars} - `Optional isCancelled` Filter by cancellation status - `Optional limit` Number of results to return (1-100) - `Optional severity` Filter by study severity - `NORMAL("normal")` - `HIGH("high")` - `STAT("stat")` - `Optional studyDescription` Filter by study description (contains match) - `Optional> studyReportStatus` Filter by report status(es) - `UNASSIGNED("unassigned")` - `ASSIGNED("assigned")` - `IN_PROGRESS("in_progress")` - `COMPLETED("completed")` - `ADDENDUM_ACTIVE("addendum_active")` ### Returns - `class StudyListResponse:` A study entity in the AutoScribe system with report workflow status - `Optional cancelledAt` Timestamp when the study was cancelled, null if not cancelled - `Optional createdAt` Timestamp when the study was created - `boolean isCancelled` Whether the study has been cancelled - `StudyReportMetadata reportMetadata` Patient demographics and scan information for report generation - `Optional age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `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') - `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') - `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("in_progress")` - `COMPLETED("completed")` - `ADDENDUM_ACTIVE("addendum_active")` - `Optional updatedAt` Timestamp when the study was last updated - `Optional assignedTo` Reference to the assigned radiologist, null if unassigned - `String email` User's email address - `String userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional firstName` User's first name - `Optional lastName` User's last name - `Optional middleName` User's middle name - `Optional suffix1` Name suffix (e.g., 'MD', 'Jr.') - `Optional suffix2` Additional name suffix - `Optional createdByApiKey` Reference to the API key used to create this study - `String apiKeyId` Unique API key identifier (UUIDv4 format) - `String description` Human-readable description of the API key - `Optional isViewerEnabled` Whether this API key has access to the Viewer product - `Optional createdByUser` Reference to the user who created this study via dashboard - `String email` User's email address - `String userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional firstName` User's first name - `Optional lastName` User's last name - `Optional middleName` User's middle name - `Optional suffix1` Name suffix (e.g., 'MD', 'Jr.') - `Optional suffix2` Additional name suffix - `Optional expressCustomer` Reference to the Express customer this study belongs to - `String expressCustomerId` Unique Express customer identifier. Format: cus_{32-hex-chars} - `String expressCustomerName` Name of the Express customer - `Optional metadata` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `Optional> priorReportTexts` Array of prior report texts to provide clinical context - `Optional> priorStudyIds` Array of prior study IDs for comparison context (format: stu_{32-hex-chars}) - `Optional> reportIds` Array of report IDs associated with this study, including addendums - `String reportId` Unique report identifier. Format: rep_{32-hex-chars} - `Status status` Current status of the report - `IN_PROGRESS("in_progress")` - `COMPLETED("completed")` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.studies.StudyListPage; import com.avara.models.autoscribe.studies.StudyListParams; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); StudyListPage page = client.autoScribe().studies().list(); } } ``` ## Retrieve `StudyRetrieveResponse autoScribe().studies().retrieve(StudyRetrieveParamsparams = StudyRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional studyId` Unique study identifier. Format: stu_{32-hex-chars} ### Returns - `class StudyRetrieveResponse:` A study entity in the AutoScribe system with report workflow status - `Optional cancelledAt` Timestamp when the study was cancelled, null if not cancelled - `Optional createdAt` Timestamp when the study was created - `boolean isCancelled` Whether the study has been cancelled - `StudyReportMetadata reportMetadata` Patient demographics and scan information for report generation - `Optional age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `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') - `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') - `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("in_progress")` - `COMPLETED("completed")` - `ADDENDUM_ACTIVE("addendum_active")` - `Optional updatedAt` Timestamp when the study was last updated - `Optional assignedTo` Reference to the assigned radiologist, null if unassigned - `String email` User's email address - `String userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional firstName` User's first name - `Optional lastName` User's last name - `Optional middleName` User's middle name - `Optional suffix1` Name suffix (e.g., 'MD', 'Jr.') - `Optional suffix2` Additional name suffix - `Optional createdByApiKey` Reference to the API key used to create this study - `String apiKeyId` Unique API key identifier (UUIDv4 format) - `String description` Human-readable description of the API key - `Optional isViewerEnabled` Whether this API key has access to the Viewer product - `Optional createdByUser` Reference to the user who created this study via dashboard - `String email` User's email address - `String userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional firstName` User's first name - `Optional lastName` User's last name - `Optional middleName` User's middle name - `Optional suffix1` Name suffix (e.g., 'MD', 'Jr.') - `Optional suffix2` Additional name suffix - `Optional expressCustomer` Reference to the Express customer this study belongs to - `String expressCustomerId` Unique Express customer identifier. Format: cus_{32-hex-chars} - `String expressCustomerName` Name of the Express customer - `Optional metadata` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `Optional> priorReportTexts` Array of prior report texts to provide clinical context - `Optional> priorStudyIds` Array of prior study IDs for comparison context (format: stu_{32-hex-chars}) - `Optional> reportIds` Array of report IDs associated with this study, including addendums - `String reportId` Unique report identifier. Format: rep_{32-hex-chars} - `Status status` Current status of the report - `IN_PROGRESS("in_progress")` - `COMPLETED("completed")` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.studies.StudyRetrieveParams; import com.avara.models.autoscribe.studies.StudyRetrieveResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); StudyRetrieveResponse study = client.autoScribe().studies().retrieve("stu_1234567890abcdef1234567890abcdef"); } } ``` ## Update `StudyUpdateResponse autoScribe().studies().update(StudyUpdateParamsparams = StudyUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional studyId` Unique study identifier. Format: stu_{32-hex-chars} - `Optional assignedTo` User ID to assign the study to, or null to unassign. Format: usr_{32-hex-chars} - `Optional expressCustomerId` Express Customer ID for the study, or null to remove. Format: cus_{32-hex-chars} - `Optional metadata` - `Optional> priorReportTexts` - `Optional> priorStudyIds` - `Optional reportMetadata` - `Optional age` - `Optional dateOfBirth` - `Optional facilityName` - `Optional height` - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` - `Optional patientName` - `Optional referringPhysicianName` - `Optional scanDate` - `Optional scanTime` - `Optional scanType` - `Optional sex` - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `double value` - `Optional severity` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `NORMAL("normal")` - `HIGH("high")` - `STAT("stat")` - `Optional 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 - `Optional cancelledAt` Timestamp when the study was cancelled, null if not cancelled - `Optional createdAt` Timestamp when the study was created - `boolean isCancelled` Whether the study has been cancelled - `StudyReportMetadata reportMetadata` Patient demographics and scan information for report generation - `Optional age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `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') - `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') - `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("in_progress")` - `COMPLETED("completed")` - `ADDENDUM_ACTIVE("addendum_active")` - `Optional updatedAt` Timestamp when the study was last updated - `Optional assignedTo` Reference to the assigned radiologist, null if unassigned - `String email` User's email address - `String userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional firstName` User's first name - `Optional lastName` User's last name - `Optional middleName` User's middle name - `Optional suffix1` Name suffix (e.g., 'MD', 'Jr.') - `Optional suffix2` Additional name suffix - `Optional createdByApiKey` Reference to the API key used to create this study - `String apiKeyId` Unique API key identifier (UUIDv4 format) - `String description` Human-readable description of the API key - `Optional isViewerEnabled` Whether this API key has access to the Viewer product - `Optional createdByUser` Reference to the user who created this study via dashboard - `String email` User's email address - `String userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional firstName` User's first name - `Optional lastName` User's last name - `Optional middleName` User's middle name - `Optional suffix1` Name suffix (e.g., 'MD', 'Jr.') - `Optional suffix2` Additional name suffix - `Optional expressCustomer` Reference to the Express customer this study belongs to - `String expressCustomerId` Unique Express customer identifier. Format: cus_{32-hex-chars} - `String expressCustomerName` Name of the Express customer - `Optional metadata` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `Optional> priorReportTexts` Array of prior report texts to provide clinical context - `Optional> priorStudyIds` Array of prior study IDs for comparison context (format: stu_{32-hex-chars}) - `Optional> reportIds` Array of report IDs associated with this study, including addendums - `String reportId` Unique report identifier. Format: rep_{32-hex-chars} - `Status status` Current status of the report - `IN_PROGRESS("in_progress")` - `COMPLETED("completed")` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.studies.StudyUpdateParams; import com.avara.models.autoscribe.studies.StudyUpdateResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); StudyUpdateResponse study = client.autoScribe().studies().update("stu_1234567890abcdef1234567890abcdef"); } } ``` ## Cancel `StudyCancelResponse autoScribe().studies().cancel(StudyCancelParamsparams = StudyCancelParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional studyId` Unique study identifier. Format: stu_{32-hex-chars} - `Optional 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 - `boolean success` - `Optional message` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.studies.StudyCancelParams; import com.avara.models.autoscribe.studies.StudyCancelResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); StudyCancelResponse response = client.autoScribe().studies().cancel(); } } ``` ## Uncancel `StudyUncancelResponse autoScribe().studies().uncancel(StudyUncancelParamsparams = StudyUncancelParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional studyId` Unique study identifier. Format: stu_{32-hex-chars} - `Optional 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 - `boolean success` - `Optional message` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.studies.StudyUncancelParams; import com.avara.models.autoscribe.studies.StudyUncancelResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); StudyUncancelResponse response = client.autoScribe().studies().uncancel(); } } ``` ## Reroute URL `StudyRerouteUrlResponse autoScribe().studies().rerouteUrl(StudyRerouteUrlParamsparams, RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `String assignedToUserId` User ID to assign study to. Format: usr_{32-hex-chars} - `Optional studyId` Unique study identifier. Format: stu_{32-hex-chars} - `Optional 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) - `String url` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.studies.StudyRerouteUrlParams; import com.avara.models.autoscribe.studies.StudyRerouteUrlResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); StudyRerouteUrlParams params = StudyRerouteUrlParams.builder() .assignedToUserId("usr_1234567890abcdef1234567890abcdef") .build(); StudyRerouteUrlResponse response = client.autoScribe().studies().rerouteUrl(params); } } ``` ## Viewer Only Reroute URL `StudyViewerOnlyRerouteUrlResponse autoScribe().studies().viewerOnlyRerouteUrl(StudyViewerOnlyRerouteUrlParamsparams = StudyViewerOnlyRerouteUrlParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional studyId` Unique study identifier. Format: stu_{32-hex-chars} - `Optional studyInstanceUid` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `Optional 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. - `String url` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.studies.StudyViewerOnlyRerouteUrlParams; import com.avara.models.autoscribe.studies.StudyViewerOnlyRerouteUrlResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); StudyViewerOnlyRerouteUrlResponse response = client.autoScribe().studies().viewerOnlyRerouteUrl(); } } ``` ## Retrieve By Uid `StudyRetrieveByUidResponse autoScribe().studies().retrieveByUid(StudyRetrieveByUidParamsparams = StudyRetrieveByUidParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional 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 - `Optional cancelledAt` Timestamp when the study was cancelled, null if not cancelled - `Optional createdAt` Timestamp when the study was created - `boolean isCancelled` Whether the study has been cancelled - `StudyReportMetadata reportMetadata` Patient demographics and scan information for report generation - `Optional age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `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') - `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') - `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("in_progress")` - `COMPLETED("completed")` - `ADDENDUM_ACTIVE("addendum_active")` - `Optional updatedAt` Timestamp when the study was last updated - `Optional assignedTo` Reference to the assigned radiologist, null if unassigned - `String email` User's email address - `String userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional firstName` User's first name - `Optional lastName` User's last name - `Optional middleName` User's middle name - `Optional suffix1` Name suffix (e.g., 'MD', 'Jr.') - `Optional suffix2` Additional name suffix - `Optional createdByApiKey` Reference to the API key used to create this study - `String apiKeyId` Unique API key identifier (UUIDv4 format) - `String description` Human-readable description of the API key - `Optional isViewerEnabled` Whether this API key has access to the Viewer product - `Optional createdByUser` Reference to the user who created this study via dashboard - `String email` User's email address - `String userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional firstName` User's first name - `Optional lastName` User's last name - `Optional middleName` User's middle name - `Optional suffix1` Name suffix (e.g., 'MD', 'Jr.') - `Optional suffix2` Additional name suffix - `Optional expressCustomer` Reference to the Express customer this study belongs to - `String expressCustomerId` Unique Express customer identifier. Format: cus_{32-hex-chars} - `String expressCustomerName` Name of the Express customer - `Optional metadata` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `Optional> priorReportTexts` Array of prior report texts to provide clinical context - `Optional> priorStudyIds` Array of prior study IDs for comparison context (format: stu_{32-hex-chars}) - `Optional> reportIds` Array of report IDs associated with this study, including addendums - `String reportId` Unique report identifier. Format: rep_{32-hex-chars} - `Status status` Current status of the report - `IN_PROGRESS("in_progress")` - `COMPLETED("completed")` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.studies.StudyRetrieveByUidParams; import com.avara.models.autoscribe.studies.StudyRetrieveByUidResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); StudyRetrieveByUidResponse response = client.autoScribe().studies().retrieveByUid("1.2.840.10008.5.1.4.1.1.2"); } } ``` ## Domain Types ### Report ID With Status - `class ReportIdWithStatus:` A report ID paired with its current status - `String reportId` Unique report identifier. Format: rep_{32-hex-chars} - `Status status` Current status of the report - `IN_PROGRESS("in_progress")` - `COMPLETED("completed")` # Users ## Invite `UserInviteResponse autoScribe().users().invite(UserInviteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `boolean canCreateReports` - `boolean canManageStudies` - `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("Physician Assistant")` - `NURSE_PRACTITIONER("Nurse Practitioner")` - `REGISTERED_NURSE("Registered Nurse")` - `PATIENT_CARE_COORDINATOR("Patient Care Coordinator")` - `FRONT_DESK_OPERATOR("Front Desk Operator")` - `IMAGING_TECHNOLOGIST("Imaging Technologist")` - `PACS_ADMINISTRATOR("PACS Administrator")` - `SOFTWARE_ENGINEER("Software Engineer")` - `REVENUE_CYCLE_MANAGER("Revenue Cycle Manager")` - `ADMINISTRATIVE_DIRECTOR("Administrative Director")` - `ADMINISTRATIVE_ASSISTANT("Administrative Assistant")` - `OTHER("Other")` - `String email` User's email address for login and notifications - `String firstName` User's first name - `boolean hasDashboardAccess` - `String lastName` User's last name - `Level level` - `ADMIN("admin")` - `MEMBER("member")` - `Optional middleName` User's middle name (optional) - `Optional npiNumber` - `Optional phoneNumber` User's phone number (10-15 digits, optional) - `Optional suffix1` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `Optional 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. - `boolean canCreateReports` Whether the user can generate and sign radiology reports. Requires NPI number - `boolean canManageStudies` Whether the user has permission to create, update, and manage studies - `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("Physician Assistant")` - `NURSE_PRACTITIONER("Nurse Practitioner")` - `REGISTERED_NURSE("Registered Nurse")` - `PATIENT_CARE_COORDINATOR("Patient Care Coordinator")` - `FRONT_DESK_OPERATOR("Front Desk Operator")` - `IMAGING_TECHNOLOGIST("Imaging Technologist")` - `PACS_ADMINISTRATOR("PACS Administrator")` - `SOFTWARE_ENGINEER("Software Engineer")` - `REVENUE_CYCLE_MANAGER("Revenue Cycle Manager")` - `ADMINISTRATIVE_DIRECTOR("Administrative Director")` - `ADMINISTRATIVE_ASSISTANT("Administrative Assistant")` - `OTHER("Other")` - `Optional createdAt` Timestamp when the user was created - `String email` User's email address for login and notifications - `String firstName` User's first name - `boolean hasDashboardAccess` Whether the user can access the dashboard interface. Required for admin users - `InvitedSource invitedSource` How the user was invited - via dashboard UI or API - `DASHBOARD("dashboard")` - `API("api")` - `Optional lastLoginAt` Timestamp of user's last login, null if never logged in - `String lastName` User's last name - `Level level` User access level. 'admin' can manage users/settings, 'member' has standard access - `ADMIN("admin")` - `MEMBER("member")` - `String userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional middleName` User's middle name (optional) - `Optional npiNumber` National Provider Identifier - required for users who can create reports (10-digit number) - `Optional phoneNumber` User's phone number (10-15 digits, optional) - `Optional suffix1` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `Optional suffix2` Additional name suffix (optional) ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.users.UserInviteParams; import com.avara.models.autoscribe.users.UserInviteResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); UserInviteParams params = UserInviteParams.builder() .canCreateReports(true) .canManageStudies(true) .clinicRole(UserInviteParams.ClinicRole.RADIOLOGIST) .email("dr.johnson@hospital.org") .firstName("Sarah") .hasDashboardAccess(true) .lastName("Johnson") .level(UserInviteParams.Level.MEMBER) .build(); UserInviteResponse response = client.autoScribe().users().invite(params); } } ``` ## List `UserListPage autoScribe().users().list(UserListParamsparams = UserListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional canCreateReports` Filter by canCreateReports permission (AutoScribe-specific) - `Optional cursor` Base64 encoded cursor from previous response - `Optional email` Filter by exact email match - `Optional firstName` Filter by first name (contains match) - `Optional invitedSource` Filter by invitation source - `DASHBOARD("dashboard")` - `API("api")` - `Optional lastName` Filter by last name (contains match) - `Optional level` Filter by user level - `OWNER("owner")` - `ADMIN("admin")` - `MEMBER("member")` - `Optional limit` Number of results to return (1-100) ### Returns - `class UserListResponse:` A user in the AutoScribe system with report creation permissions - `boolean canCreateReports` Whether the user can generate and sign radiology reports. Requires NPI number - `boolean canManageStudies` Whether the user has permission to create, update, and manage studies - `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("Physician Assistant")` - `NURSE_PRACTITIONER("Nurse Practitioner")` - `REGISTERED_NURSE("Registered Nurse")` - `PATIENT_CARE_COORDINATOR("Patient Care Coordinator")` - `FRONT_DESK_OPERATOR("Front Desk Operator")` - `IMAGING_TECHNOLOGIST("Imaging Technologist")` - `PACS_ADMINISTRATOR("PACS Administrator")` - `SOFTWARE_ENGINEER("Software Engineer")` - `REVENUE_CYCLE_MANAGER("Revenue Cycle Manager")` - `ADMINISTRATIVE_DIRECTOR("Administrative Director")` - `ADMINISTRATIVE_ASSISTANT("Administrative Assistant")` - `OTHER("Other")` - `Optional createdAt` Timestamp when the user was created - `String email` User's email address for login and notifications - `String firstName` User's first name - `boolean hasDashboardAccess` Whether the user can access the dashboard interface. Required for admin users - `InvitedSource invitedSource` How the user was invited - via dashboard UI or API - `DASHBOARD("dashboard")` - `API("api")` - `Optional lastLoginAt` Timestamp of user's last login, null if never logged in - `String lastName` User's last name - `Level level` User access level. 'owner' has full control, 'admin' can manage users/settings, 'member' has standard access - `OWNER("owner")` - `ADMIN("admin")` - `MEMBER("member")` - `String userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional middleName` User's middle name (optional) - `Optional npiNumber` National Provider Identifier - required for users who can create reports (10-digit number) - `Optional phoneNumber` User's phone number (10-15 digits, optional) - `Optional suffix1` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `Optional suffix2` Additional name suffix (optional) ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.users.UserListPage; import com.avara.models.autoscribe.users.UserListParams; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); UserListPage page = client.autoScribe().users().list(); } } ``` ## Retrieve `UserRetrieveResponse autoScribe().users().retrieve(UserRetrieveParamsparams = UserRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional userId` Unique user identifier. Format: usr_{32-hex-chars} ### Returns - `class UserRetrieveResponse:` A user in the AutoScribe system with report creation permissions - `boolean canCreateReports` Whether the user can generate and sign radiology reports. Requires NPI number - `boolean canManageStudies` Whether the user has permission to create, update, and manage studies - `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("Physician Assistant")` - `NURSE_PRACTITIONER("Nurse Practitioner")` - `REGISTERED_NURSE("Registered Nurse")` - `PATIENT_CARE_COORDINATOR("Patient Care Coordinator")` - `FRONT_DESK_OPERATOR("Front Desk Operator")` - `IMAGING_TECHNOLOGIST("Imaging Technologist")` - `PACS_ADMINISTRATOR("PACS Administrator")` - `SOFTWARE_ENGINEER("Software Engineer")` - `REVENUE_CYCLE_MANAGER("Revenue Cycle Manager")` - `ADMINISTRATIVE_DIRECTOR("Administrative Director")` - `ADMINISTRATIVE_ASSISTANT("Administrative Assistant")` - `OTHER("Other")` - `Optional createdAt` Timestamp when the user was created - `String email` User's email address for login and notifications - `String firstName` User's first name - `boolean hasDashboardAccess` Whether the user can access the dashboard interface. Required for admin users - `InvitedSource invitedSource` How the user was invited - via dashboard UI or API - `DASHBOARD("dashboard")` - `API("api")` - `Optional lastLoginAt` Timestamp of user's last login, null if never logged in - `String lastName` User's last name - `Level level` User access level. 'owner' has full control, 'admin' can manage users/settings, 'member' has standard access - `OWNER("owner")` - `ADMIN("admin")` - `MEMBER("member")` - `String userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional middleName` User's middle name (optional) - `Optional npiNumber` National Provider Identifier - required for users who can create reports (10-digit number) - `Optional phoneNumber` User's phone number (10-15 digits, optional) - `Optional suffix1` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `Optional suffix2` Additional name suffix (optional) ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.users.UserRetrieveParams; import com.avara.models.autoscribe.users.UserRetrieveResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); UserRetrieveResponse user = client.autoScribe().users().retrieve("usr_1234567890abcdef1234567890abcdef"); } } ``` ## Update `UserUpdateResponse autoScribe().users().update(UserUpdateParamsparams = UserUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional canCreateReports` - `Optional canManageStudies` - `Optional clinicRole` - `RADIOLOGIST("Radiologist")` - `CARDIOLOGIST("Cardiologist")` - `NEUROLOGIST("Neurologist")` - `UROLOGIST("Urologist")` - `GYNECOLOGIST("Gynecologist")` - `ENDOCRINOLOGIST("Endocrinologist")` - `DOCTOR("Doctor")` - `SURGEON("Surgeon")` - `PHYSICIAN("Physician")` - `PHYSICIAN_ASSISTANT("Physician Assistant")` - `NURSE_PRACTITIONER("Nurse Practitioner")` - `REGISTERED_NURSE("Registered Nurse")` - `PATIENT_CARE_COORDINATOR("Patient Care Coordinator")` - `FRONT_DESK_OPERATOR("Front Desk Operator")` - `IMAGING_TECHNOLOGIST("Imaging Technologist")` - `PACS_ADMINISTRATOR("PACS Administrator")` - `SOFTWARE_ENGINEER("Software Engineer")` - `REVENUE_CYCLE_MANAGER("Revenue Cycle Manager")` - `ADMINISTRATIVE_DIRECTOR("Administrative Director")` - `ADMINISTRATIVE_ASSISTANT("Administrative Assistant")` - `OTHER("Other")` - `Optional firstName` User's first name - `Optional hasDashboardAccess` Whether the user can access the dashboard interface. Required for admin users - `Optional lastName` User's last name - `Optional level` - `ADMIN("admin")` - `MEMBER("member")` - `Optional middleName` - `Optional npiNumber` - `Optional phoneNumber` - `Optional suffix1` - `Optional suffix2` ### Returns - `class UserUpdateResponse:` A user in the AutoScribe system with report creation permissions - `boolean canCreateReports` Whether the user can generate and sign radiology reports. Requires NPI number - `boolean canManageStudies` Whether the user has permission to create, update, and manage studies - `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("Physician Assistant")` - `NURSE_PRACTITIONER("Nurse Practitioner")` - `REGISTERED_NURSE("Registered Nurse")` - `PATIENT_CARE_COORDINATOR("Patient Care Coordinator")` - `FRONT_DESK_OPERATOR("Front Desk Operator")` - `IMAGING_TECHNOLOGIST("Imaging Technologist")` - `PACS_ADMINISTRATOR("PACS Administrator")` - `SOFTWARE_ENGINEER("Software Engineer")` - `REVENUE_CYCLE_MANAGER("Revenue Cycle Manager")` - `ADMINISTRATIVE_DIRECTOR("Administrative Director")` - `ADMINISTRATIVE_ASSISTANT("Administrative Assistant")` - `OTHER("Other")` - `Optional createdAt` Timestamp when the user was created - `String email` User's email address for login and notifications - `String firstName` User's first name - `boolean hasDashboardAccess` Whether the user can access the dashboard interface. Required for admin users - `InvitedSource invitedSource` How the user was invited - via dashboard UI or API - `DASHBOARD("dashboard")` - `API("api")` - `Optional lastLoginAt` Timestamp of user's last login, null if never logged in - `String lastName` User's last name - `Level level` User access level. 'owner' has full control, 'admin' can manage users/settings, 'member' has standard access - `OWNER("owner")` - `ADMIN("admin")` - `MEMBER("member")` - `String userId` Unique user identifier. Format: usr_{32-hex-chars} - `Optional middleName` User's middle name (optional) - `Optional npiNumber` National Provider Identifier - required for users who can create reports (10-digit number) - `Optional phoneNumber` User's phone number (10-15 digits, optional) - `Optional suffix1` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `Optional suffix2` Additional name suffix (optional) ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.users.UserUpdateParams; import com.avara.models.autoscribe.users.UserUpdateResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); UserUpdateResponse user = client.autoScribe().users().update("usr_1234567890abcdef1234567890abcdef"); } } ``` ## Revoke Access `UserRevokeAccessResponse autoScribe().users().revokeAccess(UserRevokeAccessParamsparams, RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `String userId` User ID to revoke access for. Format: usr_{32-hex-chars} ### Returns - `class UserRevokeAccessResponse:` Response for revoking user access in AutoScribe - `boolean success` - `Optional message` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.users.UserRevokeAccessParams; import com.avara.models.autoscribe.users.UserRevokeAccessResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); UserRevokeAccessParams params = UserRevokeAccessParams.builder() .userId("usr_1234567890abcdef1234567890abcdef") .build(); UserRevokeAccessResponse response = client.autoScribe().users().revokeAccess(params); } } ``` ## Reactivate `UserReactivateResponse autoScribe().users().reactivate(UserReactivateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `String userId` User ID to reactivate. Format: usr_{32-hex-chars} ### Returns - `class UserReactivateResponse:` Response for reactivating a user in AutoScribe - `boolean success` - `Optional message` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.users.UserReactivateParams; import com.avara.models.autoscribe.users.UserReactivateResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); UserReactivateParams params = UserReactivateParams.builder() .userId("usr_1234567890abcdef1234567890abcdef") .build(); UserReactivateResponse response = client.autoScribe().users().reactivate(params); } } ``` # Invitations ## List `InvitationListPage autoScribe().users().invitations().list(InvitationListParamsparams = InvitationListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional cursor` Base64 encoded cursor from previous response - `Optional endDate` Filter invitations created on or before this date (YYYY-MM-DD) - `Optional expired` Filter by expiration status - `ALL("all")` - `EXPIRED("expired")` - `NOT_EXPIRED("not-expired")` - `Optional limit` Number of results to return (1-100) - `Optional startDate` Filter invitations created on or after this date (YYYY-MM-DD) - `Optional> status` Filter by invitation status(es) - `SENT("sent")` - `ACCEPTED("accepted")` - `REJECTED("rejected")` - `REVOKED("revoked")` - `Optional userId` Filter by user ID. Format: usr_{32-hex-chars} ### Returns - `class InvitationListResponse:` A pending user invitation in the AutoScribe system - `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 - `String clinicId` UUID of the clinic this invitation belongs to - `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("Physician Assistant")` - `NURSE_PRACTITIONER("Nurse Practitioner")` - `REGISTERED_NURSE("Registered Nurse")` - `PATIENT_CARE_COORDINATOR("Patient Care Coordinator")` - `FRONT_DESK_OPERATOR("Front Desk Operator")` - `IMAGING_TECHNOLOGIST("Imaging Technologist")` - `PACS_ADMINISTRATOR("PACS Administrator")` - `SOFTWARE_ENGINEER("Software Engineer")` - `REVENUE_CYCLE_MANAGER("Revenue Cycle Manager")` - `ADMINISTRATIVE_DIRECTOR("Administrative Director")` - `ADMINISTRATIVE_ASSISTANT("Administrative Assistant")` - `OTHER("Other")` - `Optional createdAt` Timestamp when the invitation was created - `String email` Email address the invitation was sent to - `Optional expiry` When the invitation expires, null if no expiration - `String firstName` Invited user's first name - `boolean hasDashboardAccess` Whether the invited user will have dashboard access - `String invitationId` Unique invitation identifier. Format: inv_{32-hex-chars} - `InvitedSource invitedSource` How the invitation was created - 'dashboard' or 'api' - `DASHBOARD("dashboard")` - `API("api")` - `String inviterId` User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API - `String lastName` Invited user's last name - `Level level` Access level for the invited user. 'admin' or 'member' when created via API - `OWNER("owner")` - `ADMIN("admin")` - `MEMBER("member")` - `Status status` Invitation status: 'sent', 'accepted', 'rejected', or 'revoked' - `SENT("sent")` - `ACCEPTED("accepted")` - `REJECTED("rejected")` - `REVOKED("revoked")` - `Optional updatedAt` Timestamp when the invitation was last updated - `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 - `Optional invitedByApiKeyId` UUID of the API key used to send this invitation. Null if sent via dashboard - `Optional middleName` Invited user's middle name (optional) - `Optional npiNumber` National Provider Identifier - required for users who can create reports (10-digit number) - `Optional phoneNumber` Invited user's phone number (optional) - `Optional suffix1` Name suffix (e.g., 'Jr.', 'MD') - optional - `Optional suffix2` Additional name suffix - optional ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.users.invitations.InvitationListPage; import com.avara.models.autoscribe.users.invitations.InvitationListParams; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); InvitationListPage page = client.autoScribe().users().invitations().list(); } } ``` ## Retrieve `InvitationRetrieveResponse autoScribe().users().invitations().retrieve(InvitationRetrieveParamsparams = InvitationRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional invitationId` Unique invitation identifier. Format: inv_{32-hex-chars} ### Returns - `class InvitationRetrieveResponse:` A pending user invitation in the AutoScribe system - `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 - `String clinicId` UUID of the clinic this invitation belongs to - `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("Physician Assistant")` - `NURSE_PRACTITIONER("Nurse Practitioner")` - `REGISTERED_NURSE("Registered Nurse")` - `PATIENT_CARE_COORDINATOR("Patient Care Coordinator")` - `FRONT_DESK_OPERATOR("Front Desk Operator")` - `IMAGING_TECHNOLOGIST("Imaging Technologist")` - `PACS_ADMINISTRATOR("PACS Administrator")` - `SOFTWARE_ENGINEER("Software Engineer")` - `REVENUE_CYCLE_MANAGER("Revenue Cycle Manager")` - `ADMINISTRATIVE_DIRECTOR("Administrative Director")` - `ADMINISTRATIVE_ASSISTANT("Administrative Assistant")` - `OTHER("Other")` - `Optional createdAt` Timestamp when the invitation was created - `String email` Email address the invitation was sent to - `Optional expiry` When the invitation expires, null if no expiration - `String firstName` Invited user's first name - `boolean hasDashboardAccess` Whether the invited user will have dashboard access - `String invitationId` Unique invitation identifier. Format: inv_{32-hex-chars} - `InvitedSource invitedSource` How the invitation was created - 'dashboard' or 'api' - `DASHBOARD("dashboard")` - `API("api")` - `String inviterId` User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API - `String lastName` Invited user's last name - `Level level` Access level for the invited user. 'admin' or 'member' when created via API - `OWNER("owner")` - `ADMIN("admin")` - `MEMBER("member")` - `Status status` Invitation status: 'sent', 'accepted', 'rejected', or 'revoked' - `SENT("sent")` - `ACCEPTED("accepted")` - `REJECTED("rejected")` - `REVOKED("revoked")` - `Optional updatedAt` Timestamp when the invitation was last updated - `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 - `Optional invitedByApiKeyId` UUID of the API key used to send this invitation. Null if sent via dashboard - `Optional middleName` Invited user's middle name (optional) - `Optional npiNumber` National Provider Identifier - required for users who can create reports (10-digit number) - `Optional phoneNumber` Invited user's phone number (optional) - `Optional suffix1` Name suffix (e.g., 'Jr.', 'MD') - optional - `Optional suffix2` Additional name suffix - optional ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.users.invitations.InvitationRetrieveParams; import com.avara.models.autoscribe.users.invitations.InvitationRetrieveResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); InvitationRetrieveResponse invitation = client.autoScribe().users().invitations().retrieve("inv_1234567890abcdef1234567890abcdef"); } } ``` ## Update `InvitationUpdateResponse autoScribe().users().invitations().update(InvitationUpdateParamsparams = InvitationUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional invitationId` Unique invitation identifier. Format: inv_{32-hex-chars} - `Optional canCreateReports` Whether the invited user can generate and sign radiology reports. Requires NPI number - `Optional canManageStudies` Whether the invited user will have permission to create, update, and manage studies - `Optional clinicRole` - `RADIOLOGIST("Radiologist")` - `CARDIOLOGIST("Cardiologist")` - `NEUROLOGIST("Neurologist")` - `UROLOGIST("Urologist")` - `GYNECOLOGIST("Gynecologist")` - `ENDOCRINOLOGIST("Endocrinologist")` - `DOCTOR("Doctor")` - `SURGEON("Surgeon")` - `PHYSICIAN("Physician")` - `PHYSICIAN_ASSISTANT("Physician Assistant")` - `NURSE_PRACTITIONER("Nurse Practitioner")` - `REGISTERED_NURSE("Registered Nurse")` - `PATIENT_CARE_COORDINATOR("Patient Care Coordinator")` - `FRONT_DESK_OPERATOR("Front Desk Operator")` - `IMAGING_TECHNOLOGIST("Imaging Technologist")` - `PACS_ADMINISTRATOR("PACS Administrator")` - `SOFTWARE_ENGINEER("Software Engineer")` - `REVENUE_CYCLE_MANAGER("Revenue Cycle Manager")` - `ADMINISTRATIVE_DIRECTOR("Administrative Director")` - `ADMINISTRATIVE_ASSISTANT("Administrative Assistant")` - `OTHER("Other")` - `Optional firstName` Invited user's first name - `Optional hasDashboardAccess` Whether the invited user will have dashboard access - `Optional lastName` Invited user's last name - `Optional level` - `ADMIN("admin")` - `MEMBER("member")` - `Optional middleName` - `Optional npiNumber` - `Optional phoneNumber` - `Optional suffix1` - `Optional suffix2` ### Returns - `class InvitationUpdateResponse:` A pending user invitation in the AutoScribe system - `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 - `String clinicId` UUID of the clinic this invitation belongs to - `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("Physician Assistant")` - `NURSE_PRACTITIONER("Nurse Practitioner")` - `REGISTERED_NURSE("Registered Nurse")` - `PATIENT_CARE_COORDINATOR("Patient Care Coordinator")` - `FRONT_DESK_OPERATOR("Front Desk Operator")` - `IMAGING_TECHNOLOGIST("Imaging Technologist")` - `PACS_ADMINISTRATOR("PACS Administrator")` - `SOFTWARE_ENGINEER("Software Engineer")` - `REVENUE_CYCLE_MANAGER("Revenue Cycle Manager")` - `ADMINISTRATIVE_DIRECTOR("Administrative Director")` - `ADMINISTRATIVE_ASSISTANT("Administrative Assistant")` - `OTHER("Other")` - `Optional createdAt` Timestamp when the invitation was created - `String email` Email address the invitation was sent to - `Optional expiry` When the invitation expires, null if no expiration - `String firstName` Invited user's first name - `boolean hasDashboardAccess` Whether the invited user will have dashboard access - `String invitationId` Unique invitation identifier. Format: inv_{32-hex-chars} - `InvitedSource invitedSource` How the invitation was created - 'dashboard' or 'api' - `DASHBOARD("dashboard")` - `API("api")` - `String inviterId` User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API - `String lastName` Invited user's last name - `Level level` Access level for the invited user. 'admin' or 'member' when created via API - `OWNER("owner")` - `ADMIN("admin")` - `MEMBER("member")` - `Status status` Invitation status: 'sent', 'accepted', 'rejected', or 'revoked' - `SENT("sent")` - `ACCEPTED("accepted")` - `REJECTED("rejected")` - `REVOKED("revoked")` - `Optional updatedAt` Timestamp when the invitation was last updated - `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 - `Optional invitedByApiKeyId` UUID of the API key used to send this invitation. Null if sent via dashboard - `Optional middleName` Invited user's middle name (optional) - `Optional npiNumber` National Provider Identifier - required for users who can create reports (10-digit number) - `Optional phoneNumber` Invited user's phone number (optional) - `Optional suffix1` Name suffix (e.g., 'Jr.', 'MD') - optional - `Optional suffix2` Additional name suffix - optional ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.users.invitations.InvitationUpdateParams; import com.avara.models.autoscribe.users.invitations.InvitationUpdateResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); InvitationUpdateResponse invitation = client.autoScribe().users().invitations().update("inv_1234567890abcdef1234567890abcdef"); } } ``` ## Revoke `InvitationRevokeResponse autoScribe().users().invitations().revoke(InvitationRevokeParamsparams = InvitationRevokeParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional invitationId` Invitation ID to revoke. Format: inv_{32-hex-chars} - `Optional userId` User ID whose pending invitation to revoke. Format: usr_{32-hex-chars} ### Returns - `class InvitationRevokeResponse:` Response for revoking an invitation in AutoScribe - `boolean success` - `Optional message` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.users.invitations.InvitationRevokeParams; import com.avara.models.autoscribe.users.invitations.InvitationRevokeResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); InvitationRevokeResponse response = client.autoScribe().users().invitations().revoke(); } } ``` # Reports ## List `ReportListResponse autoScribe().reports().list(ReportListParamsparams = ReportListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional studyId` Unique study identifier. Format: stu_{32-hex-chars} - `Optional 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 - `List reports` Array of report objects with full details - `Optional createdAt` Timestamp when the report was created - `boolean isAddendum` Whether this report is an addendum to a previous report - `String reportId` Unique report identifier. Format: rep_{32-hex-chars} - `Optional signedAt` Timestamp when the report was signed, null if not yet signed - `StudyReportMetadata snapshotMetadata` Patient demographics and scan information for report generation - `Optional age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `double value` - `Status status` Report status: 'in_progress' or 'completed' - `IN_PROGRESS("in_progress")` - `COMPLETED("completed")` - `String studyId` Study ID this report belongs to. Format: stu_{32-hex-chars} - `Optional updatedAt` Timestamp when the report was last updated - `String userId` User ID of the radiologist who created/signed this report. Format: usr_{32-hex-chars} - `Optional reportPlainText` Plain text content of the report - `String studyId` Study ID the reports belong to. Format: stu_{32-hex-chars} - `String studyInstanceUid` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.reports.ReportListParams; import com.avara.models.autoscribe.reports.ReportListResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); ReportListResponse reports = client.autoScribe().reports().list(); } } ``` ## Text `ReportTextResponse autoScribe().reports().text(ReportTextParamsparams = ReportTextParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional reportId` Unique report identifier. Format: rep_{32-hex-chars} - `Optional studyId` Unique study identifier. Format: stu_{32-hex-chars} - `Optional 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` - `String reportId` Unique report identifier. Format: rep_{32-hex-chars} - `StudyReportMetadata snapshotMetadata` Patient demographics and scan information for report generation - `Optional age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `double value` - `String studyId` Study ID this report belongs to. Format: stu_{32-hex-chars} - `String studyInstanceUid` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `Optional plainText` Plain text content of the report - `ListReportsTextResponse` - `List reports` Array of report text items - `String reportId` Unique report identifier. Format: rep_{32-hex-chars} - `StudyReportMetadata snapshotMetadata` Patient demographics and scan information for report generation - `Optional age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `double value` - `String studyId` Study ID this report belongs to. Format: stu_{32-hex-chars} - `String studyInstanceUid` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `Optional plainText` Plain text content of the report - `String studyId` Study ID the reports belong to. Format: stu_{32-hex-chars} - `String studyInstanceUid` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.reports.ReportTextParams; import com.avara.models.autoscribe.reports.ReportTextResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); ReportTextResponse response = client.autoScribe().reports().text(); } } ``` ## Pdf `ReportPdfResponse autoScribe().reports().pdf(ReportPdfParamsparams = ReportPdfParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional reportId` Unique report identifier. Format: rep_{32-hex-chars} - `Optional studyId` Unique study identifier. Format: stu_{32-hex-chars} - `Optional 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` - `String presignedUrl` Time-limited presigned URL to download the PDF (expires after 1 hour) - `String reportId` Unique report identifier. Format: rep_{32-hex-chars} - `StudyReportMetadata snapshotMetadata` Patient demographics and scan information for report generation - `Optional age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `double value` - `String studyId` Study ID this report belongs to. Format: stu_{32-hex-chars} - `String studyInstanceUid` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `ListReportsPdfResponse` - `List reports` Array of report PDF items with download URLs - `String presignedUrl` Time-limited presigned URL to download the PDF (expires after 1 hour) - `String reportId` Unique report identifier. Format: rep_{32-hex-chars} - `StudyReportMetadata snapshotMetadata` Patient demographics and scan information for report generation - `Optional age` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `Optional dateOfBirth` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `Optional facilityName` Name of the medical facility where the scan was performed - `Optional height` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `Unit unit` - `IN("in")` - `CM("cm")` - `double value` - `Optional mrn` Medical Record Number - unique patient identifier - `Optional patientName` Full name of the patient - `Optional referringPhysicianName` Name of the physician who referred the patient for this scan - `Optional scanDate` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `Optional scanTime` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `Optional scanType` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `Optional sex` Patient's biological sex. Options: 'male', 'female', 'other' - `MALE("male")` - `FEMALE("female")` - `OTHER("other")` - `Optional weight` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `Unit unit` - `LBS("lbs")` - `KG("kg")` - `double value` - `String studyId` Study ID this report belongs to. Format: stu_{32-hex-chars} - `String studyInstanceUid` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `String studyId` Study ID the reports belong to. Format: stu_{32-hex-chars} - `String studyInstanceUid` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.reports.ReportPdfParams; import com.avara.models.autoscribe.reports.ReportPdfResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); ReportPdfResponse response = client.autoScribe().reports().pdf(); } } ``` ## Addendum `ReportAddendumResponse autoScribe().reports().addendum(ReportAddendumParamsparams = ReportAddendumParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional reportId` Unique report identifier. Format: rep_{32-hex-chars} ### Returns - `class ReportAddendumResponse:` Response for creating a report addendum - `boolean success` - `Optional message` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.reports.ReportAddendumParams; import com.avara.models.autoscribe.reports.ReportAddendumResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); ReportAddendumResponse response = client.autoScribe().reports().addendum("rep_1234567890abcdef1234567890abcdef"); } } ``` ## Cancel Addendum `ReportCancelAddendumResponse autoScribe().reports().cancelAddendum(ReportCancelAddendumParamsparams = ReportCancelAddendumParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 params` - `Optional reportId` Unique report identifier. Format: rep_{32-hex-chars} ### Returns - `class ReportCancelAddendumResponse:` Response for cancelling a report addendum - `boolean success` - `Optional message` ### Example ```java package com.avara.example; import com.avara.client.AvaraClient; import com.avara.client.okhttp.AvaraOkHttpClient; import com.avara.models.autoscribe.reports.ReportCancelAddendumParams; import com.avara.models.autoscribe.reports.ReportCancelAddendumResponse; public final class Main { private Main() {} public static void main(String[] args) { AvaraClient client = AvaraOkHttpClient.fromEnv(); ReportCancelAddendumResponse response = client.autoScribe().reports().cancelAddendum("rep_1234567890abcdef1234567890abcdef"); } } ```