ICE runs on Tomcat 11 or Tomcat 10 and requires Java 25.

To install ICE using one of the downloadable distributions, you will need two things:

• The latest release of ICE - either the binary (zipfile) distribution or the docker image from Docker Hub.

• The Implementation Guide for Integrating with ICE.  (A "track changes" version of this same guide - highlighting what has changed since the last version of the guide - is also available.)

The installation steps described below apply to the zipfile distribution. Many of the settings are also used by the docker image - see the Docker Hub page for details.

1. Note that as of Version 2.52, the opencds.properties and ice.properties files are no longer used.
   For those who previously made configuration changes in ice.properties, the same settings are now located in application.yml.

2. Install Tomcat 11 or Tomcat 10, or identify an existing instance of Tomcat.

   1. Suggested JVM setting for tomcat: -Xms512m -Xmx2560m

3. Download the binary distribution for the most recent ICE release. (Alternatively, you may build an ICE executable from the source code which has been made available under the GNU LGPL v3 license).

   1. Unzip the zip file into the Tomcat webapp directory.

   2.  Logs are directed to the Tomcat catalina.out file. We suggest configuring Tomcat to rotate and/or expunge logs at periodic intervals to preserve disk space.

   3. Start up Tomcat

      1. The service WSDL will be available from the url: http(s)://hostname:port/opencds-decision-support-service/evaluate?wsdl

      2. The endpoint will be: http(s)://hostname:port/opencds-decision-support-service/evaluate

1. Implementation Guide for Integrating with ICE - Download this very important document to learn how to integrate a clinical information system with the ICE Web Service.

2. Download the WSDL files.

3. All messages to and from the ICE service conform to version 1.0 of the vMR. The vMR 1.0 XML Schema Definition files are required for client application development. In addition, the vMR Domain Analysis Model, Release 1 may be useful in understanding the elements of the vMR and how they are related. These documents and additional supporting documentation are posted on the Downloads page.

4. See ICE Output Tips and Tricks for other options.

Sample ICE client source code is available to make it easier for developers to integrate their clinical information systems with ICE. The source code for those ICE clients are located here:

• Java: https://github.com/cdsframework/cdsframework-support-client

• C#: https://github.com/cdsframework/cdsframework-client-support-.net

• Python: https://github.com/cdsframework/pyiceclient

The ICE server source code is available on GitHub. See Building ICE from Source Code for more information.