Carnets de vaccination

Chaque carnet est représenté par son UUID. Celui-ci est obtenu lors de l’appel de récupération des données de tous les carnets du compte patient.

Lecture des données de tous les carnets du compte patient

  • GET /records.json renvoie les données de tous les carnets contenus dans le compte du patient

Les carnets sont renvoyées dans un tableau JSON ; chaque élément du carnet est au même format que le carnet renvoyé par le service /records/:uuid.json décrit ci-dessous.

Lecture des données de base d’un carnet

  • GET /records/:uuid.json renvoie les données élémentaires du carnet de vaccination (uuid, date de naissance, genre, pseudonyme), les vaccinations et le profil santé.
{
    "created_at": "2014-06-18T14:33:57+02:00",
    "updated_at": "2014-06-18T14:37:57+02:00",
    "uuid": "be5101b6-9e8e-11e1-9683-7273e9365401",
    "birthdate": "1988-12-18",
    "gender": "male",
    "nickname": "JD",
    "caption": "Homme de 23 ans",
    "vaccinations": "...",
    "health_profile": "..."
}

Voir la documentation des vaccinations et du profil santé pour en savoir plus sur leur représentation en JSON.

Création d’un carnet

  • POST /records.json crée un nouveau carnet de vaccination
{
    "birthdate": "2000-01-01",
    "gender": "female",
    "nickname": "Sarah",
    "zip_code": "33000"
}

Le champ zip_code contient le code postal de la ville de résidence de la personne. Ce champ est facultatif.

Le strict minimum des données est envoyé. Le serveur renvoie 201 Created et un objet JSON représentant le carnet créé (au même format que les données renvoyées par GET /records/:uuid.json), ce qui permet de récupérer l’UUID alloué.

Modification des données d’un carnet

  • PUT /records/:uuid.json modifie les données de base du carnet et renvoie 200 OK
{
    "birthdate": "2000-01-02"
}

On peut se contenter d’envoyer les paramètres qui ont changé (birthdate, nickname, gender ou zip_code). Ici, on rectifie la date de naissance.

Création d’un carnet sans compte

  • POST /accountless_records crée un carnet pour utilisateur grand public
{
    "email": "anocka@gmail.com",
    "mobile_phone": "0619764834",
    "birthdate": "2000-01-01",
    "gender": "female",
    "nickname": "Sarah",
    "zip_code": "33000"
}

Le numéro de téléphone mobile_phone est facultatif (il est utilisé pour augmenter la sécurité d’opérations délicates comme le renouvellement du mot de passe).

Le code postal de la ville de résidence zip_code est facultatif.

Le serveur renvoie 201 Created en cas de succès.

En cas d’information manquante ou malformée, le serveur renvoie 400 Bad Request avec un message d’erreur au format JSON.

La création du carnet déclenche l'envoi d'un e-mail à la personne lui permettant de récupérer l'accès à son carnet de vaccination électronique.

Les données fournies ne permettant pas un dédoublonnage fiable, il ne sera pas fait de vérification de pré-existance du CVE. Si la personne possède déjà un CVE, il lui sera proposé d'ignorer le message de récupération du CVE nouvellement créé.

La création du carnet requiert le recueil du consentement de la personne et à l’acceptation des conditions générales d’utilisation de MesVaccins.net (accessible à https://www.mesvaccins.net/web/conditions_of_use).

Suppression d’un carnet

  • DELETE /records/:uuid.json supprime le carnet de vaccination et renvoie 204 No Content si l'opération s'est bien passée. Si le carnet n'appartient pas au patient, le serveur renvoie 403 Forbidden.