FHIR IG analytics| Package | ch.fhir.ig.ch-vacd |
| Resource Type | CapabilityStatement |
| Id | CapabilityStatement-ch-vacd-api-capstmt-srv.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/hl7ch/ch-vacd/CapabilityStatement-ch-vacd-api-capstmt-srv.html |
| URL | http://fhir.ch/ig/ch-vacd/CapabilityStatement/ch-vacd-api-capstmt-srv |
| Version | 7.0.0-ballot |
| Status | draft |
| Date | 2026-03-23T09:43:45.742+01:00 |
| Name | CHVACDApiCapabilityStatementServer |
| Title | CH VACD FHIR API CapabilityStatement for server |
| Realm | ch |
| Authority | hl7 |
| Description | CapabilityStatement for CH VACD API (server). |
| Copyright | CC0-1.0 |
| Kind | requirements |
No resources found
| OperationDefinition | ||
| ch.fhir.ig.ch-vacd#current | ch-vacd-patient-export-operation | Generate export document |
| StructureDefinition | ||
| ch.fhir.ig.ch-core#current | ch-core-composition-epr | CH Core Composition EPR |
| ch.fhir.ig.ch-core#current | ch-core-document-epr | CH Core Document EPR |
| ch.fhir.ig.ch-core#current | ch-core-organization | CH Core Organization |
| ch.fhir.ig.ch-core#current | ch-core-organization-epr | CH Core Organization EPR |
| ch.fhir.ig.ch-core#current | ch-core-patient | CH Core Patient |
| ch.fhir.ig.ch-core#current | ch-core-patient-epr | CH Core Patient EPR |
| ch.fhir.ig.ch-core#current | ch-core-practitioner | CH Core Practitioner |
| ch.fhir.ig.ch-core#current | ch-core-practitioner-epr | CH Core Practitioner EPR |
| ch.fhir.ig.ch-core#current | ch-core-practitionerrole | CH Core PractitionerRole |
| ch.fhir.ig.ch-core#current | ch-core-practitionerrole-epr | CH Core PractitionerRole EPR |
| ch.fhir.ig.ch-core#current | ch-core-relatedperson | CH Core RelatedPerson |
| ch.fhir.ig.ch-vacd#current | ch-vacd-allergyintolerances | CH VACD AllergyIntolerance |
| ch.fhir.ig.ch-vacd#current | ch-vacd-basic-immunization | CH VACD Basic Immunization |
| ch.fhir.ig.ch-vacd#current | ch-vacd-composition-immunization-administration | CH VACD Immunization Administration Composition |
| ch.fhir.ig.ch-vacd#current | ch-vacd-composition-vaccination-record | CH VACD VaccinationRecord Composition |
| ch.fhir.ig.ch-vacd#current | ch-vacd-condition | CH VACD Condition Profile (Abstract) |
| ch.fhir.ig.ch-vacd#current | ch-vacd-document-immunization-administration | CH VACD Immunization Administration Document |
| ch.fhir.ig.ch-vacd#current | ch-vacd-document-vaccination-record | CH VACD Vaccination Record Document |
| ch.fhir.ig.ch-vacd#current | ch-vacd-immunization | CH VACD Immunization |
| ch.fhir.ig.ch-vacd#current | ch-vacd-laboratory-serology | CH VACD Laboratory And Serology |
| ch.fhir.ig.ch-vacd#current | ch-vacd-medical-problems | CH VACD Medical Problems |
| ch.fhir.ig.ch-vacd#current | ch-vacd-medication-for-immunization | CH VACD Medication For Immunization |
| ch.fhir.ig.ch-vacd#current | ch-vacd-pastillnesses | CH VACD Past Illness |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement ch-vacd-api-capstmt-srv
application/fhir+xml, application/fhir+jsonNote 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.
serverThe server will handle all resources and also complete vaccination documents
transactioninteraction described as follows:Create/update resources as Batch or Transaction
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revincludeupdate, search-type, read, create.| 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. |
CH VACD Basic Immunization
CH VACD Medical Problems
CH VACD Past Illness
update, search-type, read, create.| 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. |
update, search-type, read, create.| 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. |
update, search-type, read, create.| 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. |
update, search-type, read, create.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | token | Returns medications for a specific code |
| SHALL | identifier | token | Returns medications with this external identifier |
read.CH VACD Immunization Administration Composition
CH VACD VaccinationRecord Composition
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Who and/or what the composition is about |
| SHALL | type | token | Kind of composition |
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $document | Generate export document according to the composition |
search-type, read, create.| 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 |
update, search-type, read, create.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | name | string | A portion of the organization's name or alias |
| SHALL | identifier | token | Any identifier for the Organization. |
update, search-type, read, create.| 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 |
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $export-document | Generate export document according to the selected export type |
update, search-type, read, create.| 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 |
update, search-type, read, create.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | string |
update, search-type, read, create.| 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 |
update, search-type, read, create.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | string |
update, search-type, read, create.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | string |
{
"resourceType": "CapabilityStatement",
"id": "ch-vacd-api-capstmt-srv",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://fhir.ch/ig/ch-vacd/CapabilityStatement/ch-vacd-api-capstmt-srv",
"version": "7.0.0-ballot",
"name": "CHVACDApiCapabilityStatementServer",
"title": "CH VACD FHIR API CapabilityStatement for server",
"status": "draft",
"date": "2026-03-23T09:43:45.742+01:00",
"publisher": "HL7 Switzerland",
"contact": [
{
"name": "HL7 Switzerland",
"telecom": [
{
"system": "url",
"value": "https://www.hl7.ch/"
}
]
}
],
"description": "CapabilityStatement for CH VACD API (server).",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "CHE"
}
]
}
],
"copyright": "CC0-1.0",
"kind": "requirements",
"fhirVersion": "4.0.1",
"format": [
"application/fhir+xml",
"application/fhir+json"
],
"rest": [
{
"mode": "server",
"documentation": "The server will handle all resources and also complete vaccination documents",
"resource": [
{
"type": "AllergyIntolerance",
"profile": "http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-allergyintolerances",
"interaction": [
{
"code": "update"
},
{
"code": "search-type"
},
{
"code": "read"
},
{
"code": "create"
}
],
"searchInclude": [
"*"
],
"searchParam": [
{
"name": "code",
"type": "token",
"documentation": "Code that identifies the allergy or intolerance"
},
{
"name": "patient",
"type": "reference",
"documentation": "Who the sensitivity is for"
},
{
"name": "identifier",
"type": "token",
"documentation": "Any identifier for the AllergyIntolerance."
}
]
},
{
"type": "Condition",
"profile": "http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-condition",
"supportedProfile": [
"http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-basic-immunization",
"http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-medical-problems",
"http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-pastillnesses"
],
"interaction": [
{
"code": "update"
},
{
"code": "search-type"
},
{
"code": "read"
},
{
"code": "create"
}
],
"searchInclude": [
"*"
],
"searchParam": [
{
"name": "code",
"type": "token",
"documentation": "Code for the condition"
},
{
"name": "patient",
"type": "reference",
"documentation": "Who has the condition?"
},
{
"name": "identifier",
"type": "token",
"documentation": "Any identifier for the Condition."
}
]
},
{
"type": "Immunization",
"profile": "http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-immunization",
"interaction": [
{
"code": "update"
},
{
"code": "search-type"
},
{
"code": "read"
},
{
"code": "create"
}
],
"searchInclude": [
"*"
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "The patient for the vaccination record"
},
{
"name": "vaccine-code",
"type": "token",
"documentation": "Vaccine Product Administered"
},
{
"name": "target-disease",
"type": "token",
"documentation": "The target disease the dose is being administered against"
},
{
"name": "date",
"type": "date",
"documentation": "Vaccination (non)-Administration Date"
},
{
"name": "identifier",
"type": "token",
"documentation": "Any identifier for the Immunization."
}
]
},
{
"type": "Observation",
"profile": "http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-laboratory-serology",
"interaction": [
{
"code": "update"
},
{
"code": "search-type"
},
{
"code": "read"
},
{
"code": "create"
}
],
"searchInclude": [
"*"
],
"searchParam": [
{
"name": "code",
"type": "token",
"documentation": "The code of the observation type"
},
{
"name": "patient",
"type": "reference",
"documentation": "The subject that the observation is about (if patient)"
},
{
"name": "identifier",
"type": "token",
"documentation": "Any identifier for the Observation."
}
]
},
{
"type": "Medication",
"profile": "http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-medication-for-immunization",
"interaction": [
{
"code": "update"
},
{
"code": "search-type"
},
{
"code": "read"
},
{
"code": "create"
}
],
"searchInclude": [
"*"
],
"searchParam": [
{
"name": "code",
"type": "token",
"documentation": "Returns medications for a specific code"
},
{
"name": "identifier",
"type": "token",
"documentation": "Returns medications with this external identifier"
}
]
},
{
"type": "OperationDefinition",
"profile": "http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"interaction": [
{
"code": "read"
}
],
"searchInclude": [
"*"
]
},
{
"type": "Composition",
"profile": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-composition-epr",
"supportedProfile": [
"http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-composition-immunization-administration",
"http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-composition-vaccination-record"
],
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Who and/or what the composition is about"
},
{
"name": "type",
"type": "token",
"documentation": "Kind of composition"
}
],
"operation": [
{
"name": "document",
"definition": "http://hl7.org/fhir/OperationDefinition/Composition-document",
"documentation": "Generate export document according to the composition"
}
]
},
{
"type": "Bundle",
"profile": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-document-epr",
"supportedProfile": [
"http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-document-immunization-administration",
"http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-document-vaccination-record"
],
"interaction": [
{
"code": "search-type"
},
{
"code": "read"
},
{
"code": "create"
}
],
"searchParam": [
{
"name": "composition",
"type": "reference",
"documentation": "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"
},
{
"name": "type",
"type": "token",
"documentation": "document"
}
]
},
{
"type": "Organization",
"profile": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-organization",
"supportedProfile": [
"http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-organization-epr"
],
"interaction": [
{
"code": "update"
},
{
"code": "search-type"
},
{
"code": "read"
},
{
"code": "create"
}
],
"searchInclude": [
"*"
],
"searchParam": [
{
"name": "name",
"type": "string",
"documentation": "A portion of the organization's name or alias"
},
{
"name": "identifier",
"type": "token",
"documentation": "Any identifier for the Organization."
}
]
},
{
"type": "Patient",
"profile": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient",
"supportedProfile": [
"http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient-epr"
],
"interaction": [
{
"code": "update"
},
{
"code": "search-type"
},
{
"code": "read"
},
{
"code": "create"
}
],
"searchInclude": [
"*"
],
"searchParam": [
{
"name": "name",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
},
{
"name": "family",
"type": "string",
"documentation": "A portion of the family name of the patient"
},
{
"name": "given",
"type": "string",
"documentation": "A portion of the given name of the patient"
},
{
"name": "birthdate",
"type": "date",
"documentation": "The patient's date of birth"
},
{
"name": "gender",
"type": "token",
"documentation": "Gender of the patient"
},
{
"name": "identifier",
"type": "token",
"documentation": "A patient identifier"
},
{
"name": "address",
"type": "string",
"documentation": "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"
}
],
"operation": [
{
"name": "export-document",
"definition": "http://fhir.ch/ig/ch-vacd/OperationDefinition/ch-vacd-patient-export-operation",
"documentation": "Generate export document according to the selected export type"
}
]
},
{
"type": "Practitioner",
"profile": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-practitioner",
"supportedProfile": [
"http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-practitioner-epr"
],
"interaction": [
{
"code": "update"
},
{
"code": "search-type"
},
{
"code": "read"
},
{
"code": "create"
}
],
"searchInclude": [
"*"
],
"searchParam": [
{
"name": "name",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
},
{
"name": "family",
"type": "string",
"documentation": "A portion of the family name"
},
{
"name": "given",
"type": "string",
"documentation": "A portion of the given name of the patient"
},
{
"name": "identifier",
"type": "token",
"documentation": "A patient identifier"
},
{
"name": "address",
"type": "string",
"documentation": "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"
}
]
},
{
"type": "PractitionerRole",
"profile": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-practitionerrole",
"supportedProfile": [
"http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-practitionerrole-epr"
],
"interaction": [
{
"code": "update"
},
{
"code": "search-type"
},
{
"code": "read"
},
{
"code": "create"
}
],
"searchInclude": [
"*"
],
"searchParam": [
{
"name": "code",
"type": "string"
}
]
},
{
"type": "RelatedPerson",
"profile": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-relatedperson",
"interaction": [
{
"code": "update"
},
{
"code": "search-type"
},
{
"code": "read"
},
{
"code": "create"
}
],
"searchInclude": [
"*"
],
"searchParam": [
{
"name": "code",
"type": "string"
},
{
"name": "name",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
},
{
"name": "patient",
"type": "reference",
"documentation": "The patient this related person is related to"
}
]
},
{
"type": "Binary",
"interaction": [
{
"code": "update"
},
{
"code": "search-type"
},
{
"code": "read"
},
{
"code": "create"
}
],
"searchInclude": [
"*"
],
"searchParam": [
{
"name": "code",
"type": "string"
}
]
},
{
"type": "Device",
"interaction": [
{
"code": "update"
},
{
"code": "search-type"
},
{
"code": "read"
},
{
"code": "create"
}
],
"searchInclude": [
"*"
],
"searchParam": [
{
"name": "code",
"type": "string"
}
]
}
],
"interaction": [
{
"code": "transaction",
"documentation": "Create/update resources as Batch or Transaction"
}
]
}
]
}