VaccinationProfile
Purpose
VaccinationProfile is a nomenclature that describes an individual’s living conditions that can influence vaccination recommendations. It is used to structure the health profile questionnaire, encode answers, and render a health profile that the SADV API can use.
Concepts
- Condition
- Living condition that can affect vaccination recommendations, for example pregnancy or a chronic disease. Each condition is typed: boolean, date, integer, etc.
- ConditionGroup
- Group of conditions to display together in the health profile form.
- Health profile form
- Form used to enter an individual's living conditions. This form is structured as a tree, with each node being a group of conditions.
- Health profile
- Set of condition values associated with a given patient. It takes the form of key-value pairs where the key is a condition identifier and the value matches the expected type.
Access and Libraries
The VaccinationProfile nomenclature can be used from a client library.
For PHP integration, see the dedicated page: PHP Library.
If you want to integrate this nomenclature in another language, contact the team at contact@mesvaccins.net.
Concept Details
Area
| Property | Type | Description |
|---|---|---|
| id | string |
|
| name | Name |
|
| code | string |
|
| category | Category |
|
| parent_ids | string [] |
Condition
| Property | Type | Description |
|---|---|---|
| id | string |
|
| code | string |
Readable code. |
| type | ConditionType |
Conditions are typed objects; for example, “date of last COVID-19 history” is a date. |
| label | TranslatedField |
|
| child_label | TranslatedField |
|
| female_label | TranslatedField |
|
| male_label | TranslatedField |
|
| professional_label | TranslatedField |
|
| help | TranslatedField |
Condition.type
- Type:
ConditionType - Allowed values:
booleandateintegerfloat
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 |