...

In the recommendation for each vaccine group, a series may or may not be displayed. A series is typically not selected for display when the patient has already completed his/her series. When a series is selected for display, there are 3 different possible Series Selection Display Type designations:

Selection Types

1. SERIES_DISPLAY_UNAMBIGUOUS

   • When this display type is specified, it indicates that there is no other series that could possibly be selected for the patient to complete a series for the vaccine group.

   • ICE is forecasting the next dose based on this series. Therefore, the series specified by this display type can confidently be displayed/returned to the end user.

2. SERIES_DISPLAY_BEST_GUESS

   • When this display type is specified, it indicates that while there is more than Series that could be used for the patient to complete a series in the vaccine group, the series specified is the “best guess” and the one that ICE is accurately using for the forecast.

   • ICE is accurately forecasting the next dose based on this series. The series specified by this display type can confidently be displayed/returned to the end user, with the recognition that other series could potentially be followed or the series displayed by ICE may change future doses or vaccines added to the patient’s immunization record.

3. SERIES_DISPLAY_ALTERNATIVE (not currently used)

   • Note: This is a placeholder feature and not currently used. Additional rules specific to each vaccine group need to be developed to accurately display alternatives. Please let us know if there is an interest in this feature.

   • This display type may be returned by ICE when there are alternative series that could be followed to complete a series in the vaccine group. The utility of this display type has not yet been determined, so currently it is not returned in the ICE output.

   • May or may not be returned in conjunction with a SERIES_DISPLAY_BEST_GUESS selection.

   • An example utility for this display type would be when there are no shots on record for a particular vaccine group. For example, if a patient has not received any COVID-19 shots, ICE could return multiple different product-specific series.

   • Unlike a series specified by SERIES_DISPLAY_UNAMBIGUOUS and SERIES_DISPLAY_BEST_GUESS, any series selection specified by this display type is notused by ICE when determining the forecast.

To summarize, whenever a Series is selected for display, the logic to determine which series is selected for display is as follows:

• If there is only one series defined in a vaccine group, the series selection type is SERIES_DISPLAY_UNAMBIGUOUS.

• If there is more than one series defined in a vaccine group, the series selection type is SERIES_DISPLAY_BEST_GUESS.

Inclusion or Exclusion of Series Display Selection and Number of Doses Remaining in Output

The Series and Number of Doses Remaining structure is included (or excluded) from the output under the following circumstances.

• For each vaccine group, the list of series are specified in the ICE wiki page.

• If a dose is not recommended (i.e. - recommendation is CONDITIONAL or NOT_RECOMMENDED), a series display selection will not be returned in the output.

  • The section will be excluded entirely from the ICE output.

• If a dose is recommended (i.e. - recommendation is RECOMMENDED or FUTURE_RECOMMENDED) and the series is not complete, a series display selection will be returned in the output.

  • The series display selection and the calculated number of doses remaining in the series will be output.

• If a dose is recommended and the series is complete, a series display selection will be returned in the output.

  • The series display selection is returned. The number of doses remaining will be set to “Recurring”.

Number of Doses Remaining

...

• If the series is not complete and a dose is recommended (Due Now or Due in Future), the number of doses remaining is returned simply by subtracting the number of doses administered from the total number of doses needed to complete the selected series (i.e. - either SERIES_DISPLAY_UNAMBIGUOUS or SERIES_DISPLAY_BEST_GUESS)

• If the series is complete, there are no recurring doses defined by the series, and no doses are recommended, the number of doses remaining is 0.

• If the series is complete, there are no recurring series defined by the series, but a dose is nevertheless recommended by ICE (not a typical circumstance), the number of doses remaining is 0 doses remaining in series; one or more additional doses may still be recommended

• If the series is complete, there are recurring doses defined by the series, and a dose is recommended, the number of doses remaining is Recurring.

...