MesVaccins.net   Référence technique de l'API grand public

Délivrances de vaccins

Format d’une délivrance

Chaque délivrance est identifiée par un identifiant numérique et comporte les attributs suivants :

Identifiant id
Code MesVaccins.net identifiant la délivrance.
Vaccin vaccine
Vaccin identifié par son code MesVaccins.net id, son code UCD ucd_code, ou son code CIP icp_code (cf. la nomenclature des vaccins)
Date date
Date de délivrance du vaccin
Date et heure de mise à jour updated_at
Date et heure de mise à jour de la délivrance
Date d'expiration expiry
Date d'expiration du vaccin délivré
État status
État actuel de la délivrance :
  • waiting : la délivrance est en attente
  • injected : le vaccin délivré a été injecté
  • expired : le vaccin délivré a expiré
  • deleted : la délivrance a été effacée
Numéro de lot batch
Garantit la traçabilité du vaccin délivré
Commentaires comment
Commentaires publiés par les professionnels de santé

Lecture d’une délivrance

  • GET /records/:uuid/vaccine_issues/1.json renvoie la délivrance d'identifiant 1
{
  "id": 817,
  "date": "2016-12-19",
  "updated_at": "2016-12-19T15:02:46+01:00",
  "status": "injected",
  "batch": "",
  "comment": "Ceci est un commentaire",
  "expiry": "2018-12-12",
  "vaccine": {
    "id": 495,
    "name": "BEXSERO",
    "short_description": "Méningo B",
    "ucd_code": "",
    "cip_codes": [
      "3400926863036"
    ],
    "marketing_start": "2013-01-14",
    "marketing_end": null,
    "french": true,
    "alternative_names": [
      "BEXSERO"
    ],
    "diseases": [
      {
        "id": 45,
        "name": "Méningocoque B"
      }
    ],
    "valences": [
      {
        "id": 22,
        "name": "MenB"
      }
    ],
    "code_set": "MesVaccins.net"
  },
  "creator": {
    "id": 75876,
    "name": "Jean-Louis Koeck",
    "first_name": "Jean-Louis",
    "last_name": "Koeck"
  }
}

On a une délivrance de Bexsero réalisée le 19 décembre 2016, enregistrée par le docteur Jean-Louis Koeck.

Lecture de toutes les délivrances

  • GET /records/:uuid/vaccine_issues.json renvoie l'historique entier des délivrances du patient sous la forme d'un tableau
[
  {
    "id": "...",
    "date": "...",
    "updated_at": "...",
    "status": "...",
    "batch": "...",
    "comment": "...",
    "expiry": "...",
    "vaccine": "...",
    "creator": "..."
  },
  "..."
]

Création d’une délivrance

  • POST /records/:uuid/vaccine_issues.json enregistre une nouvelle délivrance à partir de l'objet JSON envoyé
{
  "vaccine": {
    "id": "495"
  },
  "date": "2015-07-31",
  "expiry": "2018-12-12",
  "batch": "AJ-14",
  "comment": "Délivrance en présence du responsable légal"
}

Le serveur renvoie 201 Created et un objet JSON représentant la délivrance créée (au même format que les données renvoyées par GET /records/:uuid/vaccine_issues/1.json).

En cas de détection de doublon (délivrance déjà existante pour la même date et le même vaccin), le serveur renvoie 409 Conflict.

Les paramètres status, batch (numéro de lot) et date sont optionnels : par défaut l’état est à waiting, le numéro de lot est vide et la date de délivrance est fixée à aujourd’hui.

Le paramètre id dans l’objet vaccine désigne l’identifiant du vaccin dans la base de données de MesVaccins.net. Ce même identifiant est retourné pour chaque vaccin par le service qui liste les vaccins.

Dans tous les cas, le professionnel de santé inscrit comme créateur de la délivrance sera le professionnel de santé authentifié sur MesVaccins.net, il n’est actuellement pas possible d’indiquer explicitement le champ creator dans ce message.

Modification d’une délivrance

  • PUT /records/:uuid/vaccine_issues/1.json met à jour la délivrance d'identifiant 1

On peut se contenter d’envoyer les paramètres qui ont changé. Ici, on corrige le vaccin enregistré :

{
  "vaccine": { "id": 4 }
}

Le service renvoie 200 OK en cas de succès.

Le service renvoie 400 Bad Request si le format des données d’entrée est erroné.

Suppression d’une délivrance

  • DELETE /records/:uuid/vaccine_issues/1.json supprime la délivrance d'identifiant 1.

Le service renvoie 204 No Content en cas de succès.