Dose Override Feature

As of ICE Version 1.22.1, a new feature is available that allows client applications to override how ICE would normally evaluate a specified shot.

The Dose Override feature enables client applications to indicate that an administered shot must be treated as INVALID or VALID, as specified in the request sent to the ICE service. By doing so, the client is essentially forcing ICE to bypass any logic it would normally use to evaluate the shot. ICE will mark the shot as specified in the request, regardless of what would normally be done. Typically, this feature would be used when there is a vaccine efficacy concern (e.g. - an incorrect administration, vaccine expiration, etc.), or to indicate that a shot should be marked Valid when ICE would normally evaluate it as Invalid.

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, specified below. Users should carefully consider the use cases and experiment with the feature so that are no unexpected results.

By default, this feature is disabled in the downloadable distribution. To enable it, add the following line to the ice.properties file:

enable_dose_override_feature=Y

When passing the request up to ICE, specify the shot validity using with <isValid /> element of the SubstanceAdministrationEvent, as follows:

<isValid value="true"/>

or

<isValid value=”false”/>

The example below is a combination shot. The value for the isValid element is false, indicating that all components of the vaccine (DTP, Hep B, and IPV) will all be evaluated as invalid. (It is currently not possible to specify the validity for each component of the vaccine.)

In the response, ICE will include either the DOSE_OVERRIDE_VALID or DOSE_OVERRIDE_INVALID for that shot. The response for the above request is: