URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты WbcBackgroundSignalChecker для сценария WBC Background Signal Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • Signal-to-Noise Ratio: Отношение опухолевого сигнала к WBC-фону — определяет реальную чувствительность ассая.
- ⚠️ ВАЖНО:
- • Разработка assays: Определение LOD с учетом реального WBC-фона.
- Это критически важно для достоверности MRD-мониторинга и раннего обнаружения рецидива.
- ⚠️ КРИТИЧЕСКИ ВАЖНО:
- • Residual WBC ≤10⁵/mL: Для cfDNA-анализа. Превышение = недостаточное центрифугирование.
- • WBC DNA ≤10%: Выше этого уровня опухолевой сигнал существенно разбавлен.
- • SNR ≥3.0: Ниже этого порога опухолевой сигнал статистически неразличим на фоне WBC.
- • Hemolysis ≤50: Высокий индекс = WBC-лизис = gDNA-контаминация.
- • CD45 Depletion ≥95%: При использовании деплеции эффективность должна быть подтверждена.
- • Четырёхуровневая классификация (Acceptable / Elevated / High / Critical)
- Критические параметры:
- • Residual WBC: ≤ 1×10⁵ cells/mL (cfDNA)
- • WBC DNA Contribution: ≤ 10%
- • CD45+ Events: ≤ Assay-specific limit
- • Signal-to-Noise Ratio: ≥ 3.0
- • Hemolysis Index: ≤ 50
- • Depletion Efficiency: ≥ 95% (if used)
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для WBC Background Signal 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-WBC-001 | Идентификатор образца или лабораторной пробы. |
| 2 | AssayType | string / controlled vocabulary | cfDNA_NGS | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | BiofluidSource | string / controlled vocabulary | Plasma | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | ResidualWBC_per_mL | decimal | 2500 | Примесь/остаточный компонент; используется для оценки соответствия спецификации. |
| 5 | MaxResidualWBC_per_mL | decimal | 100000 | Примесь/остаточный компонент; используется для оценки соответствия спецификации. |
| 6 | WBC_DNA_Contribution_Percent | decimal | 1.2 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 7 | MaxWBC_DNA_Contribution_Percent | decimal | 10.0 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 8 | CD45_Positive_Events | decimal | 3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | MaxCD45_Events | decimal | 50 | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | TumorSignal_VAF_or_Count | integer / decimal | 0.45 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 11 | WBC_Background_Noise | decimal | 0.02 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | MinSignalToNoise_Ratio | decimal | 3.0 | Отношение компонентов; структурный или рецептурный CQA. |
| 13 | Hemolysis_Index | decimal | 8 | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | MaxHemolysis_Index | decimal | 50 | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | CentrifugationSpeed_g | decimal | 16000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | DoubleSpin_Performed | decimal | 1 | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | CD45_Depletion_Used | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | DepletionEfficiency_Percent | decimal | 99.2 | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | MinDepletionEfficiency_Percent | decimal | 95.0 | Контролируемый входной параметр для детерминированных QC-правил. |
SampleID,AssayType,BiofluidSource,ResidualWBC_per_mL,MaxResidualWBC_per_mL,WBC_DNA_Contribution_Percent,MaxWBC_DNA_Contribution_Percent,CD45_Positive_Events,MaxCD45_Events,TumorSignal_VAF_or_Count,WBC_Background_Noise,MinSignalToNoise_Ratio,Hemolysis_Index,MaxHemolysis_Index,CentrifugationSpeed_g,DoubleSpin_Performed,CD45_Depletion_Used,DepletionEfficiency_Percent,MinDepletionEfficiency_Percent
LB-WBC-001,cfDNA_NGS,Plasma,2500,100000,1.2,10.0,3,50,0.45,0.02,3.0,8,50,16000,1,true,99.2,95.0
LB-WBC-002,CTC_Enumeration,Whole Blood,8500000,100000,35.0,10.0,420,50,5,3.8,3.0,85,50,800,0,false,0,95.0
LB-WBC-003,Methylation,Plasma,45000,100000,8.5,10.0,28,50,0.15,0.06,3.0,62,50,16000,1,true,96.5,95.0
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | SampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | AssayType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | BiofluidSource | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | ResidualWBC_per_mL | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | MaxResidualWBC_per_mL | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | WBC_DNA_Contribution_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | MaxWBC_DNA_Contribution_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | CD45_Positive_Events | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | MaxCD45_Events | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | TumorSignal_VAF_or_Count | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | WBC_Background_Noise | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | MinSignalToNoise_Ratio | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | Hemolysis_Index | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | MaxHemolysis_Index | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | CentrifugationSpeed_g | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | DoubleSpin_Performed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | CD45_Depletion_Used | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | DepletionEfficiency_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | MinDepletionEfficiency_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 | Применить правила для WBC Background Signal 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": "wbcbackgroundsignalchecker",
"utilityFolder": "WbcBackgroundSignalChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "SampleID",
"value": "LB-WBC-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "AssayType",
"value": "cfDNA_NGS",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "BiofluidSource",
"value": "Plasma",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "ResidualWBC_per_mL",
"value": "2500",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "MaxResidualWBC_per_mL",
"value": "100000",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "WBC_DNA_Contribution_Percent",
"value": "1.2",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "MaxWBC_DNA_Contribution_Percent",
"value": "10.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "CD45_Positive_Events",
"value": "3",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "MaxCD45_Events",
"value": "50",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "TumorSignal_VAF_or_Count",
"value": "0.45",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "WBC_Background_Noise",
"value": "0.02",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "MinSignalToNoise_Ratio",
"value": "3.0",
"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": "WbcBackgroundSignalChecker.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 и утверждёнными процедурами.