19.1.0 nVoq Dictation, Voice, Administrator, & APIs Release
June 2024 - See Production Deployments for deployment dates.
Changes listed on this page may be available on the Test system (test.nvoq.com), but there could be some that are not there yet.
Each item lists the version and build number in which it was tested. To see the version and build number currently deployed on Test, visit Test System Deployment Dates.
For release notes for nVoq mobile apps, see:
- nVoq Mobile Voice Version History - 19.1.0
- nVoq Wireless Microphone for Android Version History - 19.1.0 - no changes in this release
- nVoq Wireless Microphone for iOS Version History - 19.1.0
nVoq Dictation
The updates in this section impact all dictation clients, including nVoq.Voice and nVoq.Mobile Voice, as well as ISV partner clients using nVoq dictation.
- Max Concurrent Dictations Increase - We limit the number of dictations that can be processed for users to protect our resources. The maximum number that we allow to be processed by our server for a single user at one time has increased from four to eight. If more than the maximum number of dictation requests are made, you will get an error. Dictations submitted with malformed audio will also be cleaned up from the system faster so they don't count against the number of concurrent dictations. (B-17495, 3/13/2024, 19.1.0 b3; D-13493, 3/27/2024, 19.1.0 b14)
- Fix for SNS Context Not Applied Properly - In the previous release the SNS functionality (which allows nVoq dictation to understand where the cursor is within a sentence so that it knows if the next word should be capitalized or not) was not being applied properly. This meant there could be capitalized words where they didn't belong. As part of our work to improve the functionality of mid-dictation commands, SNS has been refactored to make sure that capitalization and spacing is correct, even if mid-dictation commands are active. (B-17549, 3/22/2024, 19.1.0 b10)
- Unsupported Audio Format for HTTP Dictations Fail - HTTP dictations submitted with in an unsupported audio format will now fail and get an error from the dictation server, instead of retrying (and never succeeding). A message indicating unsupported audio format will appear in our internal logs. (D-13502, 5/9/2024, 19.1.0 b49)
- Fix for WebM & MP4 Audio Not Supported with HTTP - In the previous release doing a batch upload of HTTP .mp4 audio resulted in a 406 Error, but would work with WebSockets. Support has now been added for .mp4 and also WebM audio for HTTP dictations. (D-13534, 6/4/2024, 19.1.0 b66)
nVoq Voice
- Account Lockout Message Updated - When a Voice user enters an incorrect password too many times the account may be temporarily locked (if the division level organization is configured to do so, or if the account has an Administrator Role). In the 19.1.0 release the message that displays when this happens has been updated to let the user know how long the account will be locked. Instead of saying, "Please try again later or reset your password." the message now reads, "Please try again after 15 minutes or reset your password for immediate access." (B-17383, 4/16/2024, 19.1.0 b30)
Bug Fixes in nVoq Voice
- Fix for Shortcut Menu Fails to Load - In the previous release the Voice shortcut menu can fail to load. The Shortcuts menu window opens, but continually displays a throbber (loading icon) instead of displaying the menu. This issue occurred when signing in to Voice with an SSO account (like Okta or Microsoft) with Auto Sign In enabled, signing out, and then signing back in with an nVoq account. A work-around for this issue has been added as a troubleshooting article. [Note: This troubleshooting article has been removed after deployment of 19.1.0 on all systems.] This issue, which was caused by duplicate credentials, has been fixed in the 19.1.0 release. (D-13513, 5/3/2024, 19.1.0 b44)
- Fix for Note Assist Unable to Paste Back Into Original Application - The Note Assist Delay setting on the Voice settings screen, which can already be used to postpone the action between capturing text and pasting it into the Note Assist window, can now be also used to delay the action of pasting from Note Assist back into the original application. This update is to correct an issue recently seen on user computers in which Note Assist would copy the completed note onto the clipboard, but then could not paste it back into the EMR. This is more likely to happen for users running Voice Note Assist in a virtual desktop environment, such as Citrix. The work-around is to use Ctrl+V to manually paste the completed note into your EMR or system of record after clicking the Update Note button in Note Assist. (D-13516, 5/7/2024, 19.1.0 b46)
- Fix for Note Assist Categories Failing Due to Multiple Spaces - In previous releases multiple spaces in a row of text could cause a category in a Note Assist audit to fail. Multiple spaces in a row, such as double spaces after a colon, are common in medical narratives. This issue has been fixed in the 19.1.0 release of Note Assist in Voice, Mobile Voice, and on the audit Test tab in nVoq Administrator. (D-13540, 6/7/2024, 19.1 b68)
nVoq Administrator
- Note Assist Audit Test Text Box Now Wider - The text area (on the Edit Note Assist Audit page Test tab) where you enter the clinical note that you want to test with an audit is now the full width of your browser window. This allows you to see the entire narrative and all the test matching results with less (or no) scrolling. (B-17506, 3/27/2024, 19.1.0 b14)
- Microsoft Auto Provisioning - It is now possible to auto provision nVoq accounts through Microsoft Entra ID (formerly known as Microsoft Azure Active Directory). As with Okta auto provisioned accounts, some details for Entra ID auto provisioned accounts cannot be edited in nVoq Administrator and instead must be updated in Entra ID. Instructions for auto provisioning accounts with Entra ID will be added to this site as soon as they are refined. If you are interested in auto provisioning accounts with Entra ID now, create a support ticket and let us know. (B-17366, 3/28/2024, 19.1.0 b8)
- Account Lockout Message Updated - When an Administrator user enters an incorrect password too many times the account may be temporarily locked (if the division level organization is configured to do so, or if the account has an Administrator Role). In the 19.1.0 release the message that displays when this happens has been updated to let the user know how long the account will be locked. Instead of saying, "Please try again later or reset your password." the message now reads, "Please try again after 15 minutes or reset your password for immediate access." (B-17383, 4/16/2024, 19.1.0 b30)
- Plan Selected Automatically on Auto Provisioning Settings - On the Auto Provisioning Settings tab of the Identity Providers page you can configure the default settings that will be used for nVoq accounts created via an SSO identity provider. The Plan on this page is a required setting. Beginning with the 19.1.0 version of nVoq Administrator, this setting will automatically be selected for you if your tenant has only one plan available. (B-17468, 4/16/2024, 19.1.0 b30)
- Updated Look - You may notice a slightly different look to some of the text, icons, toggles, menus, etc. in nVoq Administrator in this release. This is due to third-party upgrades on our system. Functionality has not changed. (B-17424, 4/16/2024, 19.1.0 b30)
- Cleanup of Group Organizations Page - Retired group settings and triggers have been removed from the Add Organization and Edit Organization pages. Settings removed from the Client Settings tab include: Voice Shortcut Hotkey, Advanced Paste, Desktop Shortcut, and Show Select and Say. These settings were applicable to our retired SayIt client and are not used by current nVoq applications. Two triggers, On Shortcut Result and Placing Text, were removed from the Triggers tab on this page. These are not used by current nVoq applications or nVoq customers. Note that triggers are a deprecated feature that will be removed in a future release. (B-17607, 4/30/2024, 19.1.0 b40)
- Custom Groups Retired - Because Custom Groups are not used, this feature has been retired in the 19.1.0 release of nVoq Administrator. The Custom Groups page, and the Dictation Usage Custom Groups and Shortcut Usage Custom Group reports have been removed. (B-17606, 5/1/2024, 19.1.0 b42)
- Vocabulary Recovery - The ability to restore deleted vocabulary terms has been added to nVoq Administrator in this release. When vocabulary terms are deleted they are now moved to Trash, where they remain for 30 days before they are permanently removed from the system. When a vocabulary term is moved to trash it is considered “deleted” and is removed from account profiles; a new vocabulary term with the same Written text can be created for the same organization or account as the deleted term. Vocabulary in trash can be restored for 30 days as long as the owner account or organization has not been deleted. If an organization that owned the vocabulary is deleted, the vocabulary term is deleted from trash also. Even if the organization is re-created with the same name and settings, the previously deleted vocabulary will not reappear in Trash. If an account that owned vocabulary is deleted, vocabulary previously deleted from the account disappears from Trash. If the account is later restored within 30 days of the date that the vocabulary term was moved to trash, the term reappears in Trash and can be still be restored. (B-17538, 5/2/2024, 19.1.0 b43)
- SYSTEM LEVEL: Customer Care Type and Shortcuts Usage Plan Retired - The "Customer Care" tenant type and "Shortcuts Usage" billing plan have been removed, as they were no longer being used. Tenant Type was a setting selected by nVoq when your tenant was created. There were two type values: Customer Care and Healthcare. The type selected automatically configured the default values for lower organization settings. The Customer Care tenant type was only used on the "Secure" system, which was retired earlier this year. Tenants on the "Healthcare" system all use the Healthcare tenant type. There is no change to your tenant or organizations with this option being removed. The same is true for the Shortcuts Usage billing plan: this plan was only used by Customer Care tenants on the Secure system. No one was using this option on the Healthcare system. These changes affect nVoq staff who configure tenants, as these options no longer appear on the Add or Edit Tenant pages at the System level. (B-17149, 5/6/2024, 19.1.0 b44)
- View & Restore Previous Versions of Substitutions - The 19.1.0 version of nVoq Administrator will begin saving version history of substitutions, along with the date and time they are changed and the usernames of the people who change them. You can view the history on the Edit Substitution page. This page now has a View tab, which includes all of the current substitution information, and a History tab. Click on the History tab to view version information for the substitution. Substitutions created prior to the 19.1.0 deployment of nVoq Administrator will show "Unknown" for the username who last modified the term in the first history entry. Modified By and Modified Date columns have also been added to the Substitution page list view, where substitutions created prior to the 19.1.0 deployment on your system will still show the correct date for the Modified Date, but the Modified By column will be blank here. (B-17103, 5/8/2024, 19.1.0 b48)
- Note Assist Batch Audit Improvements - In previous releases, running a Note Assist batch audit required case-sensitive column headers, and dates had to be in a Microsoft Excel format. This meant that after you downloaded patient narratives from your EHR, you may have had to fix the required audit headers (Narrative, Narrative Date, and Name) so that the case matched exactly with the headers displayed in the template, and depending on what the narrative date formats were like (some EMRs format the date to include additional information, such as time with milliseconds) you may have had to reformat those too. The 19.1.0 version of nVoq Administrator no longer requires matching case for audit headers, so you can run the batch audit with headers in all caps, or all lowercase, or however you choose and that audit file will not be rejected. Moreover, the actual header text is more flexible now too. Instead of only allowing the words "narrative," "narrative date," and "name," the headers can now be things like, "narrative text," "narrative signed date," and "worker," and the audit will still run. This means that data exported from HCHB should be processed successfully without changing header names. In addition to that, the system is more flexible with the format of dates in the date column. Batch audits now accept dates in multiple formats without rejecting the audit file. (B-17612 & B-17635, 5/13/2024, 19.1.0 b49)
- View All Account Shortcuts - Those of you who have wanted to see all account shortcuts at once will be happy to see that the Account drop-down menu on the Shortcuts page now has an "All Accounts" option at the top. This allows you to view and download all user account shortcuts and folders for all users in an organization in one list, instead of having to click on each individual name in the menu to see what shortcuts or folders they had created. When this option is selected, the Add and Upload buttons are not available in the blue toolbar, but you can still copy, delete, or download shortcuts and folders. (B-17601, 5/16/2024, 19.1.0 b52)
- Long Term Average RMS Energy No Longer Calculated - The overall Average RMS Energy is no longer being calculated for users in the 19.1.0 release. This account property, which was a calculation of average loudness of a user's dictations over a length of time, appeared on the Edit Account page Properties tab. The management of this account property was creating deadlock issues with the database. Moreover it's no longer needed as it was created for the SayIt client, which is retired. Existing Average RMS Energy account properties will remain in the database in 19.1.0, but will be removed from the Edit Account page in a later release. Note: The per-dictation Average RMS Energy is still being calculated, and you can still find that on the Detail Review & Correct page when you click on the Audio Level indicator. (B-17648, 5/20/2024, 19.1.0 b55)
- Note Assist Usage Counts as Activity in Reports - In the 19.1.0 version of nVoq Administrator running a Note Assist audit counts as "activity" on the Active Account Detail, Active Account Summary, and Product Usage reports. Previously only dictation or shortcuts counted as activity on these reports. The Active Account Detail and Summary reports have a new Active Note Assist column, which shows a "1" if a Note Assist audit was run within the selected date range. Additionally the Last Activity Time will be updated with Note Assist usage on these reports as well as on the Product Usage report. (B-17583, 6/3/2024, 19.1.0 b62)
- SYSTEM ADMINS Add or Edit Identity Provider - System-level administrators (nVoq staff) can now add or edit identity provider information for a tenant on the Identity Providers page in nVoq Administrator rather than using Postman. Tenant-level administrators can still view Identity Provider information on this page, but cannot add or edit it. (B-17281, 6/4/2024, 19.1.0 b63)
- Improvements to Account Monitor Shortcuts Report - By customer request, the Account Monitor Shortcuts report now includes the Modified Date, Written Form, Description, and Type of shortcuts on the report. We also updated a couple of column names: the "Name" column is now labeled "Shortcut Name" and the "Source" column is now labeled "Owner" to make it more clear what data those columns display. Additionally, to be more precise about what data will be presented when you check the "View all used shortcuts" checkbox, that label now says, "View all used shortcuts (Org and Account)." (B-17479, 19.1.0 b68, 6/10/2024)
Bug Fixes in nVoq Administrator
- Fix for Note Assist Category Test Fails If Matching Clause Includes Non-Alphanumeric Characters - In the previous release the Note Assist category test tool in nVoq Administrator would fail a category if a clause matching the category included non-alphanumeric characters, like punctuation. This has been fixed. In the 19.1.0 release the following characters are allowed within category clauses:
!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
. (D-13499, 4/11/2024, 19.1.0 b23) - Fix for Note Assist Categories Failing Due to Multiple Spaces - In previous releases multiple spaces in a row of text could cause a category in a Note Assist audit to fail. Multiple spaces in a row, such as double spaces after a colon, are common in medical narratives. This issue has been fixed in the 19.1.0 release of Note Assist in Voice, Mobile Voice, and on the audit Test tab in nVoq Administrator. (D-13540, 6/7/2024, 19.1 b68)
- Fix for Note Assist Audits, Categories Do Not Display with DUO Authentication - In the previous release, Tenant level administrators who sign in to nVoq Administrator with DUO two-factor authentication were unable to see categories and audits on the Note Assist page. This has been fixed in this release. (D-13544, 6/12/2024, 19.1.0 b70)
nVoq APIs
There may be changes listed here that are not yet available on the Test system.
Each item lists the version and build number in which it was tested. To see the version and build number currently deployed on Test, visit Test System Deployment Dates.
- Retired Triggers Removed from Retrieve Automation Scripts API - As a result of work done to remove retired triggers from the Organizations page in nVoq Administrator, the Retrieve Automation Scripts API endpoint now returns only the
startOfDictationAutomation
andstartupAutomation
scripts. TheendOfDictationAutomation
andshortcutResultAutomation
scripts have been removed from this endpoint. Triggers are not used by any current nVoq application, and the scripts that were removed are not used by any current nVoq customers. Note that this endpoint is deprecated. (B-17607, 4/30/2024, 19.1.0 b40) - Retired Group Properties Removed from Organizations APIs - As a result of work done to remove settings from the nVoq Administrator Organizations page that are no longer used, some group properties have been removed from the endpoints to create and update an organization. The removed properties include:
qnHotKey
,qnHotKeyModifiers
,enablePasteStrategy
,desktopShortcut
,selectAndSayAvailable
,shortcutResultAutomation
,shortcutResultEnabled
,endOfDictationAutomation
, andendOfDictationEnabled
. (B-17607, 4/30/2024, 19.1.0 b40) - Custom Groups APIs Deprecated, Removed in Next Release - As a result of the custom groups feature being retired in the 19.1.0 release of nVoq Administrator, the custom groups API endpoints have been marked as deprecated. Calling these endpoints returns a warning with a deprecation message in the response header. These endpoints will be removed in the 19.2.0 release.(B-17606, 5/1/2024,19.1.0 b42)
- https://test.nvoq.com/apidoc/administration#tag/API-Keys/operation/OrganizationsApikeysByIdentifierAndIdentifierDelete
- https://test.nvoq.com/apidoc/administration#tag/Custom-Groups/operation/OrganizationCustomGroupsPost
- https://test.nvoq.com/apidoc/administration#tag/Custom-Groups/operation/OrganizationCustomGroupByIdentifierGet
- https://test.nvoq.com/apidoc/administration#tag/Custom-Groups/operation/OrganizationCustomGroupByIdentifierPost
- https://test.nvoq.com/apidoc/administration#tag/Custom-Groups/operation/OrganizationCustomGroupByIdentifierDelete
- https://test.nvoq.com/apidoc/administration#tag/Custom-Groups/operation/CustomGroupsMembersListGet
- https://test.nvoq.com/apidoc/administration#tag/Custom-Groups/operation/CustomGroupMemberByIdentifierPost
- https://test.nvoq.com/apidoc/administration#tag/Custom-Groups/operation/CustomGroupMemberByIdentifierDelete
- Deprecated Vocabulary Endpoint Deleted - A deprecated endpoint to retrieve vocabulary for a specified username has been deleted. Instead of
SCVmcServices/profileVocabulary
(the deprecated endpoint) you should use the newer RESTful API endpoint/SCVmcServices/rest/accounts/{usernameOrUuid}/vocabulary
. (B-17538, 5/2/2024, 19.1.0 b43) - New & Updated Substitution API Endpoints - As part of our work adding the ability to view and restore previous versions of substitutions in nVoq Administrator, two new substitution endpoints have been created, and two were modified. The two new endpoints retrieve substitution history for organizations and accounts. The endpoints to retrieve organization and accounts substitutions were modified to return
modifiedTimestamp
,modifiedByUsername
, andinternalNotes
in the response. ThemodifiedTimestamp
andmodifiedByUsername
properties are used in nVoq Administrator on the Substitutions page. TheinternalNotes
property is not currently displayed. (B-17103, 5/8/2024; 19.1.0 b43)- https://test.nvoq.com/apidoc/administration#tag/Organization-Substitutions/operation/OrganizationSubstitutionHistoryGet
- https://test.nvoq.com/apidoc/administration#tag/Account-Substitutions/operation/AccountSubstitutionHistoryGet
- https://test.nvoq.com/apidoc/administration#tag/Organization-Substitutions/operation/OrganizationSubstitutionsGet
- https://test.nvoq.com/apidoc/administration#tag/Account-Substitutions/operation/AccountSubstitutionsGet
- New Accounts Query Parameter for Retrieve Shortcut & Folder Endpoints - As a result of work done in nVoq Administrator to make it possible to view all account shortcuts for all users in an organization in one list, a new
accounts
query parameter has been added to the API endpoints to retrieve a list of shortcuts and to retrieve a list of folders. This parameter only works if it is set toaccounts=all
and the call is attempting to get organization shortcuts or folders (and an account is not specified).(B-17601, 5/16/2024; 19.1.0 b52) - WebSocket Client Application Connections Using Observer Can Ignore nVoq Built-In Substitutions - In previous releases the
builtinSubstitutions
parameter of the STARTDICTATION method for WebSockets could be turned off in order to allow client applications to ignore nVoq built-in substitutions so they would not collide with custom commands. However, that parameter was only honored in the initial STARTDICTATION request, not one coming from an observer, as is the case when the nVoq iOS Wireless Microphone is used for a client application. In the 19.1.0 release two new parameters (builtinSubstitutions
andhandsFree
) have been added to the STARTDICTATION method for a WebSocket transcription observer. These parameters override the original WebSocket message. Default values (builtinSubstitutions
= on andhandsFree
=off) are used if none are provided. (B-17643 & D-13449, 5/24/2024; 19.1.0 b58) - New Warning for Multiple Headers on WebM Audio - Multiple headers sent with WebM audio can cause our dictation server to not transcribe a middle or ending portion of dictation audio. In the 19.1.0 release, if WebM audio data is sent with multiple headers, a new warning (
MULTIPLE_HEADERS
) will let you know. This message is sent back every time a surplus header is found, so for example if there are two extra header entries, the warning will appear twice. (D-13391 & D-13519, 6/3/2024; 19.1.0 b65)