URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты TumorNormalWgsInputChecker для сценария Tumor-Normal WGS Input Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- Tumor-Normal WGS Input Checker — Преаналитический QC парных образцов «опухоль–норма» для WGS
- ℹ️ Утилита выполняет проверку входного материала согласно CAP/CLIA §GEN.48800, ISO 15189 §7.3.3, FDA NGS somatic guidance и ICGC/TCGA:
- • Total Yield ≥ Required: Достаточность для библиотеки (обычно ≥1000 нг для PCR-free).
- • Integrity: DIN ≥ 2.5 (fresh frozen) или DV200 ≥ 30% (FFPE).
- • Purity Ratios: A260/A280 1.7–2.1, A260/A230 ≥ 1.8.
- • Total Yield ≥ Required: Обычно ≥1000 нг.
- • DIN ≥ 7.0: Высокая целостность критична для germline calling.
- • Purity Ratios: Те же требования, что и для опухоли.
- • ⚠ Деградированная норма = ложные соматические вызовы из-за артефактов germline filtering.
- • Pathologist Estimated Purity ≥ 20%: Минимум для надёжного соматического вызова.
- • Macrodissection: Рекомендуется при чистоте <40%.
- • Necrosis Estimate: >20% некроза снижает качество ДНК и эффективную чистоту.
- • Bioinformatic Purity: Дополнительная оценка, если доступна.
- • SNP Fingerprint Concordance ≥ 0.95: Подтверждение, что пара от одного пациента.
- • Cross-Contamination ≤ 2%: Оценка по allele balance или SNP-based методам.
- • Input Sufficient: Оба образца ≥ требуемого количества для kit.
- • Freeze-Thaw Cycles ≤ Max: Обычно ≤3 циклов.
- ⚠️ ВАЖНО:
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Tumor-Normal WGS Input 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 | TumorSampleID | string / controlled vocabulary | T-LUNG-042-FFPE | Идентификатор образца или лабораторной пробы. |
| 3 | NormalSampleID | string / controlled vocabulary | N-LUNG-042-Blood | Идентификатор образца или лабораторной пробы. |
| 4 | PrimaryTumorType | string / controlled vocabulary | NSCLC | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | TumorSourceType | string / controlled vocabulary | FFPE | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | NormalSourceType | string / controlled vocabulary | Blood_Buffy_Coat | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | TumorDNA_Concentration_ng_uL | decimal | 45.0 | Отношение компонентов; структурный или рецептурный CQA. |
| 8 | TumorDNA_TotalYield_ng | decimal | 2250 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 9 | MinTumorDNA_Yield_ng | decimal | 1000 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 10 | TumorDNA_DIN_Score | decimal | 3.2 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 11 | MinTumorDNA_DIN | integer / decimal | 2.5 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 12 | TumorDNA_DV200_Percent | decimal | 65 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 13 | MinTumorDNA_DV200_Percent | decimal | 30 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 14 | TumorDNA_A260_A280 | decimal | 1.85 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 15 | TumorDNA_A260_A230 | decimal | 2.1 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 16 | TumorDNA_QC_Passed | string / controlled vocabulary | true | Биологический/молекулярный компонент, контролируемый как CQA. |
| 17 | NormalDNA_Concentration_ng_uL | decimal | 85.0 | Отношение компонентов; структурный или рецептурный CQA. |
| 18 | NormalDNA_TotalYield_ng | decimal | 4250 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 19 | MinNormalDNA_Yield_ng | decimal | 1000 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 20 | NormalDNA_DIN_Score | decimal | 8.5 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 21 | MinNormalDNA_DIN | integer / decimal | 7.0 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 22 | NormalDNA_A260_A280 | decimal | 1.90 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 23 | NormalDNA_A260_A230 | decimal | 2.3 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 24 | NormalDNA_QC_Passed | string / controlled vocabulary | true | Биологический/молекулярный компонент, контролируемый как CQA. |
| 25 | PathologistEstimated_Purity_Percent | decimal | 65 | Чистота/профиль примесей; ключевой QC-параметр. |
| 26 | MinPathologistPurity_Percent | decimal | 20 | Чистота/профиль примесей; ключевой QC-параметр. |
| 27 | BioinformaticPurity_Estimate_Percent | decimal | 58 | Чистота/профиль примесей; ключевой QC-параметр. |
| 28 | MinBioinformaticPurity_Percent | decimal | 20 | Чистота/профиль примесей; ключевой QC-параметр. |
| 29 | PurityAssessment_Available | string / controlled vocabulary | true | Чистота/профиль примесей; ключевой QC-параметр. |
| 30 | Macrodissection_Performed | string / controlled vocabulary | Yes | Контролируемый входной параметр для детерминированных QC-правил. |
| 31 | NecrosisEstimate_Percent | decimal | 5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 32 | SNP_Fingerprint_Performed | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 33 | SNP_Concordance_Score | decimal | 0.998 | Контролируемый входной параметр для детерминированных QC-правил. |
| 34 | MinSNP_Concordance | decimal | 0.95 | Контролируемый входной параметр для детерминированных QC-правил. |
| 35 | GeneticSex_Tumor | string / controlled vocabulary | XY | Контролируемый входной параметр для детерминированных QC-правил. |
| 36 | GeneticSex_Normal | string / controlled vocabulary | XY | Контролируемый входной параметр для детерминированных QC-правил. |
| 37 | SexMatch_Confirmed | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 38 | IdentityVerification_Passed | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 39 | CrossContamination_Estimate_Percent | decimal | 0.3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 40 | MaxCrossContamination_Percent | decimal | 2.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 41 | ContaminationCheck_Passed | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 42 | LibraryPrepKit | string / controlled vocabulary | TruSeq_DNA_PCR_Free | Контролируемый входной параметр для детерминированных QC-правил. |
| 43 | RequiredInputDNA_ng | decimal | 1000 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 44 | TumorInput_Sufficient | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 45 | NormalInput_Sufficient | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 46 | FFPE_Repair_Planned | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 47 | ExtractionMethod | string / controlled vocabulary | QIAamp_FFPE | Метод или технологический подход; контролируемое справочное значение. |
| 48 | SameExtractionProtocol | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 49 | TumorStorage_Condition | string / controlled vocabulary | RT_Block | Контролируемый входной параметр для детерминированных QC-правил. |
| 50 | NormalStorage_Condition | string / controlled vocabulary | -80C | Контролируемый входной параметр для детерминированных QC-правил. |
| 51 | TumorFreezeThawCycles | integer / decimal | 0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 52 | NormalFreezeThawCycles | integer / decimal | 1 | Контролируемый входной параметр для детерминированных QC-правил. |
| 53 | MaxFreezeThawCycles | integer / decimal | 3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 54 | StorageConditions_Appropriate | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 55 | TargetTumorCoverage_X | string / controlled vocabulary | 90 | Контролируемый входной параметр для детерминированных QC-правил. |
| 56 | TargetNormalCoverage_X | string / controlled vocabulary | 30 | Контролируемый входной параметр для детерминированных QC-правил. |
| 57 | PlannedTumorNormal_Ratio | decimal | 3.0 | Отношение компонентов; структурный или рецептурный CQA. |
| 58 | MinAcceptable_TNRatio | decimal | 2.0 | Отношение компонентов; структурный или рецептурный CQA. |
| 59 | MaxAcceptable_TNRatio | decimal | 5.0 | Отношение компонентов; структурный или рецептурный CQA. |
PatientID,TumorSampleID,NormalSampleID,PrimaryTumorType,TumorSourceType,NormalSourceType,TumorDNA_Concentration_ng_uL,TumorDNA_TotalYield_ng,MinTumorDNA_Yield_ng,TumorDNA_DIN_Score,MinTumorDNA_DIN,TumorDNA_DV200_Percent,MinTumorDNA_DV200_Percent,TumorDNA_A260_A280,TumorDNA_A260_A230,TumorDNA_QC_Passed,NormalDNA_Concentration_ng_uL,NormalDNA_TotalYield_ng,MinNormalDNA_Yield_ng,NormalDNA_DIN_Score,MinNormalDNA_DIN,NormalDNA_A260_A280,NormalDNA_A260_A230,NormalDNA_QC_Passed,PathologistEstimated_Purity_Percent,MinPathologistPurity_Percent,BioinformaticPurity_Estimate_Percent,MinBioinformaticPurity_Percent,PurityAssessment_Available,Macrodissection_Performed,NecrosisEstimate_Percent,SNP_Fingerprint_Performed,SNP_Concordance_Score,MinSNP_Concordance,GeneticSex_Tumor,GeneticSex_Normal,SexMatch_Confirmed,IdentityVerification_Passed,CrossContamination_Estimate_Percent,MaxCrossContamination_Percent,ContaminationCheck_Passed,LibraryPrepKit,RequiredInputDNA_ng,TumorInput_Sufficient,NormalInput_Sufficient,FFPE_Repair_Planned,ExtractionMethod,SameExtractionProtocol,TumorStorage_Condition,NormalStorage_Condition,TumorFreezeThawCycles,NormalFreezeThawCycles,MaxFreezeThawCycles,StorageConditions_Appropriate,TargetTumorCoverage_X,TargetNormalCoverage_X,PlannedTumorNormal_Ratio,MinAcceptable_TNRatio,MaxAcceptable_TNRatio
PAT-LUNG-042,T-LUNG-042-FFPE,N-LUNG-042-Blood,NSCLC,FFPE,Blood_Buffy_Coat,45.0,2250,1000,3.2,2.5,65,30,1.85,2.1,true,85.0,4250,1000,8.5,7.0,1.90,2.3,true,65,20,58,20,true,Yes,5,true,0.998,0.95,XY,XY,true,true,0.3,2.0,true,TruSeq_DNA_PCR_Free,1000,true,true,true,QIAamp_FFPE,false,RT_Block,-80C,0,1,3,true,90,30,3.0,2.0,5.0
PAT-CRC-055,T-CRC-055-FFPE,N-CRC-055-Blood,CRC,FFPE,Blood_Buffy_Coat,12.0,600,1000,1.8,2.5,22,30,1.65,1.2,false,75.0,3750,1000,8.2,7.0,1.88,2.2,true,15,20,0,20,true,No,30,true,0.72,0.95,XX,XY,false,false,5.5,2.0,false,TruSeq_DNA_PCR_Free,1000,false,true,true,QIAamp_FFPE,false,RT_Block,-80C,4,1,3,false,90,30,3.0,2.0,5.0
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | PatientID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | TumorSampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | NormalSampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | PrimaryTumorType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | TumorSourceType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | NormalSourceType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | TumorDNA_Concentration_ng_uL | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | TumorDNA_TotalYield_ng | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | MinTumorDNA_Yield_ng | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | TumorDNA_DIN_Score | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | MinTumorDNA_DIN | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | TumorDNA_DV200_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | MinTumorDNA_DV200_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | TumorDNA_A260_A280 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | TumorDNA_A260_A230 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | TumorDNA_QC_Passed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | NormalDNA_Concentration_ng_uL | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | NormalDNA_TotalYield_ng | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | MinNormalDNA_Yield_ng | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | NormalDNA_DIN_Score | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | MinNormalDNA_DIN | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | NormalDNA_A260_A280 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | NormalDNA_A260_A230 | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | NormalDNA_QC_Passed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | PathologistEstimated_Purity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-026 | MinPathologistPurity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-027 | BioinformaticPurity_Estimate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-028 | MinBioinformaticPurity_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-029 | PurityAssessment_Available | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-030 | Macrodissection_Performed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-031 | NecrosisEstimate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-032 | SNP_Fingerprint_Performed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-033 | SNP_Concordance_Score | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-034 | MinSNP_Concordance | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-035 | GeneticSex_Tumor | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-036 | GeneticSex_Normal | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-037 | SexMatch_Confirmed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-038 | IdentityVerification_Passed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-039 | CrossContamination_Estimate_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-040 | MaxCrossContamination_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-041 | ContaminationCheck_Passed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-042 | LibraryPrepKit | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-043 | RequiredInputDNA_ng | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-044 | TumorInput_Sufficient | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-045 | NormalInput_Sufficient | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-046 | FFPE_Repair_Planned | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-047 | ExtractionMethod | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-048 | SameExtractionProtocol | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-049 | TumorStorage_Condition | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-050 | NormalStorage_Condition | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-051 | TumorFreezeThawCycles | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-052 | NormalFreezeThawCycles | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-053 | MaxFreezeThawCycles | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-054 | StorageConditions_Appropriate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-055 | TargetTumorCoverage_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-056 | TargetNormalCoverage_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-057 | PlannedTumorNormal_Ratio | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-058 | MinAcceptable_TNRatio | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-059 | MaxAcceptable_TNRatio | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для Tumor-Normal WGS Input 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": "tumornormalwgsinputchecker",
"utilityFolder": "TumorNormalWgsInputChecker",
"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": "TumorSampleID",
"value": "T-LUNG-042-FFPE",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "NormalSampleID",
"value": "N-LUNG-042-Blood",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "PrimaryTumorType",
"value": "NSCLC",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "TumorSourceType",
"value": "FFPE",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "NormalSourceType",
"value": "Blood_Buffy_Coat",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "TumorDNA_Concentration_ng_uL",
"value": "45.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "TumorDNA_TotalYield_ng",
"value": "2250",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "MinTumorDNA_Yield_ng",
"value": "1000",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "TumorDNA_DIN_Score",
"value": "3.2",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "MinTumorDNA_DIN",
"value": "2.5",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "TumorDNA_DV200_Percent",
"value": "65",
"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": "TumorNormalWgsInputChecker.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 и утверждёнными процедурами.