URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты NetworkLabSampleRoutingChecker для сценария Network Lab Sample Routing Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- Network Lab Sample Routing Checker — Верификация маршрутизации образцов в распределенной лабораторной сети
- ℹ️ Утилита выполняет комплексную проверку корректности маршрутов согласно CAP/CLIA, ISO 15189, GDP и GLP/GCP:
- • Accredited For Test: Сайт имеет аккредитацию (CAP/CLIA/ISO) для данного теста.
- • Transit Time ≤ Max Allowable: Время транспортировки не превышает стабильность образца.
- ⚠️ ВАЖНО:
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Network Lab Sample Routing 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 | ROUTE-2026-001 | Идентификатор образца или лабораторной пробы. |
| 2 | PatientID | string / controlled vocabulary | PAT-042 | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | OrderedTest | string / controlled vocabulary | NSCLC_CGP_Panel | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | Priority | string / controlled vocabulary | STAT | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | SampleType | string / controlled vocabulary | FFPE | Идентификатор образца или лабораторной пробы. |
| 6 | OriginSite | string / controlled vocabulary | Hospital_A | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | DestinationSite | string / controlled vocabulary | RefLab_Central | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | AlternateSite | string / controlled vocabulary | RefLab_East | Биологический/молекулярный компонент, контролируемый как CQA. |
| 9 | DestinationSite_TestAvailable | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | DestinationSite_SampleTypeAccepted | string / controlled vocabulary | true | Идентификатор образца или лабораторной пробы. |
| 11 | DestinationSite_CapacityAvailable | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | DestinationSite_AccreditedForTest | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | EstimatedTransit_Hours | integer / decimal | 4 | Временной параметр процесса, инкубации, хранения или анализа. |
| 14 | MaxAllowableTransit_Hours | integer / decimal | 24 | Временной параметр процесса, инкубации, хранения или анализа. |
| 15 | TemperatureControl_Available | string / controlled vocabulary | true | Температурный профиль/MKT; параметр хранения, перевозки и стабильности. |
| 16 | RequiredTempCondition_Met | string / controlled vocabulary | true | Температурный профиль/MKT; параметр хранения, перевозки и стабильности. |
| 17 | TransportMethod | string / controlled vocabulary | Courier | Метод или технологический подход; контролируемое справочное значение. |
| 18 | MTA_Required | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | MTA_Executed | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 20 | ExportLicense_Required | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 21 | ExportLicense_Valid | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 22 | ChainOfCustody_Complete | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 23 | InformedConsent_TransferOK | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 24 | SLA_Active | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 25 | SLA_TAT_Hours | integer / decimal | 120 | Временной параметр процесса, инкубации, хранения или анализа. |
| 26 | PriorityCompatible_WithSLA | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 27 | IsCrossBorder | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 28 | OriginCountry | string / controlled vocabulary | US | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 29 | DestinationCountry | string / controlled vocabulary | US | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 30 | CustomsDocumentation_Complete | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
SampleID,PatientID,OrderedTest,Priority,SampleType,OriginSite,DestinationSite,AlternateSite,DestinationSite_TestAvailable,DestinationSite_SampleTypeAccepted,DestinationSite_CapacityAvailable,DestinationSite_AccreditedForTest,EstimatedTransit_Hours,MaxAllowableTransit_Hours,TemperatureControl_Available,RequiredTempCondition_Met,TransportMethod,MTA_Required,MTA_Executed,ExportLicense_Required,ExportLicense_Valid,ChainOfCustody_Complete,InformedConsent_TransferOK,SLA_Active,SLA_TAT_Hours,PriorityCompatible_WithSLA,IsCrossBorder,OriginCountry,DestinationCountry,CustomsDocumentation_Complete
ROUTE-2026-001,PAT-042,NSCLC_CGP_Panel,STAT,FFPE,Hospital_A,RefLab_Central,RefLab_East,true,true,true,true,4,24,true,true,Courier,false,false,false,false,true,true,true,120,true,false,US,US,false
ROUTE-2026-002,PAT-055,WES_Germline,Routine,Whole_Blood,Clinic_B,RegionalLab_West,RefLab_Central,false,true,true,false,36,24,true,true,Mail,true,false,false,false,true,true,true,168,true,false,US,US,false
ROUTE-2026-003,PAT-061,MRD_Personalized,Routine,Plasma,Hospital_DE,RefLab_US,RefLab_UK,true,true,true,true,18,48,true,true,Courier,true,true,true,true,true,true,true,168,true,true,DE,US,true
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | SampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | PatientID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | OrderedTest | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | Priority | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | SampleType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | OriginSite | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | DestinationSite | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | AlternateSite | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | DestinationSite_TestAvailable | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | DestinationSite_SampleTypeAccepted | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | DestinationSite_CapacityAvailable | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | DestinationSite_AccreditedForTest | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | EstimatedTransit_Hours | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | MaxAllowableTransit_Hours | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | TemperatureControl_Available | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | RequiredTempCondition_Met | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | TransportMethod | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | MTA_Required | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | MTA_Executed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | ExportLicense_Required | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | ExportLicense_Valid | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | ChainOfCustody_Complete | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | InformedConsent_TransferOK | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | SLA_Active | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | SLA_TAT_Hours | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-026 | PriorityCompatible_WithSLA | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-027 | IsCrossBorder | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-028 | OriginCountry | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-029 | DestinationCountry | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-030 | CustomsDocumentation_Complete | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для Network Lab Sample Routing 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": "networklabsampleroutingchecker",
"utilityFolder": "NetworkLabSampleRoutingChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "SampleID",
"value": "ROUTE-2026-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "PatientID",
"value": "PAT-042",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "OrderedTest",
"value": "NSCLC_CGP_Panel",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "Priority",
"value": "STAT",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "SampleType",
"value": "FFPE",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "OriginSite",
"value": "Hospital_A",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "DestinationSite",
"value": "RefLab_Central",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "AlternateSite",
"value": "RefLab_East",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "DestinationSite_TestAvailable",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "DestinationSite_SampleTypeAccepted",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "DestinationSite_CapacityAvailable",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "DestinationSite_AccreditedForTest",
"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": "NetworkLabSampleRoutingChecker.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 и утверждёнными процедурами.