URS & FS — спецификация пользователя и функциональная спецификация
Документ описывает контролируемый интерфейс и поведение утилиты SampleToInsightJsonBridge для сценария Sample-to-Insight JSON Bridge.
Предметные ограничения и критические параметры
Ниже приведены ключевые фрагменты исходного описания. Перед продуктивным применением пределы должны быть сверены с утверждённой спецификацией, регистрационным досье и локальными SOP.
- НОРМАЛИЗАЦИЯ ТЕРМИНОЛОГИИ:
- • ⚠ Ненормализованные термины нарушают интероперабельность.
- ⚠️ ВАЖНО:
- • Sample-to-Insight bridge — это КРИТИЧЕСКИЙ ПЕРЕХОД от данных к решениям.
- • Ненормализованная терминология делает инсайт несовместимым с EHR/CDSS.
- • KB enrichment failure не должен приводить к выдаче необогащенного инсайта без предупреждения.
- 2. Terminology Service: Используйте централизованный сервис нормализации (FHIR Terminology Server).
- 5. Audit Retention: Храните аудит трансформации ≥ срока хранения клинических результатов.
URS — пользовательские требования
| ID | Требование | Критичность | Критерий приемки |
|---|
| URS-001 | Утилита должна принимать файл input.csv для Sample-to-Insight JSON Bridge с заголовками, определёнными в контракте данных. | 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 | BRIDGE-2026-001 | Идентификатор образца или лабораторной пробы. |
| 2 | PatientID | string / controlled vocabulary | PAT-LUNG-042 | Контролируемый входной параметр для детерминированных QC-правил. |
| 3 | AssayName | string / controlled vocabulary | NSCLC_CGP | Контролируемый входной параметр для детерминированных QC-правил. |
| 4 | OutputFormat | string / controlled vocabulary | FHIR_Genomics | Контролируемый входной параметр для детерминированных QC-правил. |
| 5 | SchemaVersion | string / controlled vocabulary | 2.1.0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 6 | HasPreAnalyticalData | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 7 | HasSequencingMetrics | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 8 | HasVariantCalls | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 9 | HasInterpretationData | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 10 | HasClinicalContext | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 11 | MissingRequiredFields | decimal | 0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 12 | Variants_HGVS_Compliant | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 13 | Conditions_SNOMED_Coded | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 14 | Observations_LOINC_Coded | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 15 | Drugs_Normalized_INN | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 16 | Genes_HGNC_Symbols | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 17 | UnnormalizedTerms_Count | integer / decimal | 0 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 18 | ReportabilityRules_ConfigLoaded | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 19 | RulesApplied_Successfully | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 20 | VariantsEvaluated_ByRules | decimal | 45 | Контролируемый входной параметр для детерминированных QC-правил. |
| 21 | VariantsIncluded_InInsight | decimal | 3 | Контролируемый входной параметр для детерминированных QC-правил. |
| 22 | VariantsExcluded_ByRules | decimal | 42 | Контролируемый входной параметр для детерминированных QC-правил. |
| 23 | OncoKB_Annotation_Applied | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 24 | ClinVar_Annotation_Applied | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 25 | PharmGKB_Annotation_Applied | string / controlled vocabulary | true | pH; параметр стабильности, совместимости и пригодности серии. |
| 26 | ACMG_SF_Checked | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 27 | Annotations_Added | decimal | 28 | Контролируемый входной параметр для детерминированных QC-правил. |
| 28 | Annotations_Failed | decimal | 0 | Контролируемый входной параметр для детерминированных QC-правил. |
| 29 | NoDataLoss_DuringTransform | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 30 | NoSemanticDistortion | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 31 | UnitsPreserved | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 32 | RelationshipsMaintained | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 33 | IntegrityViolations_Count | integer / decimal | 0 | Счётный показатель; используется для микробиологического, частичного или клеточного контроля. |
| 34 | OutputJSON_SyntaxValid | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 35 | OutputJSON_SchemaValid | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 36 | FHIR_Profile_Compliant | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 37 | Required_FHIR_Resources_Present | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 38 | OutputSize_KB | decimal | 85.2 | Контролируемый входной параметр для детерминированных QC-правил. |
| 39 | TransformationSteps_Logged | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 40 | SourceReferences_Traceable | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 41 | RuleDecisions_Documented | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 42 | AnnotationSources_Cited | string / controlled vocabulary | true | Контролируемый входной параметр для детерминированных QC-правил. |
| 43 | PipelineVersion | string / controlled vocabulary | v4.2.1 | Контролируемый входной параметр для детерминированных QC-правил. |
| 44 | TransformTimestamp_Utc | string / controlled vocabulary | 2026-06-09T14:30:00Z | Временной параметр процесса, инкубации, хранения или анализа. |
SampleID,PatientID,AssayName,OutputFormat,SchemaVersion,HasPreAnalyticalData,HasSequencingMetrics,HasVariantCalls,HasInterpretationData,HasClinicalContext,MissingRequiredFields,Variants_HGVS_Compliant,Conditions_SNOMED_Coded,Observations_LOINC_Coded,Drugs_Normalized_INN,Genes_HGNC_Symbols,UnnormalizedTerms_Count,ReportabilityRules_ConfigLoaded,RulesApplied_Successfully,VariantsEvaluated_ByRules,VariantsIncluded_InInsight,VariantsExcluded_ByRules,OncoKB_Annotation_Applied,ClinVar_Annotation_Applied,PharmGKB_Annotation_Applied,ACMG_SF_Checked,Annotations_Added,Annotations_Failed,NoDataLoss_DuringTransform,NoSemanticDistortion,UnitsPreserved,RelationshipsMaintained,IntegrityViolations_Count,OutputJSON_SyntaxValid,OutputJSON_SchemaValid,FHIR_Profile_Compliant,Required_FHIR_Resources_Present,OutputSize_KB,TransformationSteps_Logged,SourceReferences_Traceable,RuleDecisions_Documented,AnnotationSources_Cited,PipelineVersion,TransformTimestamp_Utc
BRIDGE-2026-001,PAT-LUNG-042,NSCLC_CGP,FHIR_Genomics,2.1.0,true,true,true,true,true,0,true,true,true,true,true,0,true,true,45,3,42,true,true,true,true,28,0,true,true,true,true,0,true,true,true,true,85.2,true,true,true,true,v4.2.1,2026-06-09T14:30:00Z
BRIDGE-2026-002,PAT-CRC-055,CRC_Panel,FHIR_Genomics,2.1.0,true,true,true,false,true,5,true,false,true,false,true,8,true,false,32,0,0,true,false,false,false,12,7,false,false,true,false,4,false,false,false,false,42.1,true,false,false,false,v4.2.1,2026-06-09T15:10:00Z
Правила валидации входных данных
| ID | Поле | Правило | Критичность |
|---|
| VR-001 | SampleID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-002 | PatientID | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-003 | AssayName | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | High |
| VR-004 | OutputFormat | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-005 | SchemaVersion | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-006 | HasPreAnalyticalData | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-007 | HasSequencingMetrics | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-008 | HasVariantCalls | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-009 | HasInterpretationData | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-010 | HasClinicalContext | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-011 | MissingRequiredFields | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-012 | Variants_HGVS_Compliant | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-013 | Conditions_SNOMED_Coded | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-014 | Observations_LOINC_Coded | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-015 | Drugs_Normalized_INN | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-016 | Genes_HGNC_Symbols | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-017 | UnnormalizedTerms_Count | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-018 | ReportabilityRules_ConfigLoaded | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-019 | RulesApplied_Successfully | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-020 | VariantsEvaluated_ByRules | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-021 | VariantsIncluded_InInsight | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-022 | VariantsExcluded_ByRules | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-023 | OncoKB_Annotation_Applied | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-024 | ClinVar_Annotation_Applied | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-025 | PharmGKB_Annotation_Applied | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-026 | ACMG_SF_Checked | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-027 | Annotations_Added | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-028 | Annotations_Failed | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-029 | NoDataLoss_DuringTransform | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-030 | NoSemanticDistortion | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-031 | UnitsPreserved | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-032 | RelationshipsMaintained | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-033 | IntegrityViolations_Count | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-034 | OutputJSON_SyntaxValid | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-035 | OutputJSON_SchemaValid | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-036 | FHIR_Profile_Compliant | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-037 | Required_FHIR_Resources_Present | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-038 | OutputSize_KB | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-039 | TransformationSteps_Logged | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-040 | SourceReferences_Traceable | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-041 | RuleDecisions_Documented | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-042 | AnnotationSources_Cited | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-043 | PipelineVersion | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | Medium |
| VR-044 | TransformTimestamp_Utc | Поле должно соответствовать утверждённому справочнику/словарю или допустимой строковой форме. | 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 | Применить правила для Sample-to-Insight JSON Bridge, включая критические пределы из описания и утверждённой спецификации. |
| 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": "sampletoinsightjsonbridge",
"utilityFolder": "SampleToInsightJsonBridge",
"package": "LiquidBiopsy",
"overallStatus": "PASS|WARNING|FAIL",
"sourceFile": "input.csv",
"processedAtUtc": "2026-06-10T00:00:00Z",
"checks": [
{
"parameter": "SampleID",
"value": "BRIDGE-2026-001",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-001"
},
{
"parameter": "PatientID",
"value": "PAT-LUNG-042",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-002"
},
{
"parameter": "AssayName",
"value": "NSCLC_CGP",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-003"
},
{
"parameter": "OutputFormat",
"value": "FHIR_Genomics",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-004"
},
{
"parameter": "SchemaVersion",
"value": "2.1.0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-005"
},
{
"parameter": "HasPreAnalyticalData",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-006"
},
{
"parameter": "HasSequencingMetrics",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-007"
},
{
"parameter": "HasVariantCalls",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-008"
},
{
"parameter": "HasInterpretationData",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-009"
},
{
"parameter": "HasClinicalContext",
"value": "true",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-010"
},
{
"parameter": "MissingRequiredFields",
"value": "0",
"status": "PASS|WARNING|FAIL",
"message": "Deterministic rule-based check result",
"ruleReference": "FS-RULE-011"
},
{
"parameter": "Variants_HGVS_Compliant",
"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": "SampleToInsightJsonBridge.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 и утверждёнными процедурами.