CH UMZH Connect IG (R4)
1.0.0-ballot - ballot Switzerland flag

CH UMZH Connect IG (R4), published by UMZH Connect Team. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/umzhconnect/umzhconnect-ig/ and changes regularly. See the Directory of published versions

CapabilityStatement: ChUmzhConnectCapabilityStatement

Official URL: http://fhir.ch/ig/ch-umzh-connect/CapabilityStatement/ChUmzhConnectCapabilityStatement Version: 1.0.0-ballot
Active as of 2026-01-27 Computable Name: UMZHconnectRestServer

Copyright/Legal: CC0-1.0

UMZH Connect API requirements. This CapabilityStatement applies to both the Placer and Fulfiller 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.

Raw OpenAPI-Swagger Definition file | Download

  • 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 TypeProfileRSUPCSearches_include_revincludeOperations
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 yy_id, url
QuestionnaireResponse yyy
ServiceRequest yy_idServiceRequest:patient, ServiceRequest:subject, ServiceRequest:ch-umzhconnectig-servicerequest-reasonreference, ServiceRequest:ch-umzhconnectig-servicerequest-supportinginfo, ServiceRequest:ch-umzhconnectig-servicerequest-insurance
Task yyyyowner, requester, status, _idTask:ch-umzhconnectig-task-inputreference, Task:ch-umzhconnectig-task-outputreference, Task:ch-umzhconnectig-task-outputcanonical
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALLurluri

Canonical URL of the Questionnaire. Used to resolve a Questionnaire referenced by canonical.

 
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.

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
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact. Mandatory — searches without _id are not supported on this resource.

 
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
ConformanceParameterTypeDocumentation
SHALLownerreference

Search by task owner

SHALLrequesterreference

Search by task requester

SHALLstatustoken

Search by task status

SHALL_idtoken

Logical id of this artifact