This page is part of the CH VACD (R4) (v7.0.0-ballot: STU 7 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

REST API

Since this IG was originally created as a specification for a document-based exchange format, it did not contain any specific documentation on the FHIR RESTful API.

Nevertheless, the resource profiles defined in this IG can be used in the context of a server with FHIR RESTful API. This also includes uploading and downloading CH VACD documents.

In a fully based FHIR environment client applications - i.e. patient vaccination app or a healthcare provider system - will communicate using the FHIR API. The endpoint can be a fully FHIR server incl. a repository for persistance or a FHIR facade connecting to a MR application.

Next to the endpoints of the resources used in a vaccination context an export operation $export-document can be provided to export the data into an vaccination record document or an immunization recommendation request message.

See the Capability Statement of a FHIR server with focus on vaccination with more details.