Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Release 1.42.1.4


The current release is version 1.42.1.3 4 - Released March 7th18th, 2024.    (Download the latest ICE release now)

...

Please subscribe to the ICE Announcements E-mail List, or contact us at ice@hln.com and we can add your e-mail address for you. We send e-mail to this list only when there is important information to share about new (or upcoming) releases or information pertinent to the operation of ICE. It is a low-volume list direct from the ICE team and we do not share group members' e-mail addresses with anyone.

Excerpt

Current News

  • March 18, 2024 - New Release of ICE - Version 1.42.1.4
    • A new release of ICE is available - Download the latest ICE release now.
    • 1.42.1.4 fixes a dose numbering issue for young patients who are continuing in an < 5 years series after 9/12/2023, clarifies a special rule in the >= 5 year series and corresponding logic to address an exception related to the handling of CVX 313, and extends the "start" date for COVID-19 vaccines in the prior season. 
    • For information about what is included in version 1.42.1, please see the News entry below and the Release Notes.
    • If you have any questions, comments, or suggestions, please do not hesitate to e-mail us at ice@hln.com.


  • March 7th, 2024 - New Release of ICE - Version 1.42.1.3
    • A
    new
    • new release of ICE is available - Download the latest ICE release now.
    • 1.42.1.3 fixes an issue discovered in v1.42.1.2. In certain situations, some historical COVID doses prior to September 12, 2023 were being evaluated as Accepted rather than Valid. This release fixes this issue.
    • For information about what is included in version 1.42.1, please see the News entry below and the Release Notes.
    • If you have any questions, comments, or suggestions, please do not hesitate to e-mail us at ice@hln.com.


  • March 5th, 2024 - New Release of ICE - Version 1.42.1.2
    • Version 1.42.1.2 fixes an issue that was discovered in version 1.42.1. Some shots in the >= 5 year COVID-19 series were incorrectly being evaluated as Invalid. Those who download version 1.42.1 will need to upgrade to this release which addresses this issue.
    • For information about what is included in version 1.42, please see the News entry below and the Release Notes.
    • If you have any questions, comments, or suggestions, please do not hesitate to e-mail us at ice@hln.com.


  • March 1st, 2024 - ICE Version 1.42.1
    • Version 1.42.1 includes updates to support the COVID-19 recommendations introduced on September 12, 2023. These recommendations are supported by an additional set of logic for the COVID-19 Vaccine Group. The new COVID-19 - September 2023 Onwards logic includes five series and adds support for the updated (2023–2024 formula) COVID-19 vaccines: CVX 309, CVX 310, CVX 311, CVX 312, and CVX 313. See the Release Notes for additional details.
    • The ICE Implementation Guide has been updated with the new COVID-19 codes: CVX 309, CVX 310, CVX 311, CVX 312, and CVX 313, and the new Sept 2023 COVID-19 series names. 
    • A Google Sheet that lists all the coded values in the Implementation Guide is also available. 
    • Forthcoming ICE updates will include the introduction of a new RSV Vaccine Group, to support RSV recommendations for infants and older adults, as well as updates to the COVID-19 – September 2023 Onwards logic. The COVID-19 – September 2023 Onward logic update will address the February 28, 2024, ACIP vote and subsequent CDC endorsement of the recommendation for adults ages 65 years and older to receive an additional dose of the updated 2023-2024 COVID-19 vaccine.
    • Not sure which version of ICE you're currently using? View the README.HISTORY file included with each zipfile distribution or pull the version dynamically at the following endpoint: http(s)://<host>:<port>/path/to/opencds-decision-support-service/version.
    • If you have any questions, comments, or suggestions, please e-mail us at ice@hln.com.


  • The Importance of Upgrading After Each ICE Release
    • With each new release, we strongly recommend that all users and service providers update their running instances of ICE as soon as possible to the latest version. Each new release contains important forecaster business logic updates and fixes.


  • ICE Code Systems and Codes Now Available in Google Sheets
    • The ICE code systems and codes are now accessible in Google Sheets as an added convenience. These are the codes as those in the Implementation Guide. The codes will continue be updated in both the places.
    • The Google Sheet is available here.


  • Configuration Note
    • As of release 1.24.1, the ICE service is configured with the output_supplemental_text option in the properties file set to enabled by default.
    • As of release 1.16.1, the ICE service is configured by default to return the earliest and overdue dates in addition to the recommendation date. In prior releases, the default configuration was to return only the recommendation date for the forecast.
      • If your application has not been configured to display the earliest and/or overdue dates, we recommend turning this feature off by changing the output_earliest_and_overdue_dates value in the ice.properties file to "N". Failure to do so may result in incorrect interpretation of the recommendation date.
      • If you are interested in returning the earliest date or overdue date, please refer to the latest ICE Implementation Guide for details indicating precisely where each of the forecast dates – earliest, recommended, and overdue – are specified in the ICE output, and under what circumstances.

Prior News

  • November 3, 2023 - New Release of ICE - Version 1.41.1
    • A new release of ICE is available - Download the latest ICE release now.
    •  See the Release Notes for additional details.Version 1.41.1 includes updates to the Pneumococcal vaccine group to support 20-valent pneumococcal conjugate vaccine (PCV20) use in children.
    • There are no changes to the ICE Implementation Guide with this release. A Google Sheet that lists all of the coded values in the Implementation Guide is also available. 
    • The ICE team is continuing work on enhancements to address new recommendations for COVID-19 and RSV. Releases with support for these changes are forthcoming. 
    • Not sure which version of ICE you're currently using? View the README.HISTORY file included with each zipfile distribution or pull the version dynamically at the following endpoint: http(s)://<host>:<port>/path/to/opencds-decision-support-service/version.
    • If you have any questions, comments, or suggestions, please e-mail us at ice@hln.com.

...

  • October 6, 2023 - New Release of ICE - Version 1.40.1
    • A new release of ICE is available - Download the latest ICE release now.
    • Version 1.40.1 includes updates to an ICE General Rule and updates to the following vaccine groups: DTP, Influenza, MMR, and Varicella. A summary follows. See the Release Notes for additional details.
      • General Rule, Live Vaccine IntervalUpdated the live vaccine interval rule to allow for an absolute minimum interval of 24 days, instead of 28 days, for live virus vaccines from the same vaccine group. 
      • DTPUpdated logic to adjust forecasting at the group level or CVX level, depending on the scenario. Added a new recommendation reason code: ADMINISTER_TDAP_OR_TD.
      • InfluenzaUpdated several CVX code descriptions to better align with CDC CVX code descriptions. Minor rule phrasing adjustments to enhance rule clarity.
      • MMRUpdated the dose 1 to dose 2 absolute minimum interval from 28 days to 24 days (live vaccine interval change). Improved the deduplication/same day logic. 
      • VaricellaUpdated the dose 1 to dose 2 absolute minimum interval from 28 days to 24 days for patients >= 13 years of age (live vaccine interval change).
    • The ICE Implementation Guide has been updated with a new recommendation reason code: ADMINISTER_TDAP_OR_TD.
    • A Google Sheet that lists all of the coded values in the Implementation Guide is also available. A version of the ICE Implementation Guide that highlights these changes is located here.
    • Not sure which version of ICE you're currently using? View the README.HISTORY file included with each zipfile distribution or pull the version dynamically at the following endpoint: http(s)://<host>:<port>/path/to/opencds-decision-support-service/version.
    • The HLN ICE team is actively working on enhancements to address new recommendations for COVID-19, pneumococcal, and RSV. Work on supporting the latest COVID-19 recommendations, recommendations for the use of PCV20 in children, and RSV recommendations for infants and adults is concurrent. Multiple releases are anticipated, between late October and November, to add support for these changes.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.
  • August 21, 2023 - New Release of ICE - Version 1.39.2
    • A new release of ICE is available - Download the latest ICE release now.
    • Version 1.39.2 addresses an issue in 1.39.1 in the COVID-19 vaccine group where the recommendation was incorrect as follows:
      • For the Pfizer Series, when recommending the 2nd dose during the following timeboxed scenario: If the patient is >= 5 years of age and the 1st dose was administered with a monovalent vaccine and within 8 weeks before 4/19/2023, ICE (1.39.1) incorrectly uses a 21 day interval rather than an 8 week interval. HLN has updated the COVID-19 Vaccine Group page to specify the changes made in 1.39.2. The changes are noted in blue in the Pfizer and Mixed Product Series interval tables towards the bottom of the page.
      • Novavax Series: If the Novavax Series was completed after 4/19/2023, ICE (1.39.1) was indicating that the series was complete. Instead, the correct recommendation is a bivalent dose 8 weeks later.
    • Version 1.39.2 is a drop-in replacement for version 1.39.1. We suggest upgrading as soon as possible.
    • There are no new code updates nor updates to the ICE Implementation Guide.
    • Not sure which version of ICE you're currently using? View the README.HISTORY file included with each zipfile distribution or pull the version dynamically at the following endpoint: http(s)://<host>:<port>/path/to/opencds-decision-support-service/version.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.
  • July 20, 2023 - New Release of ICE - Version 1.39.1
    • A new release of ICE is available - Download the latest ICE release now.
    • Version 1.39.1 includes updates to the following vaccine groups: COVID-19, Influenza, and Pneumococcal; a summary follows. See the Release Notes for additional details.
      • COVID-19
        • Support for a Pfizer bivalent booster dose for children aged 6 months through 4 years
        • Expanded support for bivalent vaccines based on most recent guidance (within the primary series and boosters)
        • Fixed a processing issue for select patients who have two CVX 212 vaccines administered on the same day.
      • Influenza: updated wiki to reflect the 2023-2024 season (no evaluation and/or forecasting changes) and added support for CVX 231.
      • Pneumococcal: fix to the Adult Recommendation Rules supplemental text descriptive text returned for patients >= 19 years and < 65 years of age with an incomplete pneumococcal series.
    • The ICE Implementation Guide has been updated with the below new codes. 
      • CVX 231 (Influenza, Southern Hemisphere, high-dose, quadrivalent)
      • Evaluation reason code VACCINE_NOT_YET_AVAILABLE_ON_DATE_SPECIFIED
      • Eecommendation reason code ADMINISTER_COVID19_BIVALENT_VACCINE.
    • A Google Sheet that lists all of the coded values in the Implementation Guide is also available. A version of the ICE Implementation Guide that highlights these changes is located here.
    • Not sure which version of ICE you're currently using? View the README.HISTORY file included with each zipfile distribution or pull the version dynamically at the following endpoint: http(s)://<host>:<port>/path/to/opencds-decision-support-service/version.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com
  • March 17th, 2023 - New Release of ICE - Version 1.38.1
    • A new release of ICE is available - Download the latest ICE release now.
    • Version 1.38.1 includes updates to the COVID-19 Vaccine Group - Prior to September 12, 2023 to align ICE with the latest guidelines. Version 1.38.1 also includes minor updates to the DTP, Polio, Hep B and Orthopoxvirus vaccine groups. A summary of updates follows. The Release Notes has additional details.
    • The ICE Implementation Guide has been updated with the following new CVX codes: (1) COVID-19 CVX codes: 230, 302, 518, 519, 520, 521; (2) DTP CVX codes: 195, 196; (3) Polio CVX codes: 195A Google Sheet that lists all of the coded values in the Implementation Guide is also available. A version of the ICE Implementation Guide that highlights these changes is located here.
    • Not sure which version of ICE you're currently using? View the README.HISTORY file included with each zipfile distribution or by hitting the following endpoint: http(s)://<host>:<port>/path/to/opencds-decision-support-service/version.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.
  • December 12th, 2022 - New Release of ICE - Version 1.37.2
    • A new release of ICE is available - Download the latest ICE release now.
    • This release corrects 2 issues identified in version 1.37.1:
      • COVID-19: Incorrect evaluation of some shots due to malformed XML in the Mixed Product Series and series selection logic related to CVX 213.
      • Hep B: When no shots are administered, incorrect conditional status for patients >= 19 years of age. Conditional status should start at age >= 60 years.
    • The ICE Implementation Guide remains unchanged.
    • To determine which version of ICE you're currently using, view the README.HISTORY file included with each zipfile distribution or by point your browser to the following URL: http(s)://<host>:<port>/path/to/opencds-decision-support-service/version.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.

...

  • August 31, 2022 - Bug Fix Release of ICE - Version 1.36.1
    • A new release of ICE is available  -  Download the latest ICE release now.
    • Version 1.36.1 includes the following additions and updates. Please see the Release Notes for details.
      • New Vaccine Group: Orthopoxvirus for May 2022 Emergency Use Authorization (Monkeypox)
        • New vaccines: CVX codes 75, 105, 206
        • The vaccine group can optionally be enabled or disabled.
          • In the zipfile distribution, the Orthopoxvirus vaccine group is disabled by default.. It can be enabled by removing the property value VACCINE_GROUP_CONCEPT.860 from the vaccine_group_exclusions property in the ice.properties file. The vaccine_group_exclusions property is a way to omit vaccine groups from the forecast, comma-delimited.
          • In the docker image distribution, the Orthopoxvirus vaccine group is enabled by default. It can be disabled by setting the VACCINE_GROUP_EXCLUSIONS environment variable with the value VACCINE_GROUP_CONCEPT.860.
      • Pneumococcal Vaccine Group Update:
        • Added new recommendation rule: "If the patient is < 65 years of age, received a valid dose in an Adult Series at < 65 years old, and the series is not complete, recommend Conditional/ HIGH_RISK".
    • The ICE Implementation Guide has been updated with the following new codes:
      • CVX codes: 75, 105, 206
      • A Google Sheet which lists all of the coded values in the Implementation Guide is also available.
      • A version of the ICE Implementation Guide that highlights these changes is located here.
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each zipfile distribution.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.

...

  • December 22, 2021 - New Release of ICE - Version 1.33.1
    • A new release of ICE is available  -  Download the latest ICE release now.
    • Version 1.33.1 includes the following additions and updates. Please see the Release Notes for details.
      • COVID-19 Vaccine Group Updates:

        • COVID-19 Booster Dose rules - Updated and added additional rules for patients who completed Pfizer 2-dose series, Moderna 2-dose series, Janssen 1-dose series, Pfizer COVID-19 Child (5-17) 2-dose series, COVID-19 vaccine series not authorized by the FDA, but authorized by the WHO, or a COVID-19 vaccine series not authorized by the FDA or WHO, but is an active COVID-19 vaccine candidate as part of a U.S.-based clinical trial of a COVID-19 vaccine. 
          • Booster Dose Minimum Age has been updated to 16 years to support new CDC recommendation that 16-17 year olds "may" receive a Pfizer booster.
        • COVID-19 Additional Dose rules - Updated and added additional rules for patients who completed Pfizer 2-dose series, Moderna 2-dose series, Janssen 1-dose series, Pfizer COVID-19 Child (5-17) 2-dose series, COVID-19 vaccine series not authorized by the FDA, but authorized by the WHO, or a COVID-19 vaccine series not authorized by the FDA or WHO, but is an active COVID-19 vaccine candidate as part of a U.S.-based clinical trial of a COVID-19 vaccine. 
        • New COVID-19 vaccine (CVX 217) - Added support and logic
          • Note - CVX 217 is a new Pfizer formulation for ages 12+ under EUA; can be used in the same way as CVX 208
        • Pfizer 2-dose series
          • Updated Absolute Minimum Intervals between Dose 1 and Dose 2
        • Moderna 2-dose series 
          • Updated Absolute Minimum Intervals between Dose 1 and Dose 2
          • Updated Absolute Minimum Age for Dose 1
          • Updated Absolute Minimum Age for Dose 2
          • Updated Minimum Age for Dose 2
          • Updated Routine Age for Dose 2
      • An updated Implementation Guide with the following new codes:
        • CVX 217 - new COVID-19 Pfizer formulation for ages 12+ under EUA; can be used in the same way as CVX 208
    • Version 1.33.1 also includes an important security fix. We strongly recommend that users update as soon as possible.
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each zipfile distribution.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.

...

  • September 21, 2021 - New Release of ICE - Version 1.30.1
    • A new release of ICE is available.  Download the latest ICE release now.
    • Version 1.30.1 includes the following additions and updates. Please see the Release Notes for details.
      • COVID-19 Updates:

        • COVID-19 Additional Dose - a dose administered when the immune response to a standard primary vaccine series is likely not to be protective.
          • Note - Alternatively, a “booster” dose of vaccine is a dose administered to restore protection after the effectiveness of protection from the primary series has declined. Once FDA approval is granted and ACIP recommendations are published in regards to "booster" doses, ICE will be updated accordingly; updates will likely be included in the next release of ICE. 
        • Additional COVID-19 vaccines:
          • COVID-19 Vaccines Not Authorized by FDA, but Authorized by WHO
            • Note - The previous version of ICE, Version 1.29.1 supports the handling of one COVID-19 vaccine that falls under this category - AstraZeneca COVID-19 vaccine (CVX 210).
          • COVID-19 Vaccines Not Authorized by the FDA or WHO
          • COVID-19 Vaccines Not Authorized by the FDA or WHO, but is an active COVID-19 vaccine candidate as part of a U.S.-based clinical trial of a COVID-19 vaccine
          • Please see the COVID-19 Vaccine Group page for details.
        • In addition to the above updates, added evaluation reason code VACCINE_NOT_APPROVED_IN_US_OR_BY_WHO to the ICE Implementation Guide. 
      • Live Virus Bug Fix:
        • Fix bug where, in certain circumstances, ICE is incorrectly recommending Varicella or MMR 28 days later rather than on the same day.
      • Updated Implementation Guide
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each zipfile distribution.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.
  • May 14, 2021 - New Release of ICE - Version 1.29.1
    • A new release of ICE is available.  Download the latest ICE release now.
    • Version 1.29.1 includes the following additions and updates. Please see the Release Notes for details.
      • COVID-19 Update: 

        • Updates have been made to expand age ranges down to >= 12 years old for the Pfizer COVID-19 Vaccine (CVX 208).
        • Recommendations have been updated to recommend COVID-19 vaccine to patients >= 12 years old. 
        • Support has been added to handle AstraZeneca COVID-19 vaccine (CVX 210) shots reported on the patient record.
          • As of now, the AstraZeneca COVID-19 vaccine has not yet been approved for use in the U.S. by the FDA, but is approved by the WHO. Please see the COVID-19 Vaccine Group page for details.
          • When the FDA approves the AstraZeneca COVID-19 vaccine (CVX 210) for use in the U.S., ICE will be updated as necessary.
        • In addition to the above updates, added evaluation reason code VACCINE_NOT_APPROVED_IN_US to the ICE Implementation Guide. 
      • Influenza Update:
        • Influenza 2021-2022 Season rules remain unchanged from last season. ICE has been updated to reflect that.
      • Updated Implementation Guide
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each zipfile distribution.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.

...

  • February 25, 2020 - Upcoming Release of ICE 
    • HLN is actively monitoring all news and updates in regards to new and existing COVID-19 vaccines (most recently, the Johnson & Johnson COVID-19 vaccine). Key dates that we are tracking:
      • Friday, 2/26 - Vaccine advisers to the FDA will meet to discuss whether to recommend the vaccine for Emergency Use Authorization (EUA); FDA will ultimately decide whether or not to grant EUA approval for the vaccine. 
      • Sunday, 2/28 - Monday, 3/1 - CDC ACIP Emergency Meeting to discuss vaccine recommendations (if approved for EUA).
    • Once a vaccine has been approved for use by FDA (either Expanded Access, EUA, or full licensure), ACIP will hold an emergency meeting and publish recommendations in a very quick timeframe (i.e. days). HLN intends to release a version of ICE that includes COVID-19 forecasting as early as possible after ACIP has published the guidelines. This initial release will contain COVID-19 logic known at the time of the release. As additional, actionable information on COVID-19 forecasting becomes available from official sources, HLN will continue to release additional versions of ICE, at appropriate times to reflect ongoing updates.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.

...

  • December 15, 2020 - New Release of ICE - Version 1.26.2
    • A new release of ICE is available. 
    • Version 1.26.2 fixes a bug in Version 1.26.1 related to COVID-19 forecasting.
    • Users who installed Version 1.26.1 should update to this release as soon as possible. 
    • As noted below, the ICE Implementation Guide contains the new codes relevant to COVID-19: CVX codes and a new Vaccine Group code for COVID-19.
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each zipfile distribution.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.
  • December 14, 2020 - New Release of ICE - Version 1.26.1
    • A new release of ICE is available.  
    • Version 1.26.1 includes the following additions and updates. Please see the Release Notes for details:
      1. ICE support for new COVID-19 Vaccine Group (with Pfizer vaccine only)
      2. Note: The subsequent release, soon after, will likely add support for the Moderna vaccine.
    • The ICE Implementation Guide has also been updated with the new codes for COVID-19: CVX, Vaccine Group, Evaluation Focus and Recommendation Focus codes.
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each zipfile distribution.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.

...

  • November 6, 2020 - New Release of ICE - Version 1.24.1
    • A new release of ICE is available. 
    • Version 1.24.1 includes the following additions and changes.
      • Logic updates to DTP, Varicella, Hib and MMR. Please see the Release Notes for details.
      • Security updates and upgrade to latest version of Drools.
      • The output_supplemental_text option is now enabled by default, but can be disabled by setting this option to "N" in the ice.properties file. Supplemental text is currently returned by some DTP and Pneumococcal rules in either evaluation of shots or recommendations. The ICE Implementation Guide describes this feature.
    • There are no changes to the ICE Implementation Guide since 1.23.1. However:
    • Note that the following configuration files and directories have minor modifications from prior releases: ice.properties, log4j and knowledge module directory location. If you are updating from a previous release of ICE and wish to change any of the properties in these files, the changes will need to be made in these files directly as the prior files will not work.
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each distribution.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.
  • September 13, 2020 - New Release of ICE - Version 1.23.1
    • A new release of ICE is available.
    • Version 1.23.1 includes the following additions and changes. Please see the Release Notes for details for all of the below:
      1. Support for new Influenza vaccines and 2020-2021 Influenza season (unchanged from previous year) in Influenza Vaccine Group.
    • The ICE Implementation Guide has also been updated with the new influenza codes. A version of this same guide with the changes since 1.22.1 highlighted is also available. Finally, the ICE code systems and codes are also accessible in Google Sheets as an added convenience.
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each distribution.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.
  • June 30, 2020 - ICE Source Code Now on GitHub
    • The ICE source code has been moved off of BitBucket and on to GitHub. Please see the Building ICE from Source Code for more details. The implementation guide and downloadable (Zip File) distribution remains in the Downloads folder of BitBucket.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.
  • February 12, 2020 - New Release of ICE - Version 1.22.1
    • A new release of ICE is available. 
    • Version 1.22.1 includes the following additions and changes. Please see the Release Notes for details for all of the below:
      1. Logic updates to the Pneumococcal Vaccine Group in accordance with the latest ACIP guidance.
      2. Bug fixes for the DTP Vaccine Group and Influenza Vaccine Group.
      3. Minor modification to how month-based calculations are performed. 
      4. In an effort to make the information returned by ICE to the end user more clear, the evaluation reason text and recommendation reason text have been reworded to be more user-friendly. The ICE SME WG worded these in a way that we believe is suitable for end users. These display values are documented on the Evaluation and Recommendation Codes page and returned by ICE in the displayName attribute of the applicable XML element. The corresponding coded values have not changed.
      5. A new option, output_supplemental_text. If this option is set to "Y" in the ice.properties file, ICE may return supplemental text in the response.
        • By default, this option is not enabled.
        • The ICE Implementation Guide specifies where and how in the response the supplemental text is output for evaluations and recommendations. 
        • This option is utilized by the Pneumococcal Vaccine Group for shared clinical decision making in the recommendation (interpretation element). The Pneumococcal rules page specifies the circumstances in which this occurs. If this option is disabled, the Pneumococcal logic will still operate correctly; applications simply won't benefit from additional text which may be displayed on the screen.
      6. A new option, enable_dose_override_feature. If this option is set to "Y" in the ice.properties file, client applications can override how ICE would normally evaluate a specified shot. The feature enables client applications to indicate that an administered shot must be treated as INVALID or VALID, as specified by the input message. Typically, this feature would be used when there is a vaccine efficacy concern (e.g. - an incorrect administration, vaccine expiration, etc.).

        • By default, this option is not enabled.
        • We suggest that this feature, if used at all, be used with caution and only under certain circumstances such as those described above and in accordance to how it operates. Users should carefully consider the use cases and experiment with the feature so that are no unexpected results.
        • More information about this option is available on Dose Override Feature page.
      7. ICE now outputs the version of the service in the response. See Version Number in the Response Message for details.
    • The ICE Implementation Guide has been updated. The ICE code systems and codes are also accessible in Google Sheets as an added convenience. Changes include:
      • New evaluation & reason codes: SUPPLEMENTAL_TEXT and OUTSIDE_SERIES.
      • Update evaluation and recommendation reasons to the user-friendly display text described above. 
      • Information on how to use the dose override feature.
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each distribution.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.
  • January 22, 2020 - A Few Updates
    • The next release of ICE, Version 1.22.1, will be available in February. This release will include logic updates to the Pneumococcal Vaccine Group.
    • The ICE distribution is now available as a docker image which can be download from Docker Hub at https://hub.docker.com/r/hlnconsulting/ice. Moving forward, whenever a new version of ICE is released, the distribution will be available both from Docker Hub as well as from the standard zip file location that we have always used.
    • We are in the process of moving the source code over to GitHub. Once this is complete and we have released the next version of ICE, we will make an announcement and remove the source code from BitBucket.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.

...

  • October 15, 2019 - New Release of ICE - Version 1.21.1
    • A new release of ICE is now available.
    • Version 1.21.1 includes the following additions and changes:
      1. Logic updates to the HPV Vaccine Group according to the latest ACIP guidance. See the Release Notes for details.
      2. A tweak to how the dose number value, returned in the vMR doseNumber element, is determined. The Release Notes contains details.
      3. A duplicate shot/same day fix whereby a non-combination shot might be selected instead of the combination shot.
    • The ICE Implementation Guide has been updated for this release. There is 1 new recommendation reason code - "ABOVE_REC_AGE".
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each distribution.
    • If you have any questions, comments or suggestions, please e-mail us at ice@hln.com.

...

  • May 31, 2019 - New Release of ICE - Version 1.17.1
    • A new release of ICE is now available.
    • Version 1.17.1 includes the following additions and changes:
      1. Logic updates to DTP, HPV, and Zoster vaccine groups. See Release Notes for details.
      2. Improvements to handling of duplicate shots. Duplicate shots typically represent "bad data" that has been passed into the ICE service. For two or more duplicate shots on the same day, ICE will select the vaccine that makes the most sense for the circumstance. See Two Shots, Same Vaccine Group, Same Day Exception Rules for the specifics on how this is handled for each vaccine group.
      3. Pneumococcal interval fix in the Adult Series where (under certain circumstances) the PPSV to PPSV 5 year recommended interval is not being applied when there is a valid PCV shot in between the PPSV shots.
      4. The Release Notes contain further details about the changes in this release.
    • Configuration Note: As of release 1.16.1, the ICE service is configured by default to return the earliest and overdue dates in addition to the recommendation date. In prior releases, the default configuration was to return only the recommendation date for the forecast.
      • If your application has not been configured to display the earliest and/or overdue dates, we recommend turning this feature off by changing the output_earliest_and_overdue_dates value in the ice.properties file to "N". Failure to do so may result in incorrect interpretation of the recommendation date. 
      • If you are interested in returning the earliest date or overdue date, please refer to the latest ICE Implementation Guide for details indicating precisely where each of the forecast dates – earliest, recommended, and overdue – are specified in the ICE output, and under what circumstances
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each distribution.
    • If you have any questions, comments or suggestions, we would very much like to hear from you! Please feel free to e-mail us anytime at ice@hln.com.

...

  • March 7, 2019 - New Release of ICE - Version 1.16.1
    • A new release of ICE is now available.
    • Version 1.16.1 includes the following additions and changes: 
      1. DTP Vaccine Group: Added an update to the "Six by Seven" rule to explicitly state that duplicate shots on the same day do not count towards this rule. The intention of this change is to prevent potentially "bad data" that may be passed into the ICE service from affecting the forecast result.
      2. Hib Vaccine Group: Improved handling of duplicate shots administered on the same day. For details, please refer to the Two Shots, Same Vaccine Group, Same Day Exception Rules page.
      3. Minor logic changes to the Meningococcal BPolioRotavirus and Pneumococcal vaccine groups.
      4. A revised ICE Implementation Guide (v3r2; and v3r2 with changes highlighted since 1.15.1). The updated guide includes a new recommendation reason: TOO_OLD_TO_INITIATE.
    • Important Note: As of this release, the ICE service is configured by default to return the earliest and overdue dates in addition to the recommendation date. In prior releases, the default configuration was to return only the recommendation date for the forecast. 
      • If your application has not been configured to display the earliest and/or overdue dates, we recommend turning this feature off by changing the output_earliest_and_overdue_dates value in the ice.properties file to "N". Failure to do so may result in incorrect interpretation of the recommendation date. 
      • If you are interested in returning the earliest date or overdue date, please refer to the latest ICE Implementation Guide for details indicating precisely where each of the forecast dates – earliest, recommended, and overdue – are specified in the ICE output, and under what circumstances.
    • The Release Notes contain further details about the changes in this release. The ICE team recommends upgrading to this latest release as soon as possible. 
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each distribution.
    • If you have any questions, comments or suggestions, please feel free to e-mail us at ice@hln.com.

...

  • February 1, 2019 - New Release of ICE - Version 1.15.1
    • A new release of ICE is now available.
    • Version 1.15.1 includes the following additions and changes: 
      1. A new 2-dose Adult Series in the Hep B vaccine group with support for the HEPLISAV-B vaccine. 
      2. Logic updates and fixes to the Meningococcal B, HPV, Influenza, Polio and DTP vaccine groups.
      3. A revised ICE Implementation Guide (v3r1; and v3r1 with changes highlighted since 1.14.1). The updated guide includes a new evaluation reason: SELECT_ADJUVANT_PRODUCT_INTERVAL.
    • The Release Notes contain further details about the changes in this release. The ICE team recommends upgrading to this latest release as soon as possible. 
    • The Earliest and Overdue Date Feature may be enabled by setting the output_earliest_and_overdue_dates property setting in the ice.properties file to "Y". Please refer to the latest ICE Implementation Guide for details indicating precisely where each of the forecast dates – earliest, recommended, and overdue – are specified in the ICE output, and under what circumstances.
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each distribution.
    • If you have any questions, comments or suggestions, please feel free to e-mail us at ice@hln.com.

...

In the downloadable distribution for this release, the ice.properties file's output_earliest_and_overdue_dates property was set to "Y". In previous releases, this property was set to "N". If you have not configured your application to handle earliest and overdue dates, change the  value to "N". The ICE Implementation Guide (v2r20) has instructions about how to interpret each of the forecast dates, including how they are specified in the ICE output and under what circumstances.


  • August 10, 2018 - New Release of ICE - Version 1.14.1
    • A new release of ICE is now available.
      • Full support for Earliest Date and Overdue Date - All Vaccine Groups
        • If enabled, ICE will output two additional forecast dates along with the Recommendation Date: the Earliest Date and Overdue Date. The Earliest Date is the soonest date that the vaccine can be given and still be considered valid. The Overdue Date is the date after which an immunization administered would be considered late.
        • The following vaccine groups return the Earliest and Overdue Date, when applicable:
          • DTP
          • Hep B
          • HPV
          • Pneumococcal
          • Hib
          • Hep A
          • MMR 
          • Zoster
          • Meningococcal ACWY
          • Polio
          • Rotavirus
          • Varicella
        • Implementers can enable the earliest/overdue date feature by setting the output_earliest_and_overdue_dates property setting in the ice.properties file to "Y". Please refer to the latest ICE Implementation Guide (v2r20) for details indicating precisely where each of the forecast dates – earliest, recommended, and overdue – are specified in the ICE output, and under what circumstances.
      • There are no updates to the ICE Implementation Guide since 1.12.1. The current guide is v2r20; and v2r20 with changes highlighted since 1.11.1).
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each distribution. The Release Notes page contains information about this and prior releases of ICE.
    • If you have any questions, comments or suggestions, please feel free to contact us at ice@hln.com.

...

  • June 17, 2018 - New Release of ICE - Version 1.13.1
    • A new release of ICE is now available.
      • An adjustment to the Pneumococcal catch-up schedule. See Exception 1B in the Pneumococcal Vaccine Group documentation for details.
      • Expanded Support for Earliest Date and Overdue Date (a recent feature that was introduced in 1.11.1).
        • If enabled, ICE will output two additional forecast dates along with the Recommendation Date: the Earliest Date and Overdue Date. The Earliest Date is the soonest date that the vaccine can be given and still be considered valid. The Overdue Date is the date after which an immunization administered would be considered late.
        • Expanded support for Earliest and Overdue Date - two additional vaccine groups (Pneumococcal and Hib), bringing the total number of supported vaccine groups to 9 (listed below):
          • Pneumococcal
          • Hib
          • Hep A
          • MMR 
          • Zoster
          • Meningococcal ACWY
          • Polio
          • Rotavirus
          • Varicella
        • The 3 remaining vaccine groups (DTP, Hep B and HPV) will be supported with Earliest and Overdue Dates in a future release of ICE in Summer 2018.
        • Note that this feature is disabled by default to ensure existing client applications do not break. Implementers can enable the earliest/overdue date feature by setting the output_earliest_and_overdue_dates property setting in the ice.properties file to "Y". Please refer to the latest ICE Implementation Guide (v2r20) for details indicating precisely where each of the forecast dates – earliest, recommended, and overdue – are specified in the ICE output, and under what circumstances.
      • There are no updates to the ICE Implementation Guide since 1.12.1. The current guide is v2r20; and v2r20 with changes highlighted since 1.11.1).
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each distribution. The Release Notes page contains information about this and prior releases of ICE.
    • If you have any questions, comments or suggestions, please feel free to contact us at ice@hln.com.

...

  • April 13, 2018 - New Release of ICE - Version 1.12.1
    • A new release of ICE is now available.
      • Version 1.12.1 includes the following additions and changes:
      • Support for Zoster vaccine recombinant (Shringrix). With the addition of this new vaccine and latest national guidance, it is possible additional doses will be forecasted for patients who previously had completed the Zoster series. Please refer to the Zoster Vaccine Group page for details.
      • Indication of a 3rd dose of MMR for high risk scenarios. The MMR Vaccine Group page has the details.
      • In the existing Hep B series, acknowledgement of adjuvanted Hep B vaccine (HEPLISAV-B - CVX 189).
        • This vaccine will be marked as NOT_EVALUATED with reason code VACCINE_NOT_SUPPORTED. The ICE team will work on a future release with further support for CVX 189 once more information is provided by national guidance sources.
        • Please refer to the Hep B Vaccine Group page for details.
      • Improved handling of shots submitted to the ICE service with "bad data", including shots with dates before the patient's date of birth.
      • Expanded Support for Earliest Date and Overdue Date (a new feature that was introduced in 1.11.1).
        • If enabled, ICE will output two additional forecast dates along with the Recommendation Date: the Earliest Date and Overdue Date. The Earliest Date is the soonest date that the vaccine can be given and still be considered valid. The Overdue Date is the date after which an immunization administered would be considered late.
        • Expanded support for Earliest and Overdue Date to three additional vaccine groups (Hep A, MMR, Zoster), bringing the total number of supported vaccine groups to 7 (listed below):
          • Hep A
          • MMR 
          • Zoster
          • Meningococcal ACWY
          • Polio
          • Rotavirus
          • Varicella 
        • The 5 remaining vaccine groups (DTP, Hep B, Hib, HPV, and Pneumococcal) will be supported with Earliest and Overdue Dates in a future release of ICE in Spring 2018.
        • Note that this feature is disabled by default to ensure existing client applications do not break. Implementers can enable the earliest/overdue date feature by setting the output_earliest_and_overdue_dates property setting in the ice.properties file to "Y". Please refer to the latest ICE Implementation Guide (v2r20) for details indicating precisely where each of the forecast dates – earliest, recommended, and overdue – are specified in the ICE output, and under what circumstances.
      • Updates to the ICE Implementation Guide (v2r20; and v2r20 with changes highlighted since 1.11.1). This guide contains the code additions for Zoster and Hep B vaccines, and a new evaluation reason code. It also contains information on how implementers may update their installation and software to properly read the Earliest, Recommended, and Overdue dates (if desired).
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each distribution. The Release Notes page contains information about this and prior releases of ICE.
    • If you have any questions, comments or suggestions, please feel free to contact us at ice@hln.com.

...

  • February 27, 2018 - Quarterly ICE Review Board Meeting
    • On February 27, 2018, HLN convened its second quarterly meeting of the ICE Review Board. While the inaugural meeting last Fall provided an introduction and information on ICE fundamentals and development processes, this latest session focused on topics ranging from the newest release of ICE that includes Earliest Date and Overdue Date for several vaccine groups; an update on the continued alignment of CDC CDSi and ICE; recent efforts to deploy ICE; and innovations such as, support for FHIR and CDS Hooks. A case study of utilizing ICE after nonviable vaccine administration was presented, and an open dialog was facilitated of relevant public health-related topics and trends. The next ICE Review Board meeting is  being planned for the 2nd quarter 2018.


  • March 9, 2018 - New Release of ICE - Version 1.11.1
    • A new release of ICE is now available.   
      • Version 1.11.1 includes the following additions and changes:
        1. Support for Earliest Date and Overdue Date
          • If enabled, ICE will output two additional forecast dates along with the Recommendation Date: the Earliest Date and Overdue Date. The Earliest Date is the soonest date that the vaccine can be given and still be considered valid. The Overdue Date is the date after which an immunization administered would be considered late.
          • In this release, ICE returns the earliest and overdue dates for 4 vaccine groups: Meningococcal ACWY, Polio, Rotavirus and VaricellaThe ICE team expects the remaining vaccine groups to be completely supported by Spring 2018.
          • Note that this feature is disabled by default to ensure existing client applications do not break. Implementers can enable the earliest/overdue date feature by setting the output_earliest_and_overdue_dates property setting in ice.properties file to "Y". Please refer to the ICE Implementation Guide for details about where each of the forecast dates – earliest, recommended, and overdue – are specified in the ICE output, and under what circumstances.
        2. General Rule Update: Fix that resulted in the General Rule "Shots Administered Below Series Absolute Minimum Age for Dose 1" not triggering when there are 2 or more invalid shots given below the absolute minimum age for Dose 1.
        3. An update to the ICE Implementation Guide. The latest ICE Implementation Guide (v2r19) describes how implementers should update their installation and software to properly read the Earliest, Recommended, and Overdue dates. The relevant information starts on page 43. Note that a "track changes" version of this same guide is also available. The tracked changes are intended to make it easier to see what has changed in the guide since the prior release (version 1.10.1.0).
    • ACIP updates for Zoster and MMR will be available in the next release, scheduled for early April.
    • As always, you can determine which version of ICE you are currently using by viewing the README.HISTORY file that is included with each distribution. The Release Notes page contains information about this and prior releases of ICE.
    • If you have any questions, comments or suggestions, please feel free to contact us at ice@hln.com.

...