Перейти к основному содержанию
DELETE
Отмени запись, установив для неё статус cancelled. Отменить можно только те записи, у которых ещё не подтверждён забор крови. Отмена записи, которая уже находится в статусе cancelled, возвращает 200 с этой записью и ничего не записывает — повторная отмена не фиксируется. В ответе передаётся Idempotent-Replayed: true, так ты сможешь отличить повторный запрос от вызова, который выполнил действие. Повторный запрос с другим значением cancellation_reason вместо этого возвращает 409: записанная причина никогда не перезаписывается. См. Идемпотентность.
Запись нельзя отменить после подтверждения забора крови — в этом случае вернётся 409 Conflict.
Требуется область доступа appointments_schedule или appointments_manage.

Запрос

Параметры пути

string
обязательно
Уникальный идентификатор (UUID) записи для отмены.

Параметры тела запроса

Тело запроса необязательно — не отправляй его вовсе, чтобы отменить запись без указания причины.
string
Причина отмены в свободной форме, до 500 символов (например, Patient no-show). Сохраняется в записи и возвращается в поле cancellation_reason в этом и последующих запросах.

Ответ

При успешном выполнении API возвращает 200 OK с отменённой записью и вложенным в неё профилем.
string
обязательно
Уникальный идентификатор записи (UUID).
string
обязательно
UUID профиля, к которому относится эта запись.
string
UUID локации для сдачи анализов, где проходит забор крови.
string
Запланированные дата и время записи в UTC (ISO 8601 с суффиксом Z, например, 2026-05-15T10:30:00Z). Может быть null.
string
обязательно
Статус записи. После успешной отмены принимает значение cancelled.
string
Причина в свободной форме, указанная при отмене записи (например, неявка, поздняя отмена, «Не удалось. Требуется повтор»). Имеет значение null, если status не равен cancelled.
string[]
обязательно
Адреса в нижнем регистре, на каждый из которых приходит одно письмо, когда все результаты лаборатории готовы. Пустой список, если отключено. См. Письма о готовности результатов.
string
обязательно
Способ забора крови: capillary (из пальца или плеча в микротейнеры) или venous (из вены в пробирки). Используется способ, заданный для записи, иначе default_draw_method её локации. После забора крови здесь указан фактически использованный способ.
string
обязательно
Временная метка создания записи в формате ISO 8601.
string
Временная метка последнего обновления в формате ISO 8601. Может быть null.
object
обязательно
Профиль пациента, связанный с этой записью.
AppointmentPanel[]
обязательно
Панели, прикреплённые к этой записи до отмены. Посмотри подробности о панели (название, биомаркеры) через Список панелей.
AppointmentIndividualBiomarker[]
обязательно
Отдельные биомаркеры, прикреплённые к этой записи вне какой-либо панели (см. Добавить отдельные биомаркеры). Сверь каждый biomarker_id со Списком биомаркеров, чтобы получить данные для отображения.
AppointmentShipmentLink[]
обязательно
Отправки, привязанные к этой записи до отмены. Каждый id можно сверить через Получить отправку.
string[]
обязательно
Лабораторные коды (штрихкоды пробирок), записанные для этой записи, в порядке сканирования. Список пуст, пока забор крови не подтверждён. При венозном заборе один код напечатан на каждой пробирке; при капиллярном — свой код на каждом микротейнере. Результаты и документы в Получить результаты ссылаются на эти коды через lab_code.

Ответы с ошибками