Client PHP pour VaccinationProfile

Introduction

VaccinationProfile est une nomenclature structurant toutes les conditions de vie d’un individu qui peuvent avoir un impact sur ses recommandations vaccinales.

Concepts

Condition: Il s'agit d'une condition de vie pouvant impact les recommandations vaccinales (par exemple être enceinte ou avoir une maladie chronique). Chaque condition est d'un type particulier (par exemple, "grossesse" est une condition de valeur booléenne, tandis que "dernier antécédent de covid 19" est une condition de valeur de type date).
ConditionGroup: Il s'agit d'un groupe de conditions à afficher ensemble dans le formulaire de profil santé.
Formulaire de profil santé: Il s'agit d'un formulaire permettant de saisir les conditions de vie d'un individu. Ce formulaire est structuré sous la forme d'un arbre, chaque noeud de l'arbre étant un groupe de conditions.
Profil santé: Il s'agit d'un ensemble de valeurs de conditions associé à un patient donné. Il prend la forme d'un ensemble de paires clé-valeurs où la clé est un identifiant de condition et la valeur est conforme au type attendu pour la condition.

Librairies

La librairie vaccination-profile vous permet de :

récupérer une nomenclature des conditions de santé pouvant influer sur les recommandations vaccinales ;
afficher un formulaire de saisie de profil santé ;
encoder et afficher un profil santé.

PHP

Pré-requis

L’outil composer doit être installé ;
Un token d’authentification doit être fourni par Syadem (contactez developers@mesvaccins.net afin d’obtenir un token d’authentification) ;
PHP 7.4 ou supérieur.

Utilisation

Initialisation

Vous devez d’abord initialiser la librairie. Durant l’initialisation de la librairie, la dernière version de la nomenclature est téléchargée.

$vaccination_profile = Syadem\VaccinationProfile\Container::init();

Notez que cette opération d’initialisation est coûteuse et doit être effectuée une seule fois. Nous vous conseillons donc de conserver l’instance de la librairie dans un cache global.

Affichage d’une condition de profil santé

$nuva = Syadem\VaccinationProfile\Container::init();
echo $nuva->getConditions()->find("2427485e-907c-4241-83c8-939237010ca2")->getName->getFr();
// => Personne immunodéprimée dans l'entourage

Installation

Pour installer la librairie vaccination-profile, vous devez ajouter le repository syadem dans votre fichier composer.json à l’aide de la commande suivante, si ce n’est déjà fait :

composer config repositories.243 composer \
  https://gitlab.mesvaccins.net/api/v4/group/243/-/packages/composer/packages.json

Il vous faut ensuite configurer votre token d’authentification :

composer config gitlab-token.gitlab.mesvaccins.net <username> <token>

Enfin, vous pouvez installer la librairie vaccination-profile :

composer require syadem/vaccination-profile

Autres langages

Si vous souhaitez utiliser la nomenclature VaccinationProfile avec un autre langage de programmation, n’hésitez pas à nous contacter à l’adresse suivante : contact@mesvaccins.net.

Détail des concepts

Area

Property	Type	Description
id	`string`
name	`Name`
code	`string`
category	`Category`
parent_ids	`string` `[]`

Condition

Property	Type	Description
id	`string`
code	`string`	Un code lisible
type	`ConditionType`	Les conditions sont des objets typés, par exemple `Date de la dernière histoire de covid 19` est une `Date`
label	`TranslatedField`
child_label	`TranslatedField`
female_label	`TranslatedField`
male_label	`TranslatedField`
professional_label	`TranslatedField`
help	`TranslatedField`

Condition.type

Type: ConditionType
Valeurs autorisées:
- boolean
- date
- integer
- float

ConditionGroup

Property	Type	Description
id	`string`
label	`Name`
parent_id	`null`
condition_ids	`string` `[]`

TranslatedField

Property	Type	Description
de	`string`
en	`string`
fr	`string`
nl	`string`
ru	`string`
ua	`string`
es	`string`
it	`string`