Reporting
User Vocabulary Editor — Macro & Template Speech Recognition Sync
1. Purpose
This IFU explains how to use the Vocabulary Editor and the updated Macro/Template creation dialog to ensure that voice macros and templates are reliably recognized by the speech engine.
2. Background
This feature adds a speech setup step directly to macro/template creation, automatically generating the correct speech-recognition entries for the macro or template name. This ensures that short clinical abbreviations (for example, "US Thyroid") reliably trigger the macro when dictated, without requiring a separate, manual configuration step.
3. Key Concepts
“Auto-Correct” (Inverse Text Normalization)
Replaces a term or phrase with another — it does not change what the engine recognizes; it automatically corrects the text that was typed.
The user provides the:
Spoken Form as plain words/letters — no digits, no symbols, no punctuation, single space between tokens.
Written Form: the actual final value to output — can include numbers, symbols, hyphens, and capitalization.Example: Spoken Form: corner artery. Written Form: coronary artery. If the system types corner artery, it is immediately replaced with coronary artery.
“New Terms or Phrases”
Works before recognition — it primes the engine with vocabulary it should expect to hear, improving the odds it recognizes the right words in the first place.
Purpose: Give the engine advance knowledge of important words/phrases so it recognizes them correctly from the start.
Mechanism: Supplies a biasing list of terms/phrases (e.g., "Thyroid Biopsy") relevant to the current context, increasing recognition accuracy for domain-specific or uncommon vocabulary.
Example: Loading "Thyroid Biopsy" into context before a dictation session so the engine is primed to recognize it correctly.
4. Managing Your Vocabulary Entries
4.1 From the Reporting Screen
Open the Vocabulary Editor dialog box from the reporting screen.
Select the “Auto-correct” tab to view and manage your user-level ITN entries.
Select the “New terms or phrases” tab to view and manage your user-level Dynamic Context entries. This tab is a table of all your current entries, with a free-text field and Save button to add new ones.
Note: If a word or phrase is still transcribed incorrectly after you add it to Auto-correct, enter it in New Terms or Phrases instead. |
You can search, add, edit, and delete entries from either tab.
Duplicate entries are not allowed in New Terms or Phrases; attempting to add one shows: “This term or phrase already exists.”
⚠ IMPORTANT: Deleting an entry from either list also removes it from the backend database. If an entry still appears to work after deletion, refresh the screen and confirm removal before assuming the system is misbehaving. |
4.2 From the Radiologist Menu (Administrators)
Administrators can access a radiologist's user-level Vocabulary Editor from the Radiologist Menu:
Open the Radiologist Menu for the relevant user.
Select the “Vocabulary Editor” tab, located next to the Custom Templates/Macros tab.
Use the “Auto-correct” and “New terms or phrases” sub-tabs, which function the same way as the radiologist's own reporting-screen Vocabulary Editor.
Note: Access is governed by the radiologist_object user permission. Read permission allows viewing both sub-tabs; Update permission is required to create, edit, or delete entries. |
5. Adding Speech Support When Creating or Editing a Macro/Template
This section applies only to users on the System Default speech engine. It applies wherever macros/templates can be created or edited: the Radiologist Profile page (Custom Templates/Macros), the reporting screen “+” button, and the Radiologist Menu (for administrators).
Enter the macro or template name.
Review the “Improve Macro Recognition” or “Improve Template Recognition” section below the name field. As you type, this section automatically suggests likely spoken forms, labeled “Auto-Generated.”
A simple name (e.g., “Lung Rad One”) generates a single suggestion: “lung rad one.”
A name containing an acronym (e.g., “AA FAT”) generates two suggestions: the natural reading (“aa fat”) and the spelled-out alternative (“a a f a t”).
Review and adjust suggestions: click any spoken form to edit it inline; press Enter or click away to save your edit (this removes the “Auto-Generated” label). Click the trash icon to remove a suggestion you don't want.
Add your own spoken form manually if needed: type it into the free-text field (excluding the macro/template command word) and click Add or press Enter. Numerals and special characters are restricted here.
Confirm the “Added terms” section reflects everything you want the macro/template to respond to, then save the macro or template.
Note: You may remove all suggested and added spoken-form entries and still save the macro/template. In that case, nothing is added to Auto-Correct or New Terms or Phrases for that macro/template, and it will not be voice-reachable. |
A maximum of 5 spoken forms is allowed per macro/template (auto-generated, manually added, combined). Once 5 exist, Add is disabled.
Spoken forms must be unique per macro/template; duplicates are rejected.
6. What Happens When You Save
Every spoken form you keep becomes a voice-reachable entry, added automatically to your Auto-Correct and New Terms or Phrases lists:
Auto-Correct: one entry per spoken form, with the macro/template's actual name as the written form. Example — template “CL Chest”: spoken “c l chest” → written “CL Chest”; spoken “cl chest” → written “CL Chest.”
New Terms or Phrases: one entry per spoken form, prefixed with the relevant command word(s).
For templates: The word “template” is prefixed. Example — “CL Abdomen XR” produces Auto-Correct entries “c l abdomen x r” and “cl abdomen xr” (both mapping to “CL Abdomen XR”) and New Terms or Phrases entries “template c l abdomen x r” and “template cl abdomen xr.” A name without acronyms, like “Implants,” needs only one entry of each: Auto-Correct “implants” → “Implants”, and New Terms or Phrases “template implants.”
For macros: The words “macro,” “cue,” and “click” are each prefixed. Example — “AA FAT” produces Auto-Correct entries “a a fat” and “aa fat” and six New Terms or Phrases entries (“macro/cue/click a a fat” and “macro/cue/click aa fat”). A name without acronyms, like “Multi stone,” needs one Auto-Correct entry (“multi stone”) and three New Terms or Phrases entries (“macro multi stone,” “cue multi stone,” “click multi stone”).
Note: You can insert a macro by voice using any of the three commands: “macro,” “cue,” or “click,” followed by the macro name. Templates are inserted by saying “template” followed by the template name. |
7. Renaming and Deleting Macros/Templates
Renaming: the old spoken-form entries are automatically deleted from Auto-Correct and New Terms or Phrases (and from the database) and replaced with new ones based on the updated name. Auto-generated entries refresh to match the new name; entries you added or dictated manually are left untouched.
Deleting: all associated spoken-form entries are automatically removed from Auto-Correct and New Terms or Phrases, and from the database, so no orphaned entries remain.
8. Existing Macros and Templates
Existing macros and templates for current radiologists are added to that user's Auto-Correct and New Terms or Phrases lists using the same logic described above. Each user's own macros/templates are added to that user's own lists.
9. Global-Level Vocabulary Editor (Administrators)
Numerals/special-character restriction and tooltip apply to the Spoken Form field in the global-level Vocabulary Editor located in the Admin menu. As with the user-level editor, deleting an entry here also removes it from the backend database.