Represents a single result from the MIRING Validation.
A miring ID and severity are required, along with a description of the error.
Solution, xpath, and sample-id are supplementary information for resolving the MIRING problem
Children:
---------
- miring-compliant: (required, qty: 1)
Is the document miring compliant?
"false" if the document contains any results with severity "fatal" or "miring", "true" otherwise.
- hmlid: (required, qty: 1)
The required HMLID element is copied from the validated HML.
- samples: (required, qty: 1)
A summary of the validated document's sample elements.
- property: (optional, qty: 0 or more)
Any property nodes that are children to the root hml node on the validated document are copied here.
- fatal-validation-errors: (optional, qty: 1)
A collection of all severity="fatal" MIRING validation results
- miring-validation-errors: (optional, qty: 1)
A collection of all severity="miring" MIRING validation results
- validation-warnings: (optional, qty: 1)
A collection of all severity="warning" MIRING validation results
- validation-info: (optional, qty: 1)
A collection of all severity="info" MIRING validation results
Attributes:
-----------
- timestamp: (required)
The exact date and time the report was generated. Most likely it is in the format "MM/dd/yyyy HH:mm:ss"
A simple wrapper for a set of miring-result nodes.
Children:
---------
- miring-result: (optional, qty: 0 or more)
Zero or many miring-result nodes
Represents a single result from the MIRING Validation.
A miring ID and severity are required, along with a description of the error.
Solution, xpath, and sample-id are supplementary information for resolving the MIRING problem
Children:
---------
- description: (required, qty: 1)
A description of the problem or result
- solution: (optional, qty: 0 or 1)
A suggestion of a solution to the miring violation.
- xpath (optional, qty: 0 or more)
An xpath pointing to the location of result.
Attributes:
-----------
- miring-rule-id: (required)
An identifier for what specific MIRING requirement is being violated
- sample-id: (optional)
If this result is specific to a sample from the validated hml, it's id is included here.
- severity (required)
The severity of a miring-result can be one of: fatal, miring, warning, info
Detailed descriptions are given in the "severity" type definition
A wrapper for a set of sample nodes. The attributes include summary information about the analyzed samples
Children:
---------
- sample: (required, qty: 1)
A sample results node, representing a sample element form the validated HML document
Attributes:
-----------
- sample_count: (required)
The number of sample elements found in the validated HML document
- compliant-sample-count: (required)
The number of sample elements found to be MIRING compliant
- noncompliant-sample-count (required)
The number of sample elements found to be MIRING noncompliant
Represents a single sample from the validated HML document.
Attributes:
-----------
- id: (required)
A sample identifier. This should be a copy of the sample:id from the validated HML.
- center-code: (optional)
If available, the sample:center-code will be copied to the report.
- miring-compliant (required)
A boolean, representing whether this individual sample is MIRING compliant.
A single sample-specific miring-result element, with a severity of "fatal" or "miring",
(but not "warning" or "info")
will result in a false, otherwise true.
Data:
-----
- resource in GL String representation (string, required)
A type representing the severity of a miring-result node. One of four possible severities.
Data:
-----
- fatal
A fatal result is one in which validation cannot continue. Most likely the document is not valid XML or HML.
Any fatal results will set the document's miring-compliant flag to false
- miring
A miring result is a violation of one or more MIRING rules.
Any miring results will set the document's miring-compliant flag to false
- warning
A warning to the user. It is not a direct violation, but the HML supplier should note the warning to ensure their data is valid.
A warning result will not invalidate the document.
- info
Information supplied to the user. It may or may not be helpful. No action is required.
A info result will not invalidate the document.
An ID to identify a sample. This attribute is required in HML, and is copied to the report for each sample.
In HML Spec, a sample ID has no uniqueness constraints, and therefore should not be expected to be unique here.
Data:
-----
- A sample ID, copied from the validated HML document.