README.txt

Meaningful Use Implementation Guide for Ambulatory Healthcare Provider Reporting to Central Cancer Registry Validation Tools
http://healthcare.nist.gov/

Release Date: 02/06/2013

This package contains the validation tools used for validating the XML documents against the structure defined by the Implementation Guide for Ambulatory Healthcare Provider Reporting to Central Cancer Registry and all included and referenced standards/specifications/guidelines.


Package Contents:

schema/ -- A directory containing the HL7 CDA R2 schema and related files.  This schema has been modified to include additions to the CDA R2 model as defined by IHE.

schematron/ -- A directory containing the schematron rules and related files for validating HL7.  The schematron includes rules for HL7 CCD, IHE specifications, HL7 CDA for Common Document Types For CDA (CDA4CDT) and Center for Disease Control and Prevention (CDC).

muCrValidator.jar -- A bare-bones, simplistic, no frills command-line tool demonstrating how to use the schema and schematron rules.

muValidationCR.war -- The .war file that will allow for a local installation of the Cancer Registry Reporting on-line Validation Tool.

lib/ -- A directory containing library .jar files needed by muCrValidator.jar.

src/ -- A directory containing the source code.

changelog.txt -- List of changes in this and previous releases.

The CCD schematron files are modified versions of the files available for download at the HL7 Wiki: http://wiki.hl7.org/index.php?title=Continuity_of_Care_Document_%28CCD%29



Command-line tool usage:

usage: java -jar muCrValidator.jar
 -input <filename>     input filename
 -output <filename>    output filename (without this option, the default
                                        filename is validationResult[timestamp].xml)


Example: username@localhost:~/cdaFiles> java -jar muCrValidator.jar -input CDA.xml -output report.xml

Note that the working directory (the directory that the .jar file is launched from) must be the directory containing the muCcdValidation.jar file (and has the lib, cdar2 and schematron directories as one level down from this).

The output of the report is an XML file containing header information (where the data about the test is displayed, a list of errors/warnings (if any), a list of successes (if any) and the original input.  The XML will be in the following format:

<Report>
	<ReportHeader>
		<ValidationStatus>Complete</ValidationStatus>
		<ServiceName>Implementation Guide for Ambulatory Healthcare Provider Reporting to Central Cancer Registry</ServiceName>
		<DateOfTest>20120919</DateOfTest>
		<TimeOfTest>160371.0117-0400</TimeOfTest>
		<ResultOfTest>Failed</ResultOfTest>
		<ErrorCount>7</ErrorCount>
	</ReportHeader>
	<Results severity="schemaViolation" specification="cda_r2">
		<issue>
			<message>cvc-complex-type.2.4.a: Invalid content was found starting with element 'addr'.
				One of '{"urn:hl7-org:v3":realmCode, "urn:hl7-org:v3":typeId,
				"urn:hl7-org:v3":templateId, "urn:hl7-org:v3":id}' is expected.</message>
		</issue>
	</Results>
	<Results severity="errors" specification="ccd">
		<issue>
			<message>CONF-390: The value for Section / code SHALL be 30954-2 Relevant diagnostic
				tests and/or laboratory data 2.16.840.1.113883.6.1 LOINC STATIC.</message>
			<context>/ClinicalDocument[1]/component[1]/structuredBody[1]/component[4]/section[1]</context>
			<test>cda:code[@code='30954-2'][@codeSystem='2.16.840.1.113883.6.1']</test>
		</issue>
...

(The rest of the XML report removed for brevity.)

Whether the overall test was a success or failure will be reported in the header along with other information such as the number of errors, date/time stamp, etc.  Violations of the CDA R2 schema will display the error message from the XML parser.  Each schematron issue contains a message, the context (an XPath expression showing the location) and the schematron test that was run at that location.

The command-line tool has been tested with Java 1.7.

Depending on the environment, the Java command-line tool may search for voc.xml files in different places.  Please verify that the JVM can find voc.xml file(s) either in the directory of the schematron file which calls them, or in the current working directory of the JVM.


.war file configuration:

Deploy the .war file to your web container (see the documentation of your web container software package for instructions on how this can be accomplished).

Once the .war project has been deployed, you will need to manually configure the application.  Open the webapps/muValidationCR/WEB-INF/web.xml file.  You will see several paths that will need to be changed to point to your local installation.

For example, you will see a path such as "/var/lib/tomcat/webapps/muValidationCR/schematron/cr/ahprccr.sch".  The "/var/lib/tomcat/" portion of the path will need to be changed to point at the location of your local Tomcat (or other web container) installation.


NOTE: NIST does not provide support for source-based installations of this software.  The source code is provided for demonstration purposes only.

For more information on this project, please visit http://healthcare.nist.gov/index.html

Any questions/comments/problems should be sent to the mailing list at: https://groups.google.com/forum/#!forum/cancer-reg-testing-tool


Disclaimers

Favorable outcome in the use of the test materials on this site does not imply
conformance recognition by NIST or HL7.

Links to non-Federal Government Web sites do not imply NIST endorsement of any
particular product, service, organization, company, information provider, or
content.

This software was developed at the National Institute of Standards and Technology
by employees of the Federal Government in the course of their official duties.
Pursuant to title 17 Section 105 of the United States Code this software is not
subject to copyright protection and is in the public domain.

The CDA Guideline Validator is an experimental system. NIST assumes no responsibility
whatsoever for its use by other parties, and makes no guarantees, expressed or implied,
about its quality, reliability, or any other characteristic. We would appreciate
acknowledgment if the software is used. This software can be redistributed and/or
modified freely provided that any derivative works bear some notice that they are
derived from it, and any modified versions bear some notice that they have been
modified.


