Extractor Format
Требования к протоколу

Требования к протоколу

UID:
EXT-SCN
VERSION:
1
CLASSIFICATION:
PREFIX:
Type
Level
MID
UID
PREFIX
STATUS
CANCEL_REASON
TAGS
REFS
Title
Statement
Rationale
Comment
TEXT
40928a59791a469c8b574a4a9da0d7de

Термины:

  • Протокол выделения нуклеиновых кислот (далее — протокол) — машиночитаемое описание автоматизированной процедуры выделения как последовательности шагов, состава компонентов и технологических параметров. Протокол не описывает механику конкретного прибора.
  • Лабораторная операция — имеющая биологический смысл часть процедуры, например лизис, связывание, промывка, сушка или элюция. Операция определяет цель, но не способ её выполнения прибором.
  • Шаг протокола — одно параметризованное технологическое действие из набора, поддерживаемого исполнителем. Одна лабораторная операция может состоять из нескольких шагов протокола.
  • Тип шага — стабильный идентификатор действия в поле kind, который определяет состав параметров и исполнительную семантику шага.
  • Исполнитель — внешняя по отношению к формату система, которая проверяет протокол и преобразует его шаги в команды конкретному прибору.
  • Запись выполнения — фактические данные отдельного запуска, включая время, измерения, предупреждения, ошибки и результат. Запись выполнения не является частью протокола.

Протокол содержит идентификатор, ревизию документа, ссылку на схему, название, описание и упорядоченную последовательность шагов. Каждый расходник протокола имеет локальный идентификатор, назначение, место и ссылку на модель. Планшет содержит описание состава одной типовой лунки. Состав включает названия компонентов, роли при необходимости и объёмы. Описание предполагает одинаковое содержимое всех рабочих лунок. Оно не утверждает, что все лунки заняты.

SECTION
1
4926d55a17384092ae34eb48cb2e7d57
SECTION-ТКП-Общие-данные
SCN-
SECTION-ТКП-Общие-данные
Общие данные
REQUIREMENT
9ec8fa746e2a4bdda2bb1f34bc15e078
SCN-001
ACTIVE

Храните ссылку на схему в объекте schema отдельно от ревизии протокола (as in [LINK: VER-001]).

REQUIREMENT
b7cf972e8934459a816f37840df458ee
SCN-002
ACTIVE

Храните даты в формате RFC 3339.

REQUIREMENT
651df63b92af4f278e6e0474c8baa9ac
SCN-003
ACTIVE

Запрещайте неизвестные обязательные типы шагов.

REQUIREMENT
bccbd0c41027459c9c53dc2e7aa9db80
SCN-004
ACTIVE

Разрешайте чтение неизвестных необязательных метаданных.

REQUIREMENT
ca6b3c33e9234e63a98afa1b11793884
SCN-005
ACTIVE

Определите обязательность каждого поля через JSON Schema.

SECTION
2
68f93061fa91412aa367a6b689f6f9a3
SECTION-ТКП-Device-requirements
SCN-
SECTION-ТКП-Device-requirements
Требования к устройству
REQUIREMENT
490582158ae24b96b8c0c1a16712159d
SCN-006
ACTIVE

Ссылайтесь на совместимую модель прибора по UUID и ревизии определения.

REQUIREMENT
e5414ed6a3784a9d8323d1ddef6d9ac2
SCN-007
ACTIVE

Указывайте требуемые возможности через required_capabilities.

REQUIREMENT
72d7b282323d44faa167669e5fe72456
SCN-008
ACTIVE

Не привязывайте протокол к серийному номеру прибора.

REQUIREMENT
5d510c01c3e249b099b2b6990faaf680
SCN-009
ACTIVE

Разрешайте ограничение минимальной версии исполнителя.

SECTION
3
b2dddea22d834ffd93edd408c067b961
LAB-
Расходники и раскладка
REQUIREMENT
73dd717bc6e94e89830531d651a28a16
LAB-001
ACTIVE

Объявляйте каждый расходник протокола один раз.

REQUIREMENT
1fddb524e3a348169ce71f4f56ecebb8
LAB-002
ACTIVE

Назначайте каждому расходнику протокола локальный идентификатор.

REQUIREMENT
8f32add4ae8941dcb5730d13a0ad42a9
LAB-003
ACTIVE

Ссылайтесь на модель расходника по UUID и ревизии определения.

REQUIREMENT
2df75fada71c4c4ba25358103da4ba45
LAB-004
ACTIVE

Назначайте расходник посадочному месту. Разрешайте назначать одному месту несколько расходников, используемых в разные моменты выполнения протокола.

Смена расходника во время выполнения относится к исполнителю. Шаг ссылается на используемый расходник, а не непосредственно на место.

REQUIREMENT
3d93f41667174be18a6cef7be43652c3
LAB-005
ACTIVE

Проверяйте наличие каждого выбранного планшета в списке supported_plates модели прибора.

REQUIREMENT
50b631dc986e4c998eae01ebe092d2c0
LAB-006
ACTIVE

Проверяйте наличие каждого выбранного колпачка в списке supported_sleeves модели прибора.

REQUIREMENT
6e704b1f944e4615af8c30746902bd49
LAB-007
ACTIVE

Указывайте назначение расходника в протоколе.

Допустимые назначения первой версии:

  • sleeve_storage;
  • sample_input;
  • lysis;
  • wash;
  • elution;
  • waste;
  • intermediate.
SECTION
4
c9c40ec320c34578b3d88323cda87ccb
REA-
Реагенты
REQUIREMENT
83893298073f4f7baa9b83fdcef97919
REA-001
ACTIVE

Проверяйте наличие определения каждого компонента, на который ссылается состав наполнения

Порядок полей JSON не влияет на ссылки. Определение может находиться внутри протокола.

REQUIREMENT
60fa208a0e584b5b9dc106026e95c9ad
REA-002
ACTIVE

Указывайте объём на одну лунку.

REQUIREMENT
c18eef11fb3d4fab8503ef47f62e9ae7
REA-003
ACTIVE

Сравнивайте сумму объёмов компонентов одной лунки с максимальным рабочим объёмом для совместимого планшета.

REQUIREMENT
ea5584a5fb82426eacf9201ec5ffb061
REA-004
ACTIVE

Храните цвет только как редакторскую подсказку.

REQUIREMENT
68bfe0494e634b198b76e37278e1edc3
REA-005
ACTIVE

Не используйте цвет для исполнительной логики.

SECTION
5
f596aca2931e4d3983c59197eec16607
STEP-
Последовательность шагов
REQUIREMENT
96d4902b002d491b930fd8a05ce4f384
STEP-001
ACTIVE

Представляйте протокол упорядоченным массивом шагов.

REQUIREMENT
992640ef4fce4c6bbab824494f36f570
STEP-002
ACTIVE

Назначайте каждому шагу уникальный UUIDv4, не зависящий от названия, типа и положения шага в последовательности.

REQUIREMENT
c91f7fe4f9924b639dcf73689415f272
STEP-003
ACTIVE

Указывайте тип шага через поле kind.

REQUIREMENT
5442783bd4c54b0dbd17ce392f6c7188
STEP-004
ACTIVE

Связывайте технологический шаг с расходником через ссылку.

REQUIREMENT
052fad4b9abd40aba0e480df2619fe73
STEP-005
ACTIVE

Не связывайте шаг напрямую с посадочным местом.

REQUIREMENT
41e8cd4777134b2e95c2af1812e31e94
STEP-006
ACTIVE

Не храните координаты осей в технологическом шаге.

REQUIREMENT
a7b0d82d64a646b6b93a5eac0919ca07
STEP-007
ACTIVE

Не храните номера двигателей в технологическом шаге.

REQUIREMENT
45a390c118964c7fb6850313ef947f4c
STEP-008
ACTIVE

Указывайте ограниченный тайм-аут для ожидающих шагов.

REQUIREMENT
2d56fadd6fe549c3ae55514bc7fb3507
STEP-009
ACTIVE

Указывайте допустимую политику ошибки через перечисление.

Политика первой версии должна поддерживать abort и operator_decision.

SECTION
6
a6cc387124d549fab2cec4f116573d31
STEP-
Типы шагов
TEXT
ccbcf8d845e04a09af092238537a9aa3
Типы шагов протокола
kind Назначение
collect_sleeves Захват рамки защитных колпачков
release_sleeves Возврат или сброс рамки защитных колпачков
set_temperature Установка целевой температуры нагревателя выбранного расходника
wait_temperature Ожидание достижения целевой температуры
mix Перемешивание содержимого выбранного планшета
collect_beads Сбор магнитных частиц на защитных колпачках
release_beads Высвобождение магнитных частиц в выбранном планшете
SECTION
6.1
420a3248810947a78342e86a23421509
MIX-
Перемешивание
REQUIREMENT
8278fde0b2004b0cb95bfc05630ce26f
MIX-001
ACTIVE

Указывайте число повторов целым положительным значением.

REQUIREMENT
89482c61103d47549306006e22231f91
MIX-002
ACTIVE

Описывайте перемешивание массивом стадий.

REQUIREMENT
77629cc3beab41e6b28090c77e0888bb
MIX-003
ACTIVE

Указывайте амплитуду в миллиметрах.

REQUIREMENT
f8587f2b8c244f778525cc18711824b6
MIX-004
ACTIVE

Указывайте скорость в миллиметрах в минуту.

REQUIREMENT
b678ccc8aaaf4eb98b6dbf83b2033248
MIX-005
ACTIVE

Указывайте длительность или число циклов.

REQUIREMENT
3f235c09e393435f885d8a37d14d099e
MIX-006
ACTIVE

Запрещайте одновременное указание двух режимов завершения.

REQUIREMENT
7624138e11314ea48d2a603307606817
MIX-007
ACTIVE

Описывайте исходное положение колпачка относительно дна лунки или расчётного уровня жидкости.

Уровень жидкости относится к состоянию без колпачка. Максимальный рабочий объём не определяет уровень после погружения.

Примеры положений: above_liquid, liquid_surface, liquid_middle, well_bottom_offset.

REQUIREMENT
1b733d3d2cf54ac0a7b220f5fd1c4e00
MIX-008
ACTIVE

Определите единицы и допустимый диапазон амплитуды.

Расчёт фактической траектории выполняет внешняя система.

REQUIREMENT
3072e0619c214b91afac0df47897e7b3
MIX-009
ACTIVE

Определите допустимый диапазон технологической скорости по справочнику модели прибора.

REQUIREMENT
8245388f25f54b95a6d94dd6bafe2169
MIX-010
ACTIVE

Указывайте лабораторное назначение перемешивания в поле purpose одним из значений lysis, wash, drying, elution или custom.

SECTION
6.2
2ca67f742d114375861e155c64347482
MAG-
Перенос магнитных частиц
REQUIREMENT
4f50c3d02aad4d45ae4b8f3087deca1f
MAG-001
ACTIVE

Связывайте сбор и высвобождение магнитных частиц с целевым планшетом.

REQUIREMENT
0d0f80f091a34274b38bfec8f36536c1
MAG-002
ACTIVE

Для сбора магнитных частиц указывайте положительное целое число циклов и положительную длительность удержания в секундах.

REQUIREMENT
57c1bb3146034decad9d4624b9d5e700
MAG-003
ACTIVE

Для высвобождения магнитных частиц указывайте исходное положение колпачка и положительную длительность в секундах.

SECTION
6.3
29f2f61c8c984d0e8e5219c6eafbd9a5
HEAT-
Нагрев
REQUIREMENT
2a909ecb19674f2e898199eb66188562
HEAT-001
ACTIVE

Связывайте нагрев с целевым расходником.

REQUIREMENT
f6583c54ee5e4c289eeac55393f15f62
HEAT-002
ACTIVE

Определяйте нагреватель через посадочное место.

REQUIREMENT
5672aad1e9654f10a48a5d1221e5689f
HEAT-003
ACTIVE

Проверяйте наличие нагревателя у места.

REQUIREMENT
ba2035a4d13b4e19bd72f1b3d82ef501
HEAT-004
ACTIVE

Проверяйте температуру по безопасному диапазону прибора.

REQUIREMENT
a9a482a347594b78b0adf6f925c037a7
HEAT-005
ACTIVE

Разделяйте установку температуры и ожидание температуры.

REQUIREMENT
481b0e34295643abaa4b8e227bb6ad03
HEAT-006
ACTIVE

Указывайте допустимое отклонение температуры.

REQUIREMENT
678008a564dd43a099a8ba92c37b6471
HEAT-007
ACTIVE

Указывайте тайм-аут ожидания.

REQUIREMENT
6cb82c5651c74d308ccc02b424da95ab
HEAT-008
ACTIVE

Определяйте действие нагревателя после завершения протокола.