Generated Narrative: CapabilityStatement ChUmzhConnectCapabilityStatement Implementation Guide Version: 1.0.0-ballot FHIR Version: 4.0.1 Supported Formats: application/fhir+json Supported Patch Formats: application/json-patch+json Published on: 2026-01-27 16:12:05+0100 Published by: UMZH Connect Team 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 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 P C Searches _include _revinclude Operations AllergyIntolerance y _id Appointment y _id Condition y _id Coverage y _id DiagnosticReport y _id DocumentReference y _id ImagingStudy y _id Immunization y _id Medication y _id MedicationStatement y _id Observation y _id Organization y _id Patient y _id Practitioner y _id PractitionerRole y _id Procedure y _id Questionnaire y y _id, url QuestionnaireResponse y y y ServiceRequest y y _id ServiceRequest:patient, ServiceRequest:subject, ServiceRequest:ch-umzhconnectig-servicerequest-reasonreference, ServiceRequest:ch-umzhconnectig-servicerequest-supportinginfo, ServiceRequest:ch-umzhconnectig-servicerequest-insurance Task y y y y owner, requester, status, _id Task:ch-umzhconnectig-task-inputreference, Task:ch-umzhconnectig-task-outputreference, Task:ch-umzhconnectig-task-outputcanonical Resource Conformance: unspecified AllergyIntolerance Core FHIR Resource AllergyIntolerance Reference Policy Interaction summary Supports read Returns the AllergyIntolerance resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's fhirContext claim. Requests for resources outside the context graph are rejected with 403 Forbidden. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified Appointment Core FHIR Resource Appointment Reference Policy Interaction summary Supports read Returns the Appointment resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's fhirContext claim. Requests for resources outside the context graph are rejected with 403 Forbidden. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified Condition Core FHIR Resource Condition Reference Policy Interaction summary Supports read Returns the Condition resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's fhirContext claim. Requests for resources outside the context graph are rejected with 403 Forbidden. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified Coverage Core FHIR Resource Coverage Reference Policy Interaction summary Supports read Returns the Coverage resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's fhirContext claim. Requests for resources outside the context graph are rejected with 403 Forbidden. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified DiagnosticReport Core FHIR Resource DiagnosticReport Reference Policy Interaction summary Supports read Returns the DiagnosticReport resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's fhirContext claim. Requests for resources outside the context graph are rejected with 403 Forbidden. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified DocumentReference Core FHIR Resource DocumentReference Reference Policy Interaction summary Supports read Returns the DocumentReference resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's fhirContext claim. Requests for resources outside the context graph are rejected with 403 Forbidden. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified ImagingStudy Core FHIR Resource ImagingStudy Reference Policy Interaction summary Supports read Returns the ImagingStudy resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's fhirContext claim. Requests for resources outside the context graph are rejected with 403 Forbidden. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified Immunization Core FHIR Resource Immunization Reference Policy Interaction summary Supports read Returns the Immunization resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's fhirContext claim. Requests for resources outside the context graph are rejected with 403 Forbidden. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified Medication Core FHIR Resource Medication Reference Policy Interaction summary Supports read Returns the Medication resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's fhirContext claim. Requests for resources outside the context graph are rejected with 403 Forbidden. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified MedicationStatement Core FHIR Resource MedicationStatement Reference Policy Interaction summary Supports read Returns the MedicationStatement resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's fhirContext claim. Requests for resources outside the context graph are rejected with 403 Forbidden. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified Observation Core FHIR Resource Observation Reference Policy Interaction summary Supports read Returns the Observation resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's fhirContext claim. Requests for resources outside the context graph are rejected with 403 Forbidden. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified Organization Core FHIR Resource Organization Reference Policy Interaction summary Supports read Returns the Organization resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's fhirContext claim. Requests for resources outside the context graph are rejected with 403 Forbidden. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified Patient Core FHIR Resource Patient Reference Policy Interaction summary Supports read Returns the Patient resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's fhirContext claim. Requests for resources outside the context graph are rejected with 403 Forbidden. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified Practitioner Core FHIR Resource Practitioner Reference Policy Interaction summary Supports read Returns the Practitioner resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's fhirContext claim. Requests for resources outside the context graph are rejected with 403 Forbidden. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified PractitionerRole Core FHIR Resource PractitionerRole Reference Policy Interaction summary Supports read Returns the PractitionerRole resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's fhirContext claim. Requests for resources outside the context graph are rejected with 403 Forbidden. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified Procedure Core FHIR Resource Procedure Reference Policy Interaction summary Supports read Returns the Procedure resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's fhirContext claim. Requests for resources outside the context graph are rejected with 403 Forbidden. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified Questionnaire Core FHIR Resource Questionnaire Reference Policy Interaction summary Supports search-type Search for Questionnaire definitions. Questionnaire is a definitional artefact shared across workflows; it carries no patient data and is not fhirContext-gated. read Read a Questionnaire by logical id or by canonical URL (url). Definitional content — not fhirContext-gated. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact SHALL url uri Canonical URL of the Questionnaire. Used to resolve a Questionnaire referenced by canonical. Resource Conformance: unspecified QuestionnaireResponse Core FHIR Resource QuestionnaireResponse Reference Policy Interaction summary Supports search-type Search for QuestionnaireResponses. Implicitly scoped to QuestionnaireResponses accessible to the calling identity. read Read a QuestionnaireResponse by logical id. Allowed if the linked parent ServiceRequest is accessible to the calling identity. create Create a QuestionnaireResponse. The created resource SHALL reference an accessible ServiceRequest via basedOn. Resource Conformance: unspecified ServiceRequest Core FHIR Resource ServiceRequest Reference Policy Interaction summary Supports search-type Search for ServiceRequests. Returns only ServiceRequests reachable from the token's fhirContext claim — in practice, the single ServiceRequest named by the token. _id is mandatory; _include is supported to materialise the workflow graph in one round-trip, and each included resource is itself subject to the fhirContext graph check. read Read a ServiceRequest by logical id. Returns the resource only if {id} matches the token's fhirContext claim. Search Parameters Conformance Parameter Type Documentation SHALL _id token Logical id of this artifact. Mandatory — searches without _id are not supported on this resource. Resource Conformance: unspecified Task Core FHIR Resource Task Reference Policy Interaction summary Supports search-type Search for Tasks. Implicitly scoped to Tasks where the calling identity is Task.owner or Task.requester — the server SHALL enforce this filter regardless of the parameters supplied by the client. A client cannot widen the result set by omitting owner/requester parameters. Task is not fhirContext-gated; it is the entry-point resource on the Fulfiller. patch JSON Patch (application/json-patch+json) update of a Task. Only Task.input, Task.owner, Task.focus, and Task.businessStatus may be patched — other paths SHALL be rejected. read Read a Task by logical id. Allowed if the calling identity is Task.owner or Task.requester. create Create a Task. Used by the Placer to raise a coordination Task on the Fulfiller. Search Parameters Conformance Parameter Type Documentation SHALL owner reference Search by task owner SHALL requester reference Search by task requester SHALL status token Search by task status SHALL _id token Logical id of this artifact
UMZH Connect API requirements. This CapabilityStatement applies to both the [Placer](ActorDefinition-ch-umzh-connect-placer.html) and [Fulfiller](ActorDefinition-ch-umzh-connect-fulfiller.html) server roles. The required interactions overlap significantly; the applicable subset depends on the actor role: - **Placer server** — hosts the ServiceRequest and all referenced clinical resources. \ The Fulfiller queries these via `read` and `search`. - **Fulfiller server** — hosts the Coordination Task and related output resources. \ The Placer creates it via `create`, applies selective updates via `patch`, and queries via `read` and `search`.
Returns the AllergyIntolerance resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's `fhirContext` claim. Requests for resources outside the context graph are rejected with `403 Forbidden`.
Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.
Returns the Appointment resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's `fhirContext` claim. Requests for resources outside the context graph are rejected with `403 Forbidden`.
Returns the Condition resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's `fhirContext` claim. Requests for resources outside the context graph are rejected with `403 Forbidden`.
Returns the Coverage resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's `fhirContext` claim. Requests for resources outside the context graph are rejected with `403 Forbidden`.
Returns the DiagnosticReport resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's `fhirContext` claim. Requests for resources outside the context graph are rejected with `403 Forbidden`.
Returns the DocumentReference resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's `fhirContext` claim. Requests for resources outside the context graph are rejected with `403 Forbidden`.
Returns the ImagingStudy resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's `fhirContext` claim. Requests for resources outside the context graph are rejected with `403 Forbidden`.
Returns the Immunization resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's `fhirContext` claim. Requests for resources outside the context graph are rejected with `403 Forbidden`.
Returns the Medication resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's `fhirContext` claim. Requests for resources outside the context graph are rejected with `403 Forbidden`.
Returns the MedicationStatement resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's `fhirContext` claim. Requests for resources outside the context graph are rejected with `403 Forbidden`.
Returns the Observation resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's `fhirContext` claim. Requests for resources outside the context graph are rejected with `403 Forbidden`.
Returns the Organization resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's `fhirContext` claim. Requests for resources outside the context graph are rejected with `403 Forbidden`.
Returns the Patient resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's `fhirContext` claim. Requests for resources outside the context graph are rejected with `403 Forbidden`.
Returns the Practitioner resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's `fhirContext` claim. Requests for resources outside the context graph are rejected with `403 Forbidden`.
Returns the PractitionerRole resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's `fhirContext` claim. Requests for resources outside the context graph are rejected with `403 Forbidden`.
Returns the Procedure resource by logical id. The resource is returned only if it is reachable from the workflow root named in the token's `fhirContext` claim. Requests for resources outside the context graph are rejected with `403 Forbidden`.
Search for Questionnaire definitions. Questionnaire is a definitional artefact shared across workflows; it carries no patient data and is **not** `fhirContext`-gated.
Read a Questionnaire by logical id or by canonical URL (url). Definitional content — **not** `fhirContext`-gated.
Canonical URL of the Questionnaire. Used to resolve a Questionnaire referenced by canonical.
Search for QuestionnaireResponses. Implicitly scoped to QuestionnaireResponses accessible to the calling identity.
Read a QuestionnaireResponse by logical id. Allowed if the linked parent ServiceRequest is accessible to the calling identity.
Create a QuestionnaireResponse. The created resource SHALL reference an accessible ServiceRequest via `basedOn`.
Search for ServiceRequests. Returns only ServiceRequests reachable from the token's `fhirContext` claim — in practice, the single ServiceRequest named by the token. `_id` is mandatory; `_include` is supported to materialise the workflow graph in one round-trip, and each included resource is itself subject to the `fhirContext` graph check.
Read a ServiceRequest by logical id. Returns the resource only if `{id}` matches the token's `fhirContext` claim.
Search for Tasks. Implicitly scoped to Tasks where the calling identity is `Task.owner` or `Task.requester` — the server SHALL enforce this filter regardless of the parameters supplied by the client. A client cannot widen the result set by omitting `owner`/`requester` parameters. Task is **not** `fhirContext`-gated; it is the entry-point resource on the Fulfiller.
JSON Patch (`application/json-patch+json`) update of a Task. Only `Task.input`, `Task.owner`, `Task.focus`, and `Task.businessStatus` may be patched — other paths SHALL be rejected.
Read a Task by logical id. Allowed if the calling identity is `Task.owner` or `Task.requester`.
Create a Task. Used by the Placer to raise a coordination Task on the Fulfiller.