Epic Scanning Best Practices for Citrix Deployments

Integration for Epic

Platform: OnBase
Product: Integration for Epic
Release: Foundation 22.1
License: Essential; Standard; Premier

Documentation Notice
Overview
Solution Overview
Epic Modules
Prelude Registration / Admissions, Discharge and Transfers (ADT)
EpicCare Inpatient and Ambulatory (EMR)
Resolute Hospital and Professional Billing
Radiant Radiology Information System
EpicCare Link
Release of Information
Epic Welcome
OnBase Integration for Epic Components
Healthcare Web Viewer
Scan Acquisition Server
Epic Front Office Scanning
Epic Release of Information Integration
EpicCare Link Integration
Epic Image Retrieval API Integration
Epic Welcome Integration
Signature Deficiencies for Epic
DeficiencyPop for Epic
HL7 Module
FHIR Module
SMART on FHIR Module
Hyland Identity Provider (IdP) Service
Document Imaging
Server Applications
Patient Window
Integration for Medical Imaging Viewer
Epic and Application Enabler
Licensing
Simplified Licensing
Installation
Installation Overview
Additional Resources
Requirements
General Requirements
Licensing
Upgrade Considerations
Integration for Epic Upgrade Considerations
Updating the Scan Acquisition Server ProgID
Before Installing the Integration
Accessing the Registry
Procedures for Installing Epic Integration Components
Adding EpicIntegrations.config Settings
Command Line Switches
-EPICPHYSICIANSTAMP
Troubleshooting
Debug Modes
Running the Scan Acquisition Server in Debug Mode
Writing Events to the Debug Log
Running the Front Office Scanning Integration in Debug Mode
Running the EpicCare Link Integration in Debug Mode
General Troubleshooting
Cannot Log on to Other OnBase Applications
OEM Authentication failed. Invalid key.
Web Viewer Troubleshooting
Bi-Directional Communication Cannot Be Processed
Requested Action Cannot Be Processed
Missing Authorized Sources
Scan Acquisition Server Troubleshooting
Cannot Connect to Epic Hyperdrive
Missing or Empty Command Line Parameters
Scanning to Multiple Orders
Missing Document Reference Endpoint
Cannot Use the Scan Acquisition Server Through a Citrix Session
Cannot Close Scanner Settings
Cannot Save Scanner Settings
Cannot Create or View Scan Formats
Cannot Access "Start Scanning" Button
Cannot Preview Scanned Images
Cannot Scan Rotated Pages
Cannot Close TWAIN Scanning Dialog Box
Missing Keyword Values on Scanned Documents
Missing Keyword Values in Keyword Type Groups
Cannot View Scanned or Swept Documents
Cannot View MHT Documents
Cannot Assign Document Types When Indexing
Kofax Read INI Errors
Cannot Store Scanned Files
Cannot Load KVIEWOCX
Cannot Read Keyword Mapping File
Missing External Authentication Information
Cannot Archive Documents
Document Missing Document Type Assignment
Failed to get session for session id
Failed to load xml for parsing
Failed to open local document page for archival
Hyland Services: caught exception in Execute() call for document archive context
OpenDocFile Error
Required output parameter for docId is missing
Missing Documents in Epic
Kofax Error
Not enough memory available to copy image from scanner
ProcessArchivalTokenEX failed
TWAIN Drive Error
Working Directory for Scan Control Not Specified in Registry
Front Office Scanning Troubleshooting
Cannot Connect to Epic Hyperdrive
Missing or Empty Command Line Parameters
Scanning to Multiple Orders
Missing Document Reference Endpoint
Missing Remote Server Location
Hyland Services Cannot Connect to the Server
Missing "DocType" Elements
Missing or Invalid Document Type Contexts
Missing Documents in Epic
Cannot Re-Index Existing Document
Cannot Access Scanner
EpicCare Link Troubleshooting
CanRetrieve()=False. FileExtension:'[ext]', ContentType:" combination invalid.
"Data Type Mismatch" Error in OnBase EpicCare Link Integration
Missing value for required keyword type
Epic Welcome Troubleshooting
Missing value for required keyword type
Contacting Support
Installing the OnBase Application Server
Enabling SMART on FHIR on the Application Server
Configuring the EpicIntegrations Configuration File
Configuration Using the EpicIntegrations Configuration Utility
Creating a New EpicIntegrations.config File
Modifying an Existing Configuration File
Upgrading an Existing Solution
Environment ID Configuration Settings
Deleting an Environment ID Mapping Row
Manual Configuration of the EpicIntegrations Configuration File
Installing the Web Viewer
Viewing Documents with the SMART on FHIR Integration
Viewing Documents with the COM Integration
Installing the Web Viewer Integration Files
Modifying the Web Viewer Configuration File
Configuring Environment IDs
Configuring the Page Event Timeout
Configuring Diagnostics Logging
Enabling Browser Developer Tools
Configuring the WebView2 User Data Folder File Location
Modifying the Web Server Configuration File
Modifying the Automatic Session Timeout Setting
Modifying E-Form and Unity Form Read-Only State Level
Connecting to a Database Manually
Specifying a Database
Disabling Deficiency Viewing
Disabling Physician Acknowledgment
Disabling Document Correction
Enabling Bi-Directional Communication
Enabling Bi-Directional Communication for SMART on FHIR Integrations
Enabling Bi-Directional Communication for COM Integrations
Configuring the Display of PDF Files
Configuring the Default Zoom Level
Modifying the Document Failed to Load Timeout
Installing the Scan Acquisition Server
How the Registry Is Used
Available Registry Settings
Choosing Where Registry Settings Are Stored
Installing Scan Client Files
Configuring EpicIntegrations.config for Scanning
Creating EpicIntegrations.config
Configuring Scan Settings in EpicIntegrations.config
Mapping Environment IDs in the Configuration File
Optional EpicIntegrations.config Scan Settings
Configuring the Default TWAIN Source
Turning Thumbnails On or Off
Scan Format Setup
Running the Scan Acquisition Server on a Test System
Enabling Digital Camera Support in Citrix Environments
Installing the Epic Front Office Scanning Integration
Installation Requirements
Installing the Front Office Scanning (FOS) Client
Creating the EpicIntegrations Configuration File
Mapping Environment IDs for Front Office Scanning
Front Office Scanning Differences in Epic
Configuration File Usage
Simplified Registration Scanning
Epic User Credentials
Background Uploads
Disconnected Mode
Close After Upload
Source of Data Sets
Keyword Mapping
Mapping Epic Keywords to Keyword Types
Mapping Required or Optional Keywords
Indexing Keywords Not Populated by Epic
Indexing Keywords with Epic Document Descriptions
Providing Default Values for Keyword Types
Document Types Available for Upload
One Specific Document Type
Multiple Specific Document Types
All Document Types Received From Epic
All Document Types in a Document Type Group
Overriding the Document Types From Epic
Document Descriptions
Configuring Default Description Values
Configuring a Maximum Number of Document Descriptions
Requiring Document Descriptions
Disabling Document Descriptions
Disabling User-Entered Descriptions
Saving User-Entered Descriptions
Text File for Saved Descriptions
Using the Epic Description to Index Documents
Requirements for Description Keyword Type
Sending Dates to Epic
Functional Overview
Disabling Dates
Saving Dates as Keyword Values
Simplified Scanning for Registration
Referrals: Link Existing OnBase Documents
Functional Overview
User Privileges for Linking Existing Documents
Configuring FOS to Link Existing Documents to Referrals
Referrals: Upload Documents from a Network Location
Functional Overview
Enabling Referral Document Upload for FOS
Moving EPICFOSCONFIG.xml
Preventing Links to Epic
Installing the Epic ROI Web Service Integration
Supported Epic Versions
Supported File Formats
Epic ROI Web Service Installation
EpicROIHandler.ashx Service Method
Application Server Configuration
HTTP and HTTPS
Timeout
Installing the EpicCare Link Integration
Supported Versions
Pre-Installation Steps for the EpicCare Link Integration
Creating the Configuration File for EpicCare Link
Installing OnBase Components on the EpicCare Link Server
Configuration Settings for the EpicCare Link Integration
appserverUrl
datasource
debugmode
debugLog
errorLog
colorImageAsJpegTiff
Epic Configuration for the EpicCare Link Integration
MediaHandlerProgIDs
WebMediaObject
MultipleMediaHandlers
Installing the Epic Image Retrieval API Integration
Supported Versions
Supported File Formats
Application Server Configuration
Identity Configuration
Data Source Configuration
Mapping HTTP Handlers
Windows Server 2012 R2
Windows Server 2016
Verifying HTTP Handler Mapping
BinaryDataRetrieval.svc
Disabling HTTPS
Installing DeficiencyPop for Epic
Supported Versions
Installing the Epic Welcome Integration
Supported Versions
Supplemental Installation for SMART on FHIR and Hyperdrive Deployments
General Requirements
Supported Versions
Supported Integration Components
Additional Resources
Application Server Requirements
Enabling SMART on FHIR on the Application Server
SMART on FHIR Launch Configuration
Configuring the Hyland Identity Provider for the Integration for Epic
Configuring a Provider for the Integration for Epic
Configuring the Integration for Epic Client to Use IdP Authentication
Configuring the SMART on FHIR Application for the Integration for Epic
Creating the SMART on FHIR Application
Configuring the SMART on FHIR Hyland IdP Settings
Configuring the SMART on FHIR EHR Authorization Settings
Web Viewer Requirements
Viewing Documents with the SMART on FHIR Integration
Enabling Bi-Directional Communication for SMART on FHIR Integrations
Scanning Requirements
Scanning Integrations
General Scanning Integration Configuration
Adding a FHIR Mapping Template for Integrated Scanning
Editing a FHIR Mapping Template for Integrated Scanning
Deleting a FHIR Mapping Template for Integrated Scanning
Hyperdrive Usage Considerations for Integrated Scanning
Reverse AutoFill Keyword Set Lookups
Troubleshooting for Integrated Scanning
Scan Acquisition Server Troubleshooting
Cannot Connect to Epic Hyperdrive
Missing or Empty Command Line Parameters
Scanning to Multiple Orders
Front Office Scanning Troubleshooting
Cannot Connect to Epic Hyperdrive
Missing or Empty Command Line Parameters
Scanning to Multiple Orders
DeficiencyPop Requirements
DeficiencyPop Scan Signature API URL Configuration
DeficiencyPop Provider ID Type Configuration
Integrating Epic with Multiple Systems
Solution Overview
Facility Mapping
Example Configuration
Assigning a Facility ID to a System
Changing a Facility ID
Mapping Facility IDs to URLs
Changing a Facility Mapping
Setting Up Integration Components
Application Servers
Scanning Integrations
EpicCare Link Integration
EpicCare Link Retrieval
EpicCare Link Upload
Epic Image Retrieval API Integration
Epic ROI Web Service Integration
Epic Welcome Integration
HL7
Sending HL7 Messages To Epic
Sending HL7 Messages From Epic
Signature Deficiencies for Epic
Legacy Licensing Introduction
Overview
Concurrent Client for EMR Integrations
Configuring the Application Server for EMR Licensing
Document Imaging
Front Office Scanning
Workflow
Workstation Client for Epic Welcome Kiosk
Epic Integrations Installer
Epic Integrations Installer Overview
Installer Requirements
Limitations
Installation
Introduction to Installers
Uninstalling Previous Versions
Preparing the Epic Integration Configuration Files
Running the Installer
Where to Run the Installer
How to Run the Installer
Scan Acquisition Server Installation Options
Front Office Scanning Installation Options
EpicCare Link Installation Options
Signature Deficiencies Installation Options
Change, Repair, or Remove an Installation
Installing Epic Integrations from the Command Line
Applying Component Installation Options
Adding Features
Configuring Properties
Features & Properties Reference for Command Line Installations
Important Notes
Server-Side Integrations
Client-Side Integrations
Configuration Properties for Command Line Installations
Scan Acquisition Server Properties
Front Office Scanning Properties
EpicCare Link Integration Properties
Citrix Installation
Citrix Installation Overview
Pre-Installation
Integrated Scanning
Epic Scanning Best Practices for Citrix Deployments
Overview
Scan Acquisition Server Setup for Citrix
Configuring Scan Acquisition Server Settings
Configuring Scan Formats
Configuring the Citrix Server
Front Office Scanning Setup for Citrix
EpicIntegrations.config Settings
EpicIntegrations.config Settings Overview
OBEpicViewer
<servers> Settings
<server>
environmentID
url
datasource
OBEpicScanControl
<Init> Settings
AllowLinkTypes
AutoCameraImport
AutoSaveRotation
DescriptionKeytype
DisableCameraSupport
DisableDocDescription
DisableSweep
DisableTwainSource
DisableWIA
EnableDocDate
GeneralHKCU
HttpTimeout
MaxDescriptions
OverridePort
OverrideSharedFormats
PreventEpicLinks
PreventLinkTypes
PrinterSinkIntegration
ScanHKCU
ServiceDatasource
ServiceURL (Required)
ShutdownDesktop
SkipWorkflow
UseServices
<Debug> Settings
ShowInput
ShowOutput
UseAllDT
WriteLog
<Diskgroup> Settings
ConfigPath
DeleteFilesTime
DescriptionPath
Path (Required)
Path Variables
<Scan> Settings
DriverCompressionOff
ForceCloseTwain
ForceTwainUI
LowTwainMode
SweepDisplay
TWAINNativeTransfer
<Mapping> Settings
FilePath
Configuration
Configuration Overview
General Configuration
User Group Configuration
Authentication Configuration
Configuring the User Name and Password
Configuring Encryption Settings for URL Integrations
Configuring Initialization Vectors for URL Integrations
Configuring the Clock Skew for URL Integrations
Changing Existing Values
Changing Existing Key Names
Epic Configuration
Web Viewer Component Configuration
URL Configuration
Document Correction Process
Designing a Correction Process
Configuring Document Types for Correction Forms
Form Template Configuration
Document Type Settings
Configuring HL7 for Corrections
Configuring Life Cycles for Corrections
Creating the Healthcare Document Correction Action
Document Correction Action Configuration
Creating an Action
Assigning an Icon
Assigning User Group Privileges
Re-ordering Actions
DocPop Document Correction
Configuring DocPop
Creating the DocPop Correction URL
Expected Document Correction Behavior
Integrating DocPop with Epic
Prerequisites
Creating a DocPop URL
Physician Acknowledgment
Configuring an HL7 Message Template for Physician Acknowledgment
Configuring a Scan Queue for Physician Acknowledgment
Configuring the Acknowledgement Note Type
Configuring Physician Users to Acknowledge Documents
Epic Physician Acknowledgment Processor
Addressing Burn Errors
Overriding Note Size Burn Errors
Shrink Stamp to Fit Note
Expand Stamp to Fit Text
Configuring Standard Note Types for Burning
Burn Processing for Standard Notes
Requirements for Burning Standard Notes
Configuring Standard Note Types to Burn on Documents
Notes, Redactions, Burned Markups, and Deficiencies on Documents with Overlays
Scan Acquisition Server Component Configuration
Scanning Prerequisites
Scanning Keyword Type Configuration
Hard-Coded Keyword Names
Identical Keyword Names
Keyword Mapping File (Recommended)
Mapping Keyword Types to Server & User Name Variables
Default Keyword Values
Mapping Default Values
Configuring Default Values
AutoFill Keyword Set Behavior
Scanning Document Type Configuration
Scan Acquisition Server: Filtering Document Types by Order Type
Scan Format Configuration
Scan Format Settings
Option: One document
Option: Multiple pages per doc
Option: One document per file
Option: Blank threshold
Option: Separate on blank page
Option: Discard blank page
Option: Sweep images Only
Option: Delete swept files
Option: Single file import
Option: Rotate pages (degrees)
Option: Separate on patch code
Option: Discard patch code page
Option: RemoteScan Digital Camera Format
Scanner Settings
File Format
Image Processing
Epic Front Office Scanning Integration Configuration
General Scanning Integration Configuration
Adding a FHIR Mapping Template for Integrated Scanning
Editing a FHIR Mapping Template for Integrated Scanning
Deleting a FHIR Mapping Template for Integrated Scanning
Epic Release of Information Integration Configuration
Environment ID Whitelist for ROI Integration
Printing Notes Using the ROI Integration
Printing Notes On Documents: Supported File Formats
Printing Notes After Documents
Printing Medical Deficiency Notes
Excluding Documents from ROI Printing
Accepted Data Formats
EpicCare Link Integration Configuration
EpicCare Link Document Type Configuration
Determining the Archival Document Type
Providing a Default Document Type for EpicCare Link Uploads
Mapping EpicCare Link Document Types
EpicCare Link Keyword Type Configuration
Keyword Mapping Logic for EpicCare Link
Mapping EpicCare Link Keyword Types
Epic Image Retrieval API Integration Configuration
Requirements for Displaying Notes
File Format Support for Notes
Note Type Print Settings
Medical Deficiency Notes
Configuring PDF Documents With Overlays to Display in Native Format
Configuring Image Documents With Overlays to Display in Native Format
DeficiencyPop for Epic Configuration
DeficiencyPop URL Configuration
DeficiencyPop for SMART on FHIR Configuration
DeficiencyPop Scan Signature API URL Configuration
DeficiencyPop Provider ID Type Configuration
Epic Welcome Integration Configuration
Epic Welcome Service Account Configuration
Epic Welcome Document Type Configuration
Mapping the Epic Welcome Document Type
Epic Welcome Keyword Type Configuration
Keyword Mapping Logic for Epic Welcome
AutoFill Keyword Sets for Epic Welcome
Mapping Epic Welcome Keyword Types
Epic Welcome: Application Server Web.config Settings
maxRequestLength
maxAllowedContentLength
External System Keys Reference
Usage
Usage Overview
Task Overview
Epic Desktop Document Scanning
Production Scanning
Epic Front Office Scanning
Epic Desktop Document Retrieval
EpicCare Link Document Retrieval and Upload
Epic Release of Information Document Printing
Epic Desktop Document Scanning
Opening the Scan Acquisition Server Client
Scanning Documents
Sweeping Files
Importing Images from a Digital Camera with WIA
Importing Images from External Media Using Autoplay
Importing Images from the Hyland Virtual Printer
Reviewing Documents
Indexing Documents
Production Scanning
Sending Documents to Physicians for Acknowledgment
Linking Physicians in the Client
Linking Physicians in the Unity Client
Epic Front Office Scanning
Startup for the Front Office Scanning Client
Indexing Documents Using Front Office Scanning
Data Sets
Document Types
Document Descriptions and Dates
Reverse AutoFill Keyword Set Lookups
Uploading Images
Discarding Images
Linking Existing Documents to Epic
EpicCare Link Document Retrieval and Upload
EpicCare Link Document Retrieval
EpicCare Link Document Upload
Epic Release of Information Document Printing
Printing Notes
Printing Medical Deficiencies
Supported File Formats for ROI
Epic Desktop Document Retrieval
Retrieving Documents
Comparing Documents
Sending a Document to Workflow for Review
Submitting a Document for Correction
Completing a Correction Form
Printing Documents Using Epic
Acknowledging Documents
Viewing Unity Forms
Navigating Documents
Web Viewer Document Shortcuts
Web Viewer Toolbars
Using Web Viewer Toolbars
Web Viewer Control Toolbar
Web Viewer PDF and OLE Document Viewer Toolbar
Web Viewer Annotations Toolbar
Moving and Resizing Annotations
Web Viewer Internal Text Search Toolbar
Performing an Internal Text Search
Generating an Internal Text Search Report
Web Viewer Pages Toolbar
Reordering Pages in a Document Using Thumbnails
Deleting Pages From Documents Using Thumbnails
Suppressing Blank Pages
Web Viewer Right-Click Menu Options
Accessing Document Properties
Encoding a Text Document
Accessing Document Processing Options
Notes
Adding Notes
Deleting a Note
Working in the Notes Dialog Box
Viewing a Document in the Notes Dialog Box
Viewing a Note in the Notes Dialog Box
Adding a Note in the Notes Dialog Box
Editing a Note in the Notes Dialog Box
Deleting a Note in the Notes Dialog Box
Setting Note Privacy Options
Notes Pane Viewer for OLE Documents
Access a Document's Keyword Values
Printing Documents from the Web Viewer
Printing E-Forms from the Web Viewer

Back to home page