Przejdź do głównej treści
POST
Złóż zamówienie na domowy zestaw testowy dla profilu pacjenta. Zamówienie domowego zestawu testowego dotyczy zestawu wysyłkowego do samodzielnego użycia — Aniva wysyła zestaw na adres dostawy, pacjent samodzielnie pobiera próbkę w domu i odsyła ją pocztą. Różni się to od wizyty, która polega na pobraniu krwi z żyły w punkcie pobrań. Wymagany jest dokładnie jeden panel. Domowy zestaw testowy odpowiada w relacji 1:1 fizycznemu produktowi — panel to zestaw — a zamówienie trafia do kolejki pakowania od razu po utworzeniu, więc jego skład musi być ustalony z góry. Nadal możesz zmienić panel przez Zaktualizuj zamówienie domowego zestawu testowego, dopóki zamówienie ma status pending.

Zestawy zastępcze

Gdy zestaw nie może dostarczyć wyników — pacjent nie był w stanie napełnić probówki, próbka dotarła ze zbyt małą ilością materiału lub laboratorium nie mogło jej przeanalizować — zamów zestaw zastępczy, wysyłając replaces_home_kit_order_id. Zestaw zastępczy to nowe zamówienie z nowym kodem laboratoryjnym, także wtedy, gdy pierwszy zestaw nigdy nie został aktywowany: laboratorium potrzebuje nowego zlecenia, a dwóch próbek pod jednym kodem nie da się odróżnić. Zastępowane zamówienie pozostaje bez zmian — zachowuje swój status, swój kod laboratoryjny oraz wszelkie wyniki już do niego przypisane. Wynikają z tego dwie rzeczy:
  • Panel jest dziedziczony. Pomiń panel_id, a zestaw zastępczy przejmie panel z zastępowanego zamówienia, czyli to, co kupił pacjent i jak oznakowane jest pudełko.
  • Wybierasz, co powtórzyć. Wyślij biomarker_ids z markerami, których nie udało się oznaczyć, a laboratorium powtórzy tylko te badania, dzięki czemu zestaw zawiera wyłącznie potrzebne probówki. Pomiń to pole, aby powtórzyć cały panel.
Markery są powtarzane w ramach grup panelu, a nie pojedynczo. Wskazanie jednego markera z grupy powoduje powtórzenie całej tej grupy, ponieważ nie można złożyć zlecenia laboratoryjnego, które raportuje więcej, niż zlecono. Zestaw zastępczy dla jednego markera może więc przynieść więcej niż jeden wynik, a liczba probówek może być większa, niż sugeruje lista markerów. Jednocześnie dla jednego zestawu może być w drodze tylko jeden zestaw zastępczy.
Jeśli integracja powstała przed wprowadzeniem tych pól, Aniva odczytuje także metadata.original_kit_id i metadata.replacement_reason przy tworzeniu zamówienia i traktuje je jako zestaw zastępczy. To jedyne miejsce, w którym metadane są interpretowane — istnieje wyłącznie dla zachowania zgodności z tą wcześniejszą integracją, a powyższe pola zawsze mają pierwszeństwo. Wysyłaj te pola.
Kod 201 oznacza, że zamówienie zostało zatwierdzone i trafi do realizacji — nie musisz robić nic więcej, aby zestaw został spakowany i wysłany. Wymaga zakresu home_kit_orders_manage. Wyślij opcjonalny nagłówek Idempotency-Key, aby ponawianie tego żądania utworzenia było bezpieczne — powtórzenie tego samego klucza zwraca pierwotną odpowiedź zamiast tworzyć kolejną wizytę. Zobacz Idempotentność.

Żądanie

Parametry treści

string
wymagane
UUID profilu pacjenta, dla którego tworzone jest zamówienie domowego zestawu testowego.
string
wymagane
UUID panelu z katalogu do zamówienia. Dokładnie jeden — domowy zestaw testowy odpowiada w relacji 1:1 fizycznemu produktowi, więc panel to zestaw. Identyfikatory paneli udostępnia Aniva dla twojego konta partnerskiego; zobacz Lista paneli. Opcjonalne w przypadku zestawu zastępczego — domyślnie przyjmuje panel z zastępowanego zamówienia.
string
UUID zamówienia domowego zestawu testowego, które to zamówienie zastępuje. Jego wysłanie tworzy zestaw zastępczy — zobacz Zestawy zastępcze powyżej. Zamówienie musi należeć do tego samego profilu i nie może mieć już zestawu zastępczego w drodze.
string
Powód zamówienia zestawu zastępczego w jednym zdaniu (na przykład Zu wenig Material, HbA1c nicht auswertbar). Wymagane, gdy wysyłasz replaces_home_kit_order_id, w przeciwnym razie ignorowane. Maksymalnie 500 znaków.
integer[]
W zestawie zastępczym są to markery, które laboratorium powtarza — zazwyczaj te, których nie udało się uzyskać z pierwszego zestawu. Każdy musi należeć do zakresu zastępowanego zamówienia; sprawdź w Lista biomarkerów z parametrem home_kit=true. Pomiń, aby powtórzyć cały panel. Akceptowane wyłącznie razem z replaces_home_kit_order_id i nie razem z innym panel_id. Nie wymaga to dodatkowego zakresu uprawnień: powtórzenie markerów, za które pacjent już zapłacił, nie jest wyborem à la carte.
object
Twoje własne pary klucz/wartość, zwracane bez zmian przy każdym odczycie i nigdy nieinterpretowane przez Aniva. Użyj tego pola do przekazania własnego numeru referencyjnego zamówienia, aby powiązać dane bez przechowywania naszych ID. Maksymalnie 20 kluczy; klucze muszą pasować do [A-Za-z0-9_-] i mieć maksymalnie 40 znaków; wartości mogą być ciągiem znaków, liczbą lub wartością logiczną, przy czym ciągi znaków mogą mieć maksymalnie 500 znaków; łącznie maksymalnie 16 384 bajtów po serializacji. Klucze zaczynające się od aniva_ są zarezerwowane. Nigdy nie umieszczaj danych osobowych ani klinicznych w metadata — to pole nie jest traktowane jak dane pacjenta.
string[]
Do 5 adresów, z których każdy otrzyma jednego e-maila, gdy wszystkie wyniki laboratoryjne będą ostateczne. E-mail zawiera link do strony z wynikami w panelu administracyjnym Aniva. Twój klucz wymaga uprawnienia results_view dla tego pacjenta, w przeciwnym razie otrzymasz 403. Pomiń to pole, aby użyć domyślnych adresów ustawionych dla grupy pacjenta. Pusta lista wyłącza wysyłanie e-maili. Zobacz E-maile o gotowych wynikach.
object
wymagane
Adres wysyłki zestawu — w jednej z dwóch form: { location_id } wskazujące znany punkt pobrań albo bezpośrednie pola adresu (name, street, city, postal_code, country_code; opcjonalnie company_name / house_number / address_line_2 / state / phone / email — te same nazwy pól co w API lokalizacji). Podaj dokładnie jedną z nich — odniesienie do lokalizacji albo adres bezpośredni, nie obie.
Packstation lub Postfiliale (tylko Niemcy): ustaw street na Packstation lub Postfiliale, house_number na trzycyfrowy numer punktu, a address_line_2 na numer DHL Postnummer odbiorcy (6–10 cyfr, spacje dozwolone). Bez numeru Postnummer przesyłki nie można nadać. Postfach nie jest obsługiwany.

Odpowiedź

W przypadku powodzenia API zwraca 201 Created wraz z nowym zamówieniem domowego zestawu testowego.
string
wymagane
Unikalny identyfikator zamówienia domowego zestawu testowego (UUID).
string
wymagane
UUID profilu, do którego należy to zamówienie domowego zestawu testowego.
string
wymagane
Aktualny status zamówienia domowego zestawu testowego. Jedna z wartości: pending, dispatched, activated lub cancelled. Nowo utworzone zamówienie ma początkowo status pending.
object
wymagane
Adres, na który ma zostać wysłany zestaw — w jednej z dwóch postaci: albo { location_id } wskazujące znaną lokalizację badań, albo pola adresu wpisane bezpośrednio (name, street, city, postal_code, country_code; pola company_name / house_number / address_line_2 / state / phone / email są opcjonalne — takie samo nazewnictwo jak w API lokalizacji). Podaj dokładnie jedną opcję — odniesienie do lokalizacji albo adres wpisany bezpośrednio, nie obie naraz.
object
wymagane
Przekazane przez ciebie pary klucz/wartość. Zawsze obecne — {}, jeśli żadnych nie ustawisz.
string
Zamówienie domowego zestawu testowego, które to zamówienie zastępuje. null w przypadku zwykłego zamówienia.
string
Podany przez ciebie powód. null w przypadku zwykłego zamówienia.
string[]
wymagane
Adresy zapisane małymi literami, z których każdy otrzymuje jednego e-maila, gdy wszystkie wyniki laboratoryjne będą ostateczne. Puste, gdy wyłączone. Zobacz E-maile o gotowych wynikach.
string
Kod próbki w laboratorium, pod którym raportowane są wyniki — wydrukowany na fizycznym zestawie i odczytywany przez pacjenta z pudełka jako kod aktywacyjny. null do czasu spakowania zestawu. Tylko do odczytu.
string
wymagane
Znacznik czasu pobrania zgłoszony przez Aktywuj. null do czasu aktywacji zestawu.
string
wymagane
Znacznik czasu ISO 8601 utworzenia zamówienia domowego zestawu testowego.
string
Znacznik czasu ISO 8601 ostatniej aktualizacji. Może mieć wartość null.
object
wymagane
Profil pacjenta powiązany z tym zamówieniem domowego zestawu testowego.
HomeKitOrderPanel[]
wymagane
Panel przypisany do tego zamówienia domowego zestawu testowego — ten przekazany jako panel_id, opatrzony czasem utworzenia zamówienia. Zawsze dokładnie jeden. Szczegóły panelu (nazwę, biomarkery) sprawdzisz w Lista paneli.
HomeKitOrderIndividualBiomarker[]
wymagane
Biomarkery dodane poza panelem. Puste przy zwykłym utworzeniu — domowe zestawy testowe zamawia się według panelu, a późniejsza zmiana tej listy wymaga zakresu uprawnień home_kit_orders_individual_biomarker_selection. W zestawie zastępczym zawiera wysłane biomarker_ids, czyli markery powtarzane przez laboratorium.
HomeKitOrderShipmentLink[]
wymagane
Przesyłki powiązane z tym zamówieniem domowego zestawu testowego, od najstarszego powiązania. Zawsze puste przy utworzeniu — pełne dane przesyłek odczytasz przez Lista przesyłek z parametrem ?home_kit_order_id=.

Odpowiedzi z błędami