URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты BloodBasedGenomicProfilingChecker для сценария Blood Based Genomic Profiling Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • Предел обнаружения (LOD): Верификация фактической чувствительности теста по VAF.
- ⚠️ ВАЖНО:
- • Жидкая биопсия работает с предельно низкими концентрациями аналита.
- ⚠️ КРИТИЧЕСКИ ВАЖНО:
- • UMI Depth: Определяет реальную чувствительность. 1000x UMI ≈ 0.1% LOD.
- • gDNA Contamination: >10% лейкоцитарной ДНК существенно снижает отношение сигнал/шум.
- Критические параметры:
- • cfDNA Yield: ≥ Min Limit
- • Hemolysis Index: ≤ Max Limit
- • Mean Depth: ≥ Min Limit
- • Unique Molecular Depth: ≥ Min Limit
- • LOD VAF: ≤ Validated LOD
- • gDNA Contamination: ≤ Max Limit
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Blood Based Genomic Profiling 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 | LB-2026-PT-001 | Идентификатор образца или лабораторной пробы. |
| 2 | PanelName | string / controlled vocabulary | OncoLiquid_500 | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | CfDNA_Yield_ng | decimal | 25.0 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 4 | Min_CfDNA_Yield_ng | decimal | 5.0 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 5 | Hemolysis_Index | decimal | 15 | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | Max_Hemolysis_Index | decimal | 50 | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | Mean_Target_Depth_X | string / controlled vocabulary | 15000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | Min_Mean_Depth_X | decimal | 10000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | Unique_Molecular_Depth_X | decimal | 2500 | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | Min_Unique_Depth_X | decimal | 1000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | LOD_VAF_Percent | decimal | 0.3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | Validated_LOD_VAF_Percent | decimal | 0.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | gDNA_Contamination_Percent | decimal | 2.5 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 14 | Max_gDNA_Contamination_Percent | decimal | 10.0 | Биологический/молекулярный компонент, контролируемый как CQA. |
SampleID,PanelName,CfDNA_Yield_ng,Min_CfDNA_Yield_ng,Hemolysis_Index,Max_Hemolysis_Index,Mean_Target_Depth_X,Min_Mean_Depth_X,Unique_Molecular_Depth_X,Min_Unique_Depth_X,LOD_VAF_Percent,Validated_LOD_VAF_Percent,gDNA_Contamination_Percent,Max_gDNA_Contamination_Percent
LB-2026-PT-001,OncoLiquid_500,25.0,5.0,15,50,15000,10000,2500,1000,0.3,0.5,2.5,10.0
LB-2026-PT-002,OncoLiquid_500,3.0,5.0,120,50,8000,10000,800,1000,1.2,0.5,25.0,10.0
LB-2026-PT-003,OncoLiquid_500,18.0,5.0,30,50,12000,10000,1800,1000,0.4,0.5,5.0,10.0
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | SampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | PanelName | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | CfDNA_Yield_ng | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | Min_CfDNA_Yield_ng | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | Hemolysis_Index | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | Max_Hemolysis_Index | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | Mean_Target_Depth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | Min_Mean_Depth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | Unique_Molecular_Depth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | Min_Unique_Depth_X | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | LOD_VAF_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | Validated_LOD_VAF_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | gDNA_Contamination_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | Max_gDNA_Contamination_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для Blood Based Genomic Profiling 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": "bloodbasedgenomicprofilingchecker",
"utilityFolder": "BloodBasedGenomicProfilingChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "SampleID",
"value": "LB-2026-PT-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "PanelName",
"value": "OncoLiquid_500",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "CfDNA_Yield_ng",
"value": "25.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "Min_CfDNA_Yield_ng",
"value": "5.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "Hemolysis_Index",
"value": "15",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "Max_Hemolysis_Index",
"value": "50",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "Mean_Target_Depth_X",
"value": "15000",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "Min_Mean_Depth_X",
"value": "10000",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "Unique_Molecular_Depth_X",
"value": "2500",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "Min_Unique_Depth_X",
"value": "1000",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "LOD_VAF_Percent",
"value": "0.3",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "Validated_LOD_VAF_Percent",
"value": "0.5",
"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": "BloodBasedGenomicProfilingChecker.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 и утверждёнными процедурами.