Přejít na hlavní obsah
Aniva Partner API je REST API, které zdravotnickým partnerům umožňuje spravovat profily pacientů, plánovat termíny odběru krve na odběrových místech a spouštět zpracování laboratorních objednávek. S API komunikuješ přes HTTPS pomocí svého partnerského API klíče.

Co můžeš dělat

  • Správa profilů — Vytvářej, načítej a aktualizuj demografické profily pacientů.
  • Plánování termínů — Rezervuj termíny odběru krve na odběrových místech Aniva.
  • Správa panelů — Přidávej nebo odebírej laboratorní panely u existujícího termínu.
  • Jednotlivé biomarkery — Připojuj nebo odebírej jednotlivé biomarkery u termínu bez výběru panelu.
  • Objednávky domácích testovacích sad — Pošli pacientovi poštou domácí testovací sadu, sleduj její zásilky a nahlas, kdy byl vzorek odebrán.
  • Katalog panelů — Procházej dostupné panely přes GET /api/v1/panels a zjisti ID panelů i to, které biomarkery do nich patří.
  • Katalog biomarkerů — Procházej biomarkery, které můžeš objednat na odběrovém místě nebo v domácí testovací sadě, přes GET /api/v1/biomarkers a zjisti jejich ID.
  • Potvrzení odběru krve — Po odběru odešli laboratorní kód (nebo kódy) a spusť zpracování laboratorní objednávky.
  • Laboratorní výsledky — Načítej klinické i genetické výsledky a stahuj laboratorní zprávy v PDF.
  • Vyhledání míst — Vypiš dostupná odběrová místa, která můžeš zobrazit pacientům.
  • Logistika zásilek — Vytvářej, sleduj, upravuj a ruš objednávky kurýrních zásilek.
  • Webhooky — Dostávej HTTPS volání, když se změní termín, objednávka domácí testovací sady, její výsledky, místo, profil nebo zásilka. Viz Webhooky.

Prozkoumej dokumentaci

Autentizace

Ověřuj požadavky pomocí svého partnerského API klíče.

Rychlý start

Proveď své první volání API během pár minut díky příkladům krok za krokem.

Profily

Zjisti, jak fungují profily pacientů a jaká data obsahují.

Termíny

Poznej životní cyklus termínu od naplánování po potvrzení.

Objednávky domácích testovacích sad

Pošli pacientovi testovací sadu domů a sleduj ji, dokud vzorek nedorazí do laboratoře.

Verzování API

Aktuální verze API je v1. Všechny endpointy mají prefix /api/v1/. Základní URL je https://anivahealth.com.
Zpětně nekompatibilní změny přijdou pod novým prefixem verze. API v1 zůstane dostupné a každé ukončení podpory bude oznámeno předem.

Datum a časová pásma

Všechny časové okamžiky při přenosu používají UTC ISO 8601 (přípona Z). Čistě kalendářní pole používají složky místního času (YYYY-MM-DD, HH:MM). Konkrétní poznámky:
  • Vstupy přijímající datum a čas (např. scheduled_at u POST / PATCH /api/v1/appointments) musí obsahovat označení časového pásma — buď Z, nebo explicitní posun jako +02:00. Hodnoty bez časového pásma jsou odmítnuty chybou 400. Obě formy kódují stejný okamžik; odpověď vždy vrací scheduled_at v UTC s Z. K zobrazení okamžiku v místním čase použij pole timezone daného místa (nebo jakýkoli jiný identifikátor IANA).
  • Vstupy s místním časem se vyhodnocují v časovém pásmu zdroje, kterého se týkají: datumy dostupnosti používají query parametr timezone (výchozí je časové pásmo místa); u zásilky se pickup_date / pickup_time_* vyhodnocují v časovém pásmu výchozího místa.
  • Pole odpovědi pouze s datem (např. tested_at, availability[].date u dostupnosti) jsou kalendářní data bez časového pásma.

Získání přístupu

API klíče vydává Aniva pro každého partnera zvlášť.
Kontaktuj Aniva a získej svůj partnerský API klíč.