URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты MrdPersonalizedPanelQcChecker для сценария MRD Personalized Panel QC Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • Germline Variants = 0: КРИТИЧЕСКИЙ параметр. Любой герминальный вариант = ложноположительный MRD.
- • Clonal Fraction ≥ 50%: Панель должна быть обогащена клональными (доминантными) вариантами.
- • Panel LOD ≤ 0.01% VAF: Чувствительность для конкретной конфигурации панели.
- • Mean Amplicon Depth ≥ 5000×: Достаточная глубина для детекции редких аллелей.
- • Amplicon Uniformity ≥ 80%: Равномерность покрытия всех мишеней.
- • Background Noise ≤ 0.001% VAF: Фоновый шум не должен превышать целевой LOD.
- ⚠️ ВАЖНО:
- 1. Matched Normal: ВСЕГДА используйте парную нормаль для фильтрации герминальных вариантов.
- 2. Clonal Selection: Приоритизируйте варианты с VAF >10% в опухоли (клональные драйверы).
- 3. Panel Redesign: При >2 failed amplicons пересоздайте панель с альтернативными праймерами.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для MRD Personalized Panel QC Checker с заголовками, определёнными в контракте данных. | High | Файл обрабатывается без ручного изменения заголовков. |
| URS-002 | Утилита должна выполнять детерминированную оценку QC/ОКК без машинного обучения и без вероятностного принятия решения о соответствии. | High | При одинаковых входных данных, версии правил и конфигурации результат полностью воспроизводим. |
| URS-003 | Утилита должна валидировать обязательные поля, типы данных, диапазоны, единицы измерения и предметную правдоподобность значений. | High | Ошибки схемы, преобразования и диапазона явно отражаются в результате. |
| URS-004 | Утилита должна применять предметные пределы и правила из описания, утверждённой спецификации, регистрационного досье и локальных SOP. | High | Каждая проверка имеет результат PASS/WARNING/FAIL и понятное сообщение. |
| URS-005 | Утилита должна формировать output.json с машинно-читаемыми результатами, исходными значениями, предупреждениями, отказами и критическими находками. | High | JSON пригоден для LIMS/ELN/MES-интеграции и QA/QC review. |
| URS-006 | Утилита должна сохранять трассируемость между серией/образцом, входным файлом, применёнными правилами и итоговым статусом. | High | Выход содержит идентификаторы, список параметров и audit metadata. |
| URS-007 | Документация должна поддерживать подготовку IQ/OQ/PQ, CSV/CSA и обсуждение с инспекторами или внутренним QA. | Medium | URS, FS, контракт input/output и тестовые сценарии поставляются вместе с утилитой. |
| URS-008 | Утилита должна использоваться как decision-support инструмент QC, а не как замена утверждённым спецификациям и выпускному решению Qualified Person/QA. | Medium | В документации указан контроль change control и необходимость сверки пределов. |
Контракт input.csv
| # | Поле | Тип | Пример | Назначение |
|---|
| 1 | PatientID | string / controlled vocabulary | PAT-LUNG-042 | Контролируемый входной параметр для детерминированных QC-правил. |
| 2 | PanelID | string / controlled vocabulary | MRD-PNL-042-v1 | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | TumorSequencingID | string / controlled vocabulary | WES-LUNG-042 | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | VariantsInPanel | decimal | 32 | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | MinVariantsInPanel | decimal | 16 | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | MaxVariantsInPanel | decimal | 48 | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | VariantsMatchedToTumor | decimal | 32 | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | GermlineVariantsInPanel | decimal | 0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | ClonalVariants_Count | integer / decimal | 24 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 10 | SubclonalVariants_Count | integer / decimal | 8 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 11 | MinClonalFraction_InPanel | decimal | 0.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | PanelLOD_Percent | decimal | 0.003 | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | MaxAcceptableLOD_Percent | decimal | 0.01 | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | MeanAmpliconDepth_X | decimal | 15000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | MinMeanAmpliconDepth_X | decimal | 5000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | AmpliconUniformity_Percent | decimal | 92.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | MinAmpliconUniformity_Percent | decimal | 80 | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | FailedAmplicons_Count | integer / decimal | 0 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 19 | TotalAmplicons_Count | integer / decimal | 32 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 20 | OffTargetAmplification_Detected | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 21 | PrimerDimer_Detected | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 22 | BackgroundNoise_VAF | decimal | 0.0002 | Контролируемый входной параметр для детерминированных QC-правил. |
| 23 | MaxBackgroundNoise_VAF | decimal | 0.001 | Контролируемый входной параметр для детерминированных QC-правил. |
| 24 | PositiveControl_Pass | string / controlled vocabulary | true | Контрольная точка/контрольный образец для валидности серии анализа. |
| 25 | NegativeControl_Pass | string / controlled vocabulary | true | Контрольная точка/контрольный образец для валидности серии анализа. |
| 26 | NoTemplateControl_Pass | string / controlled vocabulary | true | Температурный профиль/MKT; параметр хранения, перевозки и стабильности. |
| 27 | MatchedNormal_Available | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 28 | SomaticOrigin_Confirmed | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 29 | TumorVAF_Mean_InPanel | decimal | 18.5 | Контролируемый входной параметр для детерминированных QC-правил. |
PatientID,PanelID,TumorSequencingID,VariantsInPanel,MinVariantsInPanel,MaxVariantsInPanel,VariantsMatchedToTumor,GermlineVariantsInPanel,ClonalVariants_Count,SubclonalVariants_Count,MinClonalFraction_InPanel,PanelLOD_Percent,MaxAcceptableLOD_Percent,MeanAmpliconDepth_X,MinMeanAmpliconDepth_X,AmpliconUniformity_Percent,MinAmpliconUniformity_Percent,FailedAmplicons_Count,TotalAmplicons_Count,OffTargetAmplification_Detected,PrimerDimer_Detected,BackgroundNoise_VAF,MaxBackgroundNoise_VAF,PositiveControl_Pass,NegativeControl_Pass,NoTemplateControl_Pass,MatchedNormal_Available,SomaticOrigin_Confirmed,TumorVAF_Mean_InPanel
PAT-LUNG-042,MRD-PNL-042-v1,WES-LUNG-042,32,16,48,32,0,24,8,0.5,0.003,0.01,15000,5000,92.0,80,0,32,false,false,0.0002,0.001,true,true,true,true,true,18.5
PAT-CRC-018,MRD-PNL-018-v1,WES-CRC-018,20,16,48,18,3,5,15,0.5,0.015,0.01,3200,5000,65.0,80,4,20,true,true,0.002,0.001,true,true,true,false,false,6.2
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | PatientID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | PanelID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | TumorSequencingID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | VariantsInPanel | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | MinVariantsInPanel | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | MaxVariantsInPanel | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | VariantsMatchedToTumor | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | GermlineVariantsInPanel | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | ClonalVariants_Count | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | SubclonalVariants_Count | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | MinClonalFraction_InPanel | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | PanelLOD_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | MaxAcceptableLOD_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | MeanAmpliconDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | MinMeanAmpliconDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | AmpliconUniformity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | MinAmpliconUniformity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | FailedAmplicons_Count | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | TotalAmplicons_Count | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | OffTargetAmplification_Detected | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | PrimerDimer_Detected | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | BackgroundNoise_VAF | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | MaxBackgroundNoise_VAF | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | PositiveControl_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | NegativeControl_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-026 | NoTemplateControl_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-027 | MatchedNormal_Available | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-028 | SomaticOrigin_Confirmed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-029 | TumorVAF_Mean_InPanel | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
FS — функциональная спецификация
| ID | Функция | Реализация |
|---|
| FS-001 | CLI execution | Поддержать режимы запуска: demo mode без аргументов и production mode input.csv output.json. |
| FS-002 | CSV import | Прочитать input.csv в UTF-8/CSV-совместимом формате, проверить наличие заголовка и ожидаемых колонок. |
| FS-003 | Schema validation | Проверить обязательные поля, количество колонок, неизвестные ключевые поля и пустые обязательные значения. |
| FS-004 | Type conversion | Преобразовать числовые, флаговые и текстовые значения; некорректный формат фиксировать как ошибку строки. |
| FS-005 | Domain rule engine | Применить правила для MRD Personalized Panel QC Checker, включая критические пределы из описания и утверждённой спецификации. |
| FS-006 | Status aggregation | Сформировать итоговый статус: FAIL при критическом отказе, WARNING при некритическом отклонении, PASS при соответствии. |
| FS-007 | JSON export | Записать output.json с детализацией проверок, исходными значениями, предупреждениями, отказами и critical findings. |
| FS-008 | Audit support | Сохранять структуру результата пригодной для review, расследования отклонений и воспроизведения расчёта. |
| FS-009 | Integration contract | Поддержать сценарий LIMS/ELN/MES → input.csv → utility → output.json → portal/admin review. |
| FS-010 | Error handling | Возвращать явные сообщения для отсутствующего файла, пустого CSV, неверной схемы, ошибки записи output.json и некорректного формата. |
Пример output.json
{
"utilityId": "mrdpersonalizedpanelqcchecker",
"utilityFolder": "MrdPersonalizedPanelQcChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "PatientID",
"value": "PAT-LUNG-042",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "PanelID",
"value": "MRD-PNL-042-v1",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "TumorSequencingID",
"value": "WES-LUNG-042",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "VariantsInPanel",
"value": "32",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "MinVariantsInPanel",
"value": "16",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "MaxVariantsInPanel",
"value": "48",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "VariantsMatchedToTumor",
"value": "32",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "GermlineVariantsInPanel",
"value": "0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "ClonalVariants_Count",
"value": "24",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "SubclonalVariants_Count",
"value": "8",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "MinClonalFraction_InPanel",
"value": "0.5",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "PanelLOD_Percent",
"value": "0.003",
"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": "MrdPersonalizedPanelQcChecker.documentation.html"
}
}
Матрица трассируемости
| URS | FS | Тест | Подтверждение |
|---|
| URS-001 | FS-001, FS-002 | OQ-001 | Проверить запуск и импорт валидного input.csv. |
| URS-002 | FS-005, FS-006 | OQ-004 | Повторить один и тот же набор данных и сравнить output.json. |
| URS-003 | FS-003, FS-004, FS-010 | OQ-002, OQ-003 | Проверить отсутствующие колонки и неверные типы. |
| URS-004 | FS-005, FS-006 | OQ-004, PQ-001 | Проверить критические отклонения по реальным/граничным данным. |
| URS-005 | FS-007, FS-009 | OQ-005 | Проверить JSON schema и пригодность для downstream-систем. |
| URS-006 | FS-008 | OQ-006 | Проверить наличие идентификаторов и audit metadata. |
| URS-007 | FS-008, FS-010 | IQ-001, OQ-007 | Проверить комплектность документации и control evidence. |
| URS-008 | FS-005, FS-008 | PQ-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 и утверждёнными процедурами.