ChUmzhConnectCapabilityStatement
type: CapabilityStatement
node role: treeRoot
id:
  v: ChUmzhConnectCapabilityStatement
text:
  status:
    v: extensions
  div:
    v: 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-umzhconnec…
url:
  v: http://fhir.ch/ig/ch-umzh-connect/CapabilityStatement/ChUmzhConnectCapabilityStatement
version:
  v: 1.0.0-ballot
name:
  v: UMZHconnectRestServer
status:
  v: active
date:
  v: 2026-01-27T16:12:05.435+01:00
publisher:
  v: UMZH Connect Team
contact:
  name:
    v: UMZH Connect
  telecom:
    system:
      v: url
    value:
      v: https://umzhconnect.ch/
description:
  v: 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`.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
    code:
      v: CHE
copyright:
  v: CC0-1.0
kind:
  v: requirements
fhir version:
  v: 4.0.1
format:
  v: application/fhir+json
patch format:
  v: application/json-patch+json
rest:
  mode:
    v: server
  resource:
    type:
      v: AllergyIntolerance
    interaction:
      code:
        v: read
      documentation:
        v: 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`.
    versioning:
      v: versioned-update
    conditional create:
      v: false
    conditional update:
      v: false
    search param:
      name:
        v: _id
      definition:
        v: http://hl7.org/fhir/SearchParameter/Resource-id
        link: http://hl7.org/fhir/SearchParameter/Resource-id
      type:
        v: token
      documentation:
        v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.
  resource:
    type:
      v: Appointment
    interaction:
      code:
        v: read
      documentation:
        v: 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`.
    versioning:
      v: versioned-update
    conditional create:
      v: false
    conditional update:
      v: false
    search param:
      name:
        v: _id
      definition:
        v: http://hl7.org/fhir/SearchParameter/Resource-id
        link: http://hl7.org/fhir/SearchParameter/Resource-id
      type:
        v: token
      documentation:
        v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.
  resource:
    type:
      v: Condition
    interaction:
      code:
        v: read
      documentation:
        v: 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`.
    versioning:
      v: versioned-update
    conditional create:
      v: false
    conditional update:
      v: false
    search param:
      name:
        v: _id
      definition:
        v: http://hl7.org/fhir/SearchParameter/Resource-id
        link: http://hl7.org/fhir/SearchParameter/Resource-id
      type:
        v: token
      documentation:
        v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.
  resource:
    type:
      v: Coverage
    interaction:
      code:
        v: read
      documentation:
        v: 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`.
    versioning:
      v: versioned-update
    conditional create:
      v: false
    conditional update:
      v: false
    search param:
      name:
        v: _id
      definition:
        v: http://hl7.org/fhir/SearchParameter/Resource-id
        link: http://hl7.org/fhir/SearchParameter/Resource-id
      type:
        v: token
      documentation:
        v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.
  resource:
    type:
      v: DiagnosticReport
    interaction:
      code:
        v: read
      documentation:
        v: 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`.
    versioning:
      v: versioned-update
    conditional create:
      v: false
    conditional update:
      v: false
    search param:
      name:
        v: _id
      definition:
        v: http://hl7.org/fhir/SearchParameter/Resource-id
        link: http://hl7.org/fhir/SearchParameter/Resource-id
      type:
        v: token
      documentation:
        v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.
  resource:
    type:
      v: DocumentReference
    interaction:
      code:
        v: read
      documentation:
        v: 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`.
    versioning:
      v: versioned-update
    conditional create:
      v: false
    conditional update:
      v: false
    search param:
      name:
        v: _id
      definition:
        v: http://hl7.org/fhir/SearchParameter/Resource-id
        link: http://hl7.org/fhir/SearchParameter/Resource-id
      type:
        v: token
      documentation:
        v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.
  resource:
    type:
      v: ImagingStudy
    interaction:
      code:
        v: read
      documentation:
        v: 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`.

v: versioned-update

v: false

v: false

name:
  v: _id
definition:
  v: http://hl7.org/fhir/SearchParameter/Resource-id
  link: http://hl7.org/fhir/SearchParameter/Resource-id
type:
  v: token
documentation:
  v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.

type:
  v: Immunization
interaction:
  code:
    v: read
  documentation:
    v: 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`.
versioning:
  v: versioned-update
conditional create:
  v: false
conditional update:
  v: false
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.

type:
  v: Medication
interaction:
  code:
    v: read
  documentation:
    v: 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`.
versioning:
  v: versioned-update
conditional create:
  v: false
conditional update:
  v: false
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.

type:
  v: MedicationStatement
interaction:
  code:
    v: read
  documentation:
    v: 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`.
versioning:
  v: versioned-update
conditional create:
  v: false
conditional update:
  v: false
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.

type:
  v: Observation
interaction:
  code:
    v: read
  documentation:
    v: 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`.
versioning:
  v: versioned-update
conditional create:
  v: false
conditional update:
  v: false
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.

type:
  v: Organization
interaction:
  code:
    v: read
  documentation:
    v: 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`.
versioning:
  v: versioned-update
conditional create:
  v: false
conditional update:
  v: false
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.

type:
  v: Patient
interaction:
  code:
    v: read
  documentation:
    v: 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`.
versioning:
  v: versioned-update
conditional create:
  v: false
conditional update:
  v: false
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.

type:
  v: Practitioner
interaction:
  code:
    v: read
  documentation:
    v: 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`.
versioning:
  v: versioned-update
conditional create:
  v: false
conditional update:
  v: false
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.

type:
  v: PractitionerRole
interaction:
  code:
    v: read
  documentation:
    v: 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`.
versioning:
  v: versioned-update
conditional create:
  v: false
conditional update:
  v: false
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.

type:
  v: Procedure
interaction:
  code:
    v: read
  documentation:
    v: 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`.
versioning:
  v: versioned-update
conditional create:
  v: false
conditional update:
  v: false
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.

type:
  v: Questionnaire
interaction:
  code:
    v: search-type
  documentation:
    v: Search for Questionnaire definitions. Questionnaire is a definitional artefact shared across workflows; it carries no patient data and is **not** `fhirContext`-gated.
interaction:
  code:
    v: read
  documentation:
    v: Read a Questionnaire by logical id or by canonical URL (url). Definitional content — **not** `fhirContext`-gated.
versioning:
  v: versioned-update
conditional create:
  v: false
conditional update:
  v: false
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact
search param:
  name:
    v: url
  definition:
    v: http://hl7.org/fhir/SearchParameter/Questionnaire-url
    link: http://hl7.org/fhir/SearchParameter/Questionnaire-url
  type:
    v: uri
  documentation:
    v: Canonical URL of the Questionnaire. Used to resolve a Questionnaire referenced by canonical.

type:
  v: QuestionnaireResponse
interaction:
  code:
    v: search-type
  documentation:
    v: Search for QuestionnaireResponses. Implicitly scoped to QuestionnaireResponses accessible to the calling identity.
interaction:
  code:
    v: read
  documentation:
    v: Read a QuestionnaireResponse by logical id. Allowed if the linked parent ServiceRequest is accessible to the calling identity.
interaction:
  code:
    v: create
  documentation:
    v: Create a QuestionnaireResponse. The created resource SHALL reference an accessible ServiceRequest via `basedOn`.
versioning:
  v: versioned-update
conditional create:
  v: false
conditional update:
  v: false

type:
  v: ServiceRequest
interaction:
  code:
    v: search-type
  documentation:
    v: 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.
interaction:
  code:
    v: read
  documentation:
    v: Read a ServiceRequest by logical id. Returns the resource only if `{id}` matches the token's `fhirContext` claim.
versioning:
  v: versioned-update
conditional create:
  v: false
conditional update:
  v: false
search include:
  v: ServiceRequest:patient
search include:
  v: ServiceRequest:subject
search include:
  v: ServiceRequest:ch-umzhconnectig-servicerequest-reasonreference
search include:
  v: ServiceRequest:ch-umzhconnectig-servicerequest-supportinginfo
search include:
  v: ServiceRequest:ch-umzhconnectig-servicerequest-insurance
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource.

type:
  v: Task
interaction:
  code:
    v: search-type
  documentation:
    v: 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.
interaction:
  code:
    v: patch
  documentation:
    v: 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.
interaction:
  code:
    v: read
  documentation:
    v: Read a Task by logical id. Allowed if the calling identity is `Task.owner` or `Task.requester`.
interaction:
  code:
    v: create
  documentation:
    v: Create a Task. Used by the Placer to raise a coordination Task on the Fulfiller.
versioning:
  v: versioned-update
conditional create:
  v: false
conditional update:
  v: false
search include:
  v: Task:ch-umzhconnectig-task-inputreference
search include:
  v: Task:ch-umzhconnectig-task-outputreference
search include:
  v: Task:ch-umzhconnectig-task-outputcanonical
search param:
  name:
    v: owner
  definition:
    v: http://hl7.org/fhir/SearchParameter/Task-owner
    link: http://hl7.org/fhir/SearchParameter/Task-owner
  type:
    v: reference
  documentation:
    v: Search by task owner
search param:
  name:
    v: requester
  definition:
    v: http://hl7.org/fhir/SearchParameter/Task-requester
    link: http://hl7.org/fhir/SearchParameter/Task-requester
  type:
    v: reference
  documentation:
    v: Search by task requester
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/Task-status
    link: http://hl7.org/fhir/SearchParameter/Task-status
  type:
    v: token
  documentation:
    v: Search by task status
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact