check
This page provides the usage information for the rf2 check
command.
Command options overview and help
You can also see this information by running rf2 help check
from the command line.
PATH argument
The rf2 check
command accepts arbitrary number of RF2 source file paths. The PATH
argument must point to a location of file (NOTE: directories are not supported yet).
For example, consider this command line:
Executing it will print out the RF2 release structure along with certain properties of each file inside the release package. Example output:
Validation
The rf2 check
command validates each supplied source file and reports problems under the issues
property of the corresponding file output.
File Name Validation
RF2 packages are validated against the current Release Package Naming Convention, while RF2 files are validated against the current Release File Naming Convention.
If a file cannot be recognized by the currently loaded RF2 Specification (see rf2-spec.yml), the rf2 check
command will report the file as Unrecognized
type and will not attempt any other validation to run on that file.
Content Validation
On top of the file name validation, rf2 check
command provides the ability to validate the actual RF2 content of each RF2 source file. If an RF2 source file is not Unrecognized
, then the tool will search for registered validators and run them on the entirety of the file.
Currently supported content validation rules:
Not empty validation rule (reports if a column is empty)
Boolean column type validation rule (reports if a column value is not of type
Boolean
)Integer column type validation rule (reports if a column value is not of type
Integer
)SNOMED CT Identifier validation rule (reports invalid SNOMED CT IDs, see SNOMED CT ID specification for more detail)
Referenced Component ID validation rule (reports if a referenced SNOMED CT ID is invalid or valid but references unexpected SNOMED CT Component, eg.
moduleId
column should refer to a SNOMED CT Concept)EffectiveTime validation rule (reports if an
effectiveTime
column value is an incorrect ISO-8601 date value)ISO-639 validator for
languageCode
column
Custom validation rules
This feature is currently in design phase and it is planned to be released at the latest with the v1.0.0 release.
Last updated