Edit immunization compliance rules

Aspen provides default immunization compliance rules, which specify certain requirements needed for a student to be in compliance with a given immunization. These rules can be customized as needed, using XML eXtensible Markup Language.

To edit an immunization compliance rule:

1. Log on to the Health view.
2. Click the Immunization tab. The Series Definitions page appears:

3. 

3. In the Series ID column, click the name of the immunization series you want to edit the compliance rule for. The appropriate detail page appears.
4. At the Rule definition field, click . The Rule definition pop-up appears:

5. 

5. Edit the XML element, which contains information about the immunization rule. Use the following table as a guide:

Note: For the attributes listed, you can use any of the following operators: "and", "or" or "exclusive or"—if X is true, then Y has to be true (or vise versa).

6. Field	Description
   rule-set	A rule-set is a rule providing order of execution of the rules. It can contain elements plus another rule set. The rule can specify dose numbers, an age range, grade level, and range between specific doses. An attribute is a characteristic of the rule set. All rule sets contain at least 3 attributes. --------------------------------------------------------------------------------------- Attribute list: ignore-next-dose: 'true' signifies that the rule will not be used to calculate the date of the next dose latest-compliance: 'true' signifies that if the latest dose is compliant, then the whole rule is compliant, even if earlier doses are not compliant. skip-early: 'true' allows the engine to skip over doses that were administered too early in order to allow for more doses to be in compliance. grace-period: 'n' sets the maximum number of days prior to or after the dose being due that it can be administered to a student to be in compliance. gender: 'm' for male, 'f' for female. The dose for whichever gender is not specified is automatically compliant. --------------------------------------------------------------------------------------- Example: <dose-total count = "4" grade-level = "-1" /> <rule-set operator = "and" >   <dose number = "3" start-age = "1" end-age = "2" age-unit = "years" />   <dose number = "3" start-age = "4" end-age = "5" age-unit = "years" /> </rule-set> The code above means that the student must have 4 doses before entering pre-kindergarten. Also, dose 3 must occur between age 1 and 2 or between age 4 and 5.
   dose-total	Dose-total is a summation rule. It specifies that a certain number of doses are required between an age range or before a grade level. Note: Grade levels must be numeric. --------------------------------------------------------------------------------------- Attribute list: ignore-next-dose: flag to signal ignoring the rule when calculating next dose dates count:sum of doses which must exist start-age: starting age range this dose should be given in end-age: ending age range this dose should be given in age-unit: specifies the unit of measurement for the age attributes grade-level: numeric grade level which the dose must be given by (-1=PK, 1-14=grade number) start-grade: NUMERIC starting grade level end-grade: NUMERIC ending grade level grade-range: inclusive/exclusive; determines whether a dose must be given within or outside the start-end grade range start-date: starting date range the dose should be given after end-date: ending date range the dose should be given by --------------------------------------------------------------------------------------- Example: <dose-total count = "4" grade-level = "-1" /> The code above means that the student must have 4 doses before entering pre-kindergarten.
   dose	Dose is a rule for an individual immunization dose. An age range or grade level cutoff can be specified to form the rule. --------------------------------------------------------------------------------------- Attribute list: ignore-next-dose: flag to signal ignoring the rule when calculating next dose dates number: dose number this rule applies to start-age: starting age range this dose should be given in end-age: ending age range this dose should be given in age-unit: specifies the unit of measurement for the age attributes grade-level: numeric grade level which the dose must be given by (-1=PK, 1-14=grade number) start-grade: numeric starting grade level end-grade: numeric ending grade level grade-range: inclusive/exclusive; determines whether a dose must be given within or outside the start-end grade range start-date: starting date range the dose should be given after end-date: ending date range the dose should be given by --------------------------------------------------------------------------------------- Example: <dose number = "1" start-age = "1" end-age = "2" age-unit = "months" /> The code above means that the first dose must be given between one and two months old.
   dose-dependent	Dose-dependent is a rule that allows a specified dose to be dependent upon completion of a previous dose. --------------------------------------------------------------------------------------- Attributes: ignore-next-dose: flag to signal ignoring the rule when calculating next dose dates number: dose number this rule applies to after-dose-number: dose number of previous dose to compare the time span between time-after number: time range that must exist between the specified number and after-dose number time-unit: s pecifies the unit of measurement for the time-after attribute --------------------------------------------------------------------------------------- Example: <dose-dependent number="3" after-dose-number="2" time-after"4" time-unit="weeks" /> The code above specifies that the third dose must occur at least 4 weeks after the second dose. If the third dose is given earlier, the student will be out of compliance.

6. Click OK.

Note: If you modify an immunization definition, be sure to select the Custom checkbox on the New Health Immunization Definition page so that future updates do not override your customizations.