URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты LiquidBiopsySampleIntakeChecker для сценария Liquid Biopsy Sample Intake Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- • EDTA Limit: ≤2 часа при комнатной температуре — критический порог для предотвращения лизиса WBC.
- • Stabilized Tube Limit: ≤72 часа для Streck/PAXgene при RT.
- • Plasma Volume: Достаточность объема для целевого анализа (обычно ≥2 мл).
- • Freeze-Thaw Cycles: Количество циклов заморозки-разморозки (≤1 рекомендуется).
- ⚠️ ВАЖНО:
- • Преаналитика определяет 70% вариабельности результатов жидкой биопсии.
- • Гемолиз >50 единиц коррелирует с ингибированием ПЦР и повышением фона gDNA.
- ⚠️ КРИТИЧЕСКИ ВАЖНО:
- • EDTA Time ≤ 2h: Превышение = REJECT для клинических тестов.
- • Plasma Volume ≥ 2 mL: Ниже = чувствительность ниже заявленной LOD.
- • Hemolysis ≤ 50: Превышение = CONDITIONAL или REJECT в зависимости от ассая.
- • Freeze-Thaw ≤ 1: Каждый дополнительный цикл увеличивает фрагментацию cfDNA.
- 5. Escalation: Определите протокол для CONDITIONAL образцов (кто принимает решение).
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Liquid Biopsy Sample Intake 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-INT-2026-001 | Идентификатор образца или лабораторной пробы. |
| 2 | PatientID | string / controlled vocabulary | PAT-1001 | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | TubeType | string / controlled vocabulary | Streck | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | BiofluidType | string / controlled vocabulary | Whole Blood | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | CollectionTime | string / controlled vocabulary | 2026-06-08 08:00:00 | Временной параметр процесса, инкубации, хранения или анализа. |
| 6 | ReceiptTime | string / controlled vocabulary | 2026-06-09 10:00:00 | Временной параметр процесса, инкубации, хранения или анализа. |
| 7 | ProcessingTime | string / controlled vocabulary | 2026-06-09 11:00:00 | Временной параметр процесса, инкубации, хранения или анализа. |
| 8 | MaxTimeToProcessing_Hours_EDTA | integer / decimal | 2.0 | Временной параметр процесса, инкубации, хранения или анализа. |
| 9 | MaxTimeToProcessing_Hours_Stabilized | integer / decimal | 72.0 | Временной параметр процесса, инкубации, хранения или анализа. |
| 10 | StorageTemp_C | decimal | 22 | Температурный профиль/MKT; параметр хранения, перевозки и стабильности. |
| 11 | MinStorageTemp_C | decimal | 15 | Температурный профиль/MKT; параметр хранения, перевозки и стабильности. |
| 12 | MaxStorageTemp_C | decimal | 30 | Температурный профиль/MKT; параметр хранения, перевозки и стабильности. |
| 13 | PlasmaVolume_mL | decimal | 4.5 | Объём/доза; используется для расчёта нагрузки, предела или выпуска. |
| 14 | MinPlasmaVolume_mL | decimal | 2.0 | Объём/доза; используется для расчёта нагрузки, предела или выпуска. |
| 15 | HemolysisIndex | decimal | 8 | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | MaxHemolysisIndex | decimal | 50 | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | LipemiaIndex | decimal | 12 | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | MaxLipemiaIndex | decimal | 100 | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | ChainOfCustody_Complete | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 20 | RequisitionForm_Complete | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 21 | LabelMatch | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 22 | PackagingIntact | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 23 | TemperatureMonitor_Present | string / controlled vocabulary | true | Температурный профиль/MKT; параметр хранения, перевозки и стабильности. |
| 24 | TemperatureExcursion_Detected | string / controlled vocabulary | false | Температурный профиль/MKT; параметр хранения, перевозки и стабильности. |
| 25 | FreezeThawCycles | integer / decimal | 0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 26 | MaxFreezeThawCycles | integer / decimal | 1 | Контролируемый входной параметр для детерминированных QC-правил. |
SampleID,PatientID,TubeType,BiofluidType,CollectionTime,ReceiptTime,ProcessingTime,MaxTimeToProcessing_Hours_EDTA,MaxTimeToProcessing_Hours_Stabilized,StorageTemp_C,MinStorageTemp_C,MaxStorageTemp_C,PlasmaVolume_mL,MinPlasmaVolume_mL,HemolysisIndex,MaxHemolysisIndex,LipemiaIndex,MaxLipemiaIndex,ChainOfCustody_Complete,RequisitionForm_Complete,LabelMatch,PackagingIntact,TemperatureMonitor_Present,TemperatureExcursion_Detected,FreezeThawCycles,MaxFreezeThawCycles
LB-INT-2026-001,PAT-1001,Streck,Whole Blood,2026-06-08 08:00:00,2026-06-09 10:00:00,2026-06-09 11:00:00,2.0,72.0,22,15,30,4.5,2.0,8,50,12,100,true,true,true,true,true,false,0,1
LB-INT-2026-002,PAT-1002,EDTA,Plasma,2026-06-08 08:00:00,2026-06-08 16:00:00,2026-06-08 16:30:00,2.0,72.0,4,2,8,1.5,2.0,85,50,5,100,true,true,true,true,false,false,2,1
LB-INT-2026-003,PAT-1003,PAXgene,Plasma,2026-06-07 10:00:00,2026-06-09 09:00:00,2026-06-09 09:30:00,2.0,72.0,-70,-80,-20,3.0,2.0,15,50,120,100,true,true,true,true,false,false,0,1
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | SampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | PatientID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | TubeType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | BiofluidType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | CollectionTime | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | ReceiptTime | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | ProcessingTime | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | MaxTimeToProcessing_Hours_EDTA | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | MaxTimeToProcessing_Hours_Stabilized | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | StorageTemp_C | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | MinStorageTemp_C | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | MaxStorageTemp_C | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | PlasmaVolume_mL | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | MinPlasmaVolume_mL | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | HemolysisIndex | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | MaxHemolysisIndex | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | LipemiaIndex | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | MaxLipemiaIndex | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | ChainOfCustody_Complete | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | RequisitionForm_Complete | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | LabelMatch | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | PackagingIntact | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | TemperatureMonitor_Present | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | TemperatureExcursion_Detected | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | FreezeThawCycles | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-026 | MaxFreezeThawCycles | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для Liquid Biopsy Sample Intake 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": "liquidbiopsysampleintakechecker",
"utilityFolder": "LiquidBiopsySampleIntakeChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "SampleID",
"value": "LB-INT-2026-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "PatientID",
"value": "PAT-1001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "TubeType",
"value": "Streck",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "BiofluidType",
"value": "Whole Blood",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "CollectionTime",
"value": "2026-06-08 08:00:00",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "ReceiptTime",
"value": "2026-06-09 10:00:00",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "ProcessingTime",
"value": "2026-06-09 11:00:00",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "MaxTimeToProcessing_Hours_EDTA",
"value": "2.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "MaxTimeToProcessing_Hours_Stabilized",
"value": "72.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "StorageTemp_C",
"value": "22",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "MinStorageTemp_C",
"value": "15",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "MaxStorageTemp_C",
"value": "30",
"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": "LiquidBiopsySampleIntakeChecker.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 и утверждёнными процедурами.