Bookmark and Share

Direct Customization of Encounter XML

You are here:
← All Topics

First & foremost, understand that the Encounter is designed to allow customization via the ECLIPSE user interface. Any attempt to directly customize your Encounter templates in an XML editor is simply not supported by us (nor should you need any help from us in the event you have extensive experience with XML).

The information below is not a tutorial — such concepts simply don’t apply to the internal workings of ECLIPSE. Regardless, for those who intend to tinker & insist on editing our templates manually, please be aware of the following:

  • ECLIPSE has 3 integrated types of templates.
  • First, there are base templates (e.g. Cervical.xml or Custom1.xml). These are provided by & routinely updated by us.
  • Next, there are templates that contain custom rows (e.g. Cervical_CustomRows.xml or Custom1_CustomRows.xml) created automatically via the existing user interface when you add or edit rows.
  • Finally, there are templates that contain custom data (e.g. alternate dropdown list selections) for placement in existing rows (e.g. Cervical_custom.xml or Custom1_custom.xml).
  • Each template has its own structure, is parsed accordingly and ultimately merged. (NOTE: If you’re not familiar with the concept of parsing, please reconsider what you’re attempting.)
  • You should never customize base templates. We may overwrite them during program updates.
  • Carefully review the template’s structural hierarchy. If you break that hierarchy by making assumptions & creating your own structure, ECLIPSE will almost certainly not function properly. For example, ECLIPSE looks for “Subjective” and other top level XML tags by name. If you create your own top level tags, ECLIPSE will simply ignore them during parsing of the final note.
  • To observe what you *can* do, create some rows and add data within ECLIPSE. Then, examine the resulting structures in each file. Remember, if you violate the expected hierarchy, ECLIPSE can’t parse your data. Pay careful attention to the tags before preceding on your own.
  • If you update existing formats (e.g. by inserting columns in a grid) you may destroy the integrity of previously saved data.
  • Within a template, all ECLIPSE variable names follow the same naming convention. Each name is preceded by a common prefix. The only exception is today’s date. As a result, the “date” variable is shared among all templates. When you don’t follow this convention, you risk data from one template overwriting same-named variables in another template.
  • Important to remember: Keep in mind that your Encounter data helps comprise a legal document! Improperly edited templates can cause problems with stored patient Encounter data. And we cannot magically fix problems that result.


Finally, our Help Desk personnel are not computer programmers & cannot help troubleshoot your xml edits. We suggest that you take the time to review existing video documentation for the Encounter by clicking here & work within the  boundaries of the user interface.