FHIR IG Statistics: StructureDefinition/HdBe-Vaccination-event

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "HdBe-Vaccination-event",
  "url": "https://fhir.healthdata.be/StructureDefinition/HdBe-Vaccination-event",
  "name": "HdBeVaccinationevent",
  "title": "HdBe-Vaccination event",
  "status": "draft",
  "date": "2022-10-17T09:09:13.9562003+00:00",
  "publisher": "Healthdata.be (Sciensano)",
  "contact": [
    {
      "name": "Service portal – healthdata.be",
      "telecom": [
        {
          "system": "url",
          "value": "https://sciensano.service-now.com/sp",
          "use": "work"
        }
      ]
    }
  ],
  "description": "Immunization can be defined as “Generating natural immunity against pathogens by means of vaccination (active immunization) or by administering immunoglobulins (passive immunization)”.\r\n\r\nOnly the administered vaccinations are included in this information model. Administering immunoglobulins is part of the medication overview. Vaccinations have lifelong relevance.\r\n\r\nVaccinations 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.",
  "copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "zib-vaccination-v4.0-2020EN",
      "uri": "https://zibs.nl/wiki/Vaccination-v4.0(2020EN)",
      "name": "zib Vaccination-v4.0(2020EN)"
    },
    {
      "identity": "HdBe-Vaccination",
      "uri": "https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-Vaccination",
      "name": "HdBe logical model Vaccination"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "Immunization",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Immunization",
        "path": "Immunization",
        "short": "Vaccination",
        "comment": "The CBB Vaccination is mapped to this Immunization profile and a profile on ImmunizationRecommendation. All administered vaccinations are covered using this Immunization profile, while all planned vaccinations are covered in the ImmunizationRecommendation profile. Currently, only the Immunization profile is published because the current scope is actually performed immunizations.\r\n\r\nPlease note that, contrary to the related CBB concepts, `.vaccineCode` and `.occurrence[x]` are mandatory in FHIR and need to be recorded to exchange Immunization resources.",
        "alias": [
          "Vaccinatie"
        ],
        "mapping": [
          {
            "identity": "zib-vaccination-v4.0-2020EN",
            "map": "NL-CM:11.1.1",
            "comment": "Vaccination"
          },
          {
            "identity": "HdBe-Vaccination",
            "map": "Vaccination"
          }
        ]
      },
      {
        "id": "Immunization.status",
        "path": "Immunization.status",
        "comment": "This element has no functional counterpart in the CBB and cannot be implicitly mapped to other concepts. Unless a more appropriate status is recorded, it is assumed that only _completed_ Immunization resources will be exchanged."
      },
      {
        "id": "Immunization.vaccineCode",
        "path": "Immunization.vaccineCode",
        "short": "ProductCode",
        "definition": "The product code of the vaccine administered.",
        "alias": [
          "ProductCode"
        ],
        "binding": {
          "strength": "extensible",
          "valueSet": "https://fhir.healthdata.be/ValueSet/ProductCode"
        },
        "mapping": [
          {
            "identity": "zib-vaccination-v4.0-2020EN",
            "map": "NL-CM:11.1.2",
            "comment": "ProductCode"
          },
          {
            "identity": "HdBe-Vaccination",
            "map": "Vaccination.ProductCode"
          }
        ]
      },
      {
        "id": "Immunization.patient",
        "path": "Immunization.patient",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Patient",
              "https://fhir.healthdata.be/StructureDefinition/HdBe-Patient"
            ]
          }
        ]
      },
      {
        "id": "Immunization.occurrence[x]",
        "path": "Immunization.occurrence[x]",
        "slicing": {
          "discriminator": [
            {
              "type": "type",
              "path": "$this"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "Immunization.occurrence[x]:occurrenceDateTime",
        "path": "Immunization.occurrence[x]",
        "sliceName": "occurrenceDateTime",
        "short": "VaccinationDate",
        "definition": "Date (and if possible time) that the vaccine was administered.",
        "alias": [
          "VaccinatieDatum"
        ],
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "mapping": [
          {
            "identity": "zib-vaccination-v4.0-2020EN",
            "map": "NL-CM:11.1.3",
            "comment": "VaccinationDate"
          },
          {
            "identity": "HdBe-Vaccination",
            "map": "Vaccination.VaccinationDate"
          }
        ]
      },
      {
        "id": "Immunization.location",
        "path": "Immunization.location",
        "short": "Location",
        "definition": "The healthcare center where the vaccination is or or will be carried out.",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.healthdata.be/StructureDefinition/HdBe-HealthcareOrganization"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "HdBe-Vaccination",
            "map": "Vaccination.Location"
          }
        ]
      },
      {
        "id": "Immunization.doseQuantity",
        "path": "Immunization.doseQuantity",
        "short": "Dose",
        "definition": "The amount of product administered expressed in UCUM, often mL. In most cases, the entire product is administered; in some cases, a described part of the product is administered.",
        "comment": "The definition of Dose deviates slightly from the zib 2020 vaccination definition; the unit of measure is not limited to mL. This difference is according to the planned vaccination zib modifications (https://bits.nictiz.nl/browse/ZIB-1654).",
        "alias": [
          "Dosis"
        ],
        "patternQuantity": {
          "system": "http://unitsofmeasure.org"
        },
        "mapping": [
          {
            "identity": "zib-vaccination-v4.0-2020EN",
            "map": "NL-CM:11.1.4",
            "comment": "Dose"
          },
          {
            "identity": "HdBe-Vaccination",
            "map": "Vaccination.Dose"
          }
        ]
      },
      {
        "id": "Immunization.performer",
        "path": "Immunization.performer",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "function"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "Immunization.performer:administrator",
        "path": "Immunization.performer",
        "sliceName": "administrator",
        "max": "1"
      },
      {
        "id": "Immunization.performer:administrator.function",
        "path": "Immunization.performer.function",
        "min": 1,
        "patternCodeableConcept": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v2-0443",
              "code": "AP"
            }
          ]
        }
      },
      {
        "id": "Immunization.performer:administrator.actor",
        "path": "Immunization.performer.actor",
        "short": "Administrator",
        "definition": "The health professional by whom the vaccination was done or will be done.",
        "alias": [
          "Toediener"
        ],
        "type": [
          {
            "code": "Reference",
            "profile": [
              "https://fhir.healthdata.be/StructureDefinition/pattern-HealthProfessionalReference"
            ],
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Practitioner",
              "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
              "http://hl7.org/fhir/StructureDefinition/Organization",
              "https://fhir.healthdata.be/StructureDefinition/HdBe-HealthProfessional-PractitionerRole"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "zib-vaccination-v4.0-2020EN",
            "map": "NL-CM:11.1.6",
            "comment": "Administrator"
          },
          {
            "identity": "HdBe-Vaccination",
            "map": "Vaccination.Administrator"
          }
        ]
      },
      {
        "id": "Immunization.note",
        "path": "Immunization.note",
        "max": "1"
      },
      {
        "id": "Immunization.note.text",
        "path": "Immunization.note.text",
        "short": "Comment",
        "definition": "Free text explanation.  \r\n \r\nExamples of commonly used explanations are:  \r\n* \"Vaccination according to the National Immunisation Program\".  \r\n* \"Not according to the National Immunisation Program\", followed by further explanation. \r\n* \"Unknown\"",
        "alias": [
          "Toelichting"
        ],
        "mapping": [
          {
            "identity": "zib-vaccination-v4.0-2020EN",
            "map": "NL-CM:11.1.7",
            "comment": "Comment"
          },
          {
            "identity": "HdBe-Vaccination",
            "map": "Vaccination.Comment"
          }
        ]
      }
    ]
  }
}