CapabilityStatement für Rolle "Subscription" - Konformitätserklärung (CapabilityStatement)

Beschreibung

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.

Zweck

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.

CanonicalURLhttps://gematik.de/fhir/isik/CapabilityStatement/ISiKCapabilityStatementSubscriptionRolle
Intentionrequirements
Statusactive
Version5.0.0-rc

Anforderungen an die FHIR-API

Modusserver

Interaktionen

RessourcentypVerbindlichkeitREADSEARCHCREATEUPDATEDELETE
BundleSHALL
ParametersSHALL
SubscriptionSHALLSHALLSHALLSHALLSHALLSHALL

Profile

RessourcentypProfile
Bundlehttps://gematik.de/fhir/isik/StructureDefinition/BackportSubscriptionNotificationR4Fixed
Parametershttps://gematik.de/fhir/isik/StructureDefinition/BackportSubscriptionStatusR4Fixed
Subscriptionhttps://gematik.de/fhir/isik/StructureDefinition/ISiKSubscription

Ressourcentyp-spezifische Operations

RessourcenTypNameSpezifikationVerbindlichkeit
Subscriptionstatushttp://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-statusSHALL
Subscriptioneventshttp://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-eventsSHALL

Globale Operations

Dokumenten-Endpunkt

Suchparameter

RessourcenTypSuchParameterVerbindlichkeitHinweiseDefinition
Subscription_idSHALL

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.

http://hl7.org/fhir/SearchParameter/Resource-id
Subscription_tagSHALL

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.

http://hl7.org/fhir/SearchParameter/Resource-tag
Subscription_countSHALL

Beispiel: GET [base]/[Resourcetype]?_count=100 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

Subscription_hasMAY

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.

SubscriptioncriteriaSHALL

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.

http://hl7.org/fhir/SearchParameter/Subscription-criteria
SubscriptionstatusSHALL

Beispiel:
GET [base]/Subscription?status=requested
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/Subscription-status
SubscriptionurlSHALL

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.

http://hl7.org/fhir/SearchParameter/Subscription-url

(Reverse-)Include

RessourcenTyp
Subscription
Parameters
Bundle