Mapping Required or Optional Keywords - Integration for Epic - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Essential - Premier - Standard

Integration for Epic
Platform
OnBase
Product
Integration for Epic
Release
Foundation 23.1
License
Essential
Premier
Standard

In the Epic FOS XML configuration file, you can map Epic keywords to the OnBase Keyword Types in the Front Office Scanning Data Set by providing an additional attribute in the Keyword child element within either the Keywords parent element (the required Keyword Types section) or the DataSet parent element (the optional Keyword Types section).

When mapping Epic keywords to required or optional OnBase Keyword Types, note the following:

  • This configuration is only used to properly map the Epic keywords to OnBase Keyword Types. The mapping is not used for ad hoc Data Set creation, which is not allowed in the Epic Front Office Scanning integration.

  • If you are integrating with Epic Hyperdrive using a SMART on FHIR launch of the FOS client, any Epic keyword values mapped to OnBase Keyword Types in FHIR mapping templates are passed to the FOS client, regardless of what is configured in the Epic FOS configuration file. However, any Epic keyword specified in the Keywords or DataSet element of the Epic FOS configuration file is still considered required or optional for the FOS Data Set, respectively. For example, if no value is passed from Epic for an OnBase Keyword Type that is configured as required in the Epic FOS configuration file, a user must manually enter a value for that Keyword Type in the FOS client before uploading the document.

  • If you are not using a SMART on FHIR launch of the FOS client, any Epic keyword values that are not mapped to an OnBase Keyword Type in the Epic FOS configuration file are ignored by Front Office Scanning and excluded from the Data Set list of Keyword Values to be applied to the OnBase documents. Even if the names of the Epic keywords and OnBase Keyword Types are identical, they still must be mapped in the Epic FOS configuration file.

To map Epic keywords to required or optional OnBase Keyword Types:

  1. Open the Epic FOS XML configuration file (typically EPICFOSCONFIG.xml) in a plain-text editor, such as Notepad.
    By default, the Epic FOS XML configuration file is in the same location as the installation directory of the Front Office Scanning files.
    • On a 32-bit system, the default location is C:\Program Files\Hyland\Front Office Scanning
    • On a 64-bit system, the default location is C:\Program Files (x86)\Hyland\Front Office Scanning
  2. Locate one of the following elements:

    • For required Keyword Types for Data Sets, locate the Keywords element.

    • For optional Keyword Types for Data Sets, locate the DataSet element.

  3. Within the element you located, identify the Keyword child element associated with the required or optional OnBase Keyword Type to which the Epic keyword should be mapped.
  4. Within the Keyword child element you identified, add the epic attribute and set its value to the name of the Epic keyword.
    In the following example, there are two OnBase Keyword Types, Patient Full Name and Account Number, with the associated Epic keywords Patient Name and Account #, respectively. 
    <Keywords>
    <Keyword epic="Patient Name">Patient Full Name</Keyword>
    <Keyword epic="Account #">Account Number</Keyword>
</Keywords>
  5. Repeat the process of adding the epic attribute to each Keyword element representing a required or optional OnBase Keyword Type to which each Epic keyword should be mapped.
  6. Save the Epic FOS XML configuration file.