CH VACD FHIR API CapabilityStatement for server

Implementation Guide CH VACD
7.0.0-ballot-ci-build - ci-build Switzerland flag

Implementation Guide CH VACD, published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ballot-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-vacd/ and changes regularly. See the Directory of published versions

CapabilityStatement: CH VACD FHIR API CapabilityStatement for server

Official URL: http://fhir.ch/ig/ch-vacd/CapabilityStatement/ch-vacd-api-capstmt-srv				Version: 7.0.0-ballot-ci-build
Draft as of 2026-03-23				Computable Name: CHVACDApiCapabilityStatementServer
Copyright/Legal: CC0-1.0

CapabilityStatement for CH VACD API (server).

This is a first version of a possible API description.
Feedback during the Ballot 7.0.0 is very appreciated!

Raw OpenAPI-Swagger Definition file | Download

Implementation Guide Version: 7.0.0-ballot-ci-build
FHIR Version: 4.0.1
Supported Formats: application/fhir+xml, application/fhir+json
Published on: 2026-03-23 09:43:45+0100
Published by: HL7 Switzerland

Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: `server`

The server will handle all resources and also complete vaccination documents

Summary of System-wide Interactions

Supports the transactioninteraction described as follows:
Create/update resources as Batch or Transaction

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

The relevant profiles (if any)
The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
The required, recommended, and some optional search parameters (if any).
The linked resources enabled for _include
The other resources enabled for _revinclude
The operations on the resource (if any)

Resource Type	Profile	R	S	U	C	Searches	`_include`	Operations
AllergyIntolerance	http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-allergyintolerances	y	y	y	y	code, patient, identifier	`*`
Condition	http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-condition Additional supported profiles: CH VACD Basic Immunization CH VACD Medical Problems CH VACD Past Illness	y	y	y	y	code, patient, identifier	`*`
Immunization	http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-immunization	y	y	y	y	patient, vaccine-code, target-disease, date, identifier	`*`
Observation	http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-laboratory-serology	y	y	y	y	code, patient, identifier	`*`
Medication	http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-medication-for-immunization	y	y	y	y	code, identifier	`*`
OperationDefinition	http://hl7.org/fhir/StructureDefinition/OperationDefinition	y					`*`
Composition	http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-composition-epr Additional supported profiles: CH VACD Immunization Administration Composition CH VACD VaccinationRecord Composition	y	y			patient, type		`$document`
Bundle	http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-document-epr Additional supported profiles: CH VACD Immunization Administration Document CH VACD Vaccination Record Document	y	y		y	composition, type
Organization	http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-organization Additional supported profiles: CH Core Organization EPR	y	y	y	y	name, identifier	`*`
Patient	http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient Additional supported profiles: CH Core Patient EPR	y	y	y	y	name, family, given, birthdate, gender, identifier, address	`*`	`$export-document`
Practitioner	http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-practitioner Additional supported profiles: CH Core Practitioner EPR	y	y	y	y	name, family, given, identifier, address	`*`
PractitionerRole	http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-practitionerrole Additional supported profiles: CH Core PractitionerRole EPR	y	y	y	y	code	`*`
RelatedPerson	http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-relatedperson	y	y	y	y	code, name, patient	`*`
Binary		y	y	y	y	code	`*`
Device		y	y	y	y	code	`*`

Resource Conformance: unspecifiedAllergyIntolerance

Base System Profile
CH VACD AllergyIntolerance

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports update, search-type, read, create.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	code	`token`	Code that identifies the allergy or intolerance
SHALL	patient	`reference`	Who the sensitivity is for
SHALL	identifier	`token`	Any identifier for the AllergyIntolerance.

Resource Conformance: unspecifiedCondition

Base System Profile
CH VACD Condition Profile (Abstract)

Profile Conformance
SHALL

Reference Policy

Supported Profiles

CH VACD Basic Immunization
CH VACD Medical Problems
CH VACD Past Illness

Interaction summary

Supports update, search-type, read, create.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	code	`token`	Code for the condition
SHALL	patient	`reference`	Who has the condition?
SHALL	identifier	`token`	Any identifier for the Condition.

Resource Conformance: unspecifiedImmunization

Base System Profile
CH VACD Immunization

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports update, search-type, read, create.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`	The patient for the vaccination record
SHALL	vaccine-code	`token`	Vaccine Product Administered
SHALL	target-disease	`token`	The target disease the dose is being administered against
SHALL	date	`date`	Vaccination (non)-Administration Date
SHALL	identifier	`token`	Any identifier for the Immunization.

Resource Conformance: unspecifiedObservation

Base System Profile
CH VACD Laboratory And Serology

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports update, search-type, read, create.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	code	`token`	The code of the observation type
SHALL	patient	`reference`	The subject that the observation is about (if patient)
SHALL	identifier	`token`	Any identifier for the Observation.

Resource Conformance: unspecifiedMedication

Base System Profile
CH VACD Medication For Immunization

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports update, search-type, read, create.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	code	`token`	Returns medications for a specific code
SHALL	identifier	`token`	Returns medications with this external identifier

Resource Conformance: unspecifiedOperationDefinition

Base System Profile
OperationDefinition

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read.

Resource Conformance: unspecifiedComposition

Base System Profile
CH Core Composition EPR

Profile Conformance
SHALL

Reference Policy

Supported Profiles

CH VACD Immunization Administration Composition
CH VACD VaccinationRecord Composition

Interaction summary

Supports read, search-type.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`	Who and/or what the composition is about
SHALL	type	`token`	Kind of composition

Extended Operations

Conformance	Operation	Documentation
SHALL	$document	Generate export document according to the composition

Resource Conformance: unspecifiedBundle

Base System Profile
CH Core Document EPR

Profile Conformance
SHALL

Reference Policy

Supported Profiles

CH VACD Immunization Administration Document
CH VACD Vaccination Record Document

Interaction summary

Supports search-type, read, create.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	composition	`reference`	The first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to search its contents
SHALL	type	`token`	document

Resource Conformance: unspecifiedOrganization

Base System Profile
CH Core Organization

Profile Conformance
SHALL

Reference Policy

Supported Profiles

CH Core Organization EPR

Interaction summary

Supports update, search-type, read, create.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	name	`string`	A portion of the organization's name or alias
SHALL	identifier	`token`	Any identifier for the Organization.

Resource Conformance: unspecifiedPatient

Base System Profile
CH Core Patient

Profile Conformance
SHALL

Reference Policy

Supported Profiles

CH Core Patient EPR

Interaction summary

Supports update, search-type, read, create.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	name	`string`	A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
SHALL	family	`string`	A portion of the family name of the patient
SHALL	given	`string`	A portion of the given name of the patient
SHALL	birthdate	`date`	The patient's date of birth
SHALL	gender	`token`	Gender of the patient
SHALL	identifier	`token`	A patient identifier
SHALL	address	`string`	A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text

Extended Operations

Conformance	Operation	Documentation
SHALL	$export-document	Generate export document according to the selected export type

Resource Conformance: unspecifiedPractitioner

Base System Profile
CH Core Practitioner

Profile Conformance
SHALL

Reference Policy

Supported Profiles

CH Core Practitioner EPR

Interaction summary

Supports update, search-type, read, create.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	name	`string`	A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
SHALL	family	`string`	A portion of the family name
SHALL	given	`string`	A portion of the given name of the patient
SHALL	identifier	`token`	A patient identifier
SHALL	address	`string`	A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text

Resource Conformance: unspecifiedPractitionerRole

Base System Profile
CH Core PractitionerRole

Profile Conformance
SHALL

Reference Policy

Supported Profiles

CH Core PractitionerRole EPR

Interaction summary

Supports update, search-type, read, create.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	code	`string`

Resource Conformance: unspecifiedRelatedPerson

Base System Profile
CH Core RelatedPerson

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports update, search-type, read, create.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	code	`string`
SHALL	name	`string`	A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
SHALL	patient	`reference`	The patient this related person is related to

Resource Conformance: unspecifiedBinary

Core FHIR Resource
Binary

Reference Policy

Interaction summary

Supports update, search-type, read, create.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	code	`string`

Resource Conformance: unspecifiedDevice

Core FHIR Resource
Device

Reference Policy

Interaction summary

Supports update, search-type, read, create.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	code	`string`

IG © 2021+ HL7 Switzerland. Package ch.fhir.ig.ch-vacd#7.0.0-ballot-ci-build based on FHIR 4.0.1. Generated 2026-05-05
Links: Table of Contents | QA Report | Propose a change

CapabilityStatement: CH VACD FHIR API CapabilityStatement for server