Sentinel logo  Sentinel 5.18.8 User Guide

Validation Profile Management

Users with the Validation Profile role permissions can define data quality checking criteria in the application and use them to identify investigations that need to be corrected based on the criteria. See the Role Management topic for information on the available Validation Profile permissions.

Edit or Delete an Existing Validation Profile

To edit or delete an existing validation profile, click the System Administration > Validation Profile Management menu link. The Validation Profile Management page opens. Locate the validation profile in the list.

To edit the validation profile, click the Edit icon. The Validation Profile Builder opens and displays the validation profile. Make the necessary changes and click the left arrow icon in the top left-hand corner to return to the Validation Profile Management page. Your changes are automatically saved, although the validation profile must be promoted to production before it can be used or shared with others. See the Add a New Validation Profile section below for additional information on building a profile, importing and exporting, and promoting to production.

To export or revert to a previous version of the validation profile, click the Profile History icon in the upper right-hand corner of the Validation Profile Builder. The Change History pop-up window appears. Locate the previous version in the list. To export a copy of that profile version, click the Export icon. To revert to that previous version, click the Revert icon and then click Yes on the warning pop-up window. The validation profile then reverts to that previous version. (Note that this reversion action is not reversible.)

To delete the validation profile, click the Delete icon, then click Yes on the confirmation pop-up window.

Add a New Validation Profile

To create a new validation profile, click the System Administration > Validation Profile Management menu link. The Validation Profile Management page opens. Click the New button. On the New Profile window that opens, enter a Profile Name (required). If the validation profile can be shared with others, select Yes from the Shared drop-down list. Click Submit when finished. The Validation Profile Builder page opens.

On the top right side of the Validation Profile Builder page are these icons:

To add a new validation error/warning and message to the validation profile, click the Add Validation Profile icon (Add Section icon) located in the lower left-hand corner of the page. Select whether the Validation Type is an error or a warning, enter a descriptive message, and click Submit. The validation type and message appear on the page.

Example Validation Profile Builder page

To add one or more conditions for the error or warning, right-click over it on the page and select Insert Condition. (You can also edit or delete an error/warning from this context menu.) The New Condition window opens. Select a condition type from the drop-down list. The available condition types are:

The available criteria to choose from for each of the condition types are as follows. When you have finished selecting the condition type values, click Submit. The new condition type appears under the error or warning message. Click the arrow on the left side to show or hide the conditions. Use the right-click context menu to also use AND and OR comparison operators for more complex condition types.

When finished creating the conditions, click the More icon and select Promote to Production.

Condition Type: Blank Field Check

Question: Form Select the name of the form that contains the field from the drop-down list. Options include Core Data, CDC forms, supplemental forms, and outbreak event forms. Once the form is selected, all of the available fields populate in the Field drop-down list.
Question: Field Select the name of the field to conduct the search on from the drop-down list. Field names are populated based on the selected form.
Condition Select the condition from the drop-down list. The options are Blank and Not Blank. This determines if the search is conducted to test whether the selected field on the specified form is blank or not blank (has a value in it).

Condition Type: Selected Field Option Check

Question: Form Select the name of the form that contains the field from the drop-down list. Options include Core Data, CDC forms, supplemental forms, and outbreak event forms. Once the form is selected, all of the available fields populate in the Field drop-down list.
Question: Field Select the name of the field to conduct the search on from the drop-down list. Field names are populated based on the selected form.
Condition From the first drop-down list, select whether the specified field will or will not have the exact value. Next, click in the second list and select the first value to be used. If necessary, click again to add an additional value.
Example: To search for records that have an investigation status of Active or Pending, select the following criteria. Form: Core Data. Field: Investigation Status. Condition first drop-down list: Has one of the following value(s). Second list: Active, Pending. After entering these values and clicking Submit, you are returned to the Validation Profile Builder page and the error now displays this condition: Investigation Status has Active or Pending.

Condition Type: Chronological Date Comparison

Date 1: Form Select the name of the form that contains the field from the drop-down list. Options include Core Data, CDC forms, supplemental forms, and outbreak event forms. Once the form is selected, all of the available fields populate in the Field drop-down list.
Date 1: Field Select the name of the field to conduct the search on from the drop-down list. Field names are populated based on the selected form.
Date 2: Form Field / Today / Specific Date Select whether you will be using the date in the form's field, today's date, or another specified date.
If Form Field is selected, select the form and field names from the drop-down lists.
If Specific Date is selected, a new Date field appears. Click on it to enter the date or select the date from the calendar that pops up.
Date 2: Form Appears if Form Field is selected above. Select the name of the form from the drop-down list.
Date 2: Field Appears if Form Field is selected above. Select the name of the field from the drop-down list.
Condition Select whether the first date is before, after, on or before, or on or after the second date.
Example: To search for records that have patient birthdates that are after the event dates, select the following criteria. Date 1 Form: Core Data, Field: Patient's Date of Birth. Date 2: Form Field, Form: Core Data, Field: Event Date. Condition: Date 1 is Before Date 2.

Condition Type: Number of Days Comparison

Date 1: Form Select the name of the form that contains the field from the drop-down list. Options include Core Data, CDC forms, and supplemental forms, and outbreak event forms. Once the form is selected, all of the available fields populate in the Field drop-down list.
Date 1: Field Select the name of the field to conduct the search on from the drop-down list. Field names are populated based on the selected form.
Date 2: Form Field / Today / Specific Date Select whether you will be using the date in the form's field, today's date, or another specified date. If Specific Date is selected, a new Date field appears. Click on it to enter the date or select the date from the calendar that pops up.
If Form Field is selected, select the form and field names from the drop-down lists.
If Specific Date is selected, a new Date field appears. Click on it to enter the date or select the date from the calendar that pops up.
Date 2: Form Appears if Form Field is selected above. Select the name of the form from the drop-down list.
Date 2: Field Appears if Form Field is selected above. Select the name of the field from the drop-down list.
Condition Select the comparison operator (Greater, Less, Greater or Equal, Less or Equal) from the drop-down list and then set the number of days.
Example: To search for records that have a Diagnosis Date later than the current date, select the following criteria: Date 1 Form: Core Data, Field: Diagnosis Date. Date 2: Today. Condition: Number of Days between Date 1 and Date 2 is Greater than 1 days.

Share a Validation Profile with Other Users

Validation profiles can be shared with other users. To allow a validation profile to be shared, select Yes from the Shared drop-down list that appears in the first pop-up window when creating new validation profiles or click the Profile Settings icon on the Validation Profile Builder page and change it there. (Select No to turn off the sharing feature.) Note that only the user who creates a validation profile can share it with others. The Share option for  that validation profile is grayed-out for other users.

Once a validation profile is set to be shared and it has been promoted to production, it appears in the Validation Profile Management list and is available for selection in the Validation Profile Filter on the Investigations tab for all users that have the appropriate permission(s). Specific permissions allow users to use, edit, and/or delete shared validation profiles. See Role Management for more information about the Validation Profile Management permissions.

Use a Validation Profile for Data Quality Review

Once a validation profile has been promoted to production, it is available for use by users with the appropriate Validation Profile Management permissions. Note that only active validation profiles appear in the list.

To use the validation profile, go to the Investigations tab and click the Validation Profile Filters icon, then select the validation profile from the list. (If the validation profile you want to use does not appear in the drop-down list, make sure it has been promoted to production. If you did not create the profile, also make sure its Shared setting is set to Yes by asking the profile's owner to check.) The selected validation profile is automatically run against the selected Current Search records/cases and any validation warnings or errors appear in the list with a yellow background and an icon in the Validation Errors/Warnings column for that record. Hover the mouse over the icon to read the descriptive message.

NOTE: Please note following current limitations:
  • If you're using Core Data and you have only AND conditions, only the cases that have validation errors/warnings display
  • If you're using Core Data with OR conditions, or a CDC or custom form with either AND or OR conditions, all of the cases are displayed and only the ones with errors are highlighted

To correct an error, click the Edit icon for the record. Information about the error displays toward the top of the record in a yellow box. The yellow box remains until the error is fixed.

Import/Export Validation Profiles

Validation profiles can be imported and exported. There are two ways to export a validation profile:

  1. Click on the More icon and select Export Validation Profile Model. The file downloads to your computer.
  2. Click on the Profile History icon. In the change history list, locate the version you want to download (either the current version or a previous version) and click the Export icon for that version.

To import a validation profile, first create a new validation profile and enter the Profile Name and whether or not it can be shared. When the Validation Profile Builder page opens, click the More icon and select Import Validation Profile Model. Navigate to the file and upload it. Note that validation profile files have the extension ".vp".

Case Listing Exports with Validation Profiles

If the selected validation profile has conditions other than just Core Data questions using AND between the conditions (none uses OR), all of the cases are displayed and the ones with validation profile errors/warnings are highlighted. In this situation, when you click the Export button to export the case listings, an extra option appears on the Case Listing Export pop-up window: Export Investigations with Validation Profile Error/Warning Only. The two options are Yes and No. If you select No, all of the cases are exported. If you select Yes, only the cases with the errors and warnings are exported. That exported file includes a new column, Investigation Link, and users with the appropriate permissions can click on a link to correct the validation error(s) for that case.