URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты FalsePositiveReviewWorkflowBuilder для сценария False Positive Review Workflow Builder.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- ⚠️ ВАЖНО:
- FP-WF-001,NGS_Panel,VAF<5% OR novel,true,true,true,true,true,true,true,48,Technologist,Bioinformatician,Pathologist,true,2026-01-15
- Это критически важно для patient safety и regulatory compliance.
- ⚠️ КРИТИЧЕСКИ ВАЖНО:
- • Orthogonal Confirmation: ОБЯЗАТЕЛЬНО для всех FP-suspect результатов.
- • TAT: Должен учитывать клиническую срочность (онкология ≤48-72 ч).
- • Выявление критических и мажорных пробелов
- Критические параметры:
- 2. Ортогональность: Заранее определите доступные методы подтверждения для каждого типа варианта.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для False Positive Review Workflow Builder с заголовками, определёнными в контракте данных. | 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 | WorkflowID | string / controlled vocabulary | FP-WF-NGS-001 | Контролируемый входной параметр для детерминированных QC-правил. |
| 2 | AssayType | string / controlled vocabulary | NGS_Panel | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | TriggerCriteria | string / controlled vocabulary | VAF < 5% OR novel variant OR discordant with phenotype | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | HasTechnicalCheck | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | HasBioinformaticCheck | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | HasBiologicalPlausibilityCheck | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | HasOrthogonalConfirmation | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | HasEscalationPath | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | HasConclusionTemplate | string / controlled vocabulary | true | Температурный профиль/MKT; параметр хранения, перевозки и стабильности. |
| 10 | HasTurnaroundTime | string / controlled vocabulary | true | Временной параметр процесса, инкубации, хранения или анализа. |
| 11 | MaxTurnaroundHours | integer / decimal | 48 | Временной параметр процесса, инкубации, хранения или анализа. |
| 12 | ResponsibleRole_Technical | string / controlled vocabulary | Lab Technologist | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | ResponsibleRole_Bioinformatic | string / controlled vocabulary | Bioinformatician | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | ResponsibleRole_Clinical | string / controlled vocabulary | Molecular Pathologist | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | WorkflowApproved | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | ApprovalDate | string / controlled vocabulary | 2026-01-15 | Контролируемый входной параметр для детерминированных QC-правил. |
WorkflowID,AssayType,TriggerCriteria,HasTechnicalCheck,HasBioinformaticCheck,HasBiologicalPlausibilityCheck,HasOrthogonalConfirmation,HasEscalationPath,HasConclusionTemplate,HasTurnaroundTime,MaxTurnaroundHours,ResponsibleRole_Technical,ResponsibleRole_Bioinformatic,ResponsibleRole_Clinical,WorkflowApproved,ApprovalDate
FP-WF-NGS-001,NGS_Panel,VAF < 5% OR novel variant OR discordant with phenotype,true,true,true,true,true,true,true,48,Lab Technologist,Bioinformatician,Molecular Pathologist,true,2026-01-15
FP-WF-DDPCR-002,ddPCR,Positive droplets < 10 OR NTC contamination,true,false,true,false,false,true,true,24,Lab Technologist,,Molecular Pathologist,false,
FP-WF-LB-003,LiquidBiopsy,ctDNA VAF < 0.5% OR unexpected tissue origin,true,true,true,true,true,true,true,72,Lab Technologist,Bioinformatician,Oncologist,true,2026-03-01
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | WorkflowID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | AssayType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | TriggerCriteria | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | HasTechnicalCheck | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | HasBioinformaticCheck | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | HasBiologicalPlausibilityCheck | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | HasOrthogonalConfirmation | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | HasEscalationPath | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | HasConclusionTemplate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | HasTurnaroundTime | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | MaxTurnaroundHours | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | ResponsibleRole_Technical | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | ResponsibleRole_Bioinformatic | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | ResponsibleRole_Clinical | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | WorkflowApproved | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | ApprovalDate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для False Positive Review Workflow Builder, включая критические пределы из описания и утверждённой спецификации. |
| 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": "falsepositivereviewworkflowbuilder",
"utilityFolder": "FalsePositiveReviewWorkflowBuilder",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "WorkflowID",
"value": "FP-WF-NGS-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "AssayType",
"value": "NGS_Panel",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "TriggerCriteria",
"value": "VAF < 5% OR novel variant OR discordant with phenotype",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "HasTechnicalCheck",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "HasBioinformaticCheck",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "HasBiologicalPlausibilityCheck",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "HasOrthogonalConfirmation",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "HasEscalationPath",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "HasConclusionTemplate",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "HasTurnaroundTime",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "MaxTurnaroundHours",
"value": "48",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "ResponsibleRole_Technical",
"value": "Lab Technologist",
"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": "FalsePositiveReviewWorkflowBuilder.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 и утверждёнными процедурами.