URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты ComprehensiveReportabilityChecker для сценария Comprehensive Reportability Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • Структурная полнота: Проверка наличия всех 6 обязательных секций (Summary, Variants, Methodology, Limitations, Disclaimer, References).
- ⚠️ ВАЖНО:
- ReportID,PatientID,TestName,TotalVariantsDetected,ActionableVariants,TherapiesRecommended,AllActionableAddressed,HasSummary,HasVariantTable,HasMethodology,HasLimitations,HasDisclaimer,HasReferences,CDx_Compliant,InternalConsistency_Pass,Nomenclature_HGNC_Compliant,VAF_Values_Valid,Pathologist_Review_Complete,Bioinformatics_Sign_Off
- Разрозненные проверки пропускают системные проблемы (например, все данные верны, но нет секции Limitations).
- ⚠️ КРИТИЧЕСКИ ВАЖНО:
- • Disclaimer & Limitations: Отсутствие этих секций = BLOCKED.
- Критические параметры:
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Comprehensive 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 | ReportID,PatientID,TestName,TotalVariantsDetected,ActionableVariants,TherapiesRecommended,AllActionableAddressed,HasSummary,HasVariantTable,HasMethodology,HasLimitations,HasDisclaimer,HasReferences,CDx_Compliant,InternalConsistency_Pass,Nomenclature_HGNC_Compliant,VA | string / controlled vocabulary | RPT- | Биологический/молекулярный компонент, контролируемый как CQA. |
| 2 | _Values_Valid,Pathologist_Review_Complete,Bioinformatics_Sign_Off | string / controlled vocabulary | INAL-001,PAT-5001,OncoPanel CGP,12,3,3,true,true,true,true,true,true,true,true,true,true,true,true,true,true | Контролируемый входной параметр для детерминированных QC-правил. |
ReportID,PatientID,TestName,TotalVariantsDetected,ActionableVariants,TherapiesRecommended,AllActionableAddressed,HasSummary,HasVariantTable,HasMethodology,HasLimitations,HasDisclaimer,HasReferences,CDx_Compliant,InternalConsistency_Pass,Nomenclature_HGNC_Compliant,VA,_Values_Valid,Pathologist_Review_Complete,Bioinformatics_Sign_Off
RPT-,INAL-001,PAT-5001,OncoPanel CGP,12,3,3,true,true,true,true,true,true,true,true,true,true,true,true,true,true
RPT-,INAL-002,PAT-5002,OncoPanel CGP,8,2,1,false,true,true,true,false,true,true,false,false,false,true,true,false,true
RPT-,INAL-003,PAT-5003,Liquid Biopsy Panel,5,1,1,true,true,true,true,true,true,true,true,true,true,true,true,true,false
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | ReportID,PatientID,TestName,TotalVariantsDetected,ActionableVariants,TherapiesRecommended,AllActionableAddressed,HasSummary,HasVariantTable,HasMethodology,HasLimitations,HasDisclaimer,HasReferences,CDx_Compliant,InternalConsistency_Pass,Nomenclature_HGNC_Compliant,VA | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | _Values_Valid,Pathologist_Review_Complete,Bioinformatics_Sign_Off | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
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 | Применить правила для Comprehensive 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": "comprehensivereportabilitychecker",
"utilityFolder": "ComprehensiveReportabilityChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "ReportID,PatientID,TestName,TotalVariantsDetected,ActionableVariants,TherapiesRecommended,AllActionableAddressed,HasSummary,HasVariantTable,HasMethodology,HasLimitations,HasDisclaimer,HasReferences,CDx_Compliant,InternalConsistency_Pass,Nomenclature_HGNC_Compliant,VA",
"value": "RPT-",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "_Values_Valid,Pathologist_Review_Complete,Bioinformatics_Sign_Off",
"value": "INAL-001,PAT-5001,OncoPanel CGP,12,3,3,true,true,true,true,true,true,true,true,true,true,true,true,true,true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
}
],
"criticalFindings": [],
"warnings": [],
"audit": {
"inputHash": "sha256:<calculated at runtime>",
"rulesVersion": "<utility executable version>",
"documentation": "ComprehensiveReportabilityChecker.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 и утверждёнными процедурами.