Omni-Patient™ Server User’s Guide > Configuring Omni-Patient Server > Cleansing

Cleansing

Topics:

After enhancement with codes IDS documents are cleansed. This cleansing service is configurable through a configuration file. Cleansing can be disabled by commenting out all subjects. This file is located in the following directory and is called OmniCleansing.xml: 

[OmniPatient Home]/iway7/config/OmniPatient/resource

A snippet of this file is shown below.

Turning Cleansing Off

To turn cleansing off, comment out the subject element that contains a name attribute matching the IDS root tag. For example comment out <subject name="Patient"> to stop cleansing of Patient IDS documents.

Configuring Cleansing

The cleansing of an IDS document is broken into sections and managed by the existence of a <routine> element. Each <routine> element under a root subject element is evaluated and the cleansing routine is executed based on the configuration specified in the child elements. The routines are executed in the order they exist in the configuration document. A cleansing routine is made up of the following elements:

  • <subject name="">. The start of a new cleansing section. The name attribute should equal the name of the root element of the IDS. The name is case sensitive.
  • <routine name="">. The root routine element. The name element is option.
  • <endpoint>. This is the endpoint URL of the DQC cleansing web service.
  • <request>. This is the name of the request as defined in the WSDL for the specific cleansing web service it is used to wrap the request body and define the soap action.
  • <iterate_xpath> (Optional). An XPath to a collection to be cleansed. If included, multiple web service calls will be made and the request element input values will have the element XPath evaluated against each member of the collection.
  • <input>. This collection contains the names of elements that make up the request body and the XPath that sets the values.
  • <element><name>. The name of input element as defined in the WSDL for the cleansing web service. These elements must begin with in_. The in_ defines element that will return cleansed values.
  • <element><cleansed_name> (Optional). The name of the element in the cleansing web service response containing the cleansed value. If omitted, the element name is assumed to be the value of <element><name> with the in_ replaced with std_.
  • <element><xpath>. An XPath that returns a value from an element in the IDS document. When the <iterate_xpath> element is set, this XPath becomes relative to the root found by the iterate XPath.