RIVO-Noord Zorgviewer Implementation Guide
1.11.0 - sprint49 Netherlands flag

This page is part of the RIVO-Noord Zorgviewer Implementation Guide (v1.11.0: Release) based on FHIR (HL7® FHIR® Standard) R3. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: Vaccination

Official URL: http://fhir.hl7.nl/zorgviewer/StructureDefinition/Immunization Version: 1.11.0
Active as of 2025-01-20 Computable Name: Vaccination

Vaccinatie (Immunization)

Dit Profiel is het resultaat van de vergelijking tussen de zib2017 FHIR Profiel en de implementaties in Epic, Chipsoft, Topicus en Nexus. De elementen die in ieder geval in alle output beschikbaar zullen zijn. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.

Zorginformatiebouwsteen

ZIB Vaccinaties

View Definition

Kolom label FHIR Path FHIR Type Zib element Toelichting of regels
Bron .meta.extension("http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source").valueUri string nvt Lookup adhv uri (AGB-Z of OID) <adressering-base>/Organization?identifier=<.meta.tag.code> en gebruik dan Organization.name
Datum .date dateTime VaccinatieDatum
Product .vaccineCode.text string ProductCode
Toelichting .note.text string Toelichting

Request

  1. Opvragen (search) vaccinaties

    GET <ontsluiten-bronsysteem-base>/Immunization?patient=<fhir_patient_id>&status=completed

Bronsysteem herkennen

De Zorgviewer-backend of Ontsluiten bronsysteem MOET na bevragen van het bronsysteem aan elk resultaat resource een meta-tag toevoegen met de AGB, OID of URA identifier van de zorgaanbieder (zie Organization voor voorbeelden). Dit wordt vervolgens gebruikt in de "Bron" kolom in de Zorgviewer-frontend. N.B. We gebruiken hier een pre-adopt van de FHIR R4 Meta.source.

Toevoegen aan elke response, dus per resource (bij een read) of per Bundle (bij een search):

"meta": {
    "extension": [ {
        "url": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source",
        "valueUri": "urn:oid:2.16.840.1.113883.2.4.3.8"
    } ]
}

Alternatief: Elke entry van een search response Bundle bevat een referentie naar de bijbehorende Patient (<resource>.subject|patient). Elke patient heeft een Patient.managingOrganization en in de gerefereerde Organization.identifier staat vervolgens o.a. de OID van het bronsysyeem. Of je gebruikt de identifiers om een volledige Organization op te zoeken in het adresboek en zie inhoud hier.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Changes since version 1.10.0:

  • The data elements list has changed

    • Formal Views of Profile Content

    Description of Profiles, Differentials, Snapshots and how the different presentations work.

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Immunization C 0..* Zib Vaccination Vaccination
    dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
    imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
    imm-1: If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... status ?!Σ 1..1 code completed | entered-in-error
    Binding: Immunization Status Codes (required): A set of codes indicating the current status of an Immunization

    ... vaccineCode 1..1 CodeableConcept ProductCode
    Binding: Vaccine Administered Value Set (example): The code for vaccine product administered

    .... Slices for coding Σ 1..* Coding Code defined by a terminology system
    Slice: Unordered, Open by value:system
    ..... coding:All Slices Content/Rules for all slices
    ...... display SΣ 0..1 string Representation defined by the system
    ..... coding:productCodeGPKCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeGPKCodelijst (required): ProductCodeGPKCodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.1
    ..... coding:productCodeHPKCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeHPKCodelijst (required): ProductCodeHPKCodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.7
    ..... coding:productCodeZICodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeZICodelijst (required): ProductCodeZICodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.8
    ..... coding:productCodeATCCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeATCCodelijst (required): ProductCodeATCCodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: http://www.whocc.no/atc
    ..... coding:productCodePRKCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodePRKCodelijst (required): ProductCodePRKCodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.10
    ..... coding:productCodeGTINCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeGTINCodelijst (required): ProductCodeGTINCodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:1.3.160
    .... text SΣ 0..1 string Plain text representation of the concept
    ... patient 1..1 Reference(nl-core-patient) Who was immunized
    ... date S 1..1 dateTime VaccinationDate
    ... primarySource 1..1 boolean Indicates context the data was recorded in
    ... note Σ 0..* Annotation Vaccination notes
    .... text S 1..1 string Comment

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Immunization.statusrequiredImmunization Status Codes
    http://hl7.org/fhir/ValueSet/immunization-status
    from the FHIR Standard
    Immunization.vaccineCodeexampleVaccine Administered Value Set
    http://hl7.org/fhir/ValueSet/vaccine-code
    from the FHIR Standard
    Immunization.vaccineCode.coding:productCodeGPKCodelijstrequiredProductCodeGPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000
    Immunization.vaccineCode.coding:productCodeHPKCodelijstrequiredProductCodeHPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.7)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000
    Immunization.vaccineCode.coding:productCodeZICodelijstrequiredProductCodeZICodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.8)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000
    Immunization.vaccineCode.coding:productCodeATCCodelijstrequiredProductCodeATCCodelijst
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000
    Immunization.vaccineCode.coding:productCodePRKCodelijstrequiredProductCodePRKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.10)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000
    Immunization.vaccineCode.coding:productCodeGTINCodelijstrequiredProductCodeGTINCodelijst (a valid code from urn:oid:1.3.160)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-1errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
    : contained.text.empty()
    dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
    : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
    dom-4errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
    imm-1errorImmunizationIf immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
    : (notGiven = true).not() or (reaction.empty() and explanation.reason.empty())
    imm-2errorImmunizationIf immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
    : (notGiven = true) or explanation.reasonNotGiven.empty()

     

    Other representations of profile: CSV, Excel, Schematron