Nuva concepts definition

• Area
• Code
• Condition
• ConditionGroup
• Description
• Disease
• Vaccine
  • Distribution
• Valence
• Version

---

Area

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

---

Code

External codes correspond to the representation of the vaccines in other code systems. They are organised per code system.

A same vaccine may match several external codes from different code systems, such as pharmaceutical codes (CIS, CIP, PZN, CNK, etc.), logistical codes (GTIN), international vaccine codes (SNOMED-CT, ATC) or national vaccine codes (CVX, THL Rokotevalmisteet, etc.).

For a given external code there is one and only one vaccine, corresponding to the same level of precision.

Property	Type	Description
value	string	The value of the code, for example 3400936774018 (CIP for BOOSTRIXTETRA)
nomenclature	Nomenclature	A code that indicate an external nomenclature, example: CIP

Code.nomenclature

• Type: Nomenclature
• Possible values:
  • ICD10
  • SNOMED-CT
  • AIC
  • CNK
  • ATC
  • GTIN
  • CP-NRONATIDENT
  • CIS
  • CIP
  • CODE_NATIONAL_SPAIN
  • PZN
  • UPC
  • NTIN
  • CVC
  • DIN
  • EU-NUMBER
  • NDC
  • CPT
  • CVX

---

Condition

Property	Type	Description
id	string
code	string	A readable code
type	ConditionType	Conditions are typed objects, for example Date of last covid history 19 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:
  • 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

---

Disease

Property	Type	Description
id	string
name	TranslatedField
code	integer
codes	Code []
valence_ids	string []
screenable	boolean
vaccinable	boolean
updated_at	string
created_at	string

---

Distribution

	Type	Description
area_id	string
name	string
starts_on	string
ends_on	string

---

Vaccine

Vaccines represent:

• a fully qualified product (BOOSTRIXTETRA)
• a combination of valences (Tdap)
• a target disease (vaccine against rabies)

When a same product is commercialised in different territories under different brand names (such as BOOSTRIXTETRA, POLIO BOOSTRIX and BOOSTRIX-POLIO), since the production conditions may differ, one vaccine code is attributed for each brand name.

For a fully qualified product, the label is unique, not associated with a specific language, and matches the vaccine brand name.

For a combination of valences or a target disease, there is a label for each language

Property	Type	Description
id	string
name	TranslatedField
code	integer
code_nuva	string
codes	Code []
valence_ids	string []
injection_methods	string []
short_description	Description
description	Description
other_names	string []
distributions	Distribution []
generic	boolean
replaced_by_id	null
created_at	string
updated_at	string

Vaccine.injection_methods

• Type: string []
  • Each element in the array must be one of the following values:
    • intramuscular
    • subcutaneous
    • oral
    • intranasal
    • intradermal

---

Valence

The valence is the minimal functional unit to characterize a vaccine.

The most explicit ones represent a combination of antigens for a same target disease and a dose. For example, for pertussis, you will have the valences:

• aP: acellular pertussis, standard dose
• ap: acellular pertussis, low dose
• wP: whole cell pertussis

The granularity of valences is adapted to the real-world production of vaccines.

There is no need to create individual valences for antigens aiming at variants of a same disease that are always associated. Beyond the valences for known vaccines there are abstract valences, that correspond to vaccination trails with a degraded information.

For example, we add to the three valences above the abstract valences:

• Per: Pertussis valence, unspecified
• Acel: Acellular pertussis vaccine, dose unspecified

Abstract valences are presented as parents of the real valences that they could represent. Immunoglobins against vaccine preventable diseases are encoded as valences since their delivery impacts the vaccination strategy.

Property	Type	Description
id	string
code	integer
name	object
antigene_type	string
abbreviation	string
translated_abbreviation	object
disease_ids	string []
vaccine_ids	string []
created_at	string
updated_at	string
parent_id	string

---

Version

Property	Type	Description
number	integer
major	integer
minor	integer
patch	integer