Plattform-API-Referenz
Die vitalera REST API stellt 148 Endpunkte in 20+ Ressourcengruppen bereit, die alles von der Vitalzeichenerfassung bis zum Pflegeplan-Lebenszyklusmanagement abdecken. Alle Endpunkte geben JSON zurueck und folgen RESTful-Konventionen mit FHIR R5-konformen Datenmodellen.
Vollstaendige API-Dokumentation
Die interaktive API-Referenz mit Anfrage-/Antwortschemata, Parameterdetails und Beispiel-Payloads ist fuer Kunden im vitalera Dashboard verfuegbar. Kontaktieren Sie info@vitalera.io fuer den Zugang.
Authentifizierung & Benutzer
| Gruppe | Endpunkte | Beschreibung |
|---|---|---|
| JWT-Authentifizierung | 4 | JWT-Tokens generieren, aktualisieren, validieren und deaktivieren |
| Integrations-Authentifizierung | 1 | SSO-Weiterleitung fuer externe Identitaetsanbieter |
| Zugangsdatenverwaltung | 1 | Client-Zugangsdaten der Anwendung rotieren |
| Benutzer & Berechtigungen | 1 | Aktuelle Benutzerberechtigungen und Rolleninformationen |
Teilnehmer
| Gruppe | Endpunkte | Beschreibung |
|---|---|---|
| Ueberwachte (Patienten) | 10 | Teilnehmer erstellen, auflisten, aktualisieren, loeschen. Listen exportieren, Zusammenfassungen abrufen, Pflegezuweisungen verwalten und Standardplaene abfragen. |
| Fachkraefte | 5 | Fachkraefte und Pflegeteammitglieder erstellen, auflisten, aktualisieren und loeschen. |
| Monitoring-Teams | 1 | Monitoring-Teammitglieder nach Plandefinition auflisten. |
| Zusammenfassungen | 1 | Aggregierte Zaehler ueber ueberwachte Teilnehmer. |
Pflegeplaene & Aufgaben
| Gruppe | Endpunkte | Beschreibung |
|---|---|---|
| Plandefinitionen | 11 | Planvorlagen verwalten — auflisten, abrufen, veroeffentlichen, zurueckziehen, ueberarbeiten. Aktionen, App-Einstellungen, Organisationen, Profilfelder und Validierungsstatus abfragen. |
| Ueberwachte Plaene | 26 | Vollstaendiges Lebenszyklusmanagement — erstellen, aktivieren, pausieren, fortsetzen, abschliessen, widerrufen. Monitoring-Teammitglieder, Ueberschreibungen, Trigger, Abweichungen, benutzerdefinierte Felder verwalten und PDF-Berichte generieren. |
| Aufgaben | 10 | Klinische und Wellness-Aufgaben verwalten — auflisten, annehmen, starten, abschliessen, abbrechen, fehlschlagen, ablehnen. Zaehler ausstehender Aufgaben fuer Dashboard-Badges. |
Beobachtungen — Vitalzeichen
| Gruppe | Endpunkte | Beschreibung |
|---|---|---|
| Blutdruck | 2 | Systolischer, diastolischer und mittlerer arterieller Druck |
| Herzfrequenz | 2 | Kontinuierliche und Einzelmessungen der Herzfrequenz |
| Sauerstoffsaettigung (SpO2) | 2 | Pulsoximetrie-Messwerte |
| Temperatur | 2 | Koerpertemperaturmessungen |
| Cholesterin | 2 | Gesamt-, LDL-, HDL-Cholesterin-Panels |
Beobachtungen — Aktivitaet & Fitness
| Gruppe | Endpunkte | Beschreibung |
|---|---|---|
| Schrittzahl | 2 | Taegliche und Intraday-Schrittdaten |
| Kalorien | 2 | Aktiver und gesamter Kalorienverbrauch |
| Distanz | 2 | Zurueckgelegte Strecke (Gehen, Laufen, Radfahren) |
| Erklommene Etagen | 2 | Hoehengewinn und Etagen |
| Aktive Minuten | 2 | Taegliche aktive Minuten nach Intensitaetszone |
| Trainings | 2 | Strukturierte Trainingssitzungen mit Runden, HR-Zonen, Tempo |
| VO2 Max | 2 | Geschaetzte maximale Sauerstoffaufnahme |
Beobachtungen — Schlaf & Erholung
| Gruppe | Endpunkte | Beschreibung |
|---|---|---|
| Schlafsitzungen | 3 | Schlafdauer, Effizienz und Sitzungsmetadaten |
| Schlafphasen | 2 | Aufschuesselung in leicht, tief, REM und wach |
| Schlafatmung | 2 | Atemfrequenz und Stoerungen waehrend des Schlafs |
| Stresswert | 2 | Taegliche Stresslevel und Trends |
| Erholungswert | 2 | Erholungsbereitschaft nach dem Training |
| Belastungswert | 2 | Kardiovaskulaere Belastung durch Aktivitaet |
| Energielevel | 2 | Body Battery / Energiereserve-Level |
Beobachtungen — Spezialisiert
| Gruppe | Endpunkte | Beschreibung |
|---|---|---|
| Blutzucker | 2 | Einzelne Blutzuckermessungen |
| CGM-Messwerte | 2 | Kontinuierliche Glukosemonitoring-Datenpunkte |
| CGM-Zusammenfassungen | 2 | Zeit im Bereich, durchschnittliche Glukose, Variabilitaet |
| CGM-Warnungen | 2 | Hoch-/Niedrig-Glukose-Warnereignisse |
| HRV | 2 | Herzfrequenzvariabilitaet (RMSSD, SDNN) |
| EKG | 2 | Elektrokardiogramm-Wellenformdaten |
| Koerperzusammensetzung | 2 | Gewicht, Koerperfett-%, Muskelmasse, BMI |
| Hauttemperatur | 2 | Kontinuierliche Hauttemperaturmessungen |
| Peak Expiratory Flow | 2 | Asthma- und COPD-Monitoring |
| Atemfrequenz | 2 | Atemfrequenzmessungen |
| Spirometrie | 2 | FEV1, FVC und andere Lungenfunktionswerte |
| Psychische Gesundheit | 4 | Stimmungsverfolgung und Bewertungsscores |
Beobachtungen — Allgemein
| Gruppe | Endpunkte | Beschreibung |
|---|---|---|
| Datenqualitaet | 1 | Qualitaetsmetriken fuer Beobachtungsdatenstroeme |
| FIT-Datei-Upload | 1 | Rohe Garmin FIT-Dateien zur Verarbeitung hochladen |
| Garmin Sleep | 1 | Direkte Garmin Sleep API-Datenaufnahme |
| Garmin-Luecken | 1 | Luecken in Garmin-Datenstroemen identifizieren |
Fragebogen
| Gruppe | Endpunkte | Beschreibung |
|---|---|---|
| Fragebogen | 4 | Fragebogen auflisten, Details abrufen, Items mit Uebersetzungen (Accept-Language) erhalten und Antworten abfragen. |
Alarme
| Gruppe | Endpunkte | Beschreibung |
|---|---|---|
| Erkannte Probleme | 7 | Alarme klassifizieren, abbrechen oder als fehlerhaft markieren. Klassifizierungsdetails aktualisieren. Ausgeloeste Alarme abfragen. |
Termine
| Gruppe | Endpunkte | Beschreibung |
|---|---|---|
| Termine | 6 | Vollstaendiger Terminlebenszyklus — buchen, einchecken, ausfuehren, absagen, Nichterscheinen, Fehler markieren. |
Geraeteintegrationen
| Gruppe | Endpunkte | Beschreibung |
|---|---|---|
| Fitbit | 4 | Fitbit-Konten verknuepfen/trennen, Verknuepfungsstatus pruefen, letzten Synchronisierungszeitpunkt abfragen. |
| Garmin | 1 | Direkte Garmin-Datenaufnahme-Endpunkte. |
Inhalte
| Gruppe | Endpunkte | Beschreibung |
|---|---|---|
| Bibliothek | 1 | Bildungs- und Informationsinhalte auflisten. |
Basis-URL
https://api.vitalera.io/api/
Authentifizierung
Alle Endpunkte erfordern ein gueltiges JWT Bearer Token. Siehe Plattform-API-Authentifizierung.
Allgemeine Muster
- Paginierung — Listenendpunkte geben paginierte Ergebnisse mit den Feldern
count,nextundpreviouszurueck. - Filterung — Die meisten Listenendpunkte unterstuetzen Abfrageparameter zur Filterung nach Status, Datum und ressourcenspezifischen Feldern.
- Uebersetzungen — Ressourcen mit uebersetzbarem Inhalt unterstuetzen den
Accept-Language-Header. - Zustandsuebergaenge — Ressourcen mit Lebenszyklen (Aufgaben, Plaene, Termine, Alarme) verwenden dedizierte
POST /{id}/{action}/-Endpunkte. - Rate Limits — Siehe Rate Limits und Kontingente.
Vollzugriff erhalten
Die interaktive API-Referenz mit vollstaendigen Anfrage-/Antwortschemata, Parameterdokumentation und einer Sandbox-Umgebung ist fuer Kunden verfuegbar. Kontaktieren Sie uns fuer Zugangsdaten.