URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты PositiveNegativeControlTrendChecker для сценария Positive/Negative Control Trend Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- ℹ️ Утилита выполняет лонгитюдный статистический QC согласно CLSI EP23-A, CAP/CLIA, ISO 15189 §7.3 и FDA statistical QC guidance:
- • 1-2S (Warning): Одна точка за пределами 2SD. Предупреждение, не отказ.
- • 1-3S (Reject): Одна точка за пределами 3SD. Случайная ошибка или начало систематической.
- • R-4S (Reject): Размах между двумя контролями в одном запуске > 4SD. Случайная ошибка.
- • Значимый тренд: |slope| > 0.5 × SD / N.
- • Алерт при прогнозе < 20 запусков до отказа.
- ⚠️ ВАЖНО:
- • Аккредитация CAP/ISO: Документирование ongoing QC program.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Positive/Negative Control Trend 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 | ControlID | string / controlled vocabulary | POS-CTRL-001 | Контрольная точка/контрольный образец для валидности серии анализа. |
| 2 | ControlType | string / controlled vocabulary | Positive | Контрольная точка/контрольный образец для валидности серии анализа. |
| 3 | AssayName | string / controlled vocabulary | KRAS_ddPCR | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | MetricName | string / controlled vocabulary | Copies_uL | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | InstrumentID | string / controlled vocabulary | QX200-01 | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | ReagentLot | string / controlled vocabulary | LOT-2026-0451 | Идентификатор серии/партии для трассируемости. |
| 7 | HistoricalValues_Raw | string / controlled vocabulary | 2026-05-01:102.5;2026-05-05:99.8;2026-05-08:101.2;2026-05-12:100.5;2026-05-15:103.1;2026-05-19:98.7;2026-05-22:101.8;2026-05-26:100.2;2026-05-29:102.0;2026-06-02:99.5;2026-06-05:101.5;2026-06-08:100.8 | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | CurrentValue | decimal | 100.8 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | CurrentDate | string / controlled vocabulary | 2026-06-08 | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | EstablishedMean | integer / decimal | 100.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | EstablishedSD | decimal | 3.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | UpperLimit_3SD | decimal | 109.0 | Утверждённый предел, применяемый при проверке результата. |
| 13 | LowerLimit_3SD | decimal | 91.0 | Утверждённый предел, применяемый при проверке результата. |
| 14 | UpperLimit_2SD | decimal | 106.0 | Утверждённый предел, применяемый при проверке результата. |
| 15 | LowerLimit_2SD | decimal | 94.0 | Утверждённый предел, применяемый при проверке результата. |
| 16 | Rule_1_2S_Enabled | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | Rule_1_3S_Enabled | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | Rule_2_2S_Enabled | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | Rule_R_4S_Enabled | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 20 | Rule_4_1S_Enabled | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 21 | Rule_10X_Enabled | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 22 | MetricDirection | string / controlled vocabulary | Two_Sided | Контролируемый входной параметр для детерминированных QC-правил. |
ControlID,ControlType,AssayName,MetricName,InstrumentID,ReagentLot,HistoricalValues_Raw,CurrentValue,CurrentDate,EstablishedMean,EstablishedSD,UpperLimit_3SD,LowerLimit_3SD,UpperLimit_2SD,LowerLimit_2SD,Rule_1_2S_Enabled,Rule_1_3S_Enabled,Rule_2_2S_Enabled,Rule_R_4S_Enabled,Rule_4_1S_Enabled,Rule_10X_Enabled,MetricDirection
POS-CTRL-001,Positive,KRAS_ddPCR,Copies_uL,QX200-01,LOT-2026-0451,2026-05-01:102.5;2026-05-05:99.8;2026-05-08:101.2;2026-05-12:100.5;2026-05-15:103.1;2026-05-19:98.7;2026-05-22:101.8;2026-05-26:100.2;2026-05-29:102.0;2026-06-02:99.5;2026-06-05:101.5;2026-06-08:100.8,100.8,2026-06-08,100.0,3.0,109.0,91.0,106.0,94.0,true,true,true,true,true,true,Two_Sided
NEG-CTRL-002,Negative,EGFR_T790M_BEAMing,Ct,LC480-02,LOT-2026-0467,2026-05-01:38.5;2026-05-05:38.2;2026-05-08:37.9;2026-05-12:37.5;2026-05-15:37.1;2026-05-19:36.8;2026-05-22:36.4;2026-05-26:36.0;2026-05-29:35.7;2026-06-02:35.3;2026-06-05:35.0;2026-06-08:34.6,34.6,2026-06-08,38.0,1.0,41.0,35.0,40.0,36.0,true,true,true,true,true,true,Higher_Is_Better
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | ControlID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | ControlType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | AssayName | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | MetricName | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | InstrumentID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | ReagentLot | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | HistoricalValues_Raw | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | CurrentValue | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | CurrentDate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | EstablishedMean | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | EstablishedSD | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | UpperLimit_3SD | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | LowerLimit_3SD | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | UpperLimit_2SD | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | LowerLimit_2SD | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | Rule_1_2S_Enabled | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | Rule_1_3S_Enabled | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | Rule_2_2S_Enabled | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | Rule_R_4S_Enabled | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | Rule_4_1S_Enabled | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | Rule_10X_Enabled | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | MetricDirection | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для Positive/Negative Control Trend 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": "positivenegativecontroltrendchecker",
"utilityFolder": "PositiveNegativeControlTrendChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "ControlID",
"value": "POS-CTRL-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "ControlType",
"value": "Positive",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "AssayName",
"value": "KRAS_ddPCR",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "MetricName",
"value": "Copies_uL",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "InstrumentID",
"value": "QX200-01",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "ReagentLot",
"value": "LOT-2026-0451",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "HistoricalValues_Raw",
"value": "2026-05-01:102.5;2026-05-05:99.8;2026-05-08:101.2;2026-05-12:100.5;2026-05-15:103.1;2026-05-19:98.7;2026-05-22:101.8;2026-05-26:100.2;2026-05-29:102.0;2026-06-02:99.5;2026-06-05:101.5;2026-06-08:100.8",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "CurrentValue",
"value": "100.8",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "CurrentDate",
"value": "2026-06-08",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "EstablishedMean",
"value": "100.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "EstablishedSD",
"value": "3.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "UpperLimit_3SD",
"value": "109.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": "PositiveNegativeControlTrendChecker.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 и утверждёнными процедурами.