URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты LungCancerLiquidBiopsyQcChecker для сценария Lung Cancer Liquid Biopsy QC Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • cfDNA Yield: Достаточность материала для панели NSCLC (≥10 нг).
- • Mean Target Depth ≥ 10 000×: Базовый порог для детекции VAF <0.5%.
- • Unique Molecular Depth ≥ 1 000×: Чувствительность после UMI-дедупликации.
- • On-Target Rate ≥ 60%: Эффективность обогащения.
- • Uniformity ≥ 80%: Равномерность покрытия целевых регионов.
- ПОКРЫТИЕ КРИТИЧЕСКИХ ГЕНОВ NCCN (9/9 ОБЯЗАТЕЛЬНЫ):
- ⚠️ ВАЖНО:
- • cfDNA < 10 нг = чувствительность ниже заявленной LOD.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Lung Cancer Liquid Biopsy 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 | SampleID | string / controlled vocabulary | NSCLC-LB-2026-001 | Идентификатор образца или лабораторной пробы. |
| 2 | PatientID | string / controlled vocabulary | PAT-LUNG-042 | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | ClinicalContext | string / controlled vocabulary | Resistance_Detection | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | CfDNA_Yield_ng | decimal | 35.0 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 5 | MinCfDNA_Yield_ng | decimal | 10 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 6 | FragmentSize_Peak_bp | decimal | 167 | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | FragmentProfile_Valid | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | MeanTargetDepth_X | string / controlled vocabulary | 25000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | MinMeanTargetDepth_X | string / controlled vocabulary | 10000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | UniqueMolecularDepth_X | decimal | 4500 | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | MinUniqueMolecularDepth_X | decimal | 1000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | OnTargetRate_Percent | decimal | 85.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | MinOnTargetRate_Percent | decimal | 60 | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | Uniformity_Percent | decimal | 92.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | MinUniformity_Percent | decimal | 80 | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | EGFR_Covered | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | ALK_Covered | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | ROS1_Covered | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | BRAF_Covered | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 20 | MET_Exon14_Covered | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 21 | RET_Covered | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 22 | NTRK_Covered | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 23 | KRAS_G12C_Covered | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 24 | ERBB2_Covered | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 25 | InternalControl_Pass | string / controlled vocabulary | true | Биологический/молекулярный компонент, контролируемый как CQA. |
| 26 | NTC_Pass | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 27 | PositiveControl_Pass | string / controlled vocabulary | true | Контрольная точка/контрольный образец для валидности серии анализа. |
| 28 | DriverMutations_Detected | decimal | 2 | Контролируемый входной параметр для детерминированных QC-правил. |
| 29 | DetectedVariants | string / controlled vocabulary | EGFR:L858R;MET:amplification | Контролируемый входной параметр для детерминированных QC-правил. |
| 30 | ResistanceMechanism_Detected | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 31 | ResistanceVariant | string / controlled vocabulary | MET:amplification | Контролируемый входной параметр для детерминированных QC-правил. |
| 32 | MaxVAF_Detected_Percent | decimal | 3.2 | Контролируемый входной параметр для детерминированных QC-правил. |
| 33 | AssayLOD_Percent | decimal | 0.1 | Контролируемый входной параметр для детерминированных QC-правил. |
| 34 | CurrentTherapy | string / controlled vocabulary | Osimertinib | Контролируемый входной параметр для детерминированных QC-правил. |
| 35 | TherapyMatch_Variant | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
SampleID,PatientID,ClinicalContext,CfDNA_Yield_ng,MinCfDNA_Yield_ng,FragmentSize_Peak_bp,FragmentProfile_Valid,MeanTargetDepth_X,MinMeanTargetDepth_X,UniqueMolecularDepth_X,MinUniqueMolecularDepth_X,OnTargetRate_Percent,MinOnTargetRate_Percent,Uniformity_Percent,MinUniformity_Percent,EGFR_Covered,ALK_Covered,ROS1_Covered,BRAF_Covered,MET_Exon14_Covered,RET_Covered,NTRK_Covered,KRAS_G12C_Covered,ERBB2_Covered,InternalControl_Pass,NTC_Pass,PositiveControl_Pass,DriverMutations_Detected,DetectedVariants,ResistanceMechanism_Detected,ResistanceVariant,MaxVAF_Detected_Percent,AssayLOD_Percent,CurrentTherapy,TherapyMatch_Variant
NSCLC-LB-2026-001,PAT-LUNG-042,Resistance_Detection,35.0,10,167,true,25000,10000,4500,1000,85.0,60,92.0,80,true,true,true,true,true,true,true,true,true,true,true,true,2,EGFR:L858R;MET:amplification,true,MET:amplification,3.2,0.1,Osimertinib,true
NSCLC-LB-2026-002,PAT-LUNG-055,Primary_Diagnosis,5.0,10,165,true,8000,10000,600,1000,55.0,60,72.0,80,true,true,true,true,false,true,true,true,true,true,true,true,0,,false,,0,0.1,,false
NSCLC-LB-2026-003,PAT-LUNG-061,Primary_Diagnosis,22.0,10,168,true,18000,10000,3200,1000,78.0,60,88.0,80,true,true,true,true,true,true,true,true,true,true,true,true,0,,false,,0,0.1,,false
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | SampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | PatientID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | ClinicalContext | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | CfDNA_Yield_ng | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | MinCfDNA_Yield_ng | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | FragmentSize_Peak_bp | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | FragmentProfile_Valid | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | MeanTargetDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | MinMeanTargetDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | UniqueMolecularDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | MinUniqueMolecularDepth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | OnTargetRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | MinOnTargetRate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | Uniformity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | MinUniformity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | EGFR_Covered | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | ALK_Covered | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | ROS1_Covered | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | BRAF_Covered | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | MET_Exon14_Covered | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | RET_Covered | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | NTRK_Covered | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | KRAS_G12C_Covered | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | ERBB2_Covered | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | InternalControl_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-026 | NTC_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-027 | PositiveControl_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-028 | DriverMutations_Detected | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-029 | DetectedVariants | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-030 | ResistanceMechanism_Detected | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-031 | ResistanceVariant | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-032 | MaxVAF_Detected_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-033 | AssayLOD_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-034 | CurrentTherapy | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-035 | TherapyMatch_Variant | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для Lung Cancer Liquid Biopsy 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": "lungcancerliquidbiopsyqcchecker",
"utilityFolder": "LungCancerLiquidBiopsyQcChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "SampleID",
"value": "NSCLC-LB-2026-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "PatientID",
"value": "PAT-LUNG-042",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "ClinicalContext",
"value": "Resistance_Detection",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "CfDNA_Yield_ng",
"value": "35.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "MinCfDNA_Yield_ng",
"value": "10",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "FragmentSize_Peak_bp",
"value": "167",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "FragmentProfile_Valid",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "MeanTargetDepth_X",
"value": "25000",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "MinMeanTargetDepth_X",
"value": "10000",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "UniqueMolecularDepth_X",
"value": "4500",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "MinUniqueMolecularDepth_X",
"value": "1000",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "OnTargetRate_Percent",
"value": "85.0",
"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": "LungCancerLiquidBiopsyQcChecker.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 и утверждёнными процедурами.