Riferimento dell'API piattaforma
L'API REST vitalera espone 148 endpoint distribuiti in oltre 20 gruppi di risorse, coprendo tutto, dall'ingestione di segni vitali alla gestione del ciclo di vita dei piani di cura. Tutti gli endpoint restituiscono JSON e seguono le convenzioni RESTful con modelli di dati allineati a FHIR R5.
Documentazione API completa
Il riferimento API interattivo con gli schemi di richiesta/risposta, i dettagli dei parametri e gli esempi di payload e disponibile per i clienti nella dashboard vitalera. Contattate info@vitalera.io per l'accesso.
Autenticazione e utenti
| Gruppo | Endpoint | Descrizione |
|---|---|---|
| Autenticazione JWT | 4 | Generare, aggiornare, validare e disattivare i token JWT |
| Autenticazione di integrazione | 1 | Redirect SSO per i provider di identita esterni |
| Gestione delle credenziali | 1 | Rotazione delle credenziali client dell'applicazione |
| Utenti e permessi | 1 | Permessi e informazioni di ruolo dell'utente corrente |
Partecipanti
| Gruppo | Endpoint | Descrizione |
|---|---|---|
| Monitorati (Pazienti) | 10 | Creare, elencare, aggiornare, eliminare partecipanti. Esportare elenchi, recuperare riepiloghi, gestire le assegnazioni di cura e interrogare i piani predefiniti. |
| Professionisti | 5 | Creare, elencare, aggiornare, eliminare professionisti sanitari e membri del team di cura. |
| Team di monitoraggio | 1 | Elencare i membri del team di monitoraggio per definizione di piano. |
| Riepiloghi | 1 | Contatori aggregati dei partecipanti monitorati. |
Piani di cura e attivita
| Gruppo | Endpoint | Descrizione |
|---|---|---|
| Definizioni di piano | 11 | Gestire i modelli di piano -- elencare, recuperare, pubblicare, ritirare, revisionare. Interrogare azioni, impostazioni app, organizzazioni, campi profilo e stato di validazione. |
| Piani dei monitorati | 26 | Gestione completa del ciclo di vita -- creare, attivare, sospendere, riprendere, completare, revocare. Gestire i membri del team, le sovrascritture, i trigger, le deviazioni, i campi personalizzati e generare report PDF. |
| Attivita | 10 | Gestire le attivita cliniche e di benessere -- elencare, accettare, avviare, completare, annullare, fallire, rifiutare. Contatori di attivita in sospeso per i badge della dashboard. |
Osservazioni -- Segni vitali
| Gruppo | Endpoint | Descrizione |
|---|---|---|
| Pressione arteriosa | 2 | Sistolica, diastolica e pressione arteriosa media |
| Frequenza cardiaca | 2 | Misurazioni di frequenza cardiaca continue e puntuali |
| Saturazione di ossigeno (SpO2) | 2 | Letture di pulsossimetria |
| Temperatura | 2 | Misurazioni della temperatura corporea |
| Colesterolo | 2 | Pannelli colesterolo totale, LDL, HDL |
Osservazioni -- Attivita e fitness
| Gruppo | Endpoint | Descrizione |
|---|---|---|
| Conteggio passi | 2 | Dati passi giornalieri e intragiornalieri |
| Calorie | 2 | Dispendio calorico attivo e totale |
| Distanza | 2 | Distanza percorsa (camminata, corsa, ciclismo) |
| Piani saliti | 2 | Guadagno di altitudine e piani |
| Minuti attivi | 2 | Minuti attivi giornalieri per zona di intensita |
| Allenamenti | 2 | Sessioni di allenamento strutturate con giri, zone FC, ritmo |
| VO2 Max | 2 | Consumo massimo di ossigeno stimato |
Osservazioni -- Sonno e recupero
| Gruppo | Endpoint | Descrizione |
|---|---|---|
| Sessioni di sonno | 3 | Durata del sonno, efficienza e metadati di sessione |
| Fasi del sonno | 2 | Ripartizione leggero, profondo, REM e veglia |
| Respirazione nel sonno | 2 | Frequenza respiratoria e disturbi durante il sonno |
| Punteggio stress | 2 | Livelli di stress giornalieri e tendenze |
| Punteggio recupero | 2 | Prontezza al recupero post-esercizio |
| Punteggio sforzo | 2 | Sforzo cardiovascolare dall'attivita |
| Livello energia | 2 | Livelli Body Battery / riserva energetica |
Osservazioni -- Specializzate
| Gruppo | Endpoint | Descrizione |
|---|---|---|
| Glicemia | 2 | Letture puntuali della glicemia |
| Letture CGM | 2 | Punti dati del monitoraggio continuo del glucosio |
| Riepiloghi CGM | 2 | Tempo nel target, glucosio medio, variabilita |
| Avvisi CGM | 2 | Eventi di avviso glucosio alto/basso |
| HRV | 2 | Variabilita della frequenza cardiaca (RMSSD, SDNN) |
| ECG | 2 | Dati della forma d'onda dell'elettrocardiogramma |
| Composizione corporea | 2 | Peso, % massa grassa, massa muscolare, BMI |
| Temperatura cutanea | 2 | Letture continue della temperatura cutanea |
| Picco di flusso espiratorio | 2 | Monitoraggio asma e BPCO |
| Frequenza respiratoria | 2 | Misurazioni della frequenza respiratoria |
| Spirometria | 2 | FEV1, FVC e altre metriche di funzionalita polmonare |
| Salute mentale | 4 | Monitoraggio dello stato d'animo e punteggi di valutazione |
Osservazioni -- Generali
| Gruppo | Endpoint | Descrizione |
|---|---|---|
| Qualita dei dati | 1 | Metriche di qualita per i flussi di dati di osservazione |
| Upload file FIT | 1 | Caricare file FIT Garmin grezzi per l'elaborazione |
| Sonno Garmin | 1 | Ingestione diretta dei dati dell'API Garmin Sleep |
| Lacune Garmin | 1 | Identificare le lacune nei flussi di dati Garmin |
Questionari
| Gruppo | Endpoint | Descrizione |
|---|---|---|
| Questionari | 4 | Elencare i questionari, recuperare i dettagli, ottenere gli item con traduzioni (Accept-Language) e interrogare le risposte. |
Allarmi
| Gruppo | Endpoint | Descrizione |
|---|---|---|
| Problemi rilevati | 7 | Classificare, annullare o contrassegnare gli allarmi come inseriti per errore. Aggiornare i dettagli di classificazione. Interrogare gli allarmi attivati. |
Appuntamenti
| Gruppo | Endpoint | Descrizione |
|---|---|---|
| Appuntamenti | 6 | Ciclo di vita completo della pianificazione -- prenotare, registrare, completare, annullare, assenza, contrassegnare come errore. |
Integrazioni dispositivi
| Gruppo | Endpoint | Descrizione |
|---|---|---|
| Fitbit | 4 | Collegare/scollegare gli account Fitbit, verificare lo stato del collegamento, interrogare l'ultima sincronizzazione. |
| Garmin | 1 | Endpoint di ingestione diretta dei dati Garmin. |
Contenuti
| Gruppo | Endpoint | Descrizione |
|---|---|---|
| Libreria | 1 | Elencare le risorse di contenuto educativo e informativo. |
URL base
https://api.vitalera.io/api/
Autenticazione
Tutti gli endpoint richiedono un token JWT Bearer valido. Consultate Autenticazione dell'API piattaforma.
Pattern comuni
- Paginazione -- Gli endpoint di lista restituiscono risultati paginati con i campi
count,nexteprevious. - Filtraggio -- La maggior parte degli endpoint di lista supporta parametri di query per filtrare per stato, data e campi specifici della risorsa.
- Traduzioni -- Le risorse con contenuto traducibile supportano l'header
Accept-Language. - Transizioni di stato -- Le risorse con cicli di vita (attivita, piani, appuntamenti, allarmi) utilizzano endpoint
POST /{id}/{action}/dedicati. - Limiti di frequenza -- Consultate Limiti di frequenza e quote.
Ottenere l'accesso completo
Il riferimento API interattivo con schemi completi di richiesta/risposta, documentazione dei parametri e un ambiente sandbox e disponibile per i clienti. Contattateci per le credenziali.