As of ICE Version 1.22.1, a new feature is available that allows client applications to override how ICE would normally evaluate a specific shot.
This feature enables client applications to specify that an administered shot should be treated as INVALID or VALID by the ICE service. By doing so, the client is indicating that ICE shall bypass any logic it would normally use to evaluate the shot, and regardless of what would normally be done, evaluate the shot as specified in the request. Typically, this feature would be used if 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. Users should carefully consider the use cases and experiment with this feature to ensure that there are no unexpected results.
This feature is disabled in the downloadable distribution by default. 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.)
<substanceAdministrationEvent>
<templateId root="2.16.840.1.113883.3.795.11.9.1.1"/>
<id root="2.16.840.1.113883.3.795.12.100.10" extension="aaaaff20d0328zzzz16d39b552f1c74c6b43d5e0"/>
<substanceAdministrationGeneralPurpose code="384810002" codeSystem="2.16.840.1.113883.6.5"/>
<substance>
<id root="1111d60c93d6-988a-4c37-b9f0-3af4a6e6e9d4"/>
<substanceCode code="110" codeSystem="2.16.840.1.113883.12.292"/>
</substance>
<administrationTimeInterval high="20151222" low="20151222"/>
<isValid value="false"/>
</substanceAdministrationEvent>
In the response, ICE will include either the DOSE_OVERRIDE_VALID or DOSE_OVERRIDE_INVALID for that shot. The response for the above shot is:
<substanceAdministrationEvent>
<templateId root="2.16.840.1.113883.3.795.11.9.1.1"/>
<id root="2.16.840.1.113883.3.795.12.100.10" extension="aaaaff20d0328zzzz16d39b552f1c74c6b43d5e0"/>
<substanceAdministrationGeneralPurpose code="384810002" codeSystem="2.16.840.1.113883.6.5"/>
<substance>
<id root="1111d60c93d6-988a-4c37-b9f0-3af4a6e6e9d4"/>
<substanceCode code="110" codeSystem="2.16.840.1.113883.12.292"/>
</substance>
<administrationTimeInterval low="20151222000000.000-0500" high="20151222000000.000-0500"/>
<isValid value="true"/>
<relatedClinicalStatement>
<targetRelationshipToSource code="PERT" codeSystem="2.16.840.1.113883.5.1002" displayName="has pertinent information"/>
<substanceAdministrationEvent>
<templateId root="2.16.840.1.113883.3.795.11.9.1.1"/>
<id root="309a6a00-79d7-4e6b-b272-0dd8e3eaa306"/>
<dataSourceType code="ICE_1.22.1" codeSystem="2.16.840.1.113883.3.795.5.4.12.1.2" codeSystemName="org.cdsframework source"/>
<substanceAdministrationGeneralPurpose code="384810002" codeSystem="2.16.840.1.113883.6.5" codeSystemName="SNOMED CT" displayName="Immunization/vaccination management (procedure)"/>
<substance>
<id root="b427c20e-e224-47dc-a1d7-da9e255ee05a"/>
<substanceCode code="20" codeSystem="2.16.840.1.113883.12.292" displayName="DTaP"/>
</substance>
<doseNumber value="1"/>
<administrationTimeInterval low="20151222000000.000-0500" high="20151222000000.000-0500"/>
<isValid value="false"/>
<relatedClinicalStatement>
<observationResult>
<templateId root="2.16.840.1.113883.3.795.11.6.1.1"/>
<id root="fa7d4df0-00d2-439d-a4db-7cd35323126d"/>
<observationFocus code="200" codeSystem="2.16.840.1.113883.3.795.12.100.1" codeSystemName="Vaccine Groups" displayName="DTP Vaccine Group"/>
<observationEventTime low="20190319000000.000-0400" high="20190319000000.000-0400"/>
<observationValue>
<concept code="INVALID" codeSystem="2.16.840.1.113883.3.795.12.100.2" codeSystemName="ICE Evaluation Status" displayName="Valid Dose"/>
</observationValue>
<interpretation code="DOSE_OVERRIDE_INVALID" codeSystem="2.16.840.1.113883.3.795.12.100.3" codeSystemName="ICE Evaluation Reason" displayName="Dose Override, Invalid"/>
</observationResult>
</relatedClinicalStatement>
</substanceAdministrationEvent>
</relatedClinicalStatement>
<relatedClinicalStatement>
<targetRelationshipToSource code="PERT" codeSystem="2.16.840.1.113883.5.1002" displayName="has pertinent information"/>
<substanceAdministrationEvent>
<templateId root="2.16.840.1.113883.3.795.11.9.1.1"/>
<id root="aae7a87d-4e2b-41c1-a6ae-8e6241753a33"/>
<dataSourceType code="ICE_1.22.1" codeSystem="2.16.840.1.113883.3.795.5.4.12.1.2" codeSystemName="org.cdsframework source"/>
<substanceAdministrationGeneralPurpose code="384810002" codeSystem="2.16.840.1.113883.6.5" codeSystemName="SNOMED CT" displayName="Immunization/vaccination management (procedure)"/>
<substance>
<id root="64146d5f-f17b-43c9-92ce-0c54cc5b87d4"/>
<substanceCode code="08" codeSystem="2.16.840.1.113883.12.292" displayName="Hep B peds, less than 20yrs"/>
</substance>
<doseNumber value="1"/>
<administrationTimeInterval low="20151222000000.000-0500" high="20151222000000.000-0500"/>
<isValid value="true"/>
<relatedClinicalStatement>
<observationResult>
<templateId root="2.16.840.1.113883.3.795.11.6.1.1"/>
<id root="cf3cdf0a-6241-438e-b833-04f3dbb7915d"/>
<observationFocus code="100" codeSystem="2.16.840.1.113883.3.795.12.100.1" codeSystemName="Vaccine Groups" displayName="Hep B Vaccine Group"/>
<observationEventTime low="20190319000000.000-0400" high="20190319000000.000-0400"/>
<observationValue>
<concept code="VALID" codeSystem="2.16.840.1.113883.3.795.12.100.2" codeSystemName="ICE Evaluation Status" displayName="Valid Dose"/>
</observationValue>
<interpretation code="DOSE_OVERRIDE_INVALID" codeSystem="2.16.840.1.113883.3.795.12.100.3" codeSystemName="ICE Evaluation Reason" displayName="Dose Override, Invalid"/>
</observationResult>
</relatedClinicalStatement>
</substanceAdministrationEvent>
</relatedClinicalStatement>
<relatedClinicalStatement>
<targetRelationshipToSource code="PERT" codeSystem="2.16.840.1.113883.5.1002" displayName="has pertinent information"/>
<substanceAdministrationEvent>
<templateId root="2.16.840.1.113883.3.795.11.9.1.1"/>
<id root="dc7b4dc8-5496-4c3e-9d71-7468a3c99240"/>
<dataSourceType code="ICE_1.22.1" codeSystem="2.16.840.1.113883.3.795.5.4.12.1.2" codeSystemName="org.cdsframework source"/>
<substanceAdministrationGeneralPurpose code="384810002" codeSystem="2.16.840.1.113883.6.5" codeSystemName="SNOMED CT" displayName="Immunization/vaccination management (procedure)"/>
<substance>
<id root="4a2f2fc7-75b1-43a9-8a34-9d330667e0d4"/>
<substanceCode code="10" codeSystem="2.16.840.1.113883.12.292" displayName="IPV"/>
</substance>
<doseNumber value="1"/>
<administrationTimeInterval low="20151222000000.000-0500" high="20151222000000.000-0500"/>
<isValid value="true"/>
<relatedClinicalStatement>
<observationResult>
<templateId root="2.16.840.1.113883.3.795.11.6.1.1"/>
<id root="350c7439-66d1-4b49-8c14-8e7600494672"/>
<observationFocus code="400" codeSystem="2.16.840.1.113883.3.795.12.100.1" codeSystemName="Vaccine Groups" displayName="Polio Vaccine Group"/>
<observationEventTime low="20190319000000.000-0400" high="20190319000000.000-0400"/>
<observationValue>
<concept code="VALID" codeSystem="2.16.840.1.113883.3.795.12.100.2" codeSystemName="ICE Evaluation Status" displayName="Valid Dose"/>
</observationValue>
<interpretation code="DOSE_OVERRIDE_INVALID" codeSystem="2.16.840.1.113883.3.795.12.100.3" codeSystemName="ICE Evaluation Reason" displayName="Dose Override, Invalid"/>
</observationResult>
</relatedClinicalStatement>
</substanceAdministrationEvent>
</relatedClinicalStatement>
</substanceAdministrationEvent>