Manage Rules

Overview

Rules are powerful tools which allow CheckPad to validate data in a flexible way and provide applicable actions once conditions set forth in rules have been met.

These rules cannot be reused among studies or CRFs. 

The following guide has the following contents:

Rule structure

Structure and Operation of Rules

• Target: Rule's target. This target is usually a data field in a visit CRF of a particular visit
• Rule Expression: An expression which evaluate as true or false
• Run On (Mode): Mode on which a rule runs
• Action: The Corresponding Action to commence when Rule Expression equals defined values

Each rule corresponds to a single action. 

Rules with the same target will be aggregated into a rule set.

Operating Mechanism of Rules

When commencing data storage or runs rule in batch mode, the system will search and run all rules based on the current context.

Example: In a data field of a newly created CRF, the system will search and runs all rules with targets being the data fields, and Run on (Mode) as Data Entry. 

With each rule, the system will compare the results of Rule Expression and the defined results in rule.

Rule Actions

• Discrepancy Notes Action: Create Discrepancy Notes of Failed to Valuation. Check if the data field fails to match input rule in protocol
• Email: Send an email to one or many addresses with the message defined in rule
• Show Action: Display data fields, data groups specified in rule
• Hide Action: Hides data fields, data groups specified in rule
• Insert Action: Fill in defined values into a data field specified in rule
• Visit Action: Determine the start date of visit defined in rule (can be used to automatically  schedule visit)

Data Fields of A Rule

Field	Required?	Meaning	Filling instructions
Target		Target to trigger rule. The system will base on this target to search related rules upon save of data or run rules in batch mode	Search and input OID via manual search or use drag and drop to determine the required OID
Run on a Schedule
Run Time		Run monthly on the set time (Only appear if "Run on a Schedule" is selected)	Select the time to run the rules
Rule Expression		Expression used to trigger action in rule	Expression must return true or false. Can be built with the help of Rule Designer dialogue.
Actions		Select type of action	When selection actions, the data related to the action will be added into form.

There are different data fields corresponding to the type of action.

Discrepancy Note Action

Data Field	Required?	Meaning	Filling instructions
Evaluates to		Defined value - Action will be triggered if this value matches the value the Rule Expression evaluates to	True or False
Message		Message for Discrepancy Notes	Fill in message for discrepancy notes
Specify the mode where this action should run			Select from the following: Admin data entry: Upon save of completed forms Data entry started: Upon save of incomplete forms Batch: Run rules in batch Import data entry: Upon import of data

Email action

Data Field	Required?	Meaning	Filling instructions
Evaluates to		Defined value - Action will be triggered if this value matches the value the Rule Expression evaluates to	True or False
Email		List of emails	Input comma-separated emails
Message		Message for Email	Fill in message for email
Specify the mode where this action should run			Select from the following: Admin data entry: Upon save of completed forms Data entry started: Upon save of incomplete forms Batch: Run rules in batch Import data entry: Upon import of data

Show Action or Hide Action

Data Field	Required?	Meaning	Filling instructions
Evaluates to		Defined value - Action will be triggered if this value matches the value the Rule Expression evaluates to	True or False
Apply On		Fill in the OID of the data field to appear when conditions are met	Search OID manually or select OID from list in Rule Designer Can add one or more data fields to display
Specify the mode where this action should run			Select from the following: Admin data entry: Upon save of completed forms Data entry started: Upon save of incomplete forms Batch: Run rules in batch Import data entry: Upon import of data

Insert Action

Data Field	Required?	Meaning	Filling instructions
Evaluates to		Defined value - Action will be triggered if this value matches the value the Rule Expression evaluates to	True or False
Message		Message for Email	Fill in message for email
Apply On - Value		The value to be filled in the data field when conditions are met	Fill in the value
Apply On - Expression		The expression to be filled in the data field when conditions are met to calculate field value from other fields' value	Fill in the expression
Specify the mode where this action should run			Select from the following: Admin data entry: Upon save of completed forms Data entry started: Upon save of incomplete forms Batch: Run rules in batch Import data entry: Upon import of data

Visit Action

Data Field	Required?	Meaning	Filling instructions
Evaluates to		Defined value - Action will be triggered if this value matches the value the Rule Expression evaluates to	True or False
Apply To		Visit OID to be scheduled	Search OID manually or select OID from list in Rule Designer Can add one or more data fields to display
Property		Select the property to change value of	Select one from list of propertiesV
Value Expression		Input the expression to calculate value after conditions have been met
Specify the mode where this action should run			Select from the following: Admin data entry: Upon save of completed forms Data entry started: Upon save of incomplete forms Batch: Run rules in batch Import data entry: Upon import of data

Rule List Page

Accessing the page

There are 2 ways to access the rule list page: 

• Method 1: From the main menu select Task > Manage Data > Rules
• Method 2: From the build study select "View" in the Create Rule Row

Screen Layout

The rules list page consists of the following components;

1. Pagination if the number of rules exceed 10
2. Buttons to configure the display of the table or download the list
3. Expand the list (for better view on smaller screens)
4. List of rules
5. Filter rules according to corresponding column criteria
6. Action buttons corresponding for each rule:
   1. Edit rules with Rule Designer
   2. View Rule details
   3. Run Rule
   4. Remove Rule
   5. Download Rule
   6. Test Rule

Create new rule

Create new rule from XML file

Path: Tasks > Build Study > Create Rule > Click on the "+" button

After the system will display a dialogue for the user to import the rules into the system

User selects the 'Choose File' button then choose the appropriate file (file must be in .XML format). The system displays the following notification upon successful import:

User clicks on "continue" to continue importing the rule into the system. After successful import, the system redirects the usual to the initial page: build study page.

Creating rules with rule designer

MedProve encourages CheckPad users to use Rule Designers in editing rules to save time and ensure accuracy in rule creation.

Read more on Rule Designer