Перейти до основного вмісту
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. Див. Повторні читання.

Відповіді з помилками