VaccinationProfile

Introduction

VaccinationProfile is a nomenclature that structures all the life conditions of an individual that can impact their vaccination recommendations.

Concepts

Condition

This refers to a life condition that can impact vaccination recommendations (for example, being pregnant or having a chronic disease). Each condition is of a specific type (for example, "pregnancy" is a boolean value condition, while "last history of COVID-19" is a date type value condition).

ConditionGroup

This is a group of conditions to be displayed together in the health profile form.

Health Profile Form

This is a form for entering an individual's life conditions. This form is structured as a tree, with each node of the tree being a group of conditions.

Health Profile

This is a set of condition values associated with a given patient. It takes the form of a set of key-value pairs where the key is a condition identifier and the value conforms to the expected type for the condition.

Libraries

The vaccination-profile library allows you to:

• Retrieve a nomenclature of health conditions that can influence vaccination recommendations;
• Display a health profile entry form;
• Encode and display a health profile.

PHP

Prerequisites

• The composer tool must be installed;
• An authentication token must be provided by Syadem (contact developer@mesvaccins.net to obtain an authentication token);
• PHP 7.4 or higher.

Usage

Initialization

You must first initialize the library. During the initialization of the library, the latest version of the nomenclature is downloaded.

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

Note that this initialization operation is costly and should be performed only once. Therefore, it is advisable to keep the instance of the library in a global cache.

Displaying a Health Profile Condition

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

Installation

To install the vaccination-profile library, you need to add the Syadem repository to your composer.json file using the following command, if not already done:

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

Then, you need to configure your authentication token:

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

Finally, you can install the vaccination-profile library:

composer require syadem/vaccination-profile

Other Languages

If you wish to use the VaccinationProfile nomenclature with another programming language, please do not hesitate to contact us at the following address: contact@mesvaccins.net.

Detail of Concepts

Area

Condition

Condition.type

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

ConditionGroup

TranslatedField