Wat je kunt doen
- Profielbeheer — Maak demografische patiëntprofielen aan, haal ze op en werk ze bij.
- Afspraken inplannen — Plan afspraken voor bloedafname in op testlocaties van Aniva.
- Panelbeheer — Voeg labtestpanels toe aan een bestaande afspraak of verwijder ze.
- Losse biomarkers — Koppel losse biomarkers aan een afspraak of ontkoppel ze zonder een panel te kiezen.
- Thuistestkit-bestellingen — Stuur een thuistestkit per post naar een patiënt, volg de pakketten en meld wanneer het monster is afgenomen.
- Panelcatalogus — Bekijk beschikbare panels met
GET /api/v1/panelsom panel-ID’s en de bijbehorende biomarkers te vinden. - Biomarkercatalogus — Bekijk met
GET /api/v1/biomarkersde biomarkers die je op een locatie of in een thuistestkit kunt bestellen om de ID’s te vinden. - Bevestiging van bloedafname — Stuur na een bloedafname de labcode(s) in om de laborderpipeline te starten.
- Labresultaten — Haal klinische en genetische resultaten op en download pdf’s van labrapporten.
- Locaties opzoeken — Haal een overzicht op van beschikbare testlocaties om aan patiënten te tonen.
- Verzendlogistiek — Maak koerierszendingen aan, volg ze, pas ze aan en annuleer ze.
- Webhooks — Ontvang een HTTPS-aanroep wanneer een afspraak, een thuistestkit-bestelling, de resultaten ervan, een locatie, een profiel of een zending verandert. Zie Webhooks.
Verken de documentatie
Authenticatie
Authenticeer verzoeken met je partner-API-sleutel.
Snelstartgids
Doe je eerste API-aanroep in een paar minuten met stapsgewijze voorbeelden.
Profielen
Lees hoe patiëntprofielen werken en welke gegevens ze bevatten.
Afspraken
Begrijp de levenscyclus van een afspraak, van inplannen tot bevestiging.
Thuistestkit-bestellingen
Stuur een testkit naar een patiënt thuis en volg deze tot het monster het lab bereikt.
API-versiebeheer
De huidige API-versie is v1. Alle endpoints beginnen met/api/v1/. De basis-URL is https://anivahealth.com.
Datums en tijdzones
Alle tijdstippen in het dataverkeer zijn UTC ISO 8601 (Z-achtervoegsel). Kalendervelden gebruiken kloktijd-
waarden (YYYY-MM-DD, HH:MM).
Specifieke opmerkingen:
- Invoervelden met een datum-tijd (bijv.
scheduled_atbijPOST/PATCH /api/v1/appointments) moeten een tijdzone-aanduiding bevatten — ofwelZof een expliciete offset zoals+02:00. Naïeve datum-tijden worden afgewezen met400. Beide vormen coderen hetzelfde tijdstip; het antwoord geeftscheduled_ataltijd weer als UTCZ. Gebruik het veldtimezonevan de locatie (of een andere IANA- identifier) om het tijdstip bij weergave om te zetten naar lokale kloktijd. - Kloktijd-invoer wordt geïnterpreteerd in de tijdzone van de resource waarop deze betrekking heeft: beschikbaarheidsdatums
gebruiken de queryparameter
timezone(standaard de tijdzone van de locatie);pickup_date/pickup_time_*van een zending worden geïnterpreteerd in de tijdzone van de herkomstlocatie. - Antwoordvelden met alleen een datum (bijv.
tested_at, beschikbaarheidavailability[].date) zijn kalenderdatums zonder tijdzone.
Toegang krijgen
API-sleutels worden per partner uitgegeven door Aniva.Neem contact op met Aniva om je partner-API-sleutel te ontvangen.