Перейти к основному содержанию
GET
Получить список записей на забор крови. Каждая запись включает встроенный профиль пациента. Фильтры комбинируются:
  • date возвращает записи за один календарный день. День определяется по местному времени локации каждой записи, поэтому забор крови в 23:30 в Берлине относится к берлинской дате.
  • location_id возвращает записи в одной локации для сдачи анализов.
  • profile_id без date возвращает все записи для этого профиля без ограничения по времени.
  • Без profile_id и date действует временное окно по умолчанию: от 2 месяцев назад до 1 месяца вперёд.
Требуется право доступа appointments_view или appointments_schedule.

Запрос

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

string
Фильтр по UUID профиля. Если указан, возвращаются все записи для этого профиля независимо от даты записи. Если не указан, действует временное окно по умолчанию.
string
Фильтр по UUID локации для сдачи анализов.
string
Календарный день в формате YYYY-MM-DD в часовом поясе локации каждой записи. Заменяет временное окно по умолчанию. Результаты сортируются по scheduled_at, начиная с самых ранних.

Ответ

При успехе API возвращает 200 OK с массивом объектов записей.
string
обязательно
Уникальный идентификатор записи (UUID).
string
обязательно
UUID профиля, к которому относится эта запись.
string
UUID локации для сдачи анализов, где проходит забор крови.
string
Запланированные дата и время записи в UTC (ISO 8601 с суффиксом Z, например, 2026-05-15T10:30:00Z). Может быть null.
string
обязательно
Текущий статус записи. Одно из значений: pending, confirmed, blood_drawn или cancelled. Детали готовности лабораторных результатов можно получить в Получить результаты, а подробный ход доставки — из каждого элемента встроенного массива shipments (см. ниже) с переходом в Получить отправку.
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.

Повторные вызовы

Aniva хранит ответ этого эндпоинта 5 минут для каждого API-ключа. Повторный запрос в течение этого времени получает сохранённый ответ. Заголовки Cache-Status и Age показывают, что ответ сохранён, и как давно он получен. Чтобы узнавать об изменениях сразу, подпишись на события вебхуков appointment.created, appointment.rescheduled и событие каждого статуса, например appointment.confirmed. См. Повторные чтения.

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