1. Programmer's Guide
  2. Enterprise Terminology Server (ETS)
  3. Loading and Activating Coding Scheme Versions

Loading and Activating Coding Scheme Versions

Terminologies have to be loaded into ETS (as coding scheme versions), imported, and activated before they are used. This includes initial versions of core terminologies, which have to be loaded, imported and activated at implementation.

ETS provides terminology loader and importer jobs that load and import a terminology after performing required validations. ETS provides custom loader and importer jobs for core terminologies, and generic loader and importer jobs for generic and custom terminologies.

Note:

New versions of the following terminologies can be loaded if required; HDR does not seed versions of these terminologies (they are available from Apelon, Inc.):
  • IETF RFC 1766
  • ISO 3166-1 alpha-2
  • NUBC-UB92

New versions of the following terminologies can be loaded if required; HDR does not seed versions of these terminologies (they are available from Apelon, Inc.).

Caution:

Do not load versions of terminologies that are seeded in HDR. These include:.
  • HL7
  • HDR Supplemental

If you have already loaded such versions, mark them as retired and non-default.

The procedure for implementing a new coding scheme version is the same for both generic and core terminologies. To load and activate coding scheme versions, perform the following steps:

Steps

  1. Prepare the terminology files.
  2. Load the terminology into ETS as a coding scheme version.
  3. Publish the coding scheme version.
  4. Activate the coding scheme version.

You can use HDR Terminology Jobs to load and publish coding scheme versions.

See also:

  • /ets/hdr-ets-1.0.0-SNAPSHOT/db/execute/readme from hdr-1.0.0-SNAPSHOT.zip for additional information about loading.

    The notes can be categorized into DBA, General, and Terminology related notes.

    • DBA Notes: Gives a brief description of some common database management issues related to ETS, such as sizing issues, rollback adjustments for loads and imports, intermedia text indexes, and load/import performance, as well as a general description of database access patterns of ETS.
    • General Notes: Gives the basic principals common to all terminology file formats. This section must be read before moving on to the details of specific loader file formats.
    • Terminology Notes: Gives additional information relating to the core terminologies supported in ETS. Each of the core terminologies have a separate notes file. These files are to be referenced for information relating to the respective loader file formats.

Preparing Terminology Content and Control Files

To create the terminology files and move them into the correct folder, perform the following steps:

Steps

  1. If the terminology is a generic terminology, create the terminology files in the format expected by the ETS generic loader. Otherwise, ensure that the files are in the format expected by the appropriate terminology loader. (If the terminology is supported by Apelon, this step is not required.)

    See also:

    • /ets/hdr-ets-1.0.0-SNAPSHOT/db/execute/readme from hdr-1.0.0-SNAPSHOT.zip, for details regarding file formats required by ETS terminology loaders.
    • /ets/hdr-ets-1.0.0-SNAPSHOT/db/execute/readme/Change_File_Formats_General.txt from hdr-1.0.0-SNAPSHOT.zip, for details about change files.

    Note:

    • To load equivalence information for the terminology version being loaded, the change file must be specified while loading the version-ETS does not support retrospective loading of change information.
    • For equivalence processing to be performed correctly, versions must be loaded in order. Equivalence processing assumes that the codes referenced in the change file are from the version currently being loaded and its immediate predecessor.
  2. Move the terminology files to a directory in the same file system as the Applications instance-a directory that is accessible by the Oracle Database Scheduler (DBMS_SCHEDULER).
  3. Create a control file that reflects the locations of the terminology files and move it to a directory in the same file system as the Applications instance-a directory that is accessible by the Oracle Database Scheduler (DBMS_SCHEDULER).

Creating New Generic Coding Schemes

ETS lets users define and implement custom terminologies for specific needs. Custom terminologies must be based on the generic ETS terminology model. Coding schemes that implement the generic terminology model are known as generic coding schemes.

See also:

Loading a Coding Scheme Version

To load a new coding scheme version, use the Oracle Database Scheduler (DBMS_SCHEDULER).

See also:

  • /ets/hdr-ets-1.0.0-SNAPSHOT/db/execute/readme from hdr-1.0.0-SNAPSHOT.zip, for information about control files.

Using Oracle Database Scheduler (DBMS_SCHEDULER)

Select the HDR Loader Job, and enter values for the Control File (absolute path), Coding Scheme Name, and Coding Scheme Version Name parameters.

Publishing a Coding Scheme Version

A loaded terminology is staged for importation into ETS. Use HDR Importer Job directly for publishing a coding scheme version.

The published coding scheme version is in the quarantined state by default. The coding scheme version must be activated before it can be used.

Note:

In order to support concept equivalence, the HDR Importer job process does not publish a second quarantined version of a coding scheme if one already exists. This facilitates verification of equivalence between the quarantined version and the previous version of the terminology before the quarantined version is published.

Using Oracle Database Scheduler (DBMS_SCHEDULER)

For publishing a staged coding scheme version, select the HDR Importer job, and enter values for the Load Sequence Number and Dry Run Mode parameters. You can get the Load Sequence Number from the log file of the HDR Loader job that has successfully loaded the data (coding scheme versions, classifications, and cross maps).

See also:

  • Oracle Applications System Administrator's Guide

Note:

In order to support concept equivalence, the HDR Importer job does not publish a second quarantined version of a terminology if one already exists. This facilitates verification of equivalence between the quarantined version and the previous version of the terminology before the quarantined version is published.

See also:

  • /ets/hdr-ets-1.0.0-SNAPSHOT/db/execute/readme, for details regarding file formats for ETS terminologies and loaders.

Activating a New Terminology Version

A quarantined coding scheme version must be activated before it can be used. A quarantined version can be activated only ETS API.