{
"description": "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:\\n- **Placer server** — hosts the ServiceRequest and all referenced clinical resources. \\\\\\nThe Fulfiller queries these via `read` and `search`.\\n- **Fulfiller server** — hosts the Coordination Task and related output resources. \\\\\\nThe Placer creates it via `create`, applies selective updates via `patch`, and queries via `read` and `search`.",
"_filename": "CapabilityStatement-ChUmzhConnectCapabilityStatement.json",
"package_name": "ch.fhir.ig.ch-umzh-connect",
"format": [ "application/fhir+json" ],
"date": "2026-01-27T16:12:05.435+01:00",
"publisher": "UMZH Connect Team",
"patchFormat": [ "application/json-patch+json" ],
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "CHE",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "UMZHconnectRestServer",
"copyright": "CC0-1.0",
"type": null,
"experimental": null,
"resourceType": "CapabilityStatement",
"title": null,
"package_version": "1.0.0-ballot",
"status": "active",
"id": "c98e1ae3-13d1-4614-805f-e907e0574120",
"kind": "requirements",
"url": "http://fhir.ch/ig/ch-umzh-connect/CapabilityStatement/ChUmzhConnectCapabilityStatement",
"version": "1.0.0-ballot",
"contact": [ {
"name": "UMZH Connect",
"telecom": [ {
"value": "https://umzhconnect.ch/",
"system": "url"
} ]
} ],
"rest": [ {
"mode": "server",
"resource": [ {
"type": "AllergyIntolerance",
"versioning": "versioned-update",
"interaction": [ {
"code": "read",
"documentation": "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`."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "Appointment",
"versioning": "versioned-update",
"interaction": [ {
"code": "read",
"documentation": "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`."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "Condition",
"versioning": "versioned-update",
"interaction": [ {
"code": "read",
"documentation": "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`."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "Coverage",
"versioning": "versioned-update",
"interaction": [ {
"code": "read",
"documentation": "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`."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "DiagnosticReport",
"versioning": "versioned-update",
"interaction": [ {
"code": "read",
"documentation": "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`."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "DocumentReference",
"versioning": "versioned-update",
"interaction": [ {
"code": "read",
"documentation": "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`."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "ImagingStudy",
"versioning": "versioned-update",
"interaction": [ {
"code": "read",
"documentation": "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`."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "Immunization",
"versioning": "versioned-update",
"interaction": [ {
"code": "read",
"documentation": "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`."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "Medication",
"versioning": "versioned-update",
"interaction": [ {
"code": "read",
"documentation": "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`."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "MedicationStatement",
"versioning": "versioned-update",
"interaction": [ {
"code": "read",
"documentation": "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`."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "Observation",
"versioning": "versioned-update",
"interaction": [ {
"code": "read",
"documentation": "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`."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "Organization",
"versioning": "versioned-update",
"interaction": [ {
"code": "read",
"documentation": "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`."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "Patient",
"versioning": "versioned-update",
"interaction": [ {
"code": "read",
"documentation": "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`."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "Practitioner",
"versioning": "versioned-update",
"interaction": [ {
"code": "read",
"documentation": "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`."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "PractitionerRole",
"versioning": "versioned-update",
"interaction": [ {
"code": "read",
"documentation": "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`."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "Procedure",
"versioning": "versioned-update",
"interaction": [ {
"code": "read",
"documentation": "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`."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "Questionnaire",
"versioning": "versioned-update",
"interaction": [ {
"code": "search-type",
"documentation": "Search for Questionnaire definitions. Questionnaire is a definitional artefact shared across workflows; it carries no patient data and is **not** `fhirContext`-gated."
}, {
"code": "read",
"documentation": "Read a Questionnaire by logical id or by canonical URL (url). Definitional content — **not** `fhirContext`-gated."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact"
}, {
"name": "url",
"type": "uri",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-url",
"documentation": "Canonical URL of the Questionnaire. Used to resolve a Questionnaire referenced by canonical."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "QuestionnaireResponse",
"versioning": "versioned-update",
"interaction": [ {
"code": "search-type",
"documentation": "Search for QuestionnaireResponses. Implicitly scoped to QuestionnaireResponses accessible to the calling identity."
}, {
"code": "read",
"documentation": "Read a QuestionnaireResponse by logical id. Allowed if the linked parent ServiceRequest is accessible to the calling identity."
}, {
"code": "create",
"documentation": "Create a QuestionnaireResponse. The created resource SHALL reference an accessible ServiceRequest via `basedOn`."
} ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "ServiceRequest",
"versioning": "versioned-update",
"interaction": [ {
"code": "search-type",
"documentation": "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."
}, {
"code": "read",
"documentation": "Read a ServiceRequest by logical id. Returns the resource only if `{id}` matches the token's `fhirContext` claim."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact. **Mandatory** — searches without `_id` are not supported on this resource."
} ],
"searchInclude": [ "ServiceRequest:patient", "ServiceRequest:subject", "ServiceRequest:ch-umzhconnectig-servicerequest-reasonreference", "ServiceRequest:ch-umzhconnectig-servicerequest-supportinginfo", "ServiceRequest:ch-umzhconnectig-servicerequest-insurance" ],
"conditionalCreate": false,
"conditionalUpdate": false
}, {
"type": "Task",
"versioning": "versioned-update",
"interaction": [ {
"code": "search-type",
"documentation": "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."
}, {
"code": "patch",
"documentation": "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."
}, {
"code": "read",
"documentation": "Read a Task by logical id. Allowed if the calling identity is `Task.owner` or `Task.requester`."
}, {
"code": "create",
"documentation": "Create a Task. Used by the Placer to raise a coordination Task on the Fulfiller."
} ],
"searchParam": [ {
"name": "owner",
"type": "reference",
"definition": "http://hl7.org/fhir/SearchParameter/Task-owner",
"documentation": "Search by task owner"
}, {
"name": "requester",
"type": "reference",
"definition": "http://hl7.org/fhir/SearchParameter/Task-requester",
"documentation": "Search by task requester"
}, {
"name": "status",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Task-status",
"documentation": "Search by task status"
}, {
"name": "_id",
"type": "token",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Logical id of this artifact"
} ],
"searchInclude": [ "Task:ch-umzhconnectig-task-inputreference", "Task:ch-umzhconnectig-task-outputreference", "Task:ch-umzhconnectig-task-outputcanonical" ],
"conditionalCreate": false,
"conditionalUpdate": false
} ]
} ]
}