Platform API-referentie
De vitalera REST API biedt 148 eindpunten in 20+ resourcegroepen, die alles dekken van vitale functie-inname tot lifecycle-management van zorgplannen. Alle eindpunten retourneren JSON en volgen RESTful-conventies met FHIR R5-conforme gegevensmodellen.
Volledige API-documentatie
De interactieve API-referentie met verzoek-/antwoordschema's, parameterdetails en voorbeeldpayloads is beschikbaar voor klanten in het vitalera-dashboard. Neem contact op met info@vitalera.io voor toegang.
Authenticatie & gebruikers
| Groep | Eindpunten | Beschrijving |
|---|---|---|
| JWT-authenticatie | 4 | JWT-tokens genereren, vernieuwen, valideren en deactiveren |
| Integratie-authenticatie | 1 | SSO-omleiding voor externe identiteitsproviders |
| Beheer van toegangsgegevens | 1 | Clienttoegangsgegevens van de applicatie roteren |
| Gebruikers & machtigingen | 1 | Huidige gebruikersmachtigingen en rolinformatie |
Deelnemers
| Groep | Eindpunten | Beschrijving |
|---|---|---|
| Gemonitorden (patienten) | 10 | Deelnemers aanmaken, opsommen, bijwerken, verwijderen. Lijsten exporteren, samenvattingen ophalen, zorgtoewijzingen beheren en standaardplannen opvragen. |
| Professionals | 5 | Professionals en zorgteamleden aanmaken, opsommen, bijwerken en verwijderen. |
| Monitoringteams | 1 | Monitoringteamleden opsommen per plandefinitie. |
| Samenvattingen | 1 | Geaggregeerde tellers over gemonitorde deelnemers. |
Zorgplannen & taken
| Groep | Eindpunten | Beschrijving |
|---|---|---|
| Plandefinities | 11 | Plansjablonen beheren — opsommen, ophalen, publiceren, intrekken, herzien. Acties, app-instellingen, organisaties, profielvelden en validatiestatus opvragen. |
| Gemonitorde plannen | 26 | Volledig lifecycle-management — aanmaken, activeren, pauzeren, hervatten, voltooien, intrekken. Monitoringteamleden, overschrijvingen, triggers, afwijkingen, aangepaste velden beheren en PDF-rapporten genereren. |
| Taken | 10 | Klinische en wellnesstaken beheren — opsommen, accepteren, starten, voltooien, annuleren, falen, afwijzen. Tellers van openstaande taken voor dashboardbadges. |
Observaties — vitale functies
| Groep | Eindpunten | Beschrijving |
|---|---|---|
| Bloeddruk | 2 | Systolische, diastolische en gemiddelde arteriele druk |
| Hartfrequentie | 2 | Continue en enkele hartfrequentiemetingen |
| Zuurstofsaturatie (SpO2) | 2 | Pulsoximetrie-metingen |
| Temperatuur | 2 | Lichaamstemperatuurmetingen |
| Cholesterol | 2 | Totaal-, LDL-, HDL-cholesterolpanelen |
Observaties — activiteit & fitness
| Groep | Eindpunten | Beschrijving |
|---|---|---|
| Stappentelling | 2 | Dagelijkse en intraday-stapgegevens |
| Calorieen | 2 | Actieve en totale calorieverbranding |
| Afstand | 2 | Afgelegde afstand (wandelen, hardlopen, fietsen) |
| Beklommen verdiepingen | 2 | Hoogtestijging en verdiepingen |
| Actieve minuten | 2 | Dagelijkse actieve minuten per intensiteitszone |
| Workouts | 2 | Gestructureerde workoutsessies met rondes, HR-zones, tempo |
| VO2 Max | 2 | Geschatte maximale zuurstofopname |
Observaties — slaap & herstel
| Groep | Eindpunten | Beschrijving |
|---|---|---|
| Slaapsessies | 3 | Slaapduur, efficientie en sessiemetadata |
| Slaapfasen | 2 | Uitsplitsing in licht, diep, REM en wakker |
| Slaapademhaling | 2 | Ademhalingsfrequentie en verstoringen tijdens de slaap |
| Stressscore | 2 | Dagelijkse stressniveaus en trends |
| Herstelscore | 2 | Herstelgereedheid na het sporten |
| Belastingsscore | 2 | Cardiovasculaire belasting door activiteit |
| Energieniveau | 2 | Body Battery / energiereserveniveaus |
Observaties — gespecialiseerd
| Groep | Eindpunten | Beschrijving |
|---|---|---|
| Bloedglucose | 2 | Enkele bloedglucosemetingen |
| CGM-metingen | 2 | Continue glucosemonitoringgegevenspunten |
| CGM-samenvattingen | 2 | Tijd in bereik, gemiddelde glucose, variabiliteit |
| CGM-waarschuwingen | 2 | Hoge/lage glucose-waarschuwingsgebeurtenissen |
| HRV | 2 | Hartslagvariabiliteit (RMSSD, SDNN) |
| ECG | 2 | Elektrocardiogram-golfvormgegevens |
| Lichaamssamenstelling | 2 | Gewicht, lichaamsvet-%, spiermassa, BMI |
| Huidtemperatuur | 2 | Continue huidtemperatuurmetingen |
| Peak Expiratory Flow | 2 | Astma- en COPD-monitoring |
| Ademhalingsfrequentie | 2 | Ademhalingsfrequentiemetingen |
| Spirometrie | 2 | FEV1, FVC en andere longfunctiemetrieken |
| Mentale gezondheid | 4 | Stemmingstracking en beoordelingsscores |
Observaties — algemeen
| Groep | Eindpunten | Beschrijving |
|---|---|---|
| Gegevenskwaliteit | 1 | Kwaliteitsmetrieken voor observatiegegevensstromen |
| FIT-bestandsupload | 1 | Ruwe Garmin FIT-bestanden uploaden voor verwerking |
| Garmin Sleep | 1 | Directe Garmin Sleep API-gegevensinname |
| Garmin-hiaten | 1 | Hiaten in Garmin-gegevensstromen identificeren |
Vragenlijsten
| Groep | Eindpunten | Beschrijving |
|---|---|---|
| Vragenlijsten | 4 | Vragenlijsten opsommen, details ophalen, items met vertalingen (Accept-Language) verkrijgen en antwoorden opvragen. |
Alarmen
| Groep | Eindpunten | Beschrijving |
|---|---|---|
| Gedetecteerde problemen | 7 | Alarmen classificeren, annuleren of als foutief markeren. Classificatiedetails bijwerken. Getriggerde alarmen opvragen. |
Afspraken
| Groep | Eindpunten | Beschrijving |
|---|---|---|
| Afspraken | 6 | Volledige afspraak-lifecycle — boeken, inchecken, uitvoeren, annuleren, niet-verschenen, fout markeren. |
Apparaatintegraties
| Groep | Eindpunten | Beschrijving |
|---|---|---|
| Fitbit | 4 | Fitbit-accounts koppelen/ontkoppelen, koppelingsstatus controleren, laatste synchronisatietijdstip opvragen. |
| Garmin | 1 | Directe Garmin-gegevensinname-eindpunten. |
Inhoud
| Groep | Eindpunten | Beschrijving |
|---|---|---|
| Bibliotheek | 1 | Educatieve en informatieve inhoud opsommen. |
Basis-URL
https://api.vitalera.io/api/
Authenticatie
Alle eindpunten vereisen een geldig JWT Bearer-token. Zie Platform API-authenticatie.
Algemene patronen
- Paginering — Lijsteindpunten retourneren gepagineerde resultaten met de velden
count,nextenprevious. - Filtering — De meeste lijsteindpunten ondersteunen queryparameters voor filtering op status, datum en resourcespecifieke velden.
- Vertalingen — Resources met vertaalbare inhoud ondersteunen de
Accept-Language-header. - Toestandsovergangen — Resources met levenscycli (taken, plannen, afspraken, alarmen) gebruiken specifieke
POST /{id}/{action}/-eindpunten. - Rate limits — Zie Rate limits en quota's.
Volledige toegang verkrijgen
De interactieve API-referentie met complete verzoek-/antwoordschema's, parameterdocumentatie en een sandbox-omgeving is beschikbaar voor klanten. Neem contact met ons op voor toegangsgegevens.