VariantReportabilityRulesChecker

Variant Reportability Rules

Liquid Biopsy жидкостная биопсия cfDNA ctDNA CTC exosomes NGS qPCR
Open selection

Utility description: Variant Reportability Rules

Variant Reportability Rules Checker — Variant Reporting Rules Validation

ℹ️  Utility performs independent verification of reportability rules application according to AMP/ASCO/CAP, ACMG/AMP, CLIA and EU IVDR:
     • Technical Filters: Verification of minimum VAF and coverage depth thresholds for each variant.
     • Population Filters: Context-dependent gnomAD filtering (different thresholds for somatic and germline).
     • Clinical Significance: Verification of classification (ACMG/AMP Tier) alignment with reporting decision.
     • Ethical Rules: Control of secondary findings handling and patient informed consent presence.
     • Rule Engine Concordance: Comparison of expected decision with actual bioinformatics pipeline decision.

⚠️  IMPORTANT: 
     • Reportability rules must be DOCUMENTED in SOP BEFORE clinical testing begins.
     • Any rule change requires revalidation and Change Control documentation.
     • Discrepancy between rule engine and expected decision = potential pipeline error.
     • Secondary findings without patient consent = ethical violation and legal risk.

Usage:
  VariantReportabilityRulesChecker.exe                            → demo mode (console output)
  VariantReportabilityRulesChecker.exe input.csv output.json      → evaluate your data

Input format:
SampleID,VariantID,Gene,VariantType,Context,VAF_Percent,MinReportableVAF_Percent,ReadDepth,MinReportableDepth,ACMG_Classification,AMP_Tier,GnomAD_AF,MaxReportable_GNomAD_AF_Somatic,MaxReportable_GNomAD_AF_Germline,HasTherapeuticAssociation,HasDiagnosticSignificance,HasPrognosticSignificance,PatientConsent_SecondaryFindings,IsSecondaryFinding,IsOnGenePanel,RuleEngine_Pass,FilterReason

Example:
  NGS-001,EGFR:c.2573T>G,EGFR,SNV,Somatic,28.5,5,850,100,,TierI,0.00001,0.01,0.001,true,true,true,false,false,true,true,

📍 Scope of Application (Usage Where):
     • Clinical NGS Laboratories: Independent audit of rule engine decisions before report release.
     • Bioinformatics Pipeline Validation: Confirmation of correct rules implementation.
     • Regulatory Inspections: Demonstration of decision-making control system.
     • CAP/CLIA Accreditation: Documentation of reporting standards compliance.

— WHY IS THIS NEEDED?
Bioinformatics pipelines contain hundreds of rules implemented in code.
Error in one condition may lead to inclusion of false-positive variant or missing pathogenic mutation.
Independent verification serves as second safety barrier after the pipeline itself.
This is critically important for patient safety and regulatory compliance.

⚠️  CRITICAL:
• Rule Engine Concordance: ANY discrepancy = CRITICAL. Requires immediate investigation.
• Secondary Findings: Without consent = BLOCKED. Ethics committee must be notified.
• gnomAD Context: Somatic and germline thresholds are DIFFERENT. Mixing = errors.
• ACMG/AMP Alignment: Benign/Likely Benign germline variants are NOT reportable.
• Tier IV Somatic: Without clinical significance = filtered. Do not clutter report.

Key features:
• Multi-tier verification (technical → population → clinical → ethical)
• Automatic rule engine discrepancy detection
• Context-dependent thresholds (somatic vs germline)
• Aggregated per-sample report with per-variant detail
• Compliance with AMP/ASCO/CAP + ACMG/AMP + CLIA + EU IVDR

Critical parameters:
• VAF ≥ Min Reportable Threshold
• Read Depth ≥ Min Reportable Depth
• gnomAD AF ≤ Context-specific Max
• ACMG/AMP Classification → Correct Reporting Decision
• Secondary Finding Consent: True if IsSecondaryFinding
• Rule Engine Concordance: 100%

💡 Usage tips:
1. Synchronization: Update checker thresholds simultaneously with pipeline updates.
2. Test Sets: Use reference datasets with known decisions for regression testing.
3. Audit: Run checker on EVERY clinical sample, not only during validation.
4. Documentation: Save JSON reports as part of each case's audit trail.
5. Escalation: Configure automatic notification upon CRITICAL_ISSUE detection.

⚠️ Note: This utility verifies RULE APPLICATION, not clinical correctness of rules themselves. Rule correctness is determined by expert group (molecular pathologist, geneticist, bioinformatician) and documented in validation protocol. The utility guarantees that approved rules are applied consistently and without errors.

input.csv

SampleID,VariantID,Gene,VariantType,Context,VAF_Percent,MinReportableVAF_Percent,ReadDepth,MinReportableDepth,ACMG_Classification,AMP_Tier,GnomAD_AF,MaxReportable_GNomAD_AF_Somatic,MaxReportable_GNomAD_AF_Germline,HasTherapeuticAssociation,HasDiagnosticSignificance,HasPrognosticSignificance,PatientConsent_SecondaryFindings,IsSecondaryFinding,IsOnGenePanel,RuleEngine_Pass,FilterReason
NGS-2026-001,EGFR:c.2573T>G,EGFR,SNV,Somatic,28.5,5.0,850,100,,Tier I,0.00001,0.01,0.001,true,true,true,false,false,true,true,
NGS-2026-001,BRCA2:c.7868A>G,BRCA2,SNV,Germline,49.0,20.0,200,100,VUS,,0.0002,0.01,0.001,false,false,false,false,true,true,false,Secondary finding without patient consent
NGS-2026-001,TP53:c.215C>G,TP53,SNV,Somatic,8.0,5.0,500,100,,Tier IV,0.025,0.01,0.001,false,false,false,false,false,true,false,High population frequency
NGS-2026-001,MLH1:c.1852_1854del,MLH1,Indel,Germline,50.0,20.0,320,100,Pathogenic,,0.00005,0.01,0.001,false,true,true,true,false,true,true,

URS & FS — User Requirements and Functional Specification

This document describes the controlled interface and behaviour of VariantReportabilityRulesChecker for Variant Reportability Rules Checker.

Domain limits and critical parameters

Key fragments from the source description are shown below. Before production use, limits must be verified against the approved specification, registration dossier and local SOPs.
  • • Rule Engine Concordance: Comparison of expected decision with actual bioinformatics pipeline decision.
  • • Reportability rules must be DOCUMENTED in SOP BEFORE clinical testing begins.
  • SampleID,VariantID,Gene,VariantType,Context,VAF_Percent,MinReportableVAF_Percent,ReadDepth,MinReportableDepth,ACMG_Classification,AMP_Tier,GnomAD_AF,MaxReportable_GNomAD_AF_Somatic,MaxReportable_GNomAD_AF_Germline,HasTherapeuticAssociation,HasDiagnosticSignificance,HasPrognosticSignificance,PatientConsent_SecondaryFindings,IsSecondaryFinding,IsOnGenePanel,RuleEngine_Pass,FilterReason
  • NGS-001,EGFR:c.2573T>G,EGFR,SNV,Somatic,28.5,5,850,100,,TierI,0.00001,0.01,0.001,true,true,true,false,false,true,true,
  • This is critically important for patient safety and regulatory compliance.
  • ⚠️ CRITICAL:
  • • Rule Engine Concordance: ANY discrepancy = CRITICAL. Requires immediate investigation.
  • • Secondary Findings: Without consent = BLOCKED. Ethics committee must be notified.
  • Critical parameters:
  • • VAF ≥ Min Reportable Threshold
  • • Read Depth ≥ Min Reportable Depth
  • • gnomAD AF ≤ Context-specific Max
  • 5. Escalation: Configure automatic notification upon CRITICAL_ISSUE detection.

URS — User Requirements Specification

IDRequirementCriticalityAcceptance criterion
URS-001The utility shall accept an input.csv file for Variant Reportability Rules Checker with headers defined in the data contract.HighThe file is processed without manual header editing.
URS-002The utility shall perform deterministic QC evaluation without machine learning and without probabilistic conformance decisions.HighIdentical input data, rule version and configuration produce reproducible results.
URS-003The utility shall validate mandatory fields, data types, ranges, units and domain plausibility.HighSchema, conversion and range errors are explicitly reported.
URS-004The utility shall apply domain limits and rules from the description, approved specification, registration dossier and local SOPs.HighEach check has PASS/WARNING/FAIL and a clear message.
URS-005The utility shall generate output.json with machine-readable results, source values, warnings, failures and critical findings.HighJSON is suitable for LIMS/ELN/MES integration and QA/QC review.
URS-006The utility shall preserve traceability between batch/sample, input file, applied rules and final status.HighOutput contains identifiers, checked parameters and audit metadata.
URS-007The documentation shall support IQ/OQ/PQ, CSV/CSA and review by internal QA or inspectors.MediumURS, FS, input/output contract and test scenarios are supplied with the utility.
URS-008The utility shall be used as a QC decision-support tool and not as a substitute for approved specifications and QA/QP release decision.MediumDocumentation states change control and limit-verification expectations.

input.csv contract

#FieldTypeSamplePurpose
1SampleIDstring / controlled vocabularyNGS-2026-001Sample or laboratory specimen identifier.
2VariantIDstring / controlled vocabularyEGFR:c.2573T>GControlled input parameter for deterministic QC rules.
3Genestring / controlled vocabularyEGFRControlled input parameter for deterministic QC rules.
4VariantTypestring / controlled vocabularySNVControlled input parameter for deterministic QC rules.
5Contextstring / controlled vocabularySomaticControlled input parameter for deterministic QC rules.
6VAF_Percentdecimal28.5Controlled input parameter for deterministic QC rules.
7MinReportableVAF_Percentdecimal5.0Controlled input parameter for deterministic QC rules.
8ReadDepthdecimal850Controlled input parameter for deterministic QC rules.
9MinReportableDepthdecimal100Controlled input parameter for deterministic QC rules.
10ACMG_Classificationstring / controlled vocabularyControlled input parameter for deterministic QC rules.
11AMP_Tierstring / controlled vocabularyTier IControlled input parameter for deterministic QC rules.
12GnomAD_AFdecimal0.00001Controlled input parameter for deterministic QC rules.
13MaxReportable_GNomAD_AF_Somaticdecimal0.01Controlled input parameter for deterministic QC rules.
14MaxReportable_GNomAD_AF_Germlinedecimal0.001Controlled input parameter for deterministic QC rules.
15HasTherapeuticAssociationstring / controlled vocabularytrueControlled input parameter for deterministic QC rules.
16HasDiagnosticSignificancestring / controlled vocabularytrueControlled input parameter for deterministic QC rules.
17HasPrognosticSignificancestring / controlled vocabularytrueControlled input parameter for deterministic QC rules.
18PatientConsent_SecondaryFindingsstring / controlled vocabularyfalseControlled input parameter for deterministic QC rules.
19IsSecondaryFindingstring / controlled vocabularyfalseControlled input parameter for deterministic QC rules.
20IsOnGenePanelstring / controlled vocabularytrueControlled input parameter for deterministic QC rules.
21RuleEngine_Passstring / controlled vocabularytrueControlled input parameter for deterministic QC rules.
22FilterReasonstring / controlled vocabularyControlled input parameter for deterministic QC rules.
SampleID,VariantID,Gene,VariantType,Context,VAF_Percent,MinReportableVAF_Percent,ReadDepth,MinReportableDepth,ACMG_Classification,AMP_Tier,GnomAD_AF,MaxReportable_GNomAD_AF_Somatic,MaxReportable_GNomAD_AF_Germline,HasTherapeuticAssociation,HasDiagnosticSignificance,HasPrognosticSignificance,PatientConsent_SecondaryFindings,IsSecondaryFinding,IsOnGenePanel,RuleEngine_Pass,FilterReason
NGS-2026-001,EGFR:c.2573T>G,EGFR,SNV,Somatic,28.5,5.0,850,100,,Tier I,0.00001,0.01,0.001,true,true,true,false,false,true,true,
NGS-2026-001,BRCA2:c.7868A>G,BRCA2,SNV,Germline,49.0,20.0,200,100,VUS,,0.0002,0.01,0.001,false,false,false,false,true,true,false,Secondary finding without patient consent
NGS-2026-001,TP53:c.215C>G,TP53,SNV,Somatic,8.0,5.0,500,100,,Tier IV,0.025,0.01,0.001,false,false,false,false,false,true,false,High population frequency

Input validation rules

IDFieldRuleCriticality
VR-001SampleIDThe field shall match an approved dictionary or accepted string representation.High
VR-002VariantIDThe field shall match an approved dictionary or accepted string representation.High
VR-003GeneThe field shall match an approved dictionary or accepted string representation.High
VR-004VariantTypeThe field shall match an approved dictionary or accepted string representation.Medium
VR-005ContextThe field shall match an approved dictionary or accepted string representation.Medium
VR-006VAF_PercentThe field shall match an approved dictionary or accepted string representation.Medium
VR-007MinReportableVAF_PercentThe field shall match an approved dictionary or accepted string representation.Medium
VR-008ReadDepthThe field shall match an approved dictionary or accepted string representation.Medium
VR-009MinReportableDepthThe field shall match an approved dictionary or accepted string representation.Medium
VR-010ACMG_ClassificationThe field shall match an approved dictionary or accepted string representation.Medium
VR-011AMP_TierThe field shall match an approved dictionary or accepted string representation.Medium
VR-012GnomAD_AFThe field shall match an approved dictionary or accepted string representation.Medium
VR-013MaxReportable_GNomAD_AF_SomaticThe field shall match an approved dictionary or accepted string representation.Medium
VR-014MaxReportable_GNomAD_AF_GermlineThe field shall match an approved dictionary or accepted string representation.Medium
VR-015HasTherapeuticAssociationThe field shall match an approved dictionary or accepted string representation.Medium
VR-016HasDiagnosticSignificanceThe field shall match an approved dictionary or accepted string representation.Medium
VR-017HasPrognosticSignificanceThe field shall match an approved dictionary or accepted string representation.Medium
VR-018PatientConsent_SecondaryFindingsThe field shall match an approved dictionary or accepted string representation.Medium
VR-019IsSecondaryFindingThe field shall match an approved dictionary or accepted string representation.Medium
VR-020IsOnGenePanelThe field shall match an approved dictionary or accepted string representation.Medium
VR-021RuleEngine_PassThe field shall match an approved dictionary or accepted string representation.Medium
VR-022FilterReasonThe field shall match an approved dictionary or accepted string representation.Medium

FS — Functional Specification

IDFunctionImplementation
FS-001CLI executionSupport execution modes: demo mode without arguments and production mode input.csv output.json.
FS-002CSV importRead input.csv in UTF-8/CSV-compatible format and validate header and expected columns.
FS-003Schema validationCheck mandatory fields, column count, unknown key fields and empty mandatory values.
FS-004Type conversionConvert numeric, flag and text values; invalid format is recorded as a row-level error.
FS-005Domain rule engineApply rules for Variant Reportability Rules Checker, including critical limits from the description and approved specification.
FS-006Status aggregationProduce final status: FAIL for critical failure, WARNING for non-critical deviation, PASS for conformance.
FS-007JSON exportWrite output.json with detailed checks, source values, warnings, failures and critical findings.
FS-008Audit supportKeep result structure suitable for review, deviation investigation and calculation reproduction.
FS-009Integration contractSupport the scenario LIMS/ELN/MES → input.csv → utility → output.json → portal/admin review.
FS-010Error handlingReturn explicit messages for missing file, empty CSV, invalid schema, output write failure and invalid format.

Example output.json

{
  "utilityId": "variantreportabilityruleschecker",
  "utilityFolder": "VariantReportabilityRulesChecker",
  "package": "LiquidBiopsy",
  "overallStatus": "PASS|WARNING|FAIL",
  "sourceFile": "input.csv",
  "processedAtUtc": "2026-06-10T00:00:00Z",
  "checks": [
    {
      "parameter": "SampleID",
      "value": "NGS-2026-001",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-001"
    },
    {
      "parameter": "VariantID",
      "value": "EGFR:c.2573T>G",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-002"
    },
    {
      "parameter": "Gene",
      "value": "EGFR",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-003"
    },
    {
      "parameter": "VariantType",
      "value": "SNV",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-004"
    },
    {
      "parameter": "Context",
      "value": "Somatic",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-005"
    },
    {
      "parameter": "VAF_Percent",
      "value": "28.5",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-006"
    },
    {
      "parameter": "MinReportableVAF_Percent",
      "value": "5.0",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-007"
    },
    {
      "parameter": "ReadDepth",
      "value": "850",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-008"
    },
    {
      "parameter": "MinReportableDepth",
      "value": "100",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-009"
    },
    {
      "parameter": "ACMG_Classification",
      "value": "",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-010"
    },
    {
      "parameter": "AMP_Tier",
      "value": "Tier I",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-011"
    },
    {
      "parameter": "GnomAD_AF",
      "value": "0.00001",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-012"
    }
  ],
  "criticalFindings": [],
  "warnings": [],
  "audit": {
    "inputHash": "sha256:<calculated at runtime>",
    "rulesVersion": "<utility executable version>",
    "documentation": "VariantReportabilityRulesChecker.documentation.html"
  }
}

Traceability matrix

URSFSTestEvidence
URS-001FS-001, FS-002OQ-001Verify execution and import of valid input.csv.
URS-002FS-005, FS-006OQ-004Repeat the same dataset and compare output.json.
URS-003FS-003, FS-004, FS-010OQ-002, OQ-003Verify missing columns and invalid types.
URS-004FS-005, FS-006OQ-004, PQ-001Verify critical deviations on real/boundary data.
URS-005FS-007, FS-009OQ-005Verify JSON schema and downstream-system suitability.
URS-006FS-008OQ-006Verify identifiers and audit metadata.
URS-007FS-008, FS-010IQ-001, OQ-007Verify documentation completeness and control evidence.
URS-008FS-005, FS-008PQ-002Verify review workflow and no replacement of QA decision.

IQ/OQ/PQ test scenarios

IDScenarioExpected result
IQ-001Verify executable, input.csv, documentation and checksum availability.Delivery set is complete; version is recorded.
OQ-001Valid sample row from input.csv.PASS or acceptable WARNING according to rules.
OQ-002Remove a mandatory CSV column.Schema error or FAIL with missing-column reference.
OQ-003Place a non-numeric value into a numeric field.Type-conversion error with row/field reference.
OQ-004Set a critical parameter outside the limit.FAIL and critical finding.
OQ-005Verify output.json structure.All mandatory sections are present and JSON is valid.
OQ-006Verify batch/sample traceability.Input and result identifiers match.
PQ-001Verify 3–5 real user batches/samples.Result is confirmed by QC/QA review.
PQ-002Verify deviation workflow and manual QA decision.Utility supports review but does not replace approved decision.

QA/QC and change control

  • Do not rename columns without updating validator, documentation and test set.
  • Retain input.csv, output.json, executable version and checksum.
  • Before production use, perform IQ/OQ/PQ or equivalent CSV/CSA verification.
  • Critical limits shall be verified against the approved specification, registration dossier and local SOPs.
  • The utility provides structured QC decision support; final release decision remains with QA/QP and approved procedures.

Included in packages

Liquid Biopsy QC Suite

QC and pre-analytical control package for liquid biopsy workflows: cfDNA/ctDNA, CTC, EV/exosomes, methylation, NGS/qPCR/ddPCR, sample quality, contamination, sensitivity and reporting checks.

Open