ICE is open source software and in active development. This distribution comes bundled with OpenCDS 7.0.1 libraries. The ICE software will continually update to the latest versions of OpenCDS as they become available.
- Project Information: https://cdsframework.atlassian.net/wiki/spaces/ICE/overview
- Latest News: https://cdsframework.atlassian.net/wiki/spaces/ICE/pages/23920670/News
- Capabilities Overview: https://www.hln.com/ice/
- Documentation (default immunization rules, technical docs for ICE and CAT): http://www.cdsframework.org/
- Commercial Support (HLN Consulting): https://www.hln.com/ice/
- Questions: ice@hln.com
If you are interested in receiving periodic e-mails pertinent to ICE, you may subscribe to join the ICE Announcements E-mail List. We send e-mail to this list when there is important information to share about new releases or relevant to the operation of ICE. This is a low-volume list and we do not share group members' e-mail addresses with anyone.
This version of ICE requires Java 25. Prior versions of Java will not work.
To install the software, please follow the directions at Installing ICE to configure and interact with the service. The out-of-the-box working ICE service executable is available at this location.
ICE can be run either as a standalone Spring Boot service or deployed to an Apache Tomcat instance.
-
Edit
src/main/resources/application.ymlto suit your installation, taking care to only modify entries you're familiar with. If you are unsure, the configuration will work without any changes. -
Using Java 25 and the latest release of Maven 3.9, compile the software:
mvn clean install
ICE can be run standalone or deployed to Tomcat. It is recommended to allocate at least 2GB of memory regardless of the method chosen.
If running under Tomcat, it is recommended that at least 2GB of memory be allocated to a Tomcat 11 or Tomcat 10 instance.
To install into Tomcat:
- Shut down Tomcat, if running
- Copy
target/opencds-decision-support-service.warto the Tomcat webapps directory - Start Tomcat
Logs are directed to catalina.out. We suggest configuring Tomcat to rotate and/or expunge logs at periodic intervals.
This is the fastest standalone method, matching Tomcat performance. It extracts the WAR so that classes load directly from the filesystem rather than from nested archives inside the WAR.
mkdir -p ice-app && cd ice-app
jar -xf ../target/opencds-decision-support-service.war
java -Xms512m -Xmx2g org.springframework.boot.loader.launch.WarLauncherLogs are directed to standard output by default. You can configure logging in application.yml.
The standalone options (B, C, D) start on port 8080 by default. To change the port, add to application.yml, for example:
server:
port: 9080Running java -jar on the WAR file is simple, but is slower than Options A and B due to Spring Boot's nested archive class loading.
java -Xms512m -Xmx2g -jar target/opencds-decision-support-service.warRunning via Maven is convenient during development but is the slowest option due to overhead.
MAVEN_OPTS="-Xms512m -Xmx2g" mvn spring-boot:runCopyright (C) 2026 New York City Department of Health and Mental Hygiene, Bureau of Immunization Contributions by HLN Consulting, LLC
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. You should have received a copy of the GNU Lesser General Public License along with this program. If not, see http://www.gnu.org/licenses/ for more details.
The above-named contributors (HLN Consulting, LLC) are also licensed by the New York City Department of Health and Mental Hygiene, Bureau of Immunization to have (without restriction, limitation, and warranty) complete irrevocable access and rights to this project.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS, IF ANY, OR DEVELOPERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY OF ANY KIND, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
For more information about this software, see http://www.hln.com/ice or send correspondence to ice@hln.com.