URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты OncoBEAMRasCrcMutationChecker для сценария OncoBEAM RAS CRC Mutation Checker.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- КОМПАРТМЕНТАЛИЗАЦИЯ (КРИТИЧЕСКИЕ ПАРАМЕТРЫ BEAMING):
- • Total Droplets ≥ 50,000: Статистическая мощность для детекции редких аллелей.
- • Lambda ≤ 0.3: Среднее число молекул на каплю. Превышение нарушает предположение Пуассона.
- • Empty Droplets ≥ 70%: Подтверждение режима одиночных молекул.
- • Multiple Occupancy ≤ 5%: Доля капель с >1 молекулой. Высокий % = перегрузка.
- • Signal-to-Noise Ratio ≥ 10: Различимость мутантного сигнала от фона.
- • Fluorescence Separation Index ≥ 5.0: Расстояние между мутантным и WT кластерами.
- • Rain Fraction ≤ 2.0%: Доля промежуточных событий. Высокий rain = проблема зондов или амплификации.
- • Positive Control Recovery ≥ 80%: Подтверждение эффективности эмульсии и детекции.
- • Negative Control FP Rate ≤ 0.01%: Специфичность ассая.
- • Input DNA ≥ 5 ng: Достаточность материала для cfDNA/FFPE.
- • Amplifiable DNA Fraction ≥ 10%: Качество матрицы (особенно критично для FFPE).
- ⚠️ ВАЖНО:
- • Lambda > 0.3 = КОЛИЧЕСТВЕННЫЙ РЕЗУЛЬТАТ НЕВАЛИДЕН. Перегрузка эмульсии.
- • Единичные позитивные капли (<3) при VAF около LOD требуют подтверждения.
- • RAS-статус определяет выбор ПЕРВОЙ ЛИНИИ терапии в метастатическом CRC.
- 1. Lambda Optimization: Титруйте входную ДНК для достижения λ ≤ 0.3. Лучше меньше, чем больше.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для OncoBEAM RAS CRC Mutation 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 | OB-CRC-2026-001 | Идентификатор образца или лабораторной пробы. |
| 2 | PatientID | string / controlled vocabulary | PAT-CRC-042 | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | Gene | string / controlled vocabulary | KRAS | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | Exon | string / controlled vocabulary | Exon2 | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | SpecificMutation | string / controlled vocabulary | G12D | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | SampleType | string / controlled vocabulary | Plasma_cfDNA | Идентификатор образца или лабораторной пробы. |
| 7 | TotalDroplets_Analyzed | decimal | 125000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | MinTotalDroplets | decimal | 50000 | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | PositiveDroplets_Count | integer / decimal | 375 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 10 | WildTypeDroplets_Count | integer / decimal | 124625 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 11 | MutantFraction_Percent | decimal | 0.30 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | AssayLOD_Percent | decimal | 0.02 | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | AssayLOQ_Percent | decimal | 0.05 | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | Lambda_Value | decimal | 0.15 | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | MaxLambda | decimal | 0.3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | EmptyDroplet_Percent | decimal | 86.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | MinEmptyDroplet_Percent | decimal | 70 | Контролируемый входной параметр для детерминированных QC-правил. |
| 18 | MultipleOccupancy_Percent | decimal | 1.2 | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | MaxMultipleOccupancy_Percent | decimal | 5 | Контролируемый входной параметр для детерминированных QC-правил. |
| 20 | SignalToNoise_Ratio | decimal | 45.0 | Отношение компонентов; структурный или рецептурный CQA. |
| 21 | MinSignalToNoise | decimal | 10 | Контролируемый входной параметр для детерминированных QC-правил. |
| 22 | FluorescenceSeparation_Index | decimal | 12.5 | Отношение компонентов; структурный или рецептурный CQA. |
| 23 | MinFluorSeparation | integer / decimal | 5.0 | Отношение компонентов; структурный или рецептурный CQA. |
| 24 | RainEvents_Detected | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 25 | RainFraction_Percent | decimal | 0.3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 26 | MaxRainFraction_Percent | decimal | 2.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 27 | PositiveControl_Pass | string / controlled vocabulary | true | Контрольная точка/контрольный образец для валидности серии анализа. |
| 28 | PosControl_Recovery_Percent | decimal | 95.0 | Восстановление/извлечение; показатель валидности анализа. |
| 29 | MinPosControl_Recovery | decimal | 80 | Восстановление/извлечение; показатель валидности анализа. |
| 30 | NegativeControl_Pass | string / controlled vocabulary | true | Контрольная точка/контрольный образец для валидности серии анализа. |
| 31 | NegControl_FalsePositive_Rate | string / controlled vocabulary | 0.002 | Контрольная точка/контрольный образец для валидности серии анализа. |
| 32 | MaxNegControl_FP_Rate | string / controlled vocabulary | 0.01 | Контрольная точка/контрольный образец для валидности серии анализа. |
| 33 | NoTemplateControl_Pass | string / controlled vocabulary | true | Температурный профиль/MKT; параметр хранения, перевозки и стабильности. |
| 34 | InputDNA_ng | decimal | 25.0 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 35 | MinInputDNA_ng | decimal | 5 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 36 | AmplifiableDNA_Fraction | integer / decimal | 0.45 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 37 | MinAmplifiableDNA_Fraction | integer / decimal | 0.1 | Биологический/молекулярный компонент, контролируемый как CQA. |
| 38 | IsAntiEGFR_Eligible | string / controlled vocabulary | false | Контролируемый входной параметр для детерминированных QC-правил. |
| 39 | ClinicalInterpretation | string / controlled vocabulary | KRAS G12D mutant. Anti-EGFR therapy NOT recommended. | Контролируемый входной параметр для детерминированных QC-правил. |
SampleID,PatientID,Gene,Exon,SpecificMutation,SampleType,TotalDroplets_Analyzed,MinTotalDroplets,PositiveDroplets_Count,WildTypeDroplets_Count,MutantFraction_Percent,AssayLOD_Percent,AssayLOQ_Percent,Lambda_Value,MaxLambda,EmptyDroplet_Percent,MinEmptyDroplet_Percent,MultipleOccupancy_Percent,MaxMultipleOccupancy_Percent,SignalToNoise_Ratio,MinSignalToNoise,FluorescenceSeparation_Index,MinFluorSeparation,RainEvents_Detected,RainFraction_Percent,MaxRainFraction_Percent,PositiveControl_Pass,PosControl_Recovery_Percent,MinPosControl_Recovery,NegativeControl_Pass,NegControl_FalsePositive_Rate,MaxNegControl_FP_Rate,NoTemplateControl_Pass,InputDNA_ng,MinInputDNA_ng,AmplifiableDNA_Fraction,MinAmplifiableDNA_Fraction,IsAntiEGFR_Eligible,ClinicalInterpretation
OB-CRC-2026-001,PAT-CRC-042,KRAS,Exon2,G12D,Plasma_cfDNA,125000,50000,375,124625,0.30,0.02,0.05,0.15,0.3,86.0,70,1.2,5,45.0,10,12.5,5.0,false,0.3,2.0,true,95.0,80,true,0.002,0.01,true,25.0,5,0.45,0.1,false,KRAS G12D mutant. Anti-EGFR therapy NOT recommended.
OB-CRC-2026-002,PAT-CRC-055,NRAS,Exon3,Q61H,FFPE_Tissue,62000,50000,18,61982,0.03,0.02,0.05,0.45,0.3,63.5,70,8.5,5,6.0,10,3.2,5.0,true,4.5,2.0,true,72.0,80,true,0.008,0.01,true,8.0,5,0.08,0.1,false,NRAS Q61H detected but QC concerns.
OB-CRC-2026-003,PAT-CRC-061,KRAS,Exon2,None,Plasma_cfDNA,150000,50000,2,149998,0.001,0.02,0.05,0.12,0.3,88.7,70,0.8,5,52.0,10,14.0,5.0,false,0.1,2.0,true,98.0,80,true,0.001,0.01,true,30.0,5,0.52,0.1,true,KRAS Exon2 WT. Anti-EGFR therapy may be considered.
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | SampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | PatientID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | Gene | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | Exon | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | SpecificMutation | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | SampleType | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | TotalDroplets_Analyzed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | MinTotalDroplets | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | PositiveDroplets_Count | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | WildTypeDroplets_Count | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | MutantFraction_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | AssayLOD_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | AssayLOQ_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | Lambda_Value | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | MaxLambda | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | EmptyDroplet_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | MinEmptyDroplet_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | MultipleOccupancy_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | MaxMultipleOccupancy_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | SignalToNoise_Ratio | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | MinSignalToNoise | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | FluorescenceSeparation_Index | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | MinFluorSeparation | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | RainEvents_Detected | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | RainFraction_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-026 | MaxRainFraction_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-027 | PositiveControl_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-028 | PosControl_Recovery_Percent | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-029 | MinPosControl_Recovery | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-030 | NegativeControl_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-031 | NegControl_FalsePositive_Rate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-032 | MaxNegControl_FP_Rate | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-033 | NoTemplateControl_Pass | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-034 | InputDNA_ng | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-035 | MinInputDNA_ng | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-036 | AmplifiableDNA_Fraction | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-037 | MinAmplifiableDNA_Fraction | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-038 | IsAntiEGFR_Eligible | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-039 | ClinicalInterpretation | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для OncoBEAM RAS CRC Mutation 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": "oncobeamrascrcmutationchecker",
"utilityFolder": "OncoBEAMRasCrcMutationChecker",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "SampleID",
"value": "OB-CRC-2026-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "PatientID",
"value": "PAT-CRC-042",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "Gene",
"value": "KRAS",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "Exon",
"value": "Exon2",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "SpecificMutation",
"value": "G12D",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "SampleType",
"value": "Plasma_cfDNA",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "TotalDroplets_Analyzed",
"value": "125000",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "MinTotalDroplets",
"value": "50000",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "PositiveDroplets_Count",
"value": "375",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "WildTypeDroplets_Count",
"value": "124625",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "MutantFraction_Percent",
"value": "0.30",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "AssayLOD_Percent",
"value": "0.02",
"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": "OncoBEAMRasCrcMutationChecker.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 и утверждёнными процедурами.