# Auto Scribe ## Domain Types ### Study Report Metadata - `StudyReportMetadata = object { age, dateOfBirth, facilityName, 9 more }` Patient demographics and scan information for report generation - `age: optional string` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `dateOfBirth: optional string` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `facilityName: optional string` Name of the medical facility where the scan was performed - `height: optional object { unit, value }` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `unit: "in" or "cm"` - `"in"` - `"cm"` - `value: number` - `mrn: optional string` Medical Record Number - unique patient identifier - `patientName: optional string` Full name of the patient - `referringPhysicianName: optional string` Name of the physician who referred the patient for this scan - `scanDate: optional string` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `scanTime: optional string` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `scanType: optional string` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `sex: optional "male" or "female" or "other"` Patient's biological sex. Options: 'male', 'female', 'other' - `"male"` - `"female"` - `"other"` - `weight: optional object { unit, value }` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `unit: "lbs" or "kg"` - `"lbs"` - `"kg"` - `value: number` # Studies ## Create **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. ### Body Parameters - `reportMetadata: StudyReportMetadata` Patient demographics and scan information for report generation - `age: optional string` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `dateOfBirth: optional string` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `facilityName: optional string` Name of the medical facility where the scan was performed - `height: optional object { unit, value }` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `unit: "in" or "cm"` - `"in"` - `"cm"` - `value: number` - `mrn: optional string` Medical Record Number - unique patient identifier - `patientName: optional string` Full name of the patient - `referringPhysicianName: optional string` Name of the physician who referred the patient for this scan - `scanDate: optional string` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `scanTime: optional string` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `scanType: optional string` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `sex: optional "male" or "female" or "other"` Patient's biological sex. Options: 'male', 'female', 'other' - `"male"` - `"female"` - `"other"` - `weight: optional object { unit, value }` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `unit: "lbs" or "kg"` - `"lbs"` - `"kg"` - `value: number` - `severity: "normal" or "high" or "stat"` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"` - `"high"` - `"stat"` - `studyDescription: string` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `studyInstanceUid: string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `assignedTo: optional string` User ID to assign the study to. Format: usr_{32-hex-chars} - `expressCustomerId: optional string` Express customer ID for the study. Format: cus_{32-hex-chars} - `metadata: optional map[string]` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `priorReportTexts: optional array of string` - `priorStudyIds: optional array of string` ### Returns - `cancelledAt: string` Timestamp when the study was cancelled, null if not cancelled - `createdAt: string` Timestamp when the study was created - `isCancelled: boolean` Whether the study has been cancelled - `reportMetadata: StudyReportMetadata` Patient demographics and scan information for report generation - `age: optional string` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `dateOfBirth: optional string` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `facilityName: optional string` Name of the medical facility where the scan was performed - `height: optional object { unit, value }` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `unit: "in" or "cm"` - `"in"` - `"cm"` - `value: number` - `mrn: optional string` Medical Record Number - unique patient identifier - `patientName: optional string` Full name of the patient - `referringPhysicianName: optional string` Name of the physician who referred the patient for this scan - `scanDate: optional string` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `scanTime: optional string` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `scanType: optional string` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `sex: optional "male" or "female" or "other"` Patient's biological sex. Options: 'male', 'female', 'other' - `"male"` - `"female"` - `"other"` - `weight: optional object { unit, value }` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `unit: "lbs" or "kg"` - `"lbs"` - `"kg"` - `value: number` - `severity: "normal" or "high" or "stat"` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"` - `"high"` - `"stat"` - `studyDescription: string` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `studyId: string` Unique study identifier. Format: stu_{32-hex-chars} - `studyInstanceUid: string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `studyReportStatus: "unassigned" or "assigned" or "in_progress" or 2 more` 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"` - `"assigned"` - `"in_progress"` - `"completed"` - `"addendum_active"` - `updatedAt: string` Timestamp when the study was last updated - `assignedTo: optional object { email, userId, firstName, 4 more }` Reference to the assigned radiologist, null if unassigned - `email: string` User's email address - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `firstName: optional string` User's first name - `lastName: optional string` User's last name - `middleName: optional string` User's middle name - `suffix1: optional string` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: optional string` Additional name suffix - `createdByApiKey: optional object { apiKeyId, description, isViewerEnabled }` Reference to the API key used to create this study - `apiKeyId: string` Unique API key identifier (UUIDv4 format) - `description: string` Human-readable description of the API key - `isViewerEnabled: optional boolean` Whether this API key has access to the Viewer product - `createdByUser: optional object { email, userId, firstName, 4 more }` Reference to the user who created this study via dashboard - `email: string` User's email address - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `firstName: optional string` User's first name - `lastName: optional string` User's last name - `middleName: optional string` User's middle name - `suffix1: optional string` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: optional string` Additional name suffix - `expressCustomer: optional object { expressCustomerId, expressCustomerName }` Reference to the Express customer this study belongs to - `expressCustomerId: string` Unique Express customer identifier. Format: cus_{32-hex-chars} - `expressCustomerName: string` Name of the Express customer - `metadata: optional map[string]` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `priorReportTexts: optional array of string` Array of prior report texts to provide clinical context - `priorStudyIds: optional array of string` Array of prior study IDs for comparison context (format: stu_{32-hex-chars}) - `reportIds: optional array of ReportIDWithStatus` Array of report IDs associated with this study, including addendums - `reportId: string` Unique report identifier. Format: rep_{32-hex-chars} - `status: "in_progress" or "completed"` Current status of the report - `"in_progress"` - `"completed"` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/studies \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $AVARA_API_KEY" \ -d '{ "reportMetadata": { "dateOfBirth": "1985-07-20", "facilityName": "City Medical Center", "height": { "unit": "cm", "value": 165 }, "mrn": "MRN-2024-001234", "patientName": "Jane Doe", "referringPhysicianName": "Dr. Michael Chen", "scanDate": "2024-03-15", "scanType": "MRI Brain with Contrast", "sex": "female", "weight": { "unit": "kg", "value": 62 } }, "severity": "normal", "studyDescription": "Brain MRI with Contrast", "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123", "assignedTo": "usr_1234567890abcdef1234567890abcdef", "expressCustomerId": "cus_1234567890abcdef1234567890abcdef", "metadata": { "department": "radiology", "priority": "routine" } }' ``` ## List **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. ### Query Parameters - `assignedTo: optional string` Filter by assigned user ID (null = explicitly unassigned). Format: usr_<32-hex-chars> - `cursor: optional string` Base64 encoded cursor from previous response - `expressCustomerId: optional string` Filter by Express customer ID (null = studies with no customer). Format: cus_{32-hex-chars} - `isCancelled: optional boolean` Filter by cancellation status - `limit: optional number` Number of results to return (1-100) - `severity: optional "normal" or "high" or "stat"` Filter by study severity - `"normal"` - `"high"` - `"stat"` - `studyDescription: optional string` Filter by study description (contains match) - `studyReportStatus: optional array of "unassigned" or "assigned" or "in_progress" or 2 more` Filter by report status(es) - `"unassigned"` - `"assigned"` - `"in_progress"` - `"completed"` - `"addendum_active"` ### Returns - `hasMore: boolean` - `studies: array of object { cancelledAt, createdAt, isCancelled, 15 more }` - `cancelledAt: string` Timestamp when the study was cancelled, null if not cancelled - `createdAt: string` Timestamp when the study was created - `isCancelled: boolean` Whether the study has been cancelled - `reportMetadata: StudyReportMetadata` Patient demographics and scan information for report generation - `age: optional string` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `dateOfBirth: optional string` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `facilityName: optional string` Name of the medical facility where the scan was performed - `height: optional object { unit, value }` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `unit: "in" or "cm"` - `"in"` - `"cm"` - `value: number` - `mrn: optional string` Medical Record Number - unique patient identifier - `patientName: optional string` Full name of the patient - `referringPhysicianName: optional string` Name of the physician who referred the patient for this scan - `scanDate: optional string` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `scanTime: optional string` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `scanType: optional string` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `sex: optional "male" or "female" or "other"` Patient's biological sex. Options: 'male', 'female', 'other' - `"male"` - `"female"` - `"other"` - `weight: optional object { unit, value }` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `unit: "lbs" or "kg"` - `"lbs"` - `"kg"` - `value: number` - `severity: "normal" or "high" or "stat"` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"` - `"high"` - `"stat"` - `studyDescription: string` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `studyId: string` Unique study identifier. Format: stu_{32-hex-chars} - `studyInstanceUid: string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `studyReportStatus: "unassigned" or "assigned" or "in_progress" or 2 more` 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"` - `"assigned"` - `"in_progress"` - `"completed"` - `"addendum_active"` - `updatedAt: string` Timestamp when the study was last updated - `assignedTo: optional object { email, userId, firstName, 4 more }` Reference to the assigned radiologist, null if unassigned - `email: string` User's email address - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `firstName: optional string` User's first name - `lastName: optional string` User's last name - `middleName: optional string` User's middle name - `suffix1: optional string` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: optional string` Additional name suffix - `createdByApiKey: optional object { apiKeyId, description, isViewerEnabled }` Reference to the API key used to create this study - `apiKeyId: string` Unique API key identifier (UUIDv4 format) - `description: string` Human-readable description of the API key - `isViewerEnabled: optional boolean` Whether this API key has access to the Viewer product - `createdByUser: optional object { email, userId, firstName, 4 more }` Reference to the user who created this study via dashboard - `email: string` User's email address - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `firstName: optional string` User's first name - `lastName: optional string` User's last name - `middleName: optional string` User's middle name - `suffix1: optional string` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: optional string` Additional name suffix - `expressCustomer: optional object { expressCustomerId, expressCustomerName }` Reference to the Express customer this study belongs to - `expressCustomerId: string` Unique Express customer identifier. Format: cus_{32-hex-chars} - `expressCustomerName: string` Name of the Express customer - `metadata: optional map[string]` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `priorReportTexts: optional array of string` Array of prior report texts to provide clinical context - `priorStudyIds: optional array of string` Array of prior study IDs for comparison context (format: stu_{32-hex-chars}) - `reportIds: optional array of ReportIDWithStatus` Array of report IDs associated with this study, including addendums - `reportId: string` Unique report identifier. Format: rep_{32-hex-chars} - `status: "in_progress" or "completed"` Current status of the report - `"in_progress"` - `"completed"` - `cursor: optional string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/studies \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Retrieve **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. ### Path Parameters - `studyId: string` Unique study identifier. Format: stu_{32-hex-chars} ### Returns - `cancelledAt: string` Timestamp when the study was cancelled, null if not cancelled - `createdAt: string` Timestamp when the study was created - `isCancelled: boolean` Whether the study has been cancelled - `reportMetadata: StudyReportMetadata` Patient demographics and scan information for report generation - `age: optional string` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `dateOfBirth: optional string` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `facilityName: optional string` Name of the medical facility where the scan was performed - `height: optional object { unit, value }` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `unit: "in" or "cm"` - `"in"` - `"cm"` - `value: number` - `mrn: optional string` Medical Record Number - unique patient identifier - `patientName: optional string` Full name of the patient - `referringPhysicianName: optional string` Name of the physician who referred the patient for this scan - `scanDate: optional string` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `scanTime: optional string` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `scanType: optional string` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `sex: optional "male" or "female" or "other"` Patient's biological sex. Options: 'male', 'female', 'other' - `"male"` - `"female"` - `"other"` - `weight: optional object { unit, value }` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `unit: "lbs" or "kg"` - `"lbs"` - `"kg"` - `value: number` - `severity: "normal" or "high" or "stat"` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"` - `"high"` - `"stat"` - `studyDescription: string` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `studyId: string` Unique study identifier. Format: stu_{32-hex-chars} - `studyInstanceUid: string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `studyReportStatus: "unassigned" or "assigned" or "in_progress" or 2 more` 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"` - `"assigned"` - `"in_progress"` - `"completed"` - `"addendum_active"` - `updatedAt: string` Timestamp when the study was last updated - `assignedTo: optional object { email, userId, firstName, 4 more }` Reference to the assigned radiologist, null if unassigned - `email: string` User's email address - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `firstName: optional string` User's first name - `lastName: optional string` User's last name - `middleName: optional string` User's middle name - `suffix1: optional string` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: optional string` Additional name suffix - `createdByApiKey: optional object { apiKeyId, description, isViewerEnabled }` Reference to the API key used to create this study - `apiKeyId: string` Unique API key identifier (UUIDv4 format) - `description: string` Human-readable description of the API key - `isViewerEnabled: optional boolean` Whether this API key has access to the Viewer product - `createdByUser: optional object { email, userId, firstName, 4 more }` Reference to the user who created this study via dashboard - `email: string` User's email address - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `firstName: optional string` User's first name - `lastName: optional string` User's last name - `middleName: optional string` User's middle name - `suffix1: optional string` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: optional string` Additional name suffix - `expressCustomer: optional object { expressCustomerId, expressCustomerName }` Reference to the Express customer this study belongs to - `expressCustomerId: string` Unique Express customer identifier. Format: cus_{32-hex-chars} - `expressCustomerName: string` Name of the Express customer - `metadata: optional map[string]` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `priorReportTexts: optional array of string` Array of prior report texts to provide clinical context - `priorStudyIds: optional array of string` Array of prior study IDs for comparison context (format: stu_{32-hex-chars}) - `reportIds: optional array of ReportIDWithStatus` Array of report IDs associated with this study, including addendums - `reportId: string` Unique report identifier. Format: rep_{32-hex-chars} - `status: "in_progress" or "completed"` Current status of the report - `"in_progress"` - `"completed"` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/studies/$STUDY_ID \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Update **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. ### Path Parameters - `studyId: string` Unique study identifier. Format: stu_{32-hex-chars} ### Body Parameters - `assignedTo: optional string` User ID to assign the study to, or null to unassign. Format: usr_{32-hex-chars} - `expressCustomerId: optional string` Express Customer ID for the study, or null to remove. Format: cus_{32-hex-chars} - `metadata: optional map[string]` - `priorReportTexts: optional array of string` - `priorStudyIds: optional array of string` - `reportMetadata: optional object { age, dateOfBirth, facilityName, 9 more }` - `age: optional string` - `dateOfBirth: optional string` - `facilityName: optional string` - `height: optional object { unit, value }` - `unit: "in" or "cm"` - `"in"` - `"cm"` - `value: number` - `mrn: optional string` - `patientName: optional string` - `referringPhysicianName: optional string` - `scanDate: optional string` - `scanTime: optional string` - `scanType: optional string` - `sex: optional "male" or "female" or "other"` - `"male"` - `"female"` - `"other"` - `weight: optional object { unit, value }` - `unit: "lbs" or "kg"` - `"lbs"` - `"kg"` - `value: number` - `severity: optional "normal" or "high" or "stat"` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"` - `"high"` - `"stat"` - `studyDescription: optional string` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') ### Returns - `cancelledAt: string` Timestamp when the study was cancelled, null if not cancelled - `createdAt: string` Timestamp when the study was created - `isCancelled: boolean` Whether the study has been cancelled - `reportMetadata: StudyReportMetadata` Patient demographics and scan information for report generation - `age: optional string` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `dateOfBirth: optional string` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `facilityName: optional string` Name of the medical facility where the scan was performed - `height: optional object { unit, value }` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `unit: "in" or "cm"` - `"in"` - `"cm"` - `value: number` - `mrn: optional string` Medical Record Number - unique patient identifier - `patientName: optional string` Full name of the patient - `referringPhysicianName: optional string` Name of the physician who referred the patient for this scan - `scanDate: optional string` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `scanTime: optional string` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `scanType: optional string` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `sex: optional "male" or "female" or "other"` Patient's biological sex. Options: 'male', 'female', 'other' - `"male"` - `"female"` - `"other"` - `weight: optional object { unit, value }` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `unit: "lbs" or "kg"` - `"lbs"` - `"kg"` - `value: number` - `severity: "normal" or "high" or "stat"` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"` - `"high"` - `"stat"` - `studyDescription: string` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `studyId: string` Unique study identifier. Format: stu_{32-hex-chars} - `studyInstanceUid: string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `studyReportStatus: "unassigned" or "assigned" or "in_progress" or 2 more` 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"` - `"assigned"` - `"in_progress"` - `"completed"` - `"addendum_active"` - `updatedAt: string` Timestamp when the study was last updated - `assignedTo: optional object { email, userId, firstName, 4 more }` Reference to the assigned radiologist, null if unassigned - `email: string` User's email address - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `firstName: optional string` User's first name - `lastName: optional string` User's last name - `middleName: optional string` User's middle name - `suffix1: optional string` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: optional string` Additional name suffix - `createdByApiKey: optional object { apiKeyId, description, isViewerEnabled }` Reference to the API key used to create this study - `apiKeyId: string` Unique API key identifier (UUIDv4 format) - `description: string` Human-readable description of the API key - `isViewerEnabled: optional boolean` Whether this API key has access to the Viewer product - `createdByUser: optional object { email, userId, firstName, 4 more }` Reference to the user who created this study via dashboard - `email: string` User's email address - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `firstName: optional string` User's first name - `lastName: optional string` User's last name - `middleName: optional string` User's middle name - `suffix1: optional string` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: optional string` Additional name suffix - `expressCustomer: optional object { expressCustomerId, expressCustomerName }` Reference to the Express customer this study belongs to - `expressCustomerId: string` Unique Express customer identifier. Format: cus_{32-hex-chars} - `expressCustomerName: string` Name of the Express customer - `metadata: optional map[string]` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `priorReportTexts: optional array of string` Array of prior report texts to provide clinical context - `priorStudyIds: optional array of string` Array of prior study IDs for comparison context (format: stu_{32-hex-chars}) - `reportIds: optional array of ReportIDWithStatus` Array of report IDs associated with this study, including addendums - `reportId: string` Unique report identifier. Format: rep_{32-hex-chars} - `status: "in_progress" or "completed"` Current status of the report - `"in_progress"` - `"completed"` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/studies/$STUDY_ID \ -X PATCH \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Cancel **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. ### Body Parameters - `studyId: optional string` Unique study identifier. Format: stu_{32-hex-chars} - `studyInstanceUid: optional string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') ### Returns - `success: boolean` - `message: optional string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/studies/cancel \ -X POST \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Uncancel **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. ### Body Parameters - `studyId: optional string` Unique study identifier. Format: stu_{32-hex-chars} - `studyInstanceUid: optional string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') ### Returns - `success: boolean` - `message: optional string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/studies/uncancel \ -X POST \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Reroute URL **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. ### Body Parameters - `assignedToUserId: string` User ID to assign study to. Format: usr_{32-hex-chars} - `studyId: optional string` Unique study identifier. Format: stu_{32-hex-chars} - `studyInstanceUid: optional string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') ### Returns - `url: string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/studies/reroute-url \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $AVARA_API_KEY" \ -d '{ "assignedToUserId": "usr_1234567890abcdef1234567890abcdef", "studyId": "stu_1234567890abcdef1234567890abcdef", "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123" }' ``` ## Viewer Only Reroute URL **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. ### Body Parameters - `studyId: optional string` Unique study identifier. Format: stu_{32-hex-chars} - `studyInstanceUid: optional string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `userId: optional string` Optional user ID for audit tracking. Format: usr_{32-hex-chars} ### Returns - `url: string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/studies/viewer-only-reroute-url \ -X POST \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Retrieve By Uid **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. ### Path Parameters - `studyInstanceUid: string` DICOM Study Instance UID. Format: numbers and dots (e.g., 1.2.840.10008.5.1.4.1.1.2). ### Returns - `cancelledAt: string` Timestamp when the study was cancelled, null if not cancelled - `createdAt: string` Timestamp when the study was created - `isCancelled: boolean` Whether the study has been cancelled - `reportMetadata: StudyReportMetadata` Patient demographics and scan information for report generation - `age: optional string` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `dateOfBirth: optional string` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `facilityName: optional string` Name of the medical facility where the scan was performed - `height: optional object { unit, value }` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `unit: "in" or "cm"` - `"in"` - `"cm"` - `value: number` - `mrn: optional string` Medical Record Number - unique patient identifier - `patientName: optional string` Full name of the patient - `referringPhysicianName: optional string` Name of the physician who referred the patient for this scan - `scanDate: optional string` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `scanTime: optional string` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `scanType: optional string` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `sex: optional "male" or "female" or "other"` Patient's biological sex. Options: 'male', 'female', 'other' - `"male"` - `"female"` - `"other"` - `weight: optional object { unit, value }` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `unit: "lbs" or "kg"` - `"lbs"` - `"kg"` - `value: number` - `severity: "normal" or "high" or "stat"` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"` - `"high"` - `"stat"` - `studyDescription: string` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `studyId: string` Unique study identifier. Format: stu_{32-hex-chars} - `studyInstanceUid: string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `studyReportStatus: "unassigned" or "assigned" or "in_progress" or 2 more` 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"` - `"assigned"` - `"in_progress"` - `"completed"` - `"addendum_active"` - `updatedAt: string` Timestamp when the study was last updated - `assignedTo: optional object { email, userId, firstName, 4 more }` Reference to the assigned radiologist, null if unassigned - `email: string` User's email address - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `firstName: optional string` User's first name - `lastName: optional string` User's last name - `middleName: optional string` User's middle name - `suffix1: optional string` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: optional string` Additional name suffix - `createdByApiKey: optional object { apiKeyId, description, isViewerEnabled }` Reference to the API key used to create this study - `apiKeyId: string` Unique API key identifier (UUIDv4 format) - `description: string` Human-readable description of the API key - `isViewerEnabled: optional boolean` Whether this API key has access to the Viewer product - `createdByUser: optional object { email, userId, firstName, 4 more }` Reference to the user who created this study via dashboard - `email: string` User's email address - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `firstName: optional string` User's first name - `lastName: optional string` User's last name - `middleName: optional string` User's middle name - `suffix1: optional string` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: optional string` Additional name suffix - `expressCustomer: optional object { expressCustomerId, expressCustomerName }` Reference to the Express customer this study belongs to - `expressCustomerId: string` Unique Express customer identifier. Format: cus_{32-hex-chars} - `expressCustomerName: string` Name of the Express customer - `metadata: optional map[string]` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars - `priorReportTexts: optional array of string` Array of prior report texts to provide clinical context - `priorStudyIds: optional array of string` Array of prior study IDs for comparison context (format: stu_{32-hex-chars}) - `reportIds: optional array of ReportIDWithStatus` Array of report IDs associated with this study, including addendums - `reportId: string` Unique report identifier. Format: rep_{32-hex-chars} - `status: "in_progress" or "completed"` Current status of the report - `"in_progress"` - `"completed"` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/studies/by-uid/$STUDY_INSTANCE_UID \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Domain Types ### Report ID With Status - `ReportIDWithStatus = object { reportId, status }` A report ID paired with its current status - `reportId: string` Unique report identifier. Format: rep_{32-hex-chars} - `status: "in_progress" or "completed"` Current status of the report - `"in_progress"` - `"completed"` # Users ## Invite **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. ### Body Parameters - `canCreateReports: boolean` - `canManageStudies: boolean` - `clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` User's clinical or organizational role - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `email: string` User's email address for login and notifications - `firstName: string` User's first name - `hasDashboardAccess: boolean` - `lastName: string` User's last name - `level: "admin" or "member"` - `"admin"` - `"member"` - `middleName: optional string` User's middle name (optional) - `npiNumber: optional string` - `phoneNumber: optional string` User's phone number (10-15 digits, optional) - `suffix1: optional string` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `suffix2: optional string` Additional name suffix (optional) ### Returns - `canCreateReports: boolean` Whether the user can generate and sign radiology reports. Requires NPI number - `canManageStudies: boolean` Whether the user has permission to create, update, and manage studies - `clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` User's clinical or organizational role - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `createdAt: string` Timestamp when the user was created - `email: string` User's email address for login and notifications - `firstName: string` User's first name - `hasDashboardAccess: boolean` Whether the user can access the dashboard interface. Required for admin users - `invitedSource: "dashboard" or "api"` How the user was invited - via dashboard UI or API - `"dashboard"` - `"api"` - `lastLoginAt: string` Timestamp of user's last login, null if never logged in - `lastName: string` User's last name - `level: "admin" or "member"` User access level. 'admin' can manage users/settings, 'member' has standard access - `"admin"` - `"member"` - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `middleName: optional string` User's middle name (optional) - `npiNumber: optional string` National Provider Identifier - required for users who can create reports (10-digit number) - `phoneNumber: optional string` User's phone number (10-15 digits, optional) - `suffix1: optional string` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `suffix2: optional string` Additional name suffix (optional) ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $AVARA_API_KEY" \ -d '{ "canCreateReports": true, "canManageStudies": true, "clinicRole": "Radiologist", "email": "dr.johnson@hospital.org", "firstName": "Sarah", "hasDashboardAccess": true, "lastName": "Johnson", "level": "member", "middleName": "Marie", "npiNumber": "1234567893", "phoneNumber": "5551234567", "suffix1": "MD", "suffix2": "FACR" }' ``` ## List **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. ### Query Parameters - `canCreateReports: optional boolean` Filter by canCreateReports permission (AutoScribe-specific) - `cursor: optional string` Base64 encoded cursor from previous response - `email: optional string` Filter by exact email match - `firstName: optional string` Filter by first name (contains match) - `invitedSource: optional "dashboard" or "api"` Filter by invitation source - `"dashboard"` - `"api"` - `lastName: optional string` Filter by last name (contains match) - `level: optional "owner" or "admin" or "member"` Filter by user level - `"owner"` - `"admin"` - `"member"` - `limit: optional number` Number of results to return (1-100) ### Returns - `hasMore: boolean` - `users: array of object { canCreateReports, canManageStudies, clinicRole, 14 more }` - `canCreateReports: boolean` Whether the user can generate and sign radiology reports. Requires NPI number - `canManageStudies: boolean` Whether the user has permission to create, update, and manage studies - `clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` User's clinical or organizational role - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `createdAt: string` Timestamp when the user was created - `email: string` User's email address for login and notifications - `firstName: string` User's first name - `hasDashboardAccess: boolean` Whether the user can access the dashboard interface. Required for admin users - `invitedSource: "dashboard" or "api"` How the user was invited - via dashboard UI or API - `"dashboard"` - `"api"` - `lastLoginAt: string` Timestamp of user's last login, null if never logged in - `lastName: string` User's last name - `level: "owner" or "admin" or "member"` User access level. 'owner' has full control, 'admin' can manage users/settings, 'member' has standard access - `"owner"` - `"admin"` - `"member"` - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `middleName: optional string` User's middle name (optional) - `npiNumber: optional string` National Provider Identifier - required for users who can create reports (10-digit number) - `phoneNumber: optional string` User's phone number (10-15 digits, optional) - `suffix1: optional string` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `suffix2: optional string` Additional name suffix (optional) - `cursor: optional string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Retrieve **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. ### Path Parameters - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} ### Returns - `canCreateReports: boolean` Whether the user can generate and sign radiology reports. Requires NPI number - `canManageStudies: boolean` Whether the user has permission to create, update, and manage studies - `clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` User's clinical or organizational role - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `createdAt: string` Timestamp when the user was created - `email: string` User's email address for login and notifications - `firstName: string` User's first name - `hasDashboardAccess: boolean` Whether the user can access the dashboard interface. Required for admin users - `invitedSource: "dashboard" or "api"` How the user was invited - via dashboard UI or API - `"dashboard"` - `"api"` - `lastLoginAt: string` Timestamp of user's last login, null if never logged in - `lastName: string` User's last name - `level: "owner" or "admin" or "member"` User access level. 'owner' has full control, 'admin' can manage users/settings, 'member' has standard access - `"owner"` - `"admin"` - `"member"` - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `middleName: optional string` User's middle name (optional) - `npiNumber: optional string` National Provider Identifier - required for users who can create reports (10-digit number) - `phoneNumber: optional string` User's phone number (10-15 digits, optional) - `suffix1: optional string` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `suffix2: optional string` Additional name suffix (optional) ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users/$USER_ID \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Update **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. ### Path Parameters - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} ### Body Parameters - `canCreateReports: optional boolean` - `canManageStudies: optional boolean` - `clinicRole: optional "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `firstName: optional string` User's first name - `hasDashboardAccess: optional boolean` Whether the user can access the dashboard interface. Required for admin users - `lastName: optional string` User's last name - `level: optional "admin" or "member"` - `"admin"` - `"member"` - `middleName: optional string` - `npiNumber: optional string` - `phoneNumber: optional string` - `suffix1: optional string` - `suffix2: optional string` ### Returns - `canCreateReports: boolean` Whether the user can generate and sign radiology reports. Requires NPI number - `canManageStudies: boolean` Whether the user has permission to create, update, and manage studies - `clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` User's clinical or organizational role - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `createdAt: string` Timestamp when the user was created - `email: string` User's email address for login and notifications - `firstName: string` User's first name - `hasDashboardAccess: boolean` Whether the user can access the dashboard interface. Required for admin users - `invitedSource: "dashboard" or "api"` How the user was invited - via dashboard UI or API - `"dashboard"` - `"api"` - `lastLoginAt: string` Timestamp of user's last login, null if never logged in - `lastName: string` User's last name - `level: "owner" or "admin" or "member"` User access level. 'owner' has full control, 'admin' can manage users/settings, 'member' has standard access - `"owner"` - `"admin"` - `"member"` - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `middleName: optional string` User's middle name (optional) - `npiNumber: optional string` National Provider Identifier - required for users who can create reports (10-digit number) - `phoneNumber: optional string` User's phone number (10-15 digits, optional) - `suffix1: optional string` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `suffix2: optional string` Additional name suffix (optional) ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users/$USER_ID \ -X PATCH \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Revoke Access **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. ### Body Parameters - `userId: string` User ID to revoke access for. Format: usr_{32-hex-chars} ### Returns - `success: boolean` - `message: optional string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users/revoke-access \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $AVARA_API_KEY" \ -d '{ "userId": "usr_1234567890abcdef1234567890abcdef" }' ``` ## Reactivate **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. ### Body Parameters - `userId: string` User ID to reactivate. Format: usr_{32-hex-chars} ### Returns - `success: boolean` - `message: optional string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users/reactivate \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $AVARA_API_KEY" \ -d '{ "userId": "usr_1234567890abcdef1234567890abcdef" }' ``` # Invitations ## List **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. ### Query Parameters - `cursor: optional string` Base64 encoded cursor from previous response - `endDate: optional string` Filter invitations created on or before this date (YYYY-MM-DD) - `expired: optional "all" or "expired" or "not-expired"` Filter by expiration status - `"all"` - `"expired"` - `"not-expired"` - `limit: optional number` Number of results to return (1-100) - `startDate: optional string` Filter invitations created on or after this date (YYYY-MM-DD) - `status: optional array of "sent" or "accepted" or "rejected" or "revoked"` Filter by invitation status(es) - `"sent"` - `"accepted"` - `"rejected"` - `"revoked"` - `userId: optional string` Filter by user ID. Format: usr_{32-hex-chars} ### Returns - `hasMore: boolean` - `invitations: array of object { canCreateReports, canManageStudies, clinicId, 20 more }` - `canCreateReports: boolean` Whether the invited user can generate and sign radiology reports. Requires NPI number - `canManageStudies: boolean` Whether the invited user will have permission to create, update, and manage studies - `clinicId: string` UUID of the clinic this invitation belongs to - `clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` Clinical or organizational role for the invited user - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `createdAt: string` Timestamp when the invitation was created - `email: string` Email address the invitation was sent to - `expiry: string` When the invitation expires, null if no expiration - `firstName: string` Invited user's first name - `hasDashboardAccess: boolean` Whether the invited user will have dashboard access - `invitationId: string` Unique invitation identifier. Format: inv_{32-hex-chars} - `invitedSource: "dashboard" or "api"` How the invitation was created - 'dashboard' or 'api' - `"dashboard"` - `"api"` - `inviterId: string` User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API - `lastName: string` Invited user's last name - `level: "owner" or "admin" or "member"` Access level for the invited user. 'admin' or 'member' when created via API - `"owner"` - `"admin"` - `"member"` - `status: "sent" or "accepted" or "rejected" or "revoked"` Invitation status: 'sent', 'accepted', 'rejected', or 'revoked' - `"sent"` - `"accepted"` - `"rejected"` - `"revoked"` - `updatedAt: string` Timestamp when the invitation was last updated - `userId: string` 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 - `invitedByApiKeyId: optional string` UUID of the API key used to send this invitation. Null if sent via dashboard - `middleName: optional string` Invited user's middle name (optional) - `npiNumber: optional string` National Provider Identifier - required for users who can create reports (10-digit number) - `phoneNumber: optional string` Invited user's phone number (optional) - `suffix1: optional string` Name suffix (e.g., 'Jr.', 'MD') - optional - `suffix2: optional string` Additional name suffix - optional - `cursor: optional string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users/invitations \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Retrieve **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. ### Path Parameters - `invitationId: string` Unique invitation identifier. Format: inv_{32-hex-chars} ### Returns - `canCreateReports: boolean` Whether the invited user can generate and sign radiology reports. Requires NPI number - `canManageStudies: boolean` Whether the invited user will have permission to create, update, and manage studies - `clinicId: string` UUID of the clinic this invitation belongs to - `clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` Clinical or organizational role for the invited user - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `createdAt: string` Timestamp when the invitation was created - `email: string` Email address the invitation was sent to - `expiry: string` When the invitation expires, null if no expiration - `firstName: string` Invited user's first name - `hasDashboardAccess: boolean` Whether the invited user will have dashboard access - `invitationId: string` Unique invitation identifier. Format: inv_{32-hex-chars} - `invitedSource: "dashboard" or "api"` How the invitation was created - 'dashboard' or 'api' - `"dashboard"` - `"api"` - `inviterId: string` User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API - `lastName: string` Invited user's last name - `level: "owner" or "admin" or "member"` Access level for the invited user. 'admin' or 'member' when created via API - `"owner"` - `"admin"` - `"member"` - `status: "sent" or "accepted" or "rejected" or "revoked"` Invitation status: 'sent', 'accepted', 'rejected', or 'revoked' - `"sent"` - `"accepted"` - `"rejected"` - `"revoked"` - `updatedAt: string` Timestamp when the invitation was last updated - `userId: string` 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 - `invitedByApiKeyId: optional string` UUID of the API key used to send this invitation. Null if sent via dashboard - `middleName: optional string` Invited user's middle name (optional) - `npiNumber: optional string` National Provider Identifier - required for users who can create reports (10-digit number) - `phoneNumber: optional string` Invited user's phone number (optional) - `suffix1: optional string` Name suffix (e.g., 'Jr.', 'MD') - optional - `suffix2: optional string` Additional name suffix - optional ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users/invitations/$INVITATION_ID \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Update **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. ### Path Parameters - `invitationId: string` Unique invitation identifier. Format: inv_{32-hex-chars} ### Body Parameters - `canCreateReports: optional boolean` Whether the invited user can generate and sign radiology reports. Requires NPI number - `canManageStudies: optional boolean` Whether the invited user will have permission to create, update, and manage studies - `clinicRole: optional "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `firstName: optional string` Invited user's first name - `hasDashboardAccess: optional boolean` Whether the invited user will have dashboard access - `lastName: optional string` Invited user's last name - `level: optional "admin" or "member"` - `"admin"` - `"member"` - `middleName: optional string` - `npiNumber: optional string` - `phoneNumber: optional string` - `suffix1: optional string` - `suffix2: optional string` ### Returns - `canCreateReports: boolean` Whether the invited user can generate and sign radiology reports. Requires NPI number - `canManageStudies: boolean` Whether the invited user will have permission to create, update, and manage studies - `clinicId: string` UUID of the clinic this invitation belongs to - `clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` Clinical or organizational role for the invited user - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `createdAt: string` Timestamp when the invitation was created - `email: string` Email address the invitation was sent to - `expiry: string` When the invitation expires, null if no expiration - `firstName: string` Invited user's first name - `hasDashboardAccess: boolean` Whether the invited user will have dashboard access - `invitationId: string` Unique invitation identifier. Format: inv_{32-hex-chars} - `invitedSource: "dashboard" or "api"` How the invitation was created - 'dashboard' or 'api' - `"dashboard"` - `"api"` - `inviterId: string` User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API - `lastName: string` Invited user's last name - `level: "owner" or "admin" or "member"` Access level for the invited user. 'admin' or 'member' when created via API - `"owner"` - `"admin"` - `"member"` - `status: "sent" or "accepted" or "rejected" or "revoked"` Invitation status: 'sent', 'accepted', 'rejected', or 'revoked' - `"sent"` - `"accepted"` - `"rejected"` - `"revoked"` - `updatedAt: string` Timestamp when the invitation was last updated - `userId: string` 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 - `invitedByApiKeyId: optional string` UUID of the API key used to send this invitation. Null if sent via dashboard - `middleName: optional string` Invited user's middle name (optional) - `npiNumber: optional string` National Provider Identifier - required for users who can create reports (10-digit number) - `phoneNumber: optional string` Invited user's phone number (optional) - `suffix1: optional string` Name suffix (e.g., 'Jr.', 'MD') - optional - `suffix2: optional string` Additional name suffix - optional ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users/invitations/$INVITATION_ID \ -X PATCH \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Revoke **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. ### Body Parameters - `invitationId: optional string` Invitation ID to revoke. Format: inv_{32-hex-chars} - `userId: optional string` User ID whose pending invitation to revoke. Format: usr_{32-hex-chars} ### Returns - `success: boolean` - `message: optional string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users/invitations/revoke \ -X POST \ -H "Authorization: Bearer $AVARA_API_KEY" ``` # Reports ## List **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. ### Query Parameters - `studyId: optional string` Unique study identifier. Format: stu_{32-hex-chars} - `studyInstanceUid: optional string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') ### Returns - `reports: array of object { createdAt, isAddendum, reportId, 7 more }` Array of report objects with full details - `createdAt: string` Timestamp when the report was created - `isAddendum: boolean` Whether this report is an addendum to a previous report - `reportId: string` Unique report identifier. Format: rep_{32-hex-chars} - `signedAt: string` Timestamp when the report was signed, null if not yet signed - `snapshotMetadata: StudyReportMetadata` Patient demographics and scan information for report generation - `age: optional string` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `dateOfBirth: optional string` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `facilityName: optional string` Name of the medical facility where the scan was performed - `height: optional object { unit, value }` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `unit: "in" or "cm"` - `"in"` - `"cm"` - `value: number` - `mrn: optional string` Medical Record Number - unique patient identifier - `patientName: optional string` Full name of the patient - `referringPhysicianName: optional string` Name of the physician who referred the patient for this scan - `scanDate: optional string` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `scanTime: optional string` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `scanType: optional string` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `sex: optional "male" or "female" or "other"` Patient's biological sex. Options: 'male', 'female', 'other' - `"male"` - `"female"` - `"other"` - `weight: optional object { unit, value }` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `unit: "lbs" or "kg"` - `"lbs"` - `"kg"` - `value: number` - `status: "in_progress" or "completed"` Report status: 'in_progress' or 'completed' - `"in_progress"` - `"completed"` - `studyId: string` Study ID this report belongs to. Format: stu_{32-hex-chars} - `updatedAt: string` Timestamp when the report was last updated - `userId: string` User ID of the radiologist who created/signed this report. Format: usr_{32-hex-chars} - `reportPlainText: optional string` Plain text content of the report - `studyId: string` Study ID the reports belong to. Format: stu_{32-hex-chars} - `studyInstanceUid: string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/reports \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Text **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. ### Query Parameters - `reportId: optional string` Unique report identifier. Format: rep_{32-hex-chars} - `studyId: optional string` Unique study identifier. Format: stu_{32-hex-chars} - `studyInstanceUid: optional string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') ### Returns - `SingleReportTextResponse = object { reportId, snapshotMetadata, studyId, 2 more }` Response containing a single report with its plain text - `reportId: string` Unique report identifier. Format: rep_{32-hex-chars} - `snapshotMetadata: StudyReportMetadata` Patient demographics and scan information for report generation - `age: optional string` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `dateOfBirth: optional string` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `facilityName: optional string` Name of the medical facility where the scan was performed - `height: optional object { unit, value }` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `unit: "in" or "cm"` - `"in"` - `"cm"` - `value: number` - `mrn: optional string` Medical Record Number - unique patient identifier - `patientName: optional string` Full name of the patient - `referringPhysicianName: optional string` Name of the physician who referred the patient for this scan - `scanDate: optional string` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `scanTime: optional string` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `scanType: optional string` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `sex: optional "male" or "female" or "other"` Patient's biological sex. Options: 'male', 'female', 'other' - `"male"` - `"female"` - `"other"` - `weight: optional object { unit, value }` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `unit: "lbs" or "kg"` - `"lbs"` - `"kg"` - `value: number` - `studyId: string` Study ID this report belongs to. Format: stu_{32-hex-chars} - `studyInstanceUid: string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `plainText: optional string` Plain text content of the report - `ListReportsTextResponse = object { reports, studyId, studyInstanceUid }` Response containing a list of reports with their plain text - `reports: array of object { reportId, snapshotMetadata, studyId, 2 more }` Array of report text items - `reportId: string` Unique report identifier. Format: rep_{32-hex-chars} - `snapshotMetadata: StudyReportMetadata` Patient demographics and scan information for report generation - `age: optional string` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `dateOfBirth: optional string` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `facilityName: optional string` Name of the medical facility where the scan was performed - `height: optional object { unit, value }` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `unit: "in" or "cm"` - `"in"` - `"cm"` - `value: number` - `mrn: optional string` Medical Record Number - unique patient identifier - `patientName: optional string` Full name of the patient - `referringPhysicianName: optional string` Name of the physician who referred the patient for this scan - `scanDate: optional string` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `scanTime: optional string` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `scanType: optional string` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `sex: optional "male" or "female" or "other"` Patient's biological sex. Options: 'male', 'female', 'other' - `"male"` - `"female"` - `"other"` - `weight: optional object { unit, value }` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `unit: "lbs" or "kg"` - `"lbs"` - `"kg"` - `value: number` - `studyId: string` Study ID this report belongs to. Format: stu_{32-hex-chars} - `studyInstanceUid: string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `plainText: optional string` Plain text content of the report - `studyId: string` Study ID the reports belong to. Format: stu_{32-hex-chars} - `studyInstanceUid: string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/reports/text \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Pdf **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. ### Query Parameters - `reportId: optional string` Unique report identifier. Format: rep_{32-hex-chars} - `studyId: optional string` Unique study identifier. Format: stu_{32-hex-chars} - `studyInstanceUid: optional string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') ### Returns - `SingleReportPdfResponse = object { presignedUrl, reportId, snapshotMetadata, 2 more }` Response containing a single report with its PDF download URL - `presignedUrl: string` Time-limited presigned URL to download the PDF (expires after 1 hour) - `reportId: string` Unique report identifier. Format: rep_{32-hex-chars} - `snapshotMetadata: StudyReportMetadata` Patient demographics and scan information for report generation - `age: optional string` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `dateOfBirth: optional string` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `facilityName: optional string` Name of the medical facility where the scan was performed - `height: optional object { unit, value }` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `unit: "in" or "cm"` - `"in"` - `"cm"` - `value: number` - `mrn: optional string` Medical Record Number - unique patient identifier - `patientName: optional string` Full name of the patient - `referringPhysicianName: optional string` Name of the physician who referred the patient for this scan - `scanDate: optional string` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `scanTime: optional string` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `scanType: optional string` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `sex: optional "male" or "female" or "other"` Patient's biological sex. Options: 'male', 'female', 'other' - `"male"` - `"female"` - `"other"` - `weight: optional object { unit, value }` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `unit: "lbs" or "kg"` - `"lbs"` - `"kg"` - `value: number` - `studyId: string` Study ID this report belongs to. Format: stu_{32-hex-chars} - `studyInstanceUid: string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `ListReportsPdfResponse = object { reports, studyId, studyInstanceUid }` Response containing a list of reports with their PDF download URLs - `reports: array of object { presignedUrl, reportId, snapshotMetadata, 2 more }` Array of report PDF items with download URLs - `presignedUrl: string` Time-limited presigned URL to download the PDF (expires after 1 hour) - `reportId: string` Unique report identifier. Format: rep_{32-hex-chars} - `snapshotMetadata: StudyReportMetadata` Patient demographics and scan information for report generation - `age: optional string` Patient's age at time of scan (e.g., '34.5 years', '2 months') - `dateOfBirth: optional string` Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20') - `facilityName: optional string` Name of the medical facility where the scan was performed - `height: optional object { unit, value }` Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'}) - `unit: "in" or "cm"` - `"in"` - `"cm"` - `value: number` - `mrn: optional string` Medical Record Number - unique patient identifier - `patientName: optional string` Full name of the patient - `referringPhysicianName: optional string` Name of the physician who referred the patient for this scan - `scanDate: optional string` Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15') - `scanTime: optional string` Time the scan was performed. Format: HH:MM (e.g., '14:30') - `scanType: optional string` Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound') - `sex: optional "male" or "female" or "other"` Patient's biological sex. Options: 'male', 'female', 'other' - `"male"` - `"female"` - `"other"` - `weight: optional object { unit, value }` Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'}) - `unit: "lbs" or "kg"` - `"lbs"` - `"kg"` - `value: number` - `studyId: string` Study ID this report belongs to. Format: stu_{32-hex-chars} - `studyInstanceUid: string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `studyId: string` Study ID the reports belong to. Format: stu_{32-hex-chars} - `studyInstanceUid: string` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/reports/pdf \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Addendum **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. ### Path Parameters - `reportId: string` Unique report identifier. Format: rep_{32-hex-chars} ### Returns - `success: boolean` - `message: optional string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/reports/$REPORT_ID/addendum \ -X POST \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Cancel Addendum **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. ### Path Parameters - `reportId: string` Unique report identifier. Format: rep_{32-hex-chars} ### Returns - `success: boolean` - `message: optional string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/reports/$REPORT_ID/cancel-addendum \ -X POST \ -H "Authorization: Bearer $AVARA_API_KEY" ```