ClinicalReportConsistencyChecker

Clinical Report Consistency

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

Utility description: Clinical Report Consistency

Clinical Report Consistency Checker — Internal Report Consistency Validation

ℹ️  Utility performs automatic verification of molecular genetic report internal consistency according to CAP Molecular Pathology Checklist and CLIA:
     • Numerical Consistency: Reconciliation of variant counts across table, summary, and narrative text.
     • Logical Coherence: Verification that every actionable variant has corresponding therapeutic recommendation.
     • Data Uniformity: Control of VAF, CNV, and gene nomenclature (HGNC) identity across all report sections.
     • Structural Completeness: Presence of mandatory sections (disclaimer, methodology, test limitations).
     • Navigation Integrity: Cross-reference validity and template version compliance.

⚠️  IMPORTANT: 
     • Contradictory data within a single report undermines physician trust in the entire laboratory.
     • Missed therapy for actionable variant may cost patient's life.

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

Input format:
ReportID,PatientID,VariantsInTable,VariantsInSummary,ActionableVariantsInTable,TherapiesInRecommendations,AllActionableHaveTherapy,VAF_Consistent,GeneNomenclature_Consistent,HasRequiredDisclaimer,HasMethodologySection,HasLimitationsSection,CrossReferencesValid,ReportVersion,TemplateVersion

Example:
  RPT-001,PAT-01,5,5,2,2,true,true,true,true,true,true,true,v4.1,v4.1

📍 Scope of Application (Usage Where):
     • Molecular Laboratories: Final QC before pathologist signature.
     • CDSS Systems: Automatic verification of generated reports.
     • Quality Audit: Retrospective analysis of issued reports.
     • CAP/CLIA Accreditation: Demonstration of reporting quality control system.

— WHY IS THIS NEEDED?
Molecular reports contain dozens of intersecting data points in different formats.
During manual preparation or complex templating, desynchronization is inevitable.
Automated verification eliminates "blind spots" and guarantees physician sees unified, non-contradictory picture.
This is the last line of defense against interpretation errors.

⚠️  CRITICAL:
• Variant Count Mismatch: Different variant counts in table vs summary = gross error.
• Missing Therapy: Actionable variant without recommendation = incomplete report.
• VAF Discrepancy: Different VAFs in table vs text question data reliability.
• Missing Disclaimer: Report without medical disclaimer is legally defective.

Key features:
• Seven-parameter consistency check
• Separation into critical errors and warnings
• Logical coherence verification (variant ↔ therapy)
• Report template version control
• Compliance with CAP Molecular Pathology Checklist

Critical parameters:
• Variant Count: Table == Summary
• Actionable-Therapy Link: 100% coverage
• VAF Consistency: Identical across sections
• Mandatory Sections: All present
• Template Version: Match

💡 Usage tips:
1. LIMS Integration: Automatically extract report metadata for verification.
2. Pre-signature Gate: Configure signature blocking upon INCONSISTENT status.
3. Templates: Use parameterized templates to minimize manual entry.
4. Trends: Monitor frequency of inconsistency types for process improvement.
5. Training: Pathologists must understand importance of consistency checks.

⚠️ Note: This utility verifies internal consistency, not clinical correctness. It does not replace molecular pathologist expertise but guarantees structural integrity of the report.

input.csv

ReportID,PatientID,VariantsInTable,VariantsInSummary,ActionableVariantsInTable,TherapiesInRecommendations,AllActionableHaveTherapy,VAF_Consistent,GeneNomenclature_Consistent,HasRequiredDisclaimer,HasMethodologySection,HasLimitationsSection,CrossReferencesValid,ReportVersion,TemplateVersion
RPT-2026-001,PAT-2001,5,5,2,2,true,true,true,true,true,true,true,v4.1,v4.1
RPT-2026-002,PAT-2002,8,7,3,2,false,false,true,true,true,false,false,v4.0,v4.1
RPT-2026-003,PAT-2003,3,3,1,1,true,true,true,true,true,true,true,v4.1,v4.1

URS & FS — User Requirements and Functional Specification

This document describes the controlled interface and behaviour of ClinicalReportConsistencyChecker for Clinical Report Consistency 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.
  • • Structural Completeness: Presence of mandatory sections (disclaimer, methodology, test limitations).
  • ReportID,PatientID,VariantsInTable,VariantsInSummary,ActionableVariantsInTable,TherapiesInRecommendations,AllActionableHaveTherapy,VAF_Consistent,GeneNomenclature_Consistent,HasRequiredDisclaimer,HasMethodologySection,HasLimitationsSection,CrossReferencesValid,ReportVersion,TemplateVersion
  • ⚠️ CRITICAL:
  • • Separation into critical errors and warnings
  • Critical parameters:
  • 5. Training: Pathologists must understand importance of consistency checks.

URS — User Requirements Specification

IDRequirementCriticalityAcceptance criterion
URS-001The utility shall accept an input.csv file for Clinical Report Consistency 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
1ReportIDstring / controlled vocabularyRPT-2026-001Controlled input parameter for deterministic QC rules.
2PatientIDstring / controlled vocabularyPAT-2001Controlled input parameter for deterministic QC rules.
3VariantsInTabledecimal5Controlled input parameter for deterministic QC rules.
4VariantsInSummarydecimal5Controlled input parameter for deterministic QC rules.
5ActionableVariantsInTabledecimal2Controlled input parameter for deterministic QC rules.
6TherapiesInRecommendationsdecimal2Controlled input parameter for deterministic QC rules.
7AllActionableHaveTherapystring / controlled vocabularytrueControlled input parameter for deterministic QC rules.
8VAF_Consistentstring / controlled vocabularytrueControlled input parameter for deterministic QC rules.
9GeneNomenclature_Consistentstring / controlled vocabularytrueControlled input parameter for deterministic QC rules.
10HasRequiredDisclaimerstring / controlled vocabularytrueControlled input parameter for deterministic QC rules.
11HasMethodologySectionstring / controlled vocabularytrueMethod or process approach; controlled reference value.
12HasLimitationsSectionstring / controlled vocabularytrueApproved limit applied during result evaluation.
13CrossReferencesValidstring / controlled vocabularytrueControlled input parameter for deterministic QC rules.
14ReportVersionstring / controlled vocabularyv4.1Controlled input parameter for deterministic QC rules.
15TemplateVersionstring / controlled vocabularyv4.1Temperature profile/MKT; storage, shipping and stability parameter.
ReportID,PatientID,VariantsInTable,VariantsInSummary,ActionableVariantsInTable,TherapiesInRecommendations,AllActionableHaveTherapy,VAF_Consistent,GeneNomenclature_Consistent,HasRequiredDisclaimer,HasMethodologySection,HasLimitationsSection,CrossReferencesValid,ReportVersion,TemplateVersion
RPT-2026-001,PAT-2001,5,5,2,2,true,true,true,true,true,true,true,v4.1,v4.1
RPT-2026-002,PAT-2002,8,7,3,2,false,false,true,true,true,false,false,v4.0,v4.1
RPT-2026-003,PAT-2003,3,3,1,1,true,true,true,true,true,true,true,v4.1,v4.1

Input validation rules

IDFieldRuleCriticality
VR-001ReportIDThe field shall match an approved dictionary or accepted string representation.High
VR-002PatientIDThe field shall match an approved dictionary or accepted string representation.High
VR-003VariantsInTableThe field shall match an approved dictionary or accepted string representation.High
VR-004VariantsInSummaryThe field shall match an approved dictionary or accepted string representation.Medium
VR-005ActionableVariantsInTableThe field shall match an approved dictionary or accepted string representation.Medium
VR-006TherapiesInRecommendationsThe field shall match an approved dictionary or accepted string representation.Medium
VR-007AllActionableHaveTherapyThe field shall match an approved dictionary or accepted string representation.Medium
VR-008VAF_ConsistentThe field shall match an approved dictionary or accepted string representation.Medium
VR-009GeneNomenclature_ConsistentThe field shall match an approved dictionary or accepted string representation.Medium
VR-010HasRequiredDisclaimerThe field shall match an approved dictionary or accepted string representation.Medium
VR-011HasMethodologySectionThe field shall match an approved dictionary or accepted string representation.Medium
VR-012HasLimitationsSectionThe field shall match an approved dictionary or accepted string representation.Medium
VR-013CrossReferencesValidThe field shall match an approved dictionary or accepted string representation.Medium
VR-014ReportVersionThe field shall match an approved dictionary or accepted string representation.Medium
VR-015TemplateVersionThe 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 Clinical Report Consistency 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": "clinicalreportconsistencychecker",
  "utilityFolder": "ClinicalReportConsistencyChecker",
  "package": "LiquidBiopsy",
  "overallStatus": "PASS|WARNING|FAIL",
  "sourceFile": "input.csv",
  "processedAtUtc": "2026-06-10T00:00:00Z",
  "checks": [
    {
      "parameter": "ReportID",
      "value": "RPT-2026-001",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-001"
    },
    {
      "parameter": "PatientID",
      "value": "PAT-2001",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-002"
    },
    {
      "parameter": "VariantsInTable",
      "value": "5",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-003"
    },
    {
      "parameter": "VariantsInSummary",
      "value": "5",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-004"
    },
    {
      "parameter": "ActionableVariantsInTable",
      "value": "2",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-005"
    },
    {
      "parameter": "TherapiesInRecommendations",
      "value": "2",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-006"
    },
    {
      "parameter": "AllActionableHaveTherapy",
      "value": "true",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-007"
    },
    {
      "parameter": "VAF_Consistent",
      "value": "true",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-008"
    },
    {
      "parameter": "GeneNomenclature_Consistent",
      "value": "true",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-009"
    },
    {
      "parameter": "HasRequiredDisclaimer",
      "value": "true",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-010"
    },
    {
      "parameter": "HasMethodologySection",
      "value": "true",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-011"
    },
    {
      "parameter": "HasLimitationsSection",
      "value": "true",
      "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": "ClinicalReportConsistencyChecker.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