FHIR IG Statistics: StructureDefinition/ISiKSubscription

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "ISiKSubscription",
  "url": "https://gematik.de/fhir/isik/StructureDefinition/ISiKSubscription",
  "version": "5.0.0",
  "name": "ISiKSubscription",
  "title": "ISiK Subscription",
  "status": "active",
  "experimental": false,
  "date": "2025-06-26",
  "publisher": "gematik GmbH",
  "description": "ISiK Subscription  \n### Motivation\n\nSubscription ist eine FHIR Ressource, um als Client-System Benachrichtigungen über Events auf dem FHIR Server anzufragen. Der Subscription Mechanismus in FHIR R4 ist nicht geeignet, um alle relevanten Events (hier im Speziellen das Mergen von Patienten) zu unterstützen. Daher basiert das ISiK Subscription-Profil auf dem [Subscriptions R5 Backport Profil von HL7](https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription.html).\n\nUm als Subsystem über ein Subsription-Event informiert zu werden, KANN der FHIR Subscription Mechanismus gemäß des [Subscriptions R5 Backport IGs von HL7](https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/index.html) genutzt werden.\n\n### Kompatibilität\n\nDas Profil ISiKSubscription basiert auf dem [Backport-Subscription Profil](https://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition-backport-subscription.html).\nDer [SubscriptionStatus](https://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition-backport-subscription-status-r4.html), sowie das [Subscription Notification Bundle](https://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition-backport-subscription-notification-r4.html) werden unverändert direkt aus dem [Subscriptions R5 Backport IG](https://hl7.org/fhir/uv/subscriptions-backport/index.html) genutzt.  \n\nHinweise zu Inkompatibilitäten können über die [Portalseite](https://service.gematik.de/servicedesk/customer/portal/16) gemeldet werden.",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "Subscription",
  "baseDefinition": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Subscription.status",
        "path": "Subscription.status",
        "short": "Status",
        "comment": "**Bedeutung:** Der Status der Subscription, der den Serverstatus der Subscription angibt. \n  Neue Subscriptions werden immer mit dem Status `requested` an den Server übergeben. \n  Der Server ändert im Anschluss den Status auf `active` oder im Fehlerfall auf `error`.",
        "mustSupport": true
      },
      {
        "id": "Subscription.reason",
        "path": "Subscription.reason",
        "short": "Grund der Subscription",
        "comment": "**Bedeutung:** Beschreibung wieso diese Subscription erstellt wurde.",
        "mustSupport": true
      },
      {
        "id": "Subscription.criteria",
        "path": "Subscription.criteria",
        "short": "Canonical URL des SubscriptionTopic welches man abonnieren möchte.",
        "comment": "Enthält eines der in ISiK vereinbarten Subsription Topics.",
        "binding": {
          "strength": "extensible",
          "valueSet": "https://gematik.de/fhir/isik/ValueSet/ISiKSubscriptionTopicVS"
        }
      },
      {
        "id": "Subscription.criteria.extension:filterCriteria",
        "path": "Subscription.criteria.extension",
        "sliceName": "filterCriteria",
        "short": "Filterkriterium.",
        "comment": "**Bedeutung:** Filterkriterium für die Subscription. Dieses Feld ist optional und kann genutzt werden, um die Subscription auf bestimmte Events zu filtern."
      },
      {
        "id": "Subscription.criteria.extension:filterCriteria.value[x]",
        "path": "Subscription.criteria.extension.value[x]",
        "mustSupport": true
      },
      {
        "id": "Subscription.channel",
        "path": "Subscription.channel",
        "short": "Kommunikationskanal",
        "comment": "**Bedeutung:** Kommunikationskanal über den die Subscription Benachrichtigungen gesendet werden sollen.",
        "mustSupport": true
      },
      {
        "id": "Subscription.channel.extension:heartbeatPeriod",
        "path": "Subscription.channel.extension",
        "sliceName": "heartbeatPeriod",
        "short": "Heartbeat-Intervall",
        "comment": "**Bedeutung:** Intervall in dem der Server prüft, ob der Kommunikationskanal noch aktiv ist.",
        "mustSupport": true
      },
      {
        "id": "Subscription.channel.extension:heartbeatPeriod.value[x]",
        "path": "Subscription.channel.extension.value[x]",
        "mustSupport": true
      },
      {
        "id": "Subscription.channel.type",
        "path": "Subscription.channel.type",
        "short": "Typ des Kommunikationskanals",
        "comment": "**Bedeutung:** Der Typ des Kommunikationskanals, über den Subscription-Benachrichtigungen gesendet werden sollen.  \n    In ISiK MUSS der Wert `rest-hook` unterstützt werden, weitere Werte KÖNNEN unterstützt werden.",
        "mustSupport": true
      },
      {
        "id": "Subscription.channel.type.extension:customChannelType",
        "path": "Subscription.channel.type.extension",
        "sliceName": "customChannelType",
        "short": "Custom Channel Type",
        "comment": "**Bedeutung:** Custom Channel Type welcher in ISiK aktuell nicht unterstützt wird.",
        "max": "0"
      },
      {
        "id": "Subscription.channel.endpoint",
        "path": "Subscription.channel.endpoint",
        "short": "Endpunkt",
        "comment": "**Bedeutung:** Adresse des Kommunikationskanals/ Endpunkts, an den Subscription-Benachrichtigungen gesendet werden sollen. Dies ist nur für rest-hook Subscriptions relevant.",
        "mustSupport": true
      },
      {
        "id": "Subscription.channel.payload",
        "path": "Subscription.channel.payload",
        "short": "Format der Nutzdaten",
        "comment": "**Bedeutung:** Format in dem Subscription Notifications versendet werden sollen (JSON oder XML).",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "valueSet": "https://gematik.de/fhir/isik/ValueSet/FhirMimeTypeVS"
        }
      },
      {
        "id": "Subscription.channel.payload.extension:content",
        "path": "Subscription.channel.payload.extension",
        "sliceName": "content",
        "short": "Inhalt der Nutzdaten",
        "comment": "**Bedeutung:** Welcher Ressourceninhalt in der Nutzlast der Benachrichtigung geliefert werden soll.  \n      Zur Auswahl stehen eine leere Nutzlast (`empty`), nur die Ressourcen-id (`id-only`) oder der gesamte Inhalt der Ressource (`full-resource`)."
      },
      {
        "id": "Subscription.channel.header",
        "path": "Subscription.channel.header",
        "short": "Falls eine REST-Enpunkt einen Authorization-Header benötigt, kann dieser hier gesetzt werden",
        "comment": "**Bedeutung:** http-Header welcher dazu genutzt werden kann einen Authorization-header zu setzen. Dies ist nur für rest-hook Subscriptions relevant.  \n    **Hinweise:** ACHTUNG: dieses Datenfeld muss bei READ-Interaktionen maskiert werden! Siehe [R4 Subscriptions](https://hl7.org/fhir/R4/subscription.html)",
        "mustSupport": true
      }
    ]
  }
}