CapabilityStatement für Rolle "Subscription"

ISiK Subscription Implementierungsleitfaden

Version 6.0.0-rc - STU1

CapabilityStatement: CapabilityStatement für Rolle "Subscription"

Official URL: https://gematik.de/fhir/isik/CapabilityStatement/ISiKCapabilityStatementSubscriptionRolle				Version: 6.0.0-rc
Active as of 2025-12-17				Computable Name: ISiKCapabilityStatementSubscriptionRolle

Dieses CapabilityStatement beschreibt alle Interaktionen, die ein System unterstützen MUSS, welches diese Rolle implementiert.

Die CapabilityStatements in dieser Spezifikation stellen die Anforderungen seitens der gematik dar (kind = requirements). Zur Unterscheidung von Anforderungen, die erfüllt werden MÜSSEN gegenüber jenen, die erfüllt werden KÖNNEN, wird die CapabilityStatement-Expectation-Extension mit den möglichen Werten SHALL (=MUSS) und MAY (=KANN) verwendet.

CapabilityStatement für die Rolle "ISiKCapabilityStatementSubscriptionRolle". Diese Rolle beschreibt die Fähigkeiten eines Systems zur Registrierung, Verwaltung und Verarbeitung von FHIR Subscriptions auf Basis themenbasierter Benachrichtigungen nach dem R5-Modell unter Verwendung der Subscriptions-Backport-Mechanismen in FHIR R4.

Implementation Guide Version: 6.0.0-rc
FHIR Version: 4.0.1
Supported Formats: application/fhir+xml, application/fhir+json
Published on: 2025-12-17
Published by: gematik GmbH

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.

SHALL Support the Following Implementation Guides

https://gematik.de/fhir/isik/ImplementationGuide/ISiK-Subscription

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	C	D	Searches	Operations
Subscription	Supported Profiles ISiK Subscription	Y	Y	Y	Y	Y	_id, _tag, _count, _has, criteria, status, url	`$status`, `$events`
Parameters	Supported Profiles R4 Backported R5 SubscriptionStatus
Bundle	Supported Profiles R4 Topic-Based Subscription Notification Bundle

Resource Conformance: SHALLSubscription

Core FHIR Resource
Subscription

Reference Policy

Interaction summary

SHALL support read, create, update, delete, search-type.

Supported Profiles

ISiK Subscription

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	Beispiel: `GET [base]/[Resourcetype]?_id=103270` Anwendungshinweis: Der Parameter `_id` wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der `id` die `READ`-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem `_include` weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten: `GET [base]/Encounter?_id=103270&_include=Encounter:patient` Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources. Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.
SHALL	_tag	`token`	Beispiel: `GET [base]/[Resourcetype]?_tag=https://example.org/codes\|needs-review` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.
SHALL	_count	`number`	Beispiel: `GET [base]/[Resourcetype]?_count=100` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.
SHALL	criteria	`string`	Beispiel: `GET [base]/Subscription?criteria=https://gematik.de/fhir/isik/SubscriptionTopic/patient-merge` Anwendungshinweis: Dient dazu eine Subscription zu finden, die auf ein bestimmtes SubscriptionTopic verweist. Weitere Details siehe FHIR-Kernspezifikation.
SHALL	status	`token`	Beispiel: `GET [base]/Subscription?status=requested` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.
SHALL	url	`uri`	Beispiel: `GET [base]/Subscription?url=http://example.org/fhir/` Anwendungshinweis: Dient dazu eine Subscription zu finden, die auf einen REST-Endpoint verweist welcher die Subscription Notifications empfangen soll. Weitere Details siehe FHIR-Kernspezifikation.
MAY	_has	`string`	Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben `GET [base]/Patient?_has:Observation:patient:code=1234-5` Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde `GET [base]/Encounter?_has:Condition:encounter:code=A12.3` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

Extended Operations

Conformance	Operation	Documentation
SHALL	$status	Beispiel: `GET [base]/Subscription/[id]/$status` Anwendungshinweis: Dient dazu den Status einer Subscription zu ermitteln. Weitere Details siehe Subscriptions R5 Backport IG.
SHALL	$events	Beispiel: `GET [base]/Subscription/[id]/$events` Anwendungshinweis: Diese Operation wird verwendet, um nach SubscriptionNotifications zu suchen und diese zurückzugeben, die zuvor durch eine topic basierte Subscription in FHIR R4 ausgelöst wurden. Weitere Details siehe Subscriptions R5 Backport IG.