Important: This is a draft IG for trial use. Click here to give feedback.

HdBe-Vaccination

CBB	Concept	Status
HdBe-Vaccination	L'immunisation peut être définie comme la « génération d'une immunité naturelle à l'encontre d'agents pathogènes par la vaccination (immunisation active) ou par l'administration d'immunoglobulines (immunisation passive) ». Seuls les vaccins administrés sont inclus dans ce modèle d'information. L'administration d'immunoglobulines fait partie de la vue d'ensemble de la médication. Les vaccinations ont une pertinence à vie. Les vaccinations sont également pertinentes pour les patients adultes tels que les transplantés, les patients dialysés et les patients ayant un statut post-splénectomie. En outre, il existe des indications spécifiques pour la vaccination de groupes à risque, comme les voyageurs, les professionnels qui entrent en contact avec le sang ou les patients présentant des blessures, un système immunitaire affaibli ou un risque accru. Purpose Documenter les vaccinations déjà effectuées chez un patient est important pour le diagnostic de maladies infectieuses et pour l'indication et la planification de (re)vaccinations. Evidence Base La documentation sur la vaccination contient nettement moins d'éléments de données que la documentation sur la médication. La médication concerne un processus en cours d'exécution, avec de nombreux intervenants (patient, prescripteur, pharmacie, administrateur) et des détails complexes et très variés. La vaccination ne concerne que ce qui a été administré, et quand.	active

CBB

Concept

Status

HdBe-Vaccination

L'immunisation peut être définie comme la « génération d'une immunité naturelle à l'encontre d'agents pathogènes par la vaccination (immunisation active) ou par l'administration d'immunoglobulines (immunisation passive) ».

Seuls les vaccins administrés sont inclus dans ce modèle d'information. L'administration d'immunoglobulines fait partie de la vue d'ensemble de la médication. Les vaccinations ont une pertinence à vie.

Les vaccinations sont également pertinentes pour les patients adultes tels que les transplantés, les patients dialysés et les patients ayant un statut post-splénectomie. En outre, il existe des indications spécifiques pour la vaccination de groupes à risque, comme les voyageurs, les professionnels qui entrent en contact avec le sang ou les patients présentant des blessures, un système immunitaire affaibli ou un risque accru.

Purpose

Documenter les vaccinations déjà effectuées chez un patient est important pour le diagnostic de maladies infectieuses et pour l'indication et la planification de (re)vaccinations.

Evidence Base

La documentation sur la vaccination contient nettement moins d'éléments de données que la documentation sur la médication. La médication concerne un processus en cours d'exécution, avec de nombreux intervenants (patient, prescripteur, pharmacie, administrateur) et des détails complexes et très variés.

La vaccination ne concerne que ce qui a été administré, et quand.

active

Vaccination			Vaccination	Element id Vaccination Short description Vaccination Definition Concept root du modèle d'information Vaccination. Ce concept root contient tous les éléments de données du modèle d'information Vaccination. Data type Vaccination Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
id		0..1	string	There are no (further) constraints on this element Element id Vaccination.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Vaccination.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
ProductCode		0..1	CodeableConceptBinding	Element id Vaccination.ProductCode Short description CodeProduit Definition Le code produit du vaccin administré. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConcept Binding Codes Produit Vaccin VaccineProduct (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
Dose	I	0..1	Quantity	Element id Vaccination.Dose Short description Dose Definition La quantité de produit administrée indiquée en millilitres. Dans la plupart des cas, le produit entier est administré ; dans certains cas, une partie décrite du produit est administrée. Comments The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. Data type Quantity Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` qty-3: If a code for the unit is present, the system SHALL also be present `code.empty() or system.exists()` Mappings rim: n/a v2: SN (see also Range) or CQ rim: PQ, IVL<PQ>, MO, CO, depending on the values
VaccinationDate		0..1	dateTime	Element id Vaccination.VaccinationDate Short description DateVaccination Definition Date (et, si possible, heure) à laquelle le vaccin a été administré. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
Location	I	0..1	Reference(HdBe-HealthcareOrganization)	Element id Vaccination.Location Short description Location Definition The healthcare center where the vaccination is or will be carried out. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(HdBe-HealthcareOrganization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
Administrator	I	0..1	Reference(HdBe-HealthProfessional)	Element id Vaccination.Administrator Short description Administrator Definition The health professional by whom the vaccination was done or will be done. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(HdBe-HealthProfessional) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
Comment		0..1	string	Element id Vaccination.Comment Short description Commentaire Definition Explication en texte libre. Voici des exemples d'explications couramment utilisées : « Vaccination selon le Programme national de vaccination ». « Non conforme au Programme national de vaccination », suivi d'une explication plus détaillée. « Inconnue » Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a

Vaccination		0..*
Vaccination.ProductCode	CodeableConcept	0..1
Vaccination.Dose	Quantity	0..1
Vaccination.VaccinationDate	dateTime	0..1
Vaccination.Location	Reference(HdBe-HealthcareOrganization)	0..1
Vaccination.Administrator	Reference(HdBe-HealthProfessional)	0..1
Vaccination.Comment	string	0..1

Vaccination
Definition	Root concept of the Vaccination information model. This root concept contains all data elements of the Vaccination information model.
Cardinality	0...*
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
Vaccination.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Mappings	rim: n/a
Vaccination.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
Vaccination.ProductCode
Definition	The product code of the vaccine administered.
Cardinality	0...1
Type	CodeableConcept
Binding	Vaccine Product codes VaccineProduct (extensible)
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
Vaccination.Dose
Definition	The amount of product administered shown in milliliters. In most cases, the entire product is administered; in some cases, a described part of the product is administered.
Cardinality	0...1
Type	Quantity
Comments	The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` qty-3: If a code for the unit is present, the system SHALL also be present `code.empty() or system.exists()`
Mappings	rim: n/a v2: SN (see also Range) or CQ rim: PQ, IVL<PQ>, MO, CO, depending on the values
Vaccination.VaccinationDate
Definition	Date (and if possible time) that the vaccine was administered.
Cardinality	0...1
Type	dateTime
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
Vaccination.Location
Definition	The healthcare center where the vaccination is or will be carried out.
Cardinality	0...1
Type	Reference(HdBe-HealthcareOrganization)
Comments	References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
Vaccination.Administrator
Definition	The health professional by whom the vaccination was done or will be done.
Cardinality	0...1
Type	Reference(HdBe-HealthProfessional)
Comments	References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
Mappings	rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
Vaccination.Comment
Definition	Free text explanation. Examples of commonly used explanations are: - "Vaccination according to the National Immunisation Program". - "Not according to the National Immunisation Program", followed by further explanation. - "Unknown"
Cardinality	0...1
Type	string
Comments	Note that FHIR strings SHALL NOT exceed 1MB in size
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a

Example instances

vaccination
ProductCode	836393002 - Rabies lyssavirus antigen-containing vaccine product (code by SNOMED CT)
Dose
VaccinationDate	2018-02-06
Administrator	--
Administrator	Reference to HealthProfessional (E. Penninx)
Location	Reference to HealthcareOrganization (Enterprise Hospital Ziekenhuis)
Comment	Visit to Peru.

zib Vaccination-v4.0 difference

Concept	Category	Description
Description	textual	Removed all text about planned vaccinations from the Concept, Purpose and Evidence Base sections.
Description.concept	textual	Removed Dutch context.
`ProductCode`	terminology	Replaced all ValueSets by the ValueSet VaccineProduct with the descendants of SNOMED CT concept 787859002 (Vaccine Product) and loosened the binding from required to extensible.
`ProductCode`	textual	Removed contextual information about the multiple valueSets.
`VaccinationDate`	textual	Removed text about planned vaccinations, as this CBB is only used for administered vaccinations .
`Location`	element	Added element to accommodate healthcareProviders as the location (naming conform pre-adopt of higher zib version).(zib-1447).
`Administrator`	textual	Fixed incorrect mentioning of healthcareProvider with health professional as the administrator (zib-1447).
`Location`	textual	Replaced 'is or or' with 'is or'.

Terminology Bindings

Path	Name	Strength	URL
ProductCode	VaccineProduct	extensible	https://fhir.healthdata.be/ValueSet/VaccineProduct