Evaluation and Recommendation Codes

Table of Contents

The evaluation codes and corresponding reasons as well as the recommendation codes and corresponding reasons listed in the tables below are utilized in the vaccine series rules documented on the wiki. 

Evaluations

Evaluation Codes

Evaluation Status Codes

VALID

INVALID

ACCEPTED

NOT_EVALUATED

Evaluation Reason Codes and Text

Evaluation Reason Code

Evaluation Reason Text 

INSUFFICIENT_ANTIGEN

This immunization contains insufficient antigen for the patient's age.

PRIOR_TO_DOB

This immunization was recorded prior to the date of birth.

BELOW_MINIMUM_INTERVAL

This immunization was administered below the minimum interval for this dose.

BELOW_MINIMUM_AGE_SERIES

This immunization was administered below the minimum age for this dose.

BELOW_MINIMUM_AGE_FINAL_DOSEThis immunization was administered below the minimum age for the final dose.
BELOW_MINIMUM_AGE_VACCINEThis immunization was administered below the minimum age for this vaccine.
ABOVE_MAXIMUM_AGE_VACCINEThis immunization was administered above the maximum age for this vaccine.1

TOO_EARLY_LIVE_VIRUS

This immunization was administered below the minimum interval between live vaccine doses.

BOOSTER_ONLY

The vaccine administered is invalid; valid only as a booster dose.

OUTSIDE_SEASONThis immunization was administered outside of the vaccine season.1
OUTSIDE_FLU_VAC_SEASONThis immunization was administered outside of the influenza vaccine season.
DUPLICATE_SAME_DAYThis immunization is a duplicate shot.

VACCINE_NOT_ALLOWED_FOR_THIS_DOSE

The vaccine administered is not allowed for this dose.1
VACCINE_NOT_ALLOWEDThe vaccine administered is not allowed.1
D_AND_T_INVALID/P_VALID The diphtheria and tetanus components are invalid due to minimum interval violation, pertussis component is valid.

EXTRA_DOSE

This immunization was administered as an extra dose.

PROOF_OF_IMMUNITY

This immunization was administered after proof of immunity.

DISEASE_DOCUMENTEDThis immunization was administered after the disease was documented.

ABOVE_REC_AGE

This immunization was administered above the recommended age.

ABOVE_REC_AGE_SERIESThis immunization was administered above the recommended age for this series.
BELOW_REC_AGE_SERIESThis immunization was administered below the recommended age for this series.

VACCINE_NOT_SUPPORTED

The vaccine administered is not supported by the ICE service.

MISSING_ANTIGENThe immunization administered is missing an antigen.
VACCINE_NOT_LICENSED_FOR_MALESThe vaccine administered is not licensed for males. 
VACCINE_NOT_COUNTED_BASED_ON_MOST_RECENT_VACCINE_GIVEN The vaccine will not be counted based on the most recent vaccine given. (Most recent vaccine given determines which series is applied.)
VACCINE_NOT_PART_OF_THIS_SERIESThe vaccine is not a part of this series, therefore it will not be counted towards completion of this series. 
SELECT_ADJUVANT_PRODUCT_INTERVALThis immunization was administered below the minimum interval between adjuvant products.
DOSE_OVERRIDE_INVALIDThis immunization was marked Invalid as instructed by the user.
DOSE_OVERRIDE_VALIDThis immunization was marked Valid as instructed by the user.
CLINICAL_PATIENT_DISCRETIONClinical, Patient Discretion.
OUTSIDE_SERIESThis immunization was administered outside of the series.
SUPPLEMENTAL_TEXTSupplemental text is available for this evaluation.1
VACCINE_NOT_ALLOWED_IN_USThe vaccine is not allowed in the U.S.
VACCINE_NOT_APPROVED_IN_USThe vaccine is not approved for use in the U.S. 
VACCINE_NOT_APPROVED_IN_US_OR_BY_WHOThe vaccine is not approved for use in the U.S. or by the WHO. 

1These codes are not being used in the current set of default ICE rules documented on this wiki.


Recommendations

Recommendation Codes

Recommendation Status Codes

RECOMMENDED

FUTURE_RECOMMENDED

CONDITIONAL

NOT_RECOMMENDED

NOT_AVAILABLE

Recommendation Reason Codes and Text

Recommendation Reason Code

Recommendation Reason Text 

DUE_NOW

Due now.

DUE_IN_FUTURE

Due on <date due>.

ABOVE_AGE_MAY_COMPLETE Above recommended age but may complete series.1

HIGH_RISK

Recommended for high-risk groups.

COMPLETE

Completed vaccine series.

DISEASE_DOCUMENTED

Disease documented.

PROOF_OF_IMMUNITY

Proof of Immunity.

TOO_OLD

Vaccine not recommended at this age.

TOO_OLD_HIGH_RISK

Vaccine not generally recommended at this age, unless high risk.1

TOO_OLD_TO_INITIATEVaccine not recommended at this age; too old to initiate.
COMPLETE_HIGH_RISKSeries complete, unless high risk.
VAC_GROUP_NO_LONGER_RECThis vaccine group is no longer recommended.

NOT_SUPPORTED

The shots in the recommendation group were not evaluated.

BELOW_MINIMUM_AGE_HIGH_RISK_SERIESBelow minimum age for this high risk series. 
CLINICAL_PATIENT_DISCRETIONClinical, Patient Discretion
OTHER_VACCINE_PRODUCT_POSSIBLEIn addition to the vaccine product recommended, there are other vaccine products possible.
SUPPLEMENTAL_TEXTSupplemental text is available for this recommendation.

1These codes are not being used in the current set of default ICE rules documented on this wiki.