Przejdź do głównej treści
POST
Zaplanuj wizytę na pobranie krwi dla profilu pacjenta w konkretnej lokalizacji badań. Po utworzeniu wizyta domyślnie otrzymuje status confirmed (niektóre lokalizacje mogą domyślnie ustawiać pending — zależy to od konfiguracji lokalizacji). Użyj Dodaj panele, aby przypisać panele badań krwi przed potwierdzeniem pobrania krwi.
Profil może mieć najwyżej jedną wizytę w danej lokalizacji i terminie. Utworzenie wizyty w terminie, który profil już zajmuje, zwraca 409 z istniejącym appointment_id zamiast drugiej wizyty — dzięki temu ponowione lub przypadkowo powtórzone żądanie nigdy nie zduplikuje rezerwacji. Zobacz Zduplikowane wizyty.
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ść. Wymaga zakresu appointments_schedule.

Żądanie

Parametry treści

string
wymagane
UUID profilu pacjenta, dla którego tworzona jest wizyta.
string
wymagane
UUID lokalizacji badań, w której odbędzie się pobranie krwi. Użyj Lista lokalizacji, aby znaleźć dostępne identyfikatory lokalizacji.
string
wymagane
Data i godzina wizyty w formacie ISO 8601 (np. 2026-05-15T10:30:00Z lub 2026-05-15T12:30:00+02:00). Musi zawierać oznaczenie strefy czasowej — Z albo jawne przesunięcie, np. +02:00; daty i godziny bez strefy czasowej są odrzucane. Musi być w przyszłości.Musi dokładnie odpowiadać początkowi terminu w harmonogramie lokalizacji, a termin musi mieć jeszcze wolne miejsca — najpierw sprawdź Pobierz dostępność. Godziny spoza harmonogramu zwracają 400; zapełniony termin zwraca 409. W lokalizacjach prowadzonych przez Aniva termin musi też wypadać za co najmniej 12 godzin — zobacz Minimalne wyprzedzenie.
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.
string
Sposób pobrania krwi: capillary lub venous. Pomiń to pole, aby użyć default_draw_method lokalizacji. Lokalizacja musi zawierać tę metodę w draw_methods, w przeciwnym razie otrzymasz 400.

Odpowiedź

W razie powodzenia API zwraca 201 Created wraz z nową 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.
object
wymagane
Profil pacjenta powiązany z tą wizytą.
AppointmentPanel[]
wymagane
Panele aktualnie przypisane do tej wizyty. Pusta lista dla nowo utworzonych wizyt — przypisz przez Dodaj panele. Sprawdź szczegóły paneli (nazwę, biomarkery) przez Lista paneli.
AppointmentIndividualBiomarker[]
wymagane
Pojedyncze biomarkery przypisane do tej wizyty poza jakimkolwiek panelem. Pusta lista dla nowo utworzonych wizyt — przypisz przez Dodaj pojedyncze biomarkery. Porównaj każdy biomarker_id z Lista biomarkerów, aby uzyskać dane do wyświetlenia.
AppointmentShipmentLink[]
wymagane
Przesyłki powiązane z tą wizytą, od najstarszego powiązania. Pusta lista dla nowo utworzonych wizyt — powiąż przez Utwórz przesyłkę (z appointment_id) lub Powiąż wizyty z przesyłką.
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.

Minimalne wyprzedzenie

Wizyty w lokalizacjach prowadzonych przez Aniva trzeba rezerwować co najmniej 12 godzin wcześniej; rezerwacja w tym oknie zwraca 400. Pobierz dostępność już ukrywa te terminy, więc wszystko, co odczytasz z tego harmonogramu, można zarezerwować. Lokalizacje, które prowadzisz samodzielnie, nie mają minimalnego wyprzedzenia — rezerwacje na ten sam dzień i na miejscu działają bez zmian.

Zduplikowane wizyty

Profil może mieć najwyżej jedną nieanulowaną wizytę w danej lokalizacji i o tym samym czasie — jedna osoba nie może mieć pobranej krwi dwa razy w jednym miejscu i w tej samej chwili, niezależnie od liczby foteli w lokalizacji. Utworzenie wizyty w terminie, który profil już zajmuje, zwraca 409 z appointment_id wskazującym istniejącą już wizytę:
Obsłuż to, traktując żądanie jako już zastosowane: pobierz wizytę przez Pobierz wizytę, przełóż ją przez Zaktualizuj wizytę lub odwołaj ją przez Anuluj wizytę. Nie ponawiaj tworzenia — będzie nadal zwracać 409. Dzięki temu powtarzane tworzenie jest bezpieczne: żądanie wysłane ponownie po przekroczeniu limitu czasu ani dwukrotnie wysłany formularz nie utworzą dwóch wizyt dla tego samego pacjenta o tej samej porze.
appointment_id występuje tylko przy 409 dla duplikatu. 409 z powodu braku miejsc — gdy termin jest pełny, bo zajmują go inni pacjenci — zwraca samo error, a właściwym rozwiązaniem jest wybranie innego terminu z Pobierz dostępność.

Odpowiedzi z błędami