Vocabulary Portal F.A.Q.
IMO® Vocabulary Portal consists of two main components: 1) the data portion provided in a data stream file; and 2) the functionality portion consisting of Windows™ services, configuration, and licensing. This FAQ focuses on the functionality portion of the IMO® Vocabulary Portal.
- How often do you release IMO® Vocabulary Portal updates?
- Is every IMO® Vocabulary Portal update mandatory?
- How will I know what changes are included in the update?
- What is required to implement an update?
- We are hosting the IMO® Vocabulary Portal at our site, and our search has stopped working. What can we do?
- We are hosting the IMO® Vocabulary Portal at our site. How can we temporarily switch to IMO® Hosted?
- I am receiving the following message. What does it mean?
- How do I ensure that administrators receive messages from the IMO® Vocabulary Portal?
- How can I determine the version of IMO Vocabulary Portal I am running?
- Why are there two variants of the same IMO Problem IT release (the normal and the v2_2_compatible)?
1. How often do you release IMO® Vocabulary Portal updates?
IMO® is continuously working to enhance IMO® Vocabulary Portal for our clients. At this time there is no static schedule with which this occurs, as it is based on user feedback and new technologies.
2. Is every IMO® Vocabulary Portal update mandatory?
As we work to make IMO® Vocabulary Portal more efficient and robust, we hope that each update is considered for implementation. We make every effort to provide compatibility between the various versions, and ensure that new service updates will continue to read prior data streams for historical reasons. However, the data streams and services are reliant on each other, and there may be service updates that will be required. We will make every effort to notify the Download Recipients of this requirement in a timely manner, so as to allow scheduling and preparation.
3. How will I know what changes are included in the update?
Each IMO® Vocabulary Portal service or data stream update is accompanied by a What's New text file, describing and/or listing the included updates. These are available in your download folder.
4. What is required to implement an update?
Data Stream update - If implementing the regularly scheduled data stream release, it is a very quick process:
- Download the latest data stream file. The appropriate URL is provided in the release Notification email delivered to the designated IMO® Download Recipients at your organization. (See the Download FAQ for questions on downloading and your downloading account.)
- Unzip the file into your currently installed location (Default = C:\Program Files\Intelligent Medical Objects, Inc\IMO Vocabulary Portal).
NOTE: You may wish to make a backup copy of the existing file, in order to revert back to this old file if the need arises.
| Product | File Name |
| IMO® Problem (IT) - Professional | ProblemIT_Professional.cit.imo |
| IMO® Problem (IT) - Consumer | ProblemIT_Consumer.cit.imo |
| IMO® Procedure (IT) - ChargeMaster | ProcedureIT_ChargeMaster.cit.imo |
| Procedure (IT) - ICDP | ProcedureIT_ICDP.cit.imo |
| IMO® Medication (IT) - Core | MedicationIT_Core.cit.imo |
| IMO® Medication (IT) - Enhanced | MedicationIT_Enhanced.cit.imo |
| IMO® Medical Necessity | MedicalNecessity.cit.imo |
- Stop both of the IMO Vocabulary Portal Windows services: IMO® Vocabulary Messaging Service and IMO Vocabulary Search Service in Control Panel/Administrative Tools/Services.
- Start the IMO® Vocabulary Portal Windows services, one at a time.
- Do a search and confirm results are returned. If your implementation displays the version number, also confirm this number matches the version you intended to implement.
These steps are also provided in the IMO® Vocabulary Portal Install Guide PDF file, available in your download folder.
Installation Update - The following explains how to implement an IMO® Vocabulary Portal update.
NOTE: Typically, updates take only a few minutes, but it does require downtime of the portal. If users are accessing the system, you may consider rerouting your current configuration to hit IMO®. Refer to question #6 - "We are hosting the IMO® Vocabulary Portal at our site. How can we temporarily switch to IMO® Hosted?" by clicking here.
- Retain a copy of your current Configuration XML and LicenseCOMActivationInfo.dat files located in the Vocabulary Portal's installed location (Default = C:\Program Files\Intelligent Medical Objects, Inc\IMO Vocabulary Portal).
- Run the previous IMO® Interface Terminology Vocabulary Portal MSI file to uninstall the old version.
- Download the latest IMO® Interface Terminology Vocabulary Portal MSI file. The appropriate URL is provided in the release Notification email delivered to the Download Recipients. (See the Download FAQ for questions on downloading and your downloading account.)
- Follow the IMO® Vocabulary Portal Install Guide PDF file (available in your download folder) to install the new version.
NOTE: On the final screen, deselect all checkboxes, they are not needed at this time.
- Copy the files from step #1 above into the new installed location.
- Start the IMO® Vocabulary Portal Windows services, one at a time: IMO® Vocabulary Messaging Service and IMO® Vocabulary Search Service in Control Panel/Administrative Tools/Services. If the services were started by the installation, stop both services and then start each one at a time.
5. We are hosting the IMO® Vocabulary Portal at our site, and our search has stopped working. What can we do?
Stop both of the IMO® Vocabulary Portal Windows services, then start each of them, one at a time: IMO Vocabulary Messaging Service and IMO Vocabulary Search Service in Control Panel/Administrative Tools/Services.
If this does not fix the issue, look in the log file created for today's date and review if there were any issues during this restart. The log files are saved in the Log folder of the installed location (Default = C:\Program Files\Intelligent Medical Objects, Inc\IMO Vocabulary Portal).
To troubleshoot your issue, you will need to know what version of IMO Vocabulary Portal your system is running. Refer to question #9 - "How can I determine the version of IMO Vocabulary Portal I am running?" by clicking here.
If you were in the process of updating the IMO data stream file:
- Confirm the correct stream variant was downloaded.
- IMO Vocabulary Portal v2.0 or earlier – Historical versions cannot search the v2_2_compatible stream variant. Please download the appropriate stream and restart services. Also, consider upgrading your system as IMO will not be supporting v2.0 or earlier after 2011.
- IMO Vocabulary Portal v2.2 or later – Can use either stream, but since the footprint of the v2_2_compatible stream is smaller be sure to use this one.
- If the administration.log reports an “Out of Memory” error while loading data:
- If this issue is in a Production environment - To fix your search temporarily, either roll back to the prior data stream or switch to IMO-Hosted services until the issue is resolved.
- If you are using IMO Vocabulary Portal v2.0 or earlier – An upgrade is needed so the smaller v2_2_compatible stream may be used.
- If you are using IMO Vocabulary Portal v2.2 or later, and your system meets the requirements set in the IMO® Vocabulary Portal Install Guide, you will need to increase your working memory allocation. To do so:
- Download the modified IMOVocabSearchService.exe and ReadMe.txt file found in the 3GB_Support_Version folder of the Vocabulary Portal installation download location, by clicking here. (See the Download FAQ for questions on downloading and your downloading account).
- Follow the ReadMe directions for updating your system.
If the issue persists, contact IMO® Customer Support. They may need a copy of your log file and any other pertinent messages you have received. You may also consider temporarily switching to IMO® Hosted until the issue is resolved, see the below section for details.
6. We are hosting the IMO® Vocabulary Portal at our site. How can we temporarily switch to IMO® Hosted?
IMO® is happy to serve as a backup to your IMO® Vocabulary Portal setup. During your test implementation period, you probably received connection information to IMO® hosting services; these may still be utilized. If you did not have a previous IMO® connection, or have forgotten the connection information, please contact IMO® Customer Support for assistance.
7. I am receiving the following message. What does it mean?
- An error has occurred, please try again. - Some implementations utilize a custom webpage to access the IMO® Vocabulary Portal. If the webpage loads correctly, but searching returns this message repeatedly, please contact IMO® Customer Support for further assistance. There is an issue with the communication link between the webpage and the portal.
In addition, there are three types of messages reported by IMO® Vocabulary Portal:
- The administrative codes within the IMO content you are accessing may have expired as of xx/xx/xxxx. - If the latest Regulatory stream has not been implemented, this message will be emailed to administrators (if set up appropriately in the Configuration XML file) as well as appear at the top of the search results to notify them that the base codes may be outdated. However, the search will continue to provide results. It is recommended the data stream be updated if not intentionally accessing historical codes.
- The IMO content you are accessing is xx months old. - If the data stream being used is over 1 year old, this message will be emailed to administrators (if set up appropriately in the Configuration XML file) as well as appear at the top of the search results to notify them that the base codes and content are outdated. However, the search will continue to provide results. It is recommended the data stream be updated if not intentionally accessing historical codes.
- The Product License for HostedPortal_[Product type] expires in xx days. Please contact Intelligent Medical Objects, Inc. for a new license
OR
The Product License for HostedPortal_[Product type] expired and was valid until [MM/DD/YYYY].
For 30 days prior to the yearly license expiration date, this first message will be emailed to the administrators (if set up appropriately in the Configuration XML file) to warn them the product license needs reactivation. Once the license expires, search results will no longer be returned and the second message will be emailed. Users will see a message that the product has expired. For continued support, it is recommended the reactivation process be implemented earlier in the 30 days. This allows time for IMO® Customer Support to confirm licensing and return updated activation keys. Note that reactivating early does not affect the length of the next licensing period.
To reactivate:
- This is accomplished by opening up the IMO® License Activator tool (located in the IMO installation directory) and requesting a new key for the applicable product(s).
- Once you receive a reply activation email containing the new key(s), you can either copy/paste them back into the tool or click the "Check Activations" button.
- Then click the "Activate Products" button.
- Stop both of the IMO® Vocabulary Portal Windows services, then start each of them, one at a time: IMO Vocabulary Messaging Service and IMO Vocabulary Search Service in Control Panel/Administrative Tools/Services.
These steps are explained in more detail within the IMO® Vocabulary Portal Install Guide PDF file, available in your download folder.
8. How do I ensure that administrators receive messages from the IMO® Vocabulary Portal?
The Vocabulary Service Configuration XML file, located in the installation directory, manages who receives these messages. Multiple administrators may be added by adding additional ‹Email› nodes.
NOTE: The server must have internet access for this capability.
‹!-- Administrator email --›
‹Email›admin1@yourorganization.com‹/Email›
‹Email›admin2@yourorganization.com‹/Email›
9. How can I determine the version of IMO Vocabulary Portal I am running?
Locate the IMOVocabSearchService.exe file in the IMO Vocabulary Portal's installed location (Default = C:\Program Files\Intelligent Medical Objects, Inc\IMO Vocabulary Portal). Right-click on the file to view Properties. On the Version or Details tab, the File Version value is the build release version you are running.
10. Why are there two variants of the same IMO Problem IT release (the normal and the v2_2_compatible)?
One of the features of version 2.2 of the IMO Vocabulary Portal is allowing for enhanced compression of the IMO data files. While the v2_2_compatible download file is larger than its release counterpart, the memory footprint on your local IMO installation is much smaller (more than 2 times smaller). As its name implies the v2_2_compatible version will only work with versions 2.2 and higher of the IMO Vocabulary Portal. Regardless of variant, the content is the same.