Saltar al contingut principal
L’API per a col·laboradors d’Aniva és una API REST que permet als col·laboradors sanitaris gestionar perfils de pacients, programar cites d’extracció de sang als centres de proves i activar els fluxos de comandes de laboratori. Interactues amb l’API per HTTPS amb la teva clau d’API de col·laborador.

Què pots fer

  • Gestió de perfils — Crea, consulta i actualitza els perfils demogràfics dels pacients.
  • Programació de cites — Reserva cites d’extracció de sang als centres de proves d’Aniva.
  • Gestió de panells — Afegeix o elimina panells d’anàlisis de laboratori en una cita existent.
  • Biomarcadors individuals — Vincula o desvincula biomarcadors individuals a una cita sense triar un panell.
  • Comandes de kits de prova a casa — Envia un kit de prova a domicili a un pacient, fes el seguiment dels paquets i indica quan s’ha recollit la mostra.
  • Catàleg de panells — Explora els panells disponibles amb GET /api/v1/panels per veure’n els ID i els biomarcadors que inclouen.
  • Catàleg de biomarcadors — Explora els biomarcadors que pots demanar en un centre o en un kit de prova a casa amb GET /api/v1/biomarkers per veure’n els ID.
  • Confirmació d’extracció de sang — Envia el codi o els codis de laboratori després d’una extracció per activar el flux de comandes de laboratori.
  • Resultats de laboratori — Consulta els resultats clínics i genètics i descarrega els informes de laboratori en PDF.
  • Cerca de centres — Llista els centres de proves disponibles per mostrar-los als pacients.
  • Logística d’enviaments — Crea, segueix, modifica i cancel·la comandes d’enviament per missatgeria.
  • Webhooks — Rep una crida HTTPS quan canvia una cita, una comanda de kit de prova a casa, els seus resultats, un centre, un perfil o un enviament. Consulta Webhooks.

Explora la documentació

Autenticació

Autentica les peticions amb la teva clau d’API de col·laborador.

Inici ràpid

Fes la teva primera crida a l’API en pocs minuts amb exemples pas a pas.

Perfils

Descobreix com funcionen els perfils de pacients i quines dades contenen.

Cites

Entén el cicle de vida d’una cita, des de la programació fins a la confirmació.

Comandes de kits de prova a casa

Envia un kit de prova a casa d’un pacient i fes-ne el seguiment fins que la mostra arribi al laboratori.

Versions de l’API

La versió actual de l’API és la v1. Tots els endpoints porten el prefix /api/v1/. L’URL base és https://anivahealth.com.
Els canvis incompatibles s’introduiran sota un nou prefix de versió. L’API v1 continuarà disponible amb avís previ de qualsevol retirada.

Dates i zones horàries

Tots els instants transmesos estan en UTC ISO 8601 (sufix Z). Els camps només de calendari utilitzen components de rellotge local (YYYY-MM-DD, HH:MM). Notes específiques:
  • Les entrades que accepten una data i hora (p. ex. scheduled_at a POST / PATCH /api/v1/appointments) han d’incloure un indicador de zona horària — ja sigui Z o un desplaçament explícit com +02:00. Les dates i hores sense zona horària es rebutgen amb 400. Totes dues formes codifiquen el mateix instant; la resposta sempre torna a representar scheduled_at en UTC Z. Utilitza el camp timezone del centre (o qualsevol altre identificador IANA) per formatar l’instant en hora de rellotge local en mostrar-lo.
  • Les entrades de rellotge local s’interpreten en la zona horària del recurs al qual s’adrecen: les dates de disponibilitat utilitzen el paràmetre de consulta timezone (per defecte, la zona horària del centre); els camps pickup_date / pickup_time_* d’un enviament s’interpreten en la zona horària del centre d’origen.
  • Els camps de resposta que només contenen una data (p. ex. tested_at, availability[].date de disponibilitat) són dates de calendari sense zona horària.

Com obtenir accés

Aniva emet les claus d’API per cada col·laborador.
Contacta amb Aniva per rebre la teva clau d’API de col·laborador.