The following information should be considered or noted when upgrading HL7 module deployments. Read this information prior to upgrading your version of OnBase.
- Keyword Considerations
-
The following should be considered with regard to updating Keyword Values and documents using HL7:
-
When upgrading the HL7 module from a version of OnBase prior to OnBase 17, be sure to thoroughly test existing HL7 import processes configured to update or propagate Keyword Values. In a small number of situations, the update logic may yield different results from previous versions.
-
Beginning in OnBase 17, the HL7 module handles masked Keyword Values in a manner consistent with other OnBase import processors. If the HL7 module will populate or update masked Keyword Types, make sure the incoming HL7 values satisfy the masking rules exactly.
- Listener Log Retention
-
Beginning in OnBase 17, an option exists to manage the size of the hl7listenerlog database table by setting a retention period after which logs will be removed from the table. The initial process of setting a retention period and purging old logs can take a long time and may be highly resource intensive. For this reason, if you are upgrading to OnBase 17 from a previous version the default value for the retention period is 0 days, meaning no retention period is set and all logs are retained in the table as they were in previous versions. This setting can be changed in the HL7 Settings dialog box.
- Order-Based AutoFill Keyword Sets
-
Beginning in OnBase 18, medical order information and objects related to orders are no longer tracked by the HL7 module. Order-based AutoFill Keyword Sets are therefore not supported in version 18 and forward. After upgrading, any existing order-based AFKS are converted to standard AFKS, and new order-based sets cannot be created.
- Independent Order
-
Beginning in OnBase 18, medical order information and objects related to orders are no longer tracked by the HL7 module. The Independent Order message action is therefore no longer supported. After upgrading, any existing import processes configured to use the Independent Order message action are converted to use the AutoFill Keyword Set message action, and are automatically assigned to new copies of relevant message templates. Additionally, existing order-based AutoFill Keyword Sets are converted to standard AFKS, and remain assigned to the converted Independent Order import processes. There are no manual steps that need to be taken for this conversion.
- Generate Transcription Document from OBX Segment
-
Beginning in OnBase 18, the Generate Transcription Document from OBX Segment message action is no longer available. After upgrading, any existing import processes configured to use the Generate Transcription Document from OBX Segment message action are automatically converted to use the Advanced Document Import message action instead.
- Generate Transcription Document from OBX Segment
-
Beginning in OnBase 18, the Generate Transcription Document from OBX Segment message action is no longer available. After upgrading, any existing import processes configured to use the Generate Transcription Document from OBX Segment message action are automatically converted to use the Advanced Document Import message action instead.
- UU Encoding No Longer Supported
-
Beginning in OnBase 22.1, UU Encoding is no longer supported for Advanced Document Import. HL7 messages sent to an HL7 import process that is still configured for UU Encoding will automatically be rejected. Any HL7 sending system used for sending UU Encoded HL7 messages to OnBase will need to be updated to send Base64 instead. Additionally, the HL7 Import Processes in OnBase will need to be updated to use Base64 encoding in place of UU Encoding.
- HL7 Processor Deprecation
-
Beginning in OnBase Foundation EP3, the HL7 Processor has been deprecated and will no longer run. If using the Number of days to retain listener log setting, utilize the new HL7 Log Pruner task that can be configured in the Unity Management Console. No configuration changes are required as a part of this upgrade process.