URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты MrdRecurrenceMonitoringChecker для сценария MRD Recurrence Monitoring Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • FALSE ALARM SUSPECTED: Пограничная детекция около LOD. Вероятен технический шум.
- КРИТЕРИИ ПОДТВЕРЖДЕНИЯ РЕЦИДИВА:
- • ≥2 последовательных MRD+ результата ИЛИ подтверждение повторным тестом.
- • Восходящий тренд: fold change >1.5× и положительный doubling time.
- • Персистенция >60 дней без клиренса даже без роста = устойчивая остаточная болезнь.
- • Терапия: Доступность опций лечения определяет категорию «actionable».
- • Время от лечения: Ранний (<6 мес) vs поздний рецидив имеют разную тактику.
- ⚠️ ВАЖНО:
- 1. Confirmation Protocol: Заранее определите алгоритм подтверждения (повторный тест ± внеплановая визуализация).
- 2. Doubling Time: Рассчитывайте для каждого пациента индивидуально; быстрый рост (<30 дней) = высокая агрессивность.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для MRD Recurrence Monitoring 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 | REC-PAT-001 | Контролируемый входной параметр для детерминированных QC-правил. |
| 2 | PrimaryTumorType | string / controlled vocabulary | NSCLC | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | TreatmentIntent | string / controlled vocabulary | Curative | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | LastCurativeTreatment_Date | string / controlled vocabulary | 2025-08-15 | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | TotalMrDTests_Performed | decimal | 5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | ConsecutivePositive_Count | integer / decimal | 3 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 7 | CurrentVAF_Percent | decimal | 0.045 | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | PreviousVAF_Percent | decimal | 0.012 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | FoldChange_FromPrevious | decimal | 3.75 | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | DoublingTime_Days | integer / decimal | 28 | Временной параметр процесса, инкубации, хранения или анализа. |
| 11 | ConfirmedByRepeatTest | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | DaysSinceFirstDetection | integer / decimal | 75 | Временной параметр процесса, инкубации, хранения или анализа. |
| 13 | LastImaging_Date | string / controlled vocabulary | 2026-06-20 | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | LastImaging_Result | string / controlled vocabulary | NED | Результат или статус, применяемый в итоговой классификации. |
| 15 | DaysSinceLastImaging | integer / decimal | 25 | Временной параметр процесса, инкубации, хранения или анализа. |
| 16 | UnscheduledImaging_Performed | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | UnscheduledImaging_Result | string / controlled vocabulary | | Результат или статус, применяемый в итоговой классификации. |
| 18 | Symptoms_Present | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | ECOG_Status | string / controlled vocabulary | 0 | Результат или статус, применяемый в итоговой классификации. |
| 20 | ActionableTherapy_Available | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 21 | AvailableTherapyOptions | string / controlled vocabulary | Osimertinib+Chemo;Clinical_Trial | Контролируемый входной параметр для детерминированных QC-правил. |
| 22 | MonthsSinceTreatmentEnd | decimal | 10 | Контролируемый входной параметр для детерминированных QC-правил. |
| 23 | AssayName | string / controlled vocabulary | Signatera_NSCLC | Контролируемый входной параметр для детерминированных QC-правил. |
| 24 | AssayLOD_Percent | decimal | 0.001 | Контролируемый входной параметр для детерминированных QC-правил. |
| 25 | TumorInformed_Assay | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
PatientID,PrimaryTumorType,TreatmentIntent,LastCurativeTreatment_Date,TotalMrDTests_Performed,ConsecutivePositive_Count,CurrentVAF_Percent,PreviousVAF_Percent,FoldChange_FromPrevious,DoublingTime_Days,ConfirmedByRepeatTest,DaysSinceFirstDetection,LastImaging_Date,LastImaging_Result,DaysSinceLastImaging,UnscheduledImaging_Performed,UnscheduledImaging_Result,Symptoms_Present,ECOG_Status,ActionableTherapy_Available,AvailableTherapyOptions,MonthsSinceTreatmentEnd,AssayName,AssayLOD_Percent,TumorInformed_Assay
REC-PAT-001,NSCLC,Curative,2025-08-15,5,3,0.045,0.012,3.75,28,true,75,2026-06-20,NED,25,false,,false,0,true,Osimertinib+Chemo;Clinical_Trial,10,Signatera_NSCLC,0.001,true
REC-PAT-002,CRC,Curative,2025-12-01,3,1,0.004,0,0,0,false,5,2026-05-15,NED,30,false,,false,0,true,FOLFOX;CAPOX,6,Signatera_CRC,0.001,true
REC-PAT-003,Breast,Curative,2025-06-20,6,2,0.002,0.002,1.0,0,true,90,2026-06-01,NED,14,false,,false,0,false,,12,RaDaR_Breast,0.001,true
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | PatientID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | PrimaryTumorType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | TreatmentIntent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | LastCurativeTreatment_Date | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | TotalMrDTests_Performed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | ConsecutivePositive_Count | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | CurrentVAF_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | PreviousVAF_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | FoldChange_FromPrevious | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | DoublingTime_Days | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | ConfirmedByRepeatTest | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | DaysSinceFirstDetection | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | LastImaging_Date | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | LastImaging_Result | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | DaysSinceLastImaging | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | UnscheduledImaging_Performed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | UnscheduledImaging_Result | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | Symptoms_Present | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | ECOG_Status | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | ActionableTherapy_Available | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | AvailableTherapyOptions | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | MonthsSinceTreatmentEnd | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | AssayName | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | AssayLOD_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | TumorInformed_Assay | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 Recurrence Monitoring 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": "mrdrecurrencemonitoringchecker",
"utilityFolder": "MrdRecurrenceMonitoringChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "PatientID",
"value": "REC-PAT-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "PrimaryTumorType",
"value": "NSCLC",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "TreatmentIntent",
"value": "Curative",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "LastCurativeTreatment_Date",
"value": "2025-08-15",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "TotalMrDTests_Performed",
"value": "5",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "ConsecutivePositive_Count",
"value": "3",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "CurrentVAF_Percent",
"value": "0.045",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "PreviousVAF_Percent",
"value": "0.012",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "FoldChange_FromPrevious",
"value": "3.75",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "DoublingTime_Days",
"value": "28",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "ConfirmedByRepeatTest",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "DaysSinceFirstDetection",
"value": "75",
"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": "MrdRecurrenceMonitoringChecker.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 и утверждёнными процедурами.