Названия контейнеров в предпросмотре записи станут торговыми названиями
Со следующего релизаcontainers[].name в предпросмотре записи
будет содержать торговое название пробирки. type не меняется, поэтому читай type, если твоё приложение сравнивает контейнеры.Aniva теперь работает на всех языках ЕС и ещё нескольких
- Админ-панель, сайт, справочный центр и документация: на всех 32 языках.
- Профили: задай язык для каждого пациента. Страница результатов и письма с результатами используют этот язык.
Один эндпоинт для списка панелей
- Список панелей теперь возвращает
biomarker_groups. Используй его вместо/api/v2/panels. - Создание панели удалено. Используй админ-панель.
Показывай результаты анализов в своём приложении
Твои пациенты теперь могут видеть свои результаты анализов в твоём приложении: список биомаркеров, динамику каждого биомаркера и 3D Twin с оценкой по каждой сфере здоровья. Страница использует цвет твоего бренда и твой логотип в светлой или тёмной теме.Страница результатов — платное дополнение, а твой контакт в Aniva подскажет цену. Создание сессии встраивания показывает, как её настроить.Запросы списков в API кешируются до 5 минут
Эти четыре эндпоинта теперь кешируют ответ до 5 минут, поэтому изменения могут отображаться с задержкой до 5 минут:ЭндпоинтыGet по-прежнему показывают изменения сразу.Если ты опрашиваешь API для поиска изменений, используй вместо этого вебхуки.
Вебхук сообщает тебе о каждом изменении сразу, как только оно происходит. См.
Повторные запросы.Диапазоны Aniva теперь доступны
Твои результаты теперь могут включать диапазоны Aniva: общий диапазон и более узкий диапазон для каждого биомаркера, вместе с источниками, которые зафиксировала Aniva. Диапазоны различаются по возрасту, полу и неделе беременности.Чтобы получить доступ, подпиши короткое соглашение о диапазонах Aniva. Затем мы включим их для твоего API-ключа. Запроси соглашение у своего контакта в Aniva.Диапазоны находятся в новом полеaniva_range. Оно заменяет reference_range_aniva, которое
всегда было null. Диапазоны — это общая информация. Они не оценивают результат и не
являются медицинской рекомендацией или медицинским изделием. Стандартом остаётся диапазон лаборатории. См.
Диапазоны Aniva.Пробирка с фторидом теперь fluoride
Предпросмотр контейнеров называет пробирку с фторидом fluoride.
Старое значение было naf. Если твой код сравнивает container.type с naf, замени его на
fluoride.Могут появиться два новых значения: lihep_capillary и fluoride_capillary. Это капиллярная
пробирка с литий-гепарином и капиллярная пробирка с фторидом.Больше никаких двойных записей на последний слот
Если две записи на последнее место в слоте приходят одновременно, проходит только одна. Другая получает409, как и для любого заполненного слота. То же самое происходит, если запись меняют во время
её отмены или подтверждения.У Подтверждения забора крови три новые причины для 409:remapped: код теперь сопоставлен с другими панелями, чем раньше.sent_to_labиorder_in_flight: заказ уже может быть в лаборатории, поэтому код должен оставаться на своей пробирке.
Более строгие требования к адресам доставки в заказах наборов для домашнего теста
Создание набора для домашнего теста и Обновление набора для домашнего теста строже проверяютdelivery_address.country_codeпринимает строчные буквы, напримерde. Aniva сохраняет и возвращает его в верхнем регистре.- Для немецкого адреса (
DE) нуженpostal_codeровно из 5 цифр. При других значениях возвращается400. - Пробелы в начале и конце
postal_codeудаляются перед сохранением.
Новый набор вместо отправленного обратно
Когда служба доставки отправляет набор обратно к нам, мы больше не ждём коробку. Сообщи нам, что набор нужен снова, и мы сразу отправим новый. Ты также можешь создать его самостоятельно: вызови Create Home Kit, передав возвращённый набор вreplaces_home_kit_order_id. Новый набор — это отдельный заказ с новым кодом набора.Мы проверяем возвращённую коробку, когда она приходит. Затем статус возвращённого набора
меняется на cancelled, и ты видишь, что было в коробке.Письма команде, когда результаты готовы
Попроси нас задать email по умолчанию для твоей группы профилей, например общий ящик команды. Тогда на него будет приходить письмо, когда готовы результаты новой записи. Это касается записей из админ-панели, через API и от твоих пациентов.Чтобы изменить это для одной записи:- Админ-панель: измени email-адреса или отключи «Отправить мне письмо, когда результаты будут готовы».
- API: передай список в
results_ready_emails, чтобы использовать эти адреса вместо адреса по умолчанию. Чтобы сохранить адрес по умолчанию, включи его в список. Передай[], чтобы не отправлять письма.
Пациент указывает дату рождения и пол
Теперь мы можем разрешить твоей группе профилей создавать профиль безdate_of_birth и sex.
Пациент вводит оба значения на странице активации набора, причём дату рождения — дважды.
Попроси нас включить эту функцию. См.
Профили.Наборы, отправленные нам обратно
Когда служба доставки отправляет набор обратно к нам, это теперь отображается на странице Наборы для домашних тестов. Отфильтруй по Отправлен обратно, чтобы увидеть все наборы, которые служба доставки вернула нам, вместе с причиной возврата. Отправление завершается со статусомfault и вызывает событие
shipment.fault, а не delivered. Как только мы откроем коробку, ты также увидишь, что в ней
было: полный комплект, не хватает части или вскрыт. Так ты поймёшь, положен ли твоему клиенту
полный возврат.Хочешь, чтобы мы отправили набор повторно? Напиши нам код набора и правильный адрес доставки.
Мы отправим его с тем же кодом набора.Логарифмические единицы
List Units возвращает третийunit_type: logarithmic — для значения,
которое является логарифмом величины, такого как pH или индекс атерогенности. При отображении
обрабатывай его так же, как physical. Не масштабируй его: две логарифмические единицы
отличаются сдвигом, а не коэффициентом.Расчёт стоимости набора для домашнего теста со сборами
Quote Cart принимаетfulfilment. Передай home_kit и
country_code, и в расчёт добавятся позиции набора из твоего ежемесячного счёта за один заказ:
сбор за набор, устройства для сбора образца, пересылка в эту страну и обратно, защитный конверт
и запасной пакетик с ланцетами. По умолчанию остаётся draw в локации со сборами за запись.
Какой именно вариант рассчитан, указано в fulfilment.kind в ответе.Знакомься с Aniva Concierge
С этого момента наш список изменений также появляется в твоём совместном канале с нами в Slack, как только мы что-то выпускаем.Мы также создали Aniva Concierge. Есть вопрос об API или админ-панели? Упомяни @Aniva в Slack или просто ответь под постом со списком изменений. Он проверит нашу документацию и подскажет, куда нажать в админ-панели или какой эндпоинт и фильтры использовать, приложив ссылку на страницу.Список записей за один день
List Appointments принимает два новых фильтра.date
(YYYY-MM-DD) возвращает один календарный день в часовом поясе локации каждой записи, начиная с
самых ранних. location_id возвращает одну локацию для анализов. Используй оба фильтра, чтобы
получить расписание локации на сегодня.Дубликаты профилей отклоняются
Create Profile теперь возвращает409 с
error_name: "duplicate_profile_error", если среди доступных твоему ключу профилей уже есть
профиль с тем же именем, фамилией, полом и датой рождения. В ответе указан существующий
profile_id. Используй его вместо создания второго профиля. Фамилии из песочницы — исключение.Каталог анализов с твоими ценами
Новый Каталог анализов в админ-панели содержит каждый биомаркер с его лабораториями, пробирками и ценой по твоему прайс-листу.Почему у результата нет лабораторного диапазона
У каждого клинического результата в Get Results и Get Lab Results для наборов для домашних тестов теперь есть полеreference_range_lab_absent_reason. Оно указывает, почему reference_range_lab равно null:not_provided: диапазона не существует. Покажи «Неприменимо».lab_text_only: лаборатория указала только текст, например целевое значение или уровень риска. Покажиlab_reported.reference_range.not_measured: результат —undeliverable.
null, когда диапазон есть. См. Результаты.Розничные цены и координаты
- У локаций теперь есть
state_code,latitudeиlongitude. - List Retail Prices и Get Retail Prices возвращают цену каждой панели, которую аптека продаёт посетителям без записи.
- Вебхук
location.retail_prices.updatedсообщает тебе, когда меняется цена.
retail_prices_view.Заказ наборов для домашних тестов в админ-панели
Теперь ты можешь заказать набор для домашнего теста для своего пациента на странице наборов для домашних тестов в админ-панели. Выбери или создай пациента, выбери набор и введи адрес доставки. Там же ты можешь отменить набор.Прайс-лист и расчёт стоимости
- Получение прайс-листа возвращает твои тарифы по каталогу Aniva и сборы.
- Расчёт корзины рассчитывает стоимость панелей и биомаркеров без записи.
- Счёт в Расчёте корзины и Предпросмотре записи теперь
содержит
fees,total_with_fees_centsиnameв каждой строке биомаркера. rate_cardв списках принимаетidиз Получения прайс-листа.
prices_view.Больше данных о документах
Каждый элемент вdocuments в Получении результатов теперь содержит:file_name: имя, которое использует Скачивание документа.- Новое:
original_file_name,origin,content_type,etag,size_bytes.
results.updated, например итоговый отчёт Labor Quade
(_E) после предварительного (_V).Вебхуки
Aniva теперь обращается к твоему серверу, когда меняются запись, заказ набора для домашнего теста, его результаты, локация, профиль или отправление. Тебе больше не нужно опрашивать API.- Зарегистрируй HTTPS URL через
Создание вебхука. Тебе нужно
разрешение
webhooks_manage. Попроси Aniva добавить его к твоему ключу или настроить вебхук за тебя. - События охватывают каждый статус записи и заказа набора для домашнего теста, новое время или локацию,
а также каждое изменение результатов.
results.completedсообщает, что результаты окончательные. - События
location.*,profile.*иshipment.*сообщают, когда локация, профиль или отправление появляются, меняются или удаляются. Отправление также отправляетshipment.<status>при каждом изменении статуса. - События содержат идентификаторы и статусы, но никогда — лабораторные показатели или персональные данные. Запроси
urlиз события, чтобы получить данные. - Каждый запрос подписан по схеме Standard Webhooks.
- Aniva повторяет неудачную доставку 10 раз примерно в течение трёх дней. Ты можешь просматривать и повторно отправлять доставки в течение 30 дней.
- У каждого результата в Получении результатов теперь есть
id, поэтому ты можешь обновлять результат, на который указывает событиеresults.updated. - Получение локации возвращает одну локацию по её
id. На него указываетurlсобытияlocation.*.
Отправка результатов клиенту по почте
Теперь ты можешь отправить клиенту письмо о том, что его результаты анализов готовы. Отправляй его со страницы результатов анализов в админ-панели или через два новых эндпоинта: Отправка результатов по почте для записей и Отправка результатов по почте для заказов наборов для домашнего теста.- К письму можно прикрепить лабораторные отчёты в виде PDF-файлов. Каждый PDF защищён паролем: это дата рождения клиента из 8 цифр (ДДММГГГГ), и об этом написано в письме.
- Ты можешь добавить личный комментарий длиной не более 1 000 символов.
- В нём показаны название и логотип основной группы профилей этого профиля, на языке профиля.
- Каждая отправка — это одно письмо. Повторная попытка отправляет второе. Тебе нужно разрешение
results_viewдля этого клиента.
Письмо о готовности результатов
Когда ты оформляешь запись или заказываешь замену набора для домашнего теста в админ-панели, ты можешь включить «Написать мне, когда результаты будут готовы». Тогда мы отправим одно письмо тебе или на любой указанный тобой адрес, как только поступят все лабораторные результаты. В письме есть ссылка на результат в админ-панели. Клиент это письмо не получает. Тебе нужно разрешениеresults_view для этого клиента.Через API ты можешь указать до 5 адресов в results_ready_emails в
Создании записи,
Создании заказа набора для домашнего теста,
Обновлении записи и
Обновлении заказа набора для домашнего теста.Передача телефона и почты получателя с каждым набором
Если вdelivery_address набора для домашнего теста указаны phone или email, мы передаём их службе доставки. Тогда
служба доставки сообщает получателю, когда посылка в пути или ждёт в пункте выдачи. Если ты
их не укажешь, служба доставки не получит контакты, даже если они есть в профиле. Ты решаешь, кто получает
уведомления от службы доставки. В уведомлении отправителем может быть указана Aniva Health.См. Создание заказа набора для домашнего теста.Aniva Berlin P-Berg (Mariposa), Потсдам, Мангейм и Висбаден
Четыре новые локации для забора венозной крови. См. Список локаций.Страница результатов анализов
Новая страница результатов анализов в админ-панели показывает каждый забор крови и каждый активированный набор для домашнего теста с его лабораторными отчётами. Ищи по имени, дате рождения или штрихкоду пробирки. Тебе нужно разрешениеresults_view, а чтобы видеть наборы — доступ к наборам для домашнего теста.API-ключи только для активации
Новое разрешениеhome_kit_orders_activate позволяет ключу активировать наборы для домашнего теста и ничего больше. Он не может
создавать, изменять или отменять наборы. Попроси такой ключ у Aniva, если твои наборы активирует отдельная система.См. Активация заказа набора для домашнего теста.Пол должен быть мужским или женским
Создание профиля и Обновление профиля больше не принимаютsex: 0 (неизвестно). Передавай 1 для мужского пола или 2
для женского; 0 возвращает 400. Лаборатории нужен пол для референсных интервалов, а заказ
для профиля без него не мог дойти до лаборатории.См. Создание профиля.Наборы, поступившие в лабораторию без активации
Если образец поступает в лабораторию до активации набора, Aniva активирует набор. Вactivated_at записывается утро первого события отслеживания обратной посылки или утро
поступления образца в лабораторию, если отслеживания нет. Более поздний вызов активации с
другим activated_at возвращает 409.См. Активация заказа набора для домашнего теста.Интервалы Aniva в результатах
Эндпоинты результатов теперь заполняютreference_range_aniva сравнительными значениями, которые
составила Aniva, пересчитанными в единицы измерения результата. Значения зависят от возраста, пола и недели
беременности. Твоему ключу нужно разрешение ANIVA_REFERENCE_RANGES_VIEW. Без него в поле null.См. Получение результатов записи.Наборы на замену
Закажи замену, если по набору не удалось получить все результаты. Замена — это новый заказ с новым лабораторным кодом, который сохраняет панель исходного заказа.biomarker_ids задаёт, что
лаборатория исследует повторно.См. Заказы наборов для домашнего теста.Одна цена для каждого биомаркера и панели
У биомаркеров и панелей есть одно значениеprice_cents по твоему прайс-листу, а рядом с
ним — retail_cents:> 0: можно заказать отдельно.0: соотношение (см.requires) или можно заказать только с другими маркерами (см.positions).null: цена не указана, поэтому заказать нельзя.
groups[] удалено из списков и из предпросмотра записи. Поля цены
retail и yours удалены.См. Цены.Ключи идемпотентности
Эндпоинты создания профилей, записей, заказов наборов для домашнего теста и отправлений принимают заголовокIdempotency-Key. Повторный запрос с тем же ключом возвращает первый ответ и ничего не
записывает.См. Идемпотентность.
