Przejdź do głównej treści
GET
Pobierz listę wizyt na pobranie krwi. Każda wizyta zawiera osadzony profil pacjenta. Filtry się łączą:
  • date zwraca wizyty w jednym dniu kalendarzowym. Dzień jest dniem lokalnym dla lokalizacji każdej wizyty, więc pobranie krwi o 23:30 w Berlinie liczy się według daty w Berlinie.
  • location_id zwraca wizyty w jednej lokalizacji badań.
  • profile_id bez date zwraca wszystkie wizyty dla tego profilu, bez ograniczenia czasowego.
  • Bez profile_id i bez date obowiązuje domyślne okno czasowe: od 2 miesięcy wstecz do 1 miesiąca w przód.
Wymaga zakresu appointments_view lub appointments_schedule.

Żądanie

Parametry zapytania

string
Filtruj według UUID profilu. Po podaniu zwracane są wszystkie wizyty dla tego profilu niezależnie od daty zaplanowania. Po pominięciu obowiązuje domyślne okno czasowe.
string
Filtruj według UUID lokalizacji badań.
string
Dzień kalendarzowy w formacie YYYY-MM-DD, w strefie czasowej lokalizacji każdej wizyty. Zastępuje domyślne okno czasowe. Wyniki są sortowane według scheduled_at, od najwcześniejszych.

Odpowiedź

W przypadku powodzenia API zwraca 200 OK z tablicą obiektów wizyt.
string
wymagane
Unikalny identyfikator wizyty (UUID).
string
wymagane
UUID profilu, do którego należy ta wizyta.
string
UUID lokalizacji badania, w której odbywa się pobranie krwi.
string
Zaplanowana data i godzina wizyty w formacie UTC (ISO 8601 z sufiksem Z, np. 2026-05-15T10:30:00Z). Może mieć wartość null.
string
wymagane
Bieżący status wizyty. Jedna z wartości: pending, confirmed, blood_drawn lub cancelled. Szczegółowy stopień gotowości wyników laboratoryjnych wynika z Pobierz wyniki; bardziej szczegółowy postęp przesyłki — z każdego wpisu w dołączonej tablicy shipments (zobacz niżej), który prowadzi do Pobierz przesyłkę.
string
Dowolny tekst powodu zapisany przy anulowaniu wizyty (np. nieobecność, późne anulowanie, „Nieudane. Wymagane powtórzenie”). Ma wartość null, chyba że status to cancelled.
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
wymagane
Sposób pobrania krwi: capillary (z opuszka palca lub ramienia, do mikroprobówek) lub venous (z żyły, do probówek). Jest to metoda ustawiona dla wizyty, a w przeciwnym razie default_draw_method jej lokalizacji. Po pobraniu krwi jest to metoda, której użyto.
string
wymagane
Znacznik czasu ISO 8601 utworzenia wizyty.
string
Znacznik czasu ISO 8601 ostatniej aktualizacji. Może mieć wartość null.
object
wymagane
Profil pacjenta powiązany z tą wizytą.
AppointmentPanel[]
wymagane
Panele aktualnie przypisane do tej wizyty. Nie obejmuje anulowanych przypisań. Szczegóły panelu (nazwę, biomarkery) sprawdzisz przez Lista paneli.
AppointmentIndividualBiomarker[]
wymagane
Pojedyncze biomarkery przypisane do tej wizyty poza panelami (zobacz Dodaj własne biomarkery). Sprawdź każde biomarker_id w Wyświetl biomarkery, aby uzyskać dane do wyświetlenia.
AppointmentShipmentLink[]
wymagane
Przesyłki powiązane z tą wizytą, od najstarszego powiązania. Pusta tablica, gdy brak powiązanych przesyłek. Porównaj każde id z Pobierz przesyłkę, aby uzyskać pełne dane przesyłki (status, numer śledzenia, aktualizacje statusu itp.).
string[]
wymagane
Kody laboratoryjne (kody kreskowe probówek) zapisane dla tej wizyty w kolejności skanowania. Puste do momentu potwierdzenia pobrania krwi. Pobranie żylne ma jeden kod wydrukowany na każdej probówce, a pobranie włośniczkowe ma jeden kod na mikroprobówkę. Wyniki i dokumenty w Pobierz wyniki odwołują się do tych kodów przez lab_code.

Powtarzane wywołania

Aniva przechowuje odpowiedź tego punktu końcowego przez 5 minut dla każdego klucza API. Ponowne wywołanie w tym czasie zwraca zapisaną odpowiedź. Nagłówki Cache-Status i Age pokazują, że odpowiedź jest zapisana i jaki jest jej wiek. Aby dowiadywać się o zmianach od razu, zasubskrybuj zdarzenia webhooka appointment.created, appointment.rescheduled oraz zdarzenie dla każdego statusu, na przykład appointment.confirmed. Zobacz Powtarzane odczyty.

Odpowiedzi z błędami