URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты ProteomicSignalAcceptanceChecker для сценария Proteomic Signal Acceptance Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • Signal-to-LOD Ratio: Маргинальная детекция при ratio < 3.
- • Replicate CV ≤ 20%: Воспроизводимость технических репликатов.
- • IPCC Deviation ≤ 15% (Olink): Внутрипланшетный контроль нормализации.
- • INC Counts ≥ threshold (Olink): Эффективность инкубации.
- • Extension Control ≥ threshold (Olink): Эффективность удлинения.
- НОРМАЛИЗАЦИЯ:
- • NPX Scale Factor 0.5–2.0: Допустимый диапазон нормализационного фактора.
- • Вне диапазона = аномальная нормализация образца.
- ⚠️ ВАЖНО:
- 3. Control Hierarchy: Sample controls > protein-specific flags > statistical outliers.
- 4. Orthogonal Verification: Для критических биомаркеров со specificity flag failure планируйте WB/targeted MS.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Proteomic Signal Acceptance 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 | PL-042 | Идентификатор образца или лабораторной пробы. |
| 2 | ProteinTarget | string / controlled vocabulary | IL6 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 3 | UniProtID | string / controlled vocabulary | P05231 | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | Platform | string / controlled vocabulary | Olink_Explore | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | AssayPanel | string / controlled vocabulary | Inflammation_92 | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | RawSignal_NPX_or_RFU | decimal | 8.45 | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | NormalizedValue | decimal | 8.45 | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | Units | string / controlled vocabulary | NPX | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | LOD_Value | decimal | 0.12 | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | LOQ_Value | decimal | 0.45 | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | AboveLOD | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | AboveLOQ | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | SignalToLOD_Ratio | decimal | 70.4 | Отношение компонентов; структурный или рецептурный CQA. |
| 14 | NumTechnicalReplicates | integer / decimal | 2 | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | ReplicateCV_Percent | decimal | 4.2 | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | MaxReplicateCV_Percent | decimal | 20 | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | ReplicateMean | integer / decimal | 8.45 | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | ReplicateSD | integer / decimal | 0.35 | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | IPCC_Deviation_Percent | decimal | 3.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 20 | MaxIPCC_Deviation_Percent | decimal | 15 | Контролируемый входной параметр для детерминированных QC-правил. |
| 21 | INC_CountsPerSec | integer / decimal | 850 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 22 | MinINC_CountsPerSec | integer / decimal | 100 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 23 | ExtensionControl_Counts | integer / decimal | 2500 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 24 | MinExtensionControl_Counts | integer / decimal | 500 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 25 | SampleControls_Pass | string / controlled vocabulary | true | Идентификатор образца или лабораторной пробы. |
| 26 | SpecificityFlag_Pass | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 27 | OutlierFlag_Raised | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 28 | NPX_ScaleFactor | decimal | 1.02 | Контролируемый входной параметр для детерминированных QC-правил. |
| 29 | MinNPX_ScaleFactor | decimal | 0.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 30 | MaxNPX_ScaleFactor | decimal | 2.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 31 | ExpectedRange_Low | decimal | 0.5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 32 | ExpectedRange_High | decimal | 15.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 33 | WithinBiologicalRange | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 34 | TissueContext | string / controlled vocabulary | Plasma | Контролируемый входной параметр для детерминированных QC-правил. |
| 35 | PlateID | string / controlled vocabulary | PLT-2026-089 | Контролируемый входной параметр для детерминированных QC-правил. |
| 36 | WellPosition | string / controlled vocabulary | D6 | Контролируемый входной параметр для детерминированных QC-правил. |
| 37 | IsPlateEdge | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 38 | ReagentLot | string / controlled vocabulary | OLK-2026-089 | Идентификатор серии/партии для трассируемости. |
SampleID,ProteinTarget,UniProtID,Platform,AssayPanel,RawSignal_NPX_or_RFU,NormalizedValue,Units,LOD_Value,LOQ_Value,AboveLOD,AboveLOQ,SignalToLOD_Ratio,NumTechnicalReplicates,ReplicateCV_Percent,MaxReplicateCV_Percent,ReplicateMean,ReplicateSD,IPCC_Deviation_Percent,MaxIPCC_Deviation_Percent,INC_CountsPerSec,MinINC_CountsPerSec,ExtensionControl_Counts,MinExtensionControl_Counts,SampleControls_Pass,SpecificityFlag_Pass,OutlierFlag_Raised,NPX_ScaleFactor,MinNPX_ScaleFactor,MaxNPX_ScaleFactor,ExpectedRange_Low,ExpectedRange_High,WithinBiologicalRange,TissueContext,PlateID,WellPosition,IsPlateEdge,ReagentLot
PL-042,IL6,P05231,Olink_Explore,Inflammation_92,8.45,8.45,NPX,0.12,0.45,true,true,70.4,2,4.2,20,8.45,0.35,3.5,15,850,100,2500,500,true,true,false,1.02,0.5,2.0,0.5,15.0,true,Plasma,PLT-2026-089,D6,false,OLK-2026-089
PL-055,TNFRSF1A,P19438,Olink_Explore,Inflammation_92,0.38,0.38,NPX,0.15,0.52,true,false,2.5,2,28.5,20,0.38,0.108,18.2,15,95,100,420,500,false,true,true,0.42,0.5,2.0,1.0,12.0,false,Plasma,PLT-2026-090,A1,true,OLK-2026-090
PL-061,MMP9,P14780,SomaLogic,Cardiovascular_200,1250,1180,RFU,50,180,true,true,25.0,3,8.5,20,1250,106,5.0,15,0,0,0,0,true,false,false,1.05,0.5,2.0,200,5000,true,Serum,SL-2026-045,F8,false,SL-2026-112
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | SampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | ProteinTarget | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | UniProtID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | Platform | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | AssayPanel | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | RawSignal_NPX_or_RFU | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | NormalizedValue | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | Units | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | LOD_Value | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | LOQ_Value | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | AboveLOD | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | AboveLOQ | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | SignalToLOD_Ratio | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | NumTechnicalReplicates | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | ReplicateCV_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | MaxReplicateCV_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | ReplicateMean | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | ReplicateSD | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | IPCC_Deviation_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | MaxIPCC_Deviation_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | INC_CountsPerSec | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | MinINC_CountsPerSec | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | ExtensionControl_Counts | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | MinExtensionControl_Counts | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | SampleControls_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-026 | SpecificityFlag_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-027 | OutlierFlag_Raised | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-028 | NPX_ScaleFactor | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-029 | MinNPX_ScaleFactor | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-030 | MaxNPX_ScaleFactor | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-031 | ExpectedRange_Low | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-032 | ExpectedRange_High | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-033 | WithinBiologicalRange | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-034 | TissueContext | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-035 | PlateID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-036 | WellPosition | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-037 | IsPlateEdge | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-038 | ReagentLot | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для Proteomic Signal Acceptance 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": "proteomicsignalacceptancechecker",
"utilityFolder": "ProteomicSignalAcceptanceChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "SampleID",
"value": "PL-042",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "ProteinTarget",
"value": "IL6",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "UniProtID",
"value": "P05231",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "Platform",
"value": "Olink_Explore",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "AssayPanel",
"value": "Inflammation_92",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "RawSignal_NPX_or_RFU",
"value": "8.45",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "NormalizedValue",
"value": "8.45",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "Units",
"value": "NPX",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "LOD_Value",
"value": "0.12",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "LOQ_Value",
"value": "0.45",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "AboveLOD",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "AboveLOQ",
"value": "true",
"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": "ProteomicSignalAcceptanceChecker.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 и утверждёнными процедурами.