This guide serves as a reference for the Cancer Report Validator (CRV) and provides details regarding the user interface and how to interpret the results reported to users.
The Home tab can be accessed at the top of the screen and describes the purpose and background of the CRV. A link to the test data is also included.
The Validator tab is displayed by default and can be accessed at the top of the screen.
Under the Submit section, the user should select a file that represents the cancer event report that should be validated.
There are two options for validation: context-free and context-specific.
In context-free validation, the submitted cancer event report is only validated according to the conformance statements in the Cancer Registries IG, without any comparison of the data element values to the test data.
In context-specific validation, data element values in the submitted cancer event report are matched against those specified in the test data spreadsheets (see Test Data Documentation).
As part of context-specific validation, the CRV also checks that certain pairs of values in the report are equal. This occurs as follows:
Please see the Test Data Documentation for more details regarding the test cases.
The results of each cancer event report submission are displayed in an accordion-style collapsible panel where a summary is displayed in a color-coded rectangular bar and more detailed results are displayed within the panel in several tabs. In the right-hand corner of the rectangular bar, the user can click on the X to remove the results for an entire submission.
The rectangular bar at the top of the panel lists the file name that was submitted, the time of submission, the test case that was selected, and a results summary.
The results can be downloaded in either JSON or XML format from the rectangular bar by clicking on either the JSON or XML icons in the "Download" box.
The Details tab includes information regarding the cancer event report submission and the test case that was selected.
The IG Conformance Events tab includes a summary of the IG conformance validation events above a table containing a row for each validation event.
IG conformance events will be displayed/activation of the Schematron validation will occur only when a ClinicalDocument root element is present in the cancer event report at a minimum, as indicated below. Additional namespaces can be declared at the root element or in a child element elsewhere in the cancer event report.
|
The statistics represent the number of IG conformance validation events that fall into one of the following categories:
For each of the categories above, the following numbers are displayed: a of b (c Filtered), where:
Prior to any filtering of validation events in the table, the results for all IG conformance validation events are displayed. Any errors are displayed as the first rows of the table. The table below describes the columns in the table and the available filtering options on a per column basis, if applicable.
Column Name | Description | Filtering Options |
---|---|---|
Status | Indicates the status of the validation event
| ERROR, WARN, INFO, or Pass |
Location | Indicates the general location in the submitted report where an element corresponding to the assertion tested can be found in terms of
| Line number |
Expression |
| |
Description | Text associated with/describing the conformance statement as listed in the IG. | |
Messages | Additional messages that the user may want to look at, which pertain to validation events that involve vocabulary validation. These messages could further explain the status and/or result of the validation event. e.g. "Vocabulary validation disabled for assertion," "Code was not specified," "Invalid code," "Invalid code display name." | |
Vocabulary Sets | Includes information regarding the value set and/or code system from which the code was selected from (e.g. OIDs, name, version), if applicable. Displays the actual and expected results. | ID |
Code | Applicable to events that contain some type of code attribute
| ID |
Pattern | A pattern in the Schematron file corresponding to a template id in the IG, including a phase level (errors, warnings, infos). Patterns are composed of rules. | ID |
Rule | A rule in the Schematron file that is composed of assertions. | ID |
Assertion | An assertion in the Schematron file corresponding to a conformance statement(s) in the IG.
| ID |
ID | Validation event id, which users can provide in support requests when they have questions regarding a particular assertion. The same validation id will correspond to the same assertion that is tested for a given cancer event report submission. |
The Test Data Conformance Events tab includes a summary of the test data conformance validation events above a table containing a row for each validation event.
The statistics represent the number of test data conformance validation events that fall into one of the following categories:
For each of the categories above, the following numbers are displayed: a of b (c Filtered), where:
Prior to any filtering of validation events in the table, the results for all test data validation events are displayed. Any mismatches are displayed as the first rows of the table. The table below describes the columns in the table and the available filtering options on a per column basis, if applicable.
Column Name | Description | Filtering Options |
---|---|---|
Status | Indicates the status of the validation event
| Mismatch or Match |
Actual Result | The value found in the submitted report at the location specified in the "Location" column. | ID |
Expected Result(s) | The possible value(s) that could be used in the submitted report, as specified in the test data. | ID |
Location | Indicates the location in the submitted report where a data element corresponding to the test data can be found in terms of
| Line # |
Messages | Additional messages that the user may want to look at, which further explain the status and/or result of the validation event (i.e. why there is a mismatch). Examples include:
| |
ID | Validation event id, which users can provide in support requests when they have questions regarding a particular test data match or mismatch. The same validation id will correspond to the same match or mismatch tested for a given cancer event report submission. |