Implementation Guide CH VACD
5.0.0 - trial-use Switzerland flag

This page is part of the CH VACD (R4) (v5.0.0: STU 5) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Immunization Administration Document

The Immunization Administration document describes the content and format of an immunization administration document. It serves to document changes in the immunization status and contains information on applied immunizations and further relevant chapters as medical and exposition risks or serology results.

This document is allowed to be used in context of the Swiss EPR but can also used in context of data exchange next to the Swiss EPR.

Aggregation

Immunization Administration document have one to multiple entries documenting actions on a patient around vaccination. An Immunization Administration document can, but does normally not document the complete immunization status of a patient. Therefor we have defined the document Vaccination Record which can be created by the the aggregation of Immunization Administration documents and is described here.

FHIR document (Bundle)

This exchange format is defined as a document type that corresponds to a Bundle as a FHIR resource. A Bundle has a list of entries. The first entry is the Composition, in which all contained entries are then referenced.

Fig.: Immunization Administration document

Fig.: Immunization Administration document

Identifiers

Identifier Format

In CH VACD it is specified to use an UUID as identifier, for both the document and resource identifiers. For representing UUIDs the system needs to be urn:ietf:rfc:3986 as described here. The value has to start with urn:uuid:.

Document Identifier

Document identifier in 1.1 Immunization Administration:
Bundle.identifier/Composition.identifier. In first version of the document the both are equal. On updates of the document they differ.

  "identifier" : {
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:uuid:5bca53b2-0973-4b91-961e-b1e93474c9c2"
  }

Narrative Text Generation

The narrative text in the composition of the bundle of type document can be generated using the FHIR XML representation and the defined xslt transformer defined in this implementation guide. For further details see Narrative Text Generation.

Examples

  • 1.1 Example Immunization Administration document: XML, JSON
  • 2.1 Example Immunization Administration composition: XML, JSON
  • 3.1 Example Patient: XML, JSON

Resource profiles