Přejít na hlavní obsah
GET
Načti seznam termínů odběru krve. Každý termín obsahuje vložený profil pacienta. Filtry se kombinují:
  • date vrací termíny v jednom kalendářním dni. Den se řídí místním dnem odběrového místa daného termínu, takže odběr krve ve 23:30 v Berlíně spadá do berlínského data.
  • location_id vrací termíny na jednom odběrovém místě.
  • profile_id bez date vrací všechny termíny daného profilu bez časového omezení.
  • Bez profile_id a bez date platí výchozí časové okno: 2 měsíce zpět až 1 měsíc dopředu.
Vyžaduje scope appointments_view nebo appointments_schedule.

Požadavek

Parametry dotazu

string
Filtr podle UUID profilu. Když je zadaný, vrátí se všechny termíny tohoto profilu bez ohledu na datum naplánování. Když chybí, platí výchozí časové okno.
string
Filtr podle UUID odběrového místa.
string
Kalendářní den ve formátu YYYY-MM-DD v časovém pásmu odběrového místa daného termínu. Nahrazuje výchozí časové okno. Výsledky jsou seřazené podle scheduled_at od nejdřívějšího.

Odpověď

Při úspěchu API vrátí 200 OK s polem objektů termínů.
string
povinné
Jedinečný identifikátor termínu (UUID).
string
povinné
UUID profilu, ke kterému tento termín patří.
string
UUID odběrového místa, kde odběr krve probíhá.
string
Plánované datum a čas termínu v UTC (ISO 8601 s příponou Z, např. 2026-05-15T10:30:00Z). Může být null.
string
povinné
Aktuální stav termínu. Jedna z hodnot pending, confirmed, blood_drawn nebo cancelled. Podrobnější stav dokončení laboratorních výsledků najdeš v Získat výsledky; detailnější průběh zásilky v jednotlivých položkách pole shipments (viz níže) a následně v Získat zásilku.
string
Volný text s důvodem zaznamenaným při zrušení termínu (např. nedostavení se, pozdní zrušení, „Nezdařilo se. Nutné opakování“). null, pokud status není cancelled.
string[]
povinné
Adresy malými písmeny, z nichž každá dostane jeden e-mail, jakmile jsou všechny laboratorní výsledky konečné. Prázdné, když je vypnuto. Viz E-maily o připravených výsledcích.
string
povinné
Způsob odběru krve: capillary (z konečku prstu nebo horní části paže do mikrozkumavek) nebo venous (ze žíly do zkumavek). Jde o metodu nastavenou u termínu, jinak default_draw_method jeho místa. Po odběru krve uvádí metodu, která byla použita.
string
povinné
Časové razítko ISO 8601 vytvoření termínu.
string
Časové razítko ISO 8601 poslední aktualizace. Může být null.
object
povinné
Profil pacienta spojený s tímto termínem.
AppointmentPanel[]
povinné
Panely aktuálně připojené k tomuto termínu. Nezahrnuje zrušená připojení. Detaily panelu (název, biomarkery) najdeš přes Seznam panelů.
AppointmentIndividualBiomarker[]
povinné
Samostatné biomarkery připojené k tomuto termínu mimo jakýkoli panel (viz Přidat vlastní biomarkery). Údaje pro zobrazení pro každé biomarker_id dohledej přes Vypsat biomarkery.
AppointmentShipmentLink[]
povinné
Zásilky propojené s tímto termínem, od nejstaršího propojení. Prázdné pole, když nejsou propojeny žádné zásilky. Každé id spáruj s Načíst zásilku pro úplná data zásilky (stav, sledovací číslo, aktualizace stavu atd.).
string[]
povinné
Laboratorní kódy (čárové kódy zkumavek) zaznamenané pro tento termín v pořadí skenování. Prázdné, dokud není potvrzen odběr krve. Žilní odběr krve má jeden kód vytištěný na každé zkumavce; kapilární odběr má jeden kód pro každou mikrozkumavku. Výsledky a dokumenty v Získat výsledky na tyto kódy odkazují přes lab_code.

Opakovaná volání

Aniva ukládá odpověď tohoto endpointu po dobu 5 minut pro každý API klíč. Opakované volání v tomto čase dostane uloženou odpověď. Hlavičky Cache-Status a Age ukazují, že je odpověď uložená a jak je stará. Pokud se chceš o změně dozvědět hned, přihlas se k odběru událostí webhooku appointment.created, appointment.rescheduled a události každého stavu, například appointment.confirmed. Podívej se na Opakovaná čtení.

Chybové odpovědi