URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты ResistanceMutationReportabilityChecker для сценария Resistance Mutation Reportability Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • Above LOD: Вариант должен быть выше предела обнаружения ассая.
- • Supporting Reads ≥ 3: Минимальная поддержка прочтениями.
- • UMI Confirmed: Для low-VAF (<1%) подтверждение уникальными молекулами.
- • Evidence Level: FDA Label > Guideline > Clinical Trial > Preclinical > Case Report.
- • Standardized Drug Names: INN/generic per WHO.
- ⚠️ ВАЖНО:
- • Аккредитация CAP/ISO: Документирование процесса интерпретации резистентности.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Resistance Mutation Reportability 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 | RES-2026-001 | Идентификатор образца или лабораторной пробы. |
| 2 | PatientID | string / controlled vocabulary | PAT-LUNG-042 | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | PrimaryTumorType | string / controlled vocabulary | NSCLC | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | DetectedVariant | string / controlled vocabulary | EGFR:c.2369C>T (p.T790M) | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | Gene | string / controlled vocabulary | EGFR | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | VariantType | string / controlled vocabulary | SNV | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | AssociatedDrug | string / controlled vocabulary | Osimertinib | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | ResistanceMechanism | string / controlled vocabulary | On_Target_Gatekeeper | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | ResistanceType | string / controlled vocabulary | Acquired | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | EvidenceLevel | string / controlled vocabulary | FDA_Label | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | KnowledgeBase_Source | string / controlled vocabulary | OncoKB | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | VariantInKnowledgeBase | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | KnowledgeBase_ResistanceRating | string / controlled vocabulary | Resistant | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | CurrentTherapy | string / controlled vocabulary | Osimertinib | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | PriorTherapies | string / controlled vocabulary | Erlotinib;Chemotherapy | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | PatientCurrentlyOnAssociatedDrug | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | PatientPreviouslyOnAssociatedDrug | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | LineOfTherapy | string / controlled vocabulary | Second_Line | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | AlternativeTherapy_Available | string / controlled vocabulary | true | Биологический/молекулярный компонент, контролируемый как CQA. |
| 20 | AlternativeTherapy_Names | string / controlled vocabulary | Amivantamab+Lazertinib;Chemotherapy;Clinical_Trial | Биологический/молекулярный компонент, контролируемый как CQA. |
| 21 | CrossResistance_ToAlternatives | string / controlled vocabulary | false | Биологический/молекулярный компонент, контролируемый как CQA. |
| 22 | CrossResistantDrugs | string / controlled vocabulary | | Контролируемый входной параметр для детерминированных QC-правил. |
| 23 | VAF_Percent | decimal | 12.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 24 | AssayLOD_Percent | decimal | 0.1 | Контролируемый входной параметр для детерминированных QC-правил. |
| 25 | AboveLOD | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 26 | SupportingReads | decimal | 850 | Контролируемый входной параметр для детерминированных QC-правил. |
| 27 | MinSupportingReads | decimal | 3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 28 | UMI_Confirmed | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 29 | StrandBias_Detected | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 30 | ArtifactFlag_Raised | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 31 | ProposedTier | string / controlled vocabulary | Tier_I_Level_A | Контролируемый входной параметр для детерминированных QC-правил. |
| 32 | TierAssignment_Valid | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 33 | InterpretationText_Complete | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 34 | DrugName_Standardized | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 35 | MechanismDescribed_InReport | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 36 | ClinicalTrialOptions_Listed | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 37 | NovelResistanceVariant | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 38 | ConflictingEvidence | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 39 | ComplexResistance_Pattern | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 40 | RequiresMDT_Discussion | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
SampleID,PatientID,PrimaryTumorType,DetectedVariant,Gene,VariantType,AssociatedDrug,ResistanceMechanism,ResistanceType,EvidenceLevel,KnowledgeBase_Source,VariantInKnowledgeBase,KnowledgeBase_ResistanceRating,CurrentTherapy,PriorTherapies,PatientCurrentlyOnAssociatedDrug,PatientPreviouslyOnAssociatedDrug,LineOfTherapy,AlternativeTherapy_Available,AlternativeTherapy_Names,CrossResistance_ToAlternatives,CrossResistantDrugs,VAF_Percent,AssayLOD_Percent,AboveLOD,SupportingReads,MinSupportingReads,UMI_Confirmed,StrandBias_Detected,ArtifactFlag_Raised,ProposedTier,TierAssignment_Valid,InterpretationText_Complete,DrugName_Standardized,MechanismDescribed_InReport,ClinicalTrialOptions_Listed,NovelResistanceVariant,ConflictingEvidence,ComplexResistance_Pattern,RequiresMDT_Discussion
RES-2026-001,PAT-LUNG-042,NSCLC,EGFR:c.2369C>T (p.T790M),EGFR,SNV,Osimertinib,On_Target_Gatekeeper,Acquired,FDA_Label,OncoKB,true,Resistant,Osimertinib,Erlotinib;Chemotherapy,true,true,Second_Line,true,Amivantamab+Lazertinib;Chemotherapy;Clinical_Trial,false,,12.5,0.1,true,850,3,true,false,false,Tier_I_Level_A,true,true,true,true,true,false,false,false,false
RES-2026-002,PAT-CRC-055,CRC,KRAS:c.183A>T (p.Q61H),KRAS,SNV,Cetuximab,Off_Target_Bypass,Primary,Preclinical,CIViC,true,Uncertain,FOLFOX+Cetuximab,,true,false,First_Line,true,Bevacizumab+FOLFIRI,false,,8.2,0.1,true,420,3,true,false,false,Tier_II_Level_D,false,false,true,false,false,false,true,false,true
RES-2026-003,PAT-BRCA-061,Breast,ESR1:c.1619G>A (p.Y537S),ESR1,SNV,Tamoxifen,On_Target_Activating,Acquired,Guideline,OncoKB,true,Resistant,Letrozole,Tamoxifen,false,true,Third_Plus,true,Fulvestrant;Elacestrant,false,,0.05,0.1,false,2,3,false,true,true,Tier_I_Level_A,true,true,true,true,true,false,false,false,false
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | SampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | PatientID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | PrimaryTumorType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | DetectedVariant | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | Gene | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | VariantType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | AssociatedDrug | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | ResistanceMechanism | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | ResistanceType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | EvidenceLevel | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | KnowledgeBase_Source | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | VariantInKnowledgeBase | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | KnowledgeBase_ResistanceRating | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | CurrentTherapy | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | PriorTherapies | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | PatientCurrentlyOnAssociatedDrug | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | PatientPreviouslyOnAssociatedDrug | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | LineOfTherapy | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | AlternativeTherapy_Available | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | AlternativeTherapy_Names | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | CrossResistance_ToAlternatives | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | CrossResistantDrugs | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | VAF_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | AssayLOD_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | AboveLOD | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-026 | SupportingReads | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-027 | MinSupportingReads | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-028 | UMI_Confirmed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-029 | StrandBias_Detected | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-030 | ArtifactFlag_Raised | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-031 | ProposedTier | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-032 | TierAssignment_Valid | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-033 | InterpretationText_Complete | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-034 | DrugName_Standardized | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-035 | MechanismDescribed_InReport | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-036 | ClinicalTrialOptions_Listed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-037 | NovelResistanceVariant | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-038 | ConflictingEvidence | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-039 | ComplexResistance_Pattern | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-040 | RequiresMDT_Discussion | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для Resistance Mutation Reportability 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": "resistancemutationreportabilitychecker",
"utilityFolder": "ResistanceMutationReportabilityChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "SampleID",
"value": "RES-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": "PrimaryTumorType",
"value": "NSCLC",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "DetectedVariant",
"value": "EGFR:c.2369C>T (p.T790M)",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "Gene",
"value": "EGFR",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "VariantType",
"value": "SNV",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "AssociatedDrug",
"value": "Osimertinib",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "ResistanceMechanism",
"value": "On_Target_Gatekeeper",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "ResistanceType",
"value": "Acquired",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "EvidenceLevel",
"value": "FDA_Label",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "KnowledgeBase_Source",
"value": "OncoKB",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "VariantInKnowledgeBase",
"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": "ResistanceMutationReportabilityChecker.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 и утверждёнными процедурами.