Service de diagnostic vaccinal

Pré-requis : Voir Généralités et authentification

Description

Comme les autres services compris dans l’API de conseil, le diagnostic n’est déterminé qu’à partir des informations envoyées.

  • POST /decision_support/immunisation_assessment.json calcule un diagnostic vaccinal à partir de différents éléments :
    • un âge
    • un sexe
    • une liste de conditions de santé (qui constituent un profil santé)
    • une liste de vaccinations (qui constituent un historique vaccinal)

Format des données de requête

Les données d’entrée doivent être formatées dans un objet JSON dont voici un exemple :

{
    "birth_date": "2000-01-01",
    "gender": "female",
    "condition_ids": [52, 145, 146],
    "vaccinations": [
      {
        "date": "2015-04-04T16:04:20+02:00",
        "vaccine_id": 549,
        "booster": false
      },
      {
        "date": "2017-04-04T16:04:20+02:00",
        "vaccine_id": 7,
        "booster": false
      }
    ],
    "user_type": "patient"
}
Champ Format Présence
birth_date Date au format ISO 8601 Obligatoire
gender Valeurs possibles : "male" ou "female" Obligatoire
condition_ids Tableau des identifiants numériques des conditions de santé cochées par le patient lors de la phase de personnalisation de la recommandation. Facultatif
vaccinations Tableau des vaccinations, décrites par l'identifiant du vaccin et la date d'administration.
En l'absence du paramètre, il est consideré par défaut comme vide.
Facultatif
user_type Type de l'utilisateur. Valeurs possibles : "patient" ou "professional".
Ce paramètre conditionne la formulation des messages ("Vous..."/"Votre patient..."), ainsi que le niveau de détail et de vocabulaire dans les diagnostics
En son absence, il est fixé par défaut à "patient".
Facultatif

Vaccinations

Chaque élément du tableau vaccinations a la structure suivante :

Champ Format Présence
vaccine_id Identifiant du vaccin, récupérable sur l'index des vaccins Obligatoire
date Date d'administration du vaccin au format ISO 8601 Obligatoire
booster true si le vaccin est un rappel, false sinon Obligatoire

Date de naissance

Cf. le paramètre Date de naissance des recommandations

Format des données de réponse

Cf. le format spécifié ici

Exemple de données de réponse

{
  "schedule_status": "late",
  "rules_revision": "1.0",
  "assessments":  [
    {
      "disease": {
        "id": 43427226,
        "name": "Méningocoque C"
      },
      "conditions": [],
      "dose_count": 0,
      "message": "Pas à jour",
      "schedule_status": "late",
      "next_vaccination_date": "2018-04-04",
      "group_name": null,
      "recommendation": {
        "messages": [],
        "alerts": [],
        "comments": [],
        "justifications": [],
        "level": "Inconnu",
        "refund": "Non remboursé par la sécurité sociale",
        "reference_texts": []
      }
    },
    {
      "disease": {
        "id": 530139750,
        "name": "Hépatite A"
      },
      "conditions": [],
      "dose_count": 0,
      "message": "Situation imprévue",
      "schedule_status": "unresolved",
      "next_vaccination_date": null,
      "group_name": null,
      "recommendation": {
        "messages": [],
        "alerts": [],
        "comments": [],
        "justifications": [],
        "level": "Inconnu",
        "refund": "Non remboursé par la sécurité sociale",
        "reference_texts": []
      },
    },
    "..."
  ]
}

Format des objets de diagnostic

Chaque objet porte sur une maladie donnée.

Les différents éléments de la réponse sont :

Nom du paramètre Description
schedule_status Indique le retard éventuel de la vaccination.
Peut prendre l'une des valeurs suivantes : unresolved, to-do, late, up-to-date.
rules_revision Numéro de version des règles du système expert utilisées pour générer le diagnostic.
assessments Liste des éléments du diagnostic.

Chaque élément de la liste assessments est un diagnostic relatif à une maladie, et contient ces attributs :

disease Maladie concernée.
group_name Nom du groupe de maladie concerné ou null si aucun groupe n'est concerné
conditions Conditions justifiant le statut.
dose_count Nombre de doses de vaccin reçues par le vacciné contre cette maladie.
next_vaccination_date Date de la prochaine vaccination.
recommendation Recommandation correspondant au diagnostic actuel, dont la structure est spécifiée sur cette page .