cda-schematron-validator

cda-schematron-validator

Release History

1.1.12

• Update xmldom to the latest version

1.1.11

• License file added

1.1.10

• Fix grunt race condition reported by github

  "file.copy operations in GruntJS are vulnerable to a TOCTOU race condition leading to arbitrary file write in GitHub repository gruntjs/grunt prior to 1.5.3. This vulnerability is capable of arbitrary file writes which can lead to local privilege escalation to the GruntJS user if a lower-privileged user has write access to both source and destination directories as the lower-privileged user can create a symlink to the GruntJS user's .bashrc file or replace /etc/shadow file if the GruntJS user is root."

1.1.9

• Fix grunt vulnerability

1.1.8

• jsdoc module added
• parseSchematron.js moved to lib

1.1.7

• Introduced a new method called validateFileObjectAsync which allows to supply an object with key, value pairs where key represents the identifier of the xml, and the value represents xml file content or path to validate
• An array of results will be returned from the validateFileObjectAsync method
• Test file test/asyncFileList.test.js has the example usage
• The result object has the property fileInfo that would return the key the identifier of the xml to identify and debug issues
• The result object of the array result from the method validateFileListAsync now has the property fileIndex that will give an indication of which xml file the result belongs to for debugging purposes

1.1.6

• Methods have been moved to js files and relocated to lib directory
• Introduced a new method called validateFileListAsync which allows to supply an array of xml file content or paths to validate
• An array of results will be returned from the validateFileListAsync method
• Test file test/asyncFileList.test.js has the example usage
• Started to make use of Promise.all for async methods
• Documentation of the methods completed by 40%

1.1.5

• Major methods have been divided into multiple small methods to avoid redundancy across sync and async methods, and reduce maintenance

1.1.4 (Stable Release)

• Major deviations from the source repository

  • By default the warning will be turned off in contrast to the parent repository

  • To get warnings, users have to explicitly specify the option includeWarnings with value boolean true

  • We also deviate from the previous behavior where all the checks for warnings were done at the assertion level just before testing the xpath. We now would not even parse the phase with @id="warnings" which should improve the performance.

• Minor cosmetic changes to the code

1.1.1 to 1.1.3

• Only keeping the necessary data in the test files taken from HL7 C-CDA schematron repository to avoid bloating the module

• Added pre-commit hooks with husky

• Added code standardization with prettier, ESLint, and lint-staged

1.1.0

• Fix the issue with the rule check which was working in the original repository, but not in the fork
• Added HL7 C-CDA schematron file and resource file from https://github.com/HL7/CDA-ccda-2.1/releases/tag/2019JUN
• Added a test case vitalSigns.test.js that tests the resource file and sub assertions
• Used resources https://github.com/jddamore/ccda-samples and https://github.com/HL7/C-CDA-Examples/tree/master/Vital%20Signs to create the test file vitalSigns.xml

1.0.10

• Fix null context issue associated with assertions within assertions
• Skip abstract rules associated with assertions within assertions

1.0.9

• Fixed the bug introduced in 1.0.8 trying to adjust to different data types of the return value
• Changed variable names to improve understanding of the process

1.0.8

• Bug fix identifying the ignored errors

1.0.7

• Added async validate function validateAsync
• Added testsAsync to test validateAsync
• Plan to use common functions between sync and async methods in the future release

1.0.0 to 1.0.6

A fork to the original cda-schematron. All credit to Eric Wadkins. Visit the github https://github.com/ewadkins/cda-schematron for the original repo.

This is just a cosmetic change with updated node modules, a couple of minor bugs observed, and esversion 6 changes.

The changes are fully backward compatible. So, leaving the original documentation as is below.

New option parameter parsedSchematronMap

In addition to everything that was possible, you can now supply a new option parameter parsedSchematronMap. You can create a schematron map as follows.

const fs = require('fs');
const dom = require('@xmldom/xmldom').DOMParser;
const { parseSchematron, validate } = require('cda-schematron-validator');
const schematronString = fs.readFileSync('SchematronFilePath', 'utf-8').toString();
const schematronDoc = new dom().parseFromString(schematronString);
const schematronMap = parseSchematron(schematronDoc);
const options = { 
    parsedSchematronMap: schematronMap
    };
const results =  validate('xml string or file path', 'schematron sting, file path or null', options);

If a schematron map is provided, the schematron string or path will not be read.

To install this npm module, it will be

npm i cda-schematron-validator

Mocha VS Code configuratin added to directly execute the test file in test/tests.js using VS Code.

Documentation of the parent repo cda-schematron

A javascript implementation of schematron testing for XML documents. This specifically resolves a need for a package that allows a quick, reliable install for validating HL7 clinical documents, such as C-CDA.

Check out cda-schematron-server, a server wrapper of cda-schematron, for easy schematron validation.

Validating xml

var validator = require('cda-schematron');

var xmlPath = 'someFile.xml';
var schematronPath = 'someFile.sch';

var fs = require('fs');
var xml = fs.readFileSync(xmlPath).toString();
var schematron = fs.readFileSync(schematronPath).toString();

var results = validator.validate(xml, schematron);

File paths can also be passed to the validator directly. The following lines all return the same results:

var results = validator.validate(xml, schematronPath);

var results = validator.validate(xmlPath, schematron);

var results = validator.validate(xmlPath, schematronPath);

Results

results is an object containing arrays errors, warnings, and ignoreds.

Errors and warnings are reported as determined by the schematron and test descriptions. They are of the following form:

{
    type: type,                     // "error" or "warning"
    test: test,                     // xpath test
    simplifiedTest: simplifiedTest, // xpath test with resource values included, if applicable, null otherwise
    description: description,       // schematron description of the test case
    line: line,                     // line number of the violating context
    path: path,                     // xpath path of the violating context
    patternId: patternId,           // schematron-assigned pattern id
    ruleId: ruleId,                 // schematron-assigned rule id
    assertionId: assertionId,       // schematron-assigned assertion id
    context: context,               // xpath context of the rule
    xml: xml                        // xml snippet of the violating context
}

Ignored tests are those that resulted in an exception while running (eg. the test is invalid xpath and could not be parsed properly) and require manual inspection. They are of the following form:

{
    errorMessage: errorMessage,     // reason for the exception/ignoring the test
    type: type,                     // "error" or "warning"
    test: test,                     // xpath test
    simplifiedTest: simplifiedTest, // xpath test with resource values included, if applicable, null otherwise
    description: description,       // schematron description of the test case
    patternId: patternId,           // schematron-assigned pattern id
    ruleId: ruleId,                 // schematron-assigned rule id
    assertionId: assertionId,       // schematron-assigned assertion id
    context: context,               // xpath context of the rule
}

Options

The validate function takes in an options object as an optional third argument. The three fields that can be included in options are as follows:

• includeWarnings: true or false, this determines whether or not warnings should be tested and returned. Defaults to true.

• resourceDir: the path to a directory containing resource files (eg. voc.xml) which may be necessary for some schematron tests. Defaults to './', the current directory.

• xmlSnippetMaxLength: an integer, which is the maximum length of the xml field in validation results. Defaults to 200. Set to 0 for unlimited length.

Here is an example with warnings disabled:

var results = validator.validate(xml, schematron, { includeWarnings: false });

Cache

The validator uses a cache to store parsed schematrons, an intermediate data structure used to store revelant schematron information. This reduces the runtime of the validator when validating against the same schematron multiple times. You can clear the cache at any time with:

validator.clearCache();

License (MIT)

Copyright © 2017 Eric Wadkins

Copyright © 2022 Priyaranjan (Raj) Tokachichu

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.