ReportabilityRulesJsonBuilder

Reportability Rules JSON Builder

Liquid Biopsy жидкостная биопсия cfDNA ctDNA CTC exosomes NGS qPCR
Открыть подборку

Описание утилиты: Reportability Rules JSON Builder

Reportability Rules JSON Builder — Генерация и валидация JSON-конфигураций правил репортабельности

ℹ️  Утилита обеспечивает машиночитаемое представление правил репортабельности согласно AMP/ASCO/CAP Tiering v2, ACMG/AMP 2015 + SVI, HL7 FHIR Genomics Reporting и CAP/CLIA §GEN.48800:

     СТРУКТУРА КОНФИГУРАЦИИ:
     • Schema Version: Поддерживаемые версии схемы (2.0.0, 2.1.0, 2.2.0).
     • Ruleset Metadata: ID, name, effective date, supersedes version, approver.
     • Applicable Contexts: Клинические контексты, к которым применяется набор правил.

     ГЛОБАЛЬНЫЕ ПОРОГИ:
     • Min VAF (somatic/germline): Минимальная частота аллеля для репортабельности.
     • Min Depth: Минимальная глубина покрытия.
     • Max gnomAD AF: Максимальная популяционная частота для соматических/герминальных вариантов.
     • Min Quality Score: Минимальный балл качества вызова.

     ПРАВИЛА ВКЛЮЧЕНИЯ (INCLUSION):
     • Условная логика: AND/OR комбинации условий.
     • Поля: classification, tier, therapeutic_association, diagnostic_significance, prognostic_significance.
     • Приоритеты: Разрешение конфликтов между правилами.
     • Ссылки на стандарты: ACMG criteria codes, AMP Tier levels.

     ПРАВИЛА ИСКЛЮЧЕНИЯ (EXCLUSION):
     • Benign/Likely Benign классификация.
     • Высокая популяционная частота (gnomAD AF > threshold).
     • Технические флаги (low quality, strand bias, insufficient depth).
     • Отсутствие согласия на вторичные находки.

     УСЛОВНЫЕ ПРАВИЛА (CONDITIONAL):
     • IF-THEN-ELSE логика для контекстно-зависимых решений.
     • Пример: IF germline AND pathogenic AND consent_SF=true THEN include ELSE exclude.

     TIER MAPPING (AMP/ASCO/CAP):
     • Tier I (Level A/B): Strong clinical significance.
     • Tier II (Level C/D): Potential clinical significance.
     • Tier III: Unknown significance.
     • Tier IV: Benign/Likely benign.
     • ⚠ Все 4 уровня должны быть определены.

     ПОЛИТИКА ВТОРИЧНЫХ НАХОДОК:
     • ACMG SF List Version: Версия списка генов вторичных находок.
     • Explicit Consent Required: Требование явного согласия пациента.
     • Report Only P/LP: Репортаж только патогенных/вероятно патогенных.
     • Opt-Out Respected: Уважение отказа пациента от вторичных находок.

⚠️  ВАЖНО:
     • Текстовые SOP ≠ программная реализация. Только JSON-конфигурация гарантирует однозначность.
     • Противоречивые правила без приоритетов = НЕПРЕДСКАЗУЕМОЕ ПОВЕДЕНИЕ при деплое.
     • Отсутствие tier mapping делает невозможной корректную классификацию соматических вариантов.
     • Политика вторичных находок ОБЯЗАТЕЛЬНА; отсутствие = регуляторное нарушение.
     • Каждая версия конфигурации должна иметь уникальную версию и ссылку на предыдущую.
     • Approval chain должен быть задокументирован; неутвержденная конфигурация не может быть задеплоена.
     • Конфигурация должна быть обратно совместима или явно помечена как breaking change.

Использование:
  ReportabilityRulesJsonBuilder.exe                            → демо-режим (вывод в консоль)
  ReportabilityRulesJsonBuilder.exe input.csv output.json      → оценка ваших данных

📍 Область применения:
     • Биоинформатические пайплайны: Машиночитаемые правила для автоматической фильтрации вариантов.
     • LIMS/LIS интеграция: Единый источник правды для правил репортабельности.
     • Аккредитация CAP/ISO: Документирование стандартизированных критериев репортажа.
     • Change Control: Версионирование и аудит изменений правил.
     • Мультицентровые сети: Единообразие правил между лабораториями.

💡 Советы:
1. Schema Evolution: Используйте semantic versioning; minor = backward compatible, major = breaking.
2. Testing Framework: Создайте тестовые наборы вариантов для регрессионного тестирования каждой версии.
3. Human-Readable Export: Генерируйте PDF/HTML документацию из JSON для утверждения комитетом.
4. Override Mechanism: Предусмотрите механизм ручного override с обязательным обоснованием.
5. Audit Logging: Логируйте каждое применение правил с указанием версии конфигурации.

⚠️ Примечание: Утилита валидирует СТРУКТУРУ И СОГЛАСОВАННОСТЬ JSON-конфигурации. Она не проверяет клиническую корректность самих правил. Корректность правил определяется молекулярным патологом и утверждается комитетом. Утилита гарантирует, что утвержденные правила представлены в машиночитаемом, непротиворечивом формате.

input.csv

RulesetId,RulesetName,SchemaVersion,EffectiveDate,SupersedesVersion,ApprovedBy,ApplicableContexts,InclusionRuleCount,ExclusionRuleCount,ConditionalRuleCount,JsonSyntaxValid,HasGlobalThresholds,HasTierMapping,HasSecondaryFindingsPolicy,AllRequiredFieldsPresent,NoContradictoryRules,VersionHistoryConsistent
RULES-NSCLC-CGP-v3.2,NSCLC CGP Reportability Rules,2.1.0,2026-06-01,RULES-NSCLC-CGP-v3.1,Molecular Pathology Committee,Somatic_NSCLC;Somatic_SolidTumor,12,8,5,true,true,true,true,true,true,true
RULES-HEME-PANEL-v1.0-draft,Heme Panel Reportability Rules DRAFT,2.1.0,2026-07-01,,,"Somatic_Hematologic",6,3,0,true,true,false,false,false,false,false

URS & FS — спецификация пользователя и функциональная спецификация

Документ описывает контролируемый интерфейс и поведение утилиты ReportabilityRulesJsonBuilder для сценария Reportability Rules JSON Builder.

Предметные ограничения и критические параметры

Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
  • • Высокая популяционная частота (gnomAD AF > threshold).
  • • ⚠ Все 4 уровня должны быть определены.
  • ⚠️ ВАЖНО:
  • • Аккредитация CAP/ISO: Документирование стандартизированных критериев репортажа.
  • ⚠️ Примечание: Утилита валидирует СТРУКТУРУ И СОГЛАСОВАННОСТЬ JSON-конфигурации. Она не проверяет клиническую корректность самих правил. Корректность правил определяется молекулярным патологом и утверждается комитетом. Утилита гарантирует, что утвержденные правила представлены в машиночитаемом, непротиворечивом формате.

URS — пользовательские требования

IDТребованиеКритичностьКритерий приемки
URS-001Утилита должна принимать файл input.csv для Reportability Rules JSON Builder с заголовками, определёнными в контракте данных.HighФайл обрабатывается без ручного изменения заголовков.
URS-002Утилита должна выполнять детерминированную оценку QC/ОКК без машинного обучения и без вероятностного принятия решения о соответствии.HighПри одинаковых входных данных, версии правил и конфигурации результат полностью воспроизводим.
URS-003Утилита должна валидировать обязательные поля, типы данных, диапазоны, единицы измерения и предметную правдоподобность значений.HighОшибки схемы, преобразования и диапазона явно отражаются в результате.
URS-004Утилита должна применять предметные пределы и правила из описания, утверждённой спецификации, регистрационного досье и локальных SOP.HighКаждая проверка имеет результат PASS/WARNING/FAIL и понятное сообщение.
URS-005Утилита должна формировать output.json с машинно-читаемыми результатами, исходными значениями, предупреждениями, отказами и критическими находками.HighJSON пригоден для LIMS/ELN/MES-интеграции и QA/QC review.
URS-006Утилита должна сохранять трассируемость между серией/образцом, входным файлом, применёнными правилами и итоговым статусом.HighВыход содержит идентификаторы, список параметров и audit metadata.
URS-007Документация должна поддерживать подготовку IQ/OQ/PQ, CSV/CSA и обсуждение с инспекторами или внутренним QA.MediumURS, FS, контракт input/output и тестовые сценарии поставляются вместе с утилитой.
URS-008Утилита должна использоваться как decision-support инструмент QC, а не как замена утверждённым спецификациям и выпускному решению Qualified Person/QA.MediumВ документации указан контроль change control и необходимость сверки пределов.

Контракт input.csv

#ПолеТипПримерНазначение
1RulesetIdstring / controlled vocabularyRULES-NSCLC-CGP-v3.2Контролируемый входной параметр для детерминированных QC-правил.
2RulesetNamestring / controlled vocabularyNSCLC CGP Reportability RulesКонтролируемый входной параметр для детерминированных QC-правил.
3SchemaVersionstring / controlled vocabulary2.1.0Контролируемый входной параметр для детерминированных QC-правил.
4EffectiveDatestring / controlled vocabulary2026-06-01Контролируемый входной параметр для детерминированных QC-правил.
5SupersedesVersionstring / controlled vocabularyRULES-NSCLC-CGP-v3.1Контролируемый входной параметр для детерминированных QC-правил.
6ApprovedBystring / controlled vocabularyMolecular Pathology CommitteeКонтролируемый входной параметр для детерминированных QC-правил.
7ApplicableContextsstring / controlled vocabularySomatic_NSCLC;Somatic_SolidTumorКонтролируемый входной параметр для детерминированных QC-правил.
8InclusionRuleCountinteger / decimal12Счётный показатель; используется для микробиологического, частичного или клеточного контроля.
9ExclusionRuleCountinteger / decimal8Счётный показатель; используется для микробиологического, частичного или клеточного контроля.
10ConditionalRuleCountinteger / decimal5Счётный показатель; используется для микробиологического, частичного или клеточного контроля.
11JsonSyntaxValidstring / controlled vocabularytrueКонтролируемый входной параметр для детерминированных QC-правил.
12HasGlobalThresholdsstring / controlled vocabularytrueКонтролируемый входной параметр для детерминированных QC-правил.
13HasTierMappingstring / controlled vocabularytrueКонтролируемый входной параметр для детерминированных QC-правил.
14HasSecondaryFindingsPolicystring / controlled vocabularytrueКонтролируемый входной параметр для детерминированных QC-правил.
15AllRequiredFieldsPresentstring / controlled vocabularytrueКонтролируемый входной параметр для детерминированных QC-правил.
16NoContradictoryRulesstring / controlled vocabularytrueКонтролируемый входной параметр для детерминированных QC-правил.
17VersionHistoryConsistentstring / controlled vocabularytrueКонтролируемый входной параметр для детерминированных QC-правил.
RulesetId,RulesetName,SchemaVersion,EffectiveDate,SupersedesVersion,ApprovedBy,ApplicableContexts,InclusionRuleCount,ExclusionRuleCount,ConditionalRuleCount,JsonSyntaxValid,HasGlobalThresholds,HasTierMapping,HasSecondaryFindingsPolicy,AllRequiredFieldsPresent,NoContradictoryRules,VersionHistoryConsistent
RULES-NSCLC-CGP-v3.2,NSCLC CGP Reportability Rules,2.1.0,2026-06-01,RULES-NSCLC-CGP-v3.1,Molecular Pathology Committee,Somatic_NSCLC;Somatic_SolidTumor,12,8,5,true,true,true,true,true,true,true
RULES-HEME-PANEL-v1.0-draft,Heme Panel Reportability Rules DRAFT,2.1.0,2026-07-01,,,Somatic_Hematologic,6,3,0,true,true,false,false,false,false,false

Правила валидации входных данных

IDПолеПравилоКритичность
VR-001RulesetIdПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.High
VR-002RulesetNameПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.High
VR-003SchemaVersionПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.High
VR-004EffectiveDateПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.Medium
VR-005SupersedesVersionПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.Medium
VR-006ApprovedByПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.Medium
VR-007ApplicableContextsПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.Medium
VR-008InclusionRuleCountПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.Medium
VR-009ExclusionRuleCountПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.Medium
VR-010ConditionalRuleCountПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.Medium
VR-011JsonSyntaxValidПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.Medium
VR-012HasGlobalThresholdsПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.Medium
VR-013HasTierMappingПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.Medium
VR-014HasSecondaryFindingsPolicyПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.Medium
VR-015AllRequiredFieldsPresentПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.Medium
VR-016NoContradictoryRulesПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.Medium
VR-017VersionHistoryConsistentПоле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме.Medium

FS — функциональная спецификация

IDФункцияРеализация
FS-001CLI executionПоддержать режимы запуска: demo mode без аргументов и production mode input.csv output.json.
FS-002CSV importПрочитать input.csv в UTF-8/CSV-совместимом формате, проверить наличие заголовка и ожидаемых колонок.
FS-003Schema validationПроверить обязательные поля, количество колонок, неизвестные ключевые поля и пустые обязательные значения.
FS-004Type conversionПреобразовать числовые, флаговые и текстовые значения; некорректный формат фиксировать как ошибку строки.
FS-005Domain rule engineПрименить правила для Reportability Rules JSON Builder, включая критические пределы из описания и утверждённой спецификации.
FS-006Status aggregationСформировать итоговый статус: FAIL при критическом отказе, WARNING при некритическом отклонении, PASS при соответствии.
FS-007JSON exportЗаписать output.json с детализацией проверок, исходными значениями, предупреждениями, отказами и critical findings.
FS-008Audit supportСохранять структуру результата пригодной для review, расследования отклонений и воспроизведения расчёта.
FS-009Integration contractПоддержать сценарий LIMS/ELN/MES → input.csv → utility → output.json → portal/admin review.
FS-010Error handlingВозвращать явные сообщения для отсутствующего файла, пустого CSV, неверной схемы, ошибки записи output.json и некорректного формата.

Пример output.json

{
  "utilityId": "reportabilityrulesjsonbuilder",
  "utilityFolder": "ReportabilityRulesJsonBuilder",
  "package": "LiquidBiopsy",
  "overallStatus": "PASS|WARNING|FAIL",
  "sourceFile": "input.csv",
  "processedAtUtc": "2026-06-10T00:00:00Z",
  "checks": [
    {
      "parameter": "RulesetId",
      "value": "RULES-NSCLC-CGP-v3.2",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-001"
    },
    {
      "parameter": "RulesetName",
      "value": "NSCLC CGP Reportability Rules",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-002"
    },
    {
      "parameter": "SchemaVersion",
      "value": "2.1.0",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-003"
    },
    {
      "parameter": "EffectiveDate",
      "value": "2026-06-01",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-004"
    },
    {
      "parameter": "SupersedesVersion",
      "value": "RULES-NSCLC-CGP-v3.1",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-005"
    },
    {
      "parameter": "ApprovedBy",
      "value": "Molecular Pathology Committee",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-006"
    },
    {
      "parameter": "ApplicableContexts",
      "value": "Somatic_NSCLC;Somatic_SolidTumor",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-007"
    },
    {
      "parameter": "InclusionRuleCount",
      "value": "12",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-008"
    },
    {
      "parameter": "ExclusionRuleCount",
      "value": "8",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-009"
    },
    {
      "parameter": "ConditionalRuleCount",
      "value": "5",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-010"
    },
    {
      "parameter": "JsonSyntaxValid",
      "value": "true",
      "status": "PASS|WARNING|FAIL",
      "message": "Deterministic rule-based check result",
      "ruleReference": "FS-RULE-011"
    },
    {
      "parameter": "HasGlobalThresholds",
      "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": "ReportabilityRulesJsonBuilder.documentation.html"
  }
}

Матрица трассируемости

URSFSТестПодтверждение
URS-001FS-001, FS-002OQ-001Проверить запуск и импорт валидного input.csv.
URS-002FS-005, FS-006OQ-004Повторить один и тот же набор данных и сравнить output.json.
URS-003FS-003, FS-004, FS-010OQ-002, OQ-003Проверить отсутствующие колонки и неверные типы.
URS-004FS-005, FS-006OQ-004, PQ-001Проверить критические отклонения по реальным/граничным данным.
URS-005FS-007, FS-009OQ-005Проверить JSON schema и пригодность для downstream-систем.
URS-006FS-008OQ-006Проверить наличие идентификаторов и audit metadata.
URS-007FS-008, FS-010IQ-001, OQ-007Проверить комплектность документации и control evidence.
URS-008FS-005, FS-008PQ-002Проверить review workflow и запрет автоматической замены QA-решения.

IQ/OQ/PQ тестовые сценарии

IDСценарийОжидаемый результат
IQ-001Проверить наличие executable, input.csv, документации и контрольной суммы.Комплект поставки полон; версия зафиксирована.
OQ-001Валидная строка из примера input.csv.PASS или допустимый WARNING согласно правилам.
OQ-002Удалить обязательную колонку из CSV.Ошибка схемы или FAIL с указанием отсутствующей колонки.
OQ-003Внести нечисловое значение в числовое поле.Ошибка преобразования типа с указанием строки/поля.
OQ-004Значение критического параметра вывести за предел.FAIL и critical finding.
OQ-005Проверить структуру output.json.Все обязательные секции присутствуют, JSON валиден.
OQ-006Проверить трассируемость серии/образца.Идентификаторы входа и результатов совпадают.
PQ-001Проверить 3–5 реальных партий/образцов пользователя.Результат подтверждён QC/QA review.
PQ-002Проверить workflow отклонения и ручного QA-решения.Утилита поддерживает review, но не заменяет утверждённое решение.

QA/QC и change control

  • Не менять имена колонок без обновления валидатора, документации и тестового набора.
  • Хранить input.csv, output.json, версию исполняемого файла и контрольную сумму.
  • Перед продуктивным использованием провести IQ/OQ/PQ или эквивалентную CSV/CSA-проверку.
  • Критические пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
  • Утилита предоставляет формализованный QC decision support, но окончательное решение выпуска остаётся за QA/QP и утверждёнными процедурами.

Входит в пакеты

Жидкостная биопсия

Пакет для QC и преданалитического контроля жидкостной биопсии: cfDNA/ctDNA, CTC, EV/exosomes, метилирование, NGS/qPCR/ddPCR, контроль образцов, контаминации, чувствительности и отчётности.

Открыть