HdBe-Vaccination
CBB | Description | Status |
---|---|---|
HdBe-Vaccination | Immunization can be defined as “Generating natural immunity against pathogens by means of vaccination (active immunization) or by administering immunoglobulins (passive immunization)”. Only the administered vaccinations are included in this information model. Administering immunoglobulins is part of the medication overview. Vaccinations have lifelong relevance. Vaccinations are also relevant for adult patients such as transplant patients, dialysis patients and patients with a post-splenectomy status. In addition, there are specific indications for the vaccination of risk groups, such as travelers, professionals who come into contact with blood or patients with wounds, weakened immune systems or heightened risk. PurposeDocumenting vaccinations that have already taken place in a patient is important for things such as the diagnostics of infectious diseases and the indication and planning of (re)vaccinations. Evidence BaseVaccination documentation contains far fewer data elements than medication documentation. Medication concerns a running order process with many participants (patient, prescriber, pharmacy, administrator) and complex, very diverse details. Vaccinations are only about what was administered and when. | active |
Vaccination | Vaccination | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
ProductCode | 0..1 | CodeableConceptBinding | |
Dose | I | 0..1 | Quantity |
VaccinationDate | 0..1 | dateTime | |
Location | I | 0..1 | Reference(HdBe-HealthcareOrganization) |
Administrator | I | 0..1 | Reference(HdBe-HealthProfessional) |
Comment | 0..1 | string |
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 |
|
Mappings |
|
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 |
|
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 |
|
Mappings |
|
Vaccination.ProductCode | |
Definition | The product code of the vaccine administered. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Vaccine Product codes |
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 |
|
Mappings |
|
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 |
|
Mappings |
|
Vaccination.VaccinationDate | |
Definition | Date (and if possible time) that the vaccine was administered. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
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 |
|
Mappings |
|
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 |
|
Mappings |
|
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 |
|
Mappings |
|
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 |