ISiK Subscription - Definitions - ISiK Terminplanung Implementierungsleitfaden v6.0.0-rc

Resource Profile: ISiKSubscription - Detailed Descriptions

Active as of 2026-04-02

Definitions for the ISiKSubscription resource profile.

Key Elements Table
Differential Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Subscription
Definition	The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.
Short	Server push subscription criteria
Control	0..*
Is Modifier	false
Must Support	false
Summary	false
Alternate Names	WebHook, Hook, Routing Rule
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (`contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()`) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
2. Subscription.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short	serverseitige, interne ID des DatensatzesLogical id of this artifact
Comments	bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine `id` verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine `id`verfügen. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control	0..1
Type	idstring
Is Modifier	false
Must Support	true
Summary	true
4. Subscription.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short	Verweis auf die Regeln, nach denen die Ressource erstellt wurdeA set of rules under which this content was created
Comments	Begründung Constraint: In ISiK existiert kein Use-Case für dieses Element. Da es sich um ein Modifying Element handelt, wird es daher ausgeschlossen. Darüber hinaus werden die Regeln als URI vorgehalten. Dies führt dazu, dass sich hinter der URI eine beliebige Menge an Regeln befinden kann; wodurch nicht sichergestellt werden kann, dass alle Clients die Regeln korrekt interpretieren können. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control	0..01
Type	uri
Is Modifier	true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	false
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Subscription.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short	Extensions that cannot be ignored
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support	false
Summary	false
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Subscription.status
Definition	The status of the subscription, which marks the server state for managing the subscription.
Short	Statusrequested \| active \| error \| off
Comments	Bedeutung: Der Status der Subscription, der den Serverstatus der Subscription angibt. Neue Subscriptions werden immer mit dem Status `requested` an den Server übergeben. Der Server ändert im Anschluss den Status auf `active` oder im Fehlerfall auf `error`. A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Control	1..1
Binding	The codes SHALL be taken from SubscriptionStatushttp://hl7.org/fhir/ValueSet/subscription-status\|4.0.1 (required to `http://hl7.org/fhir/ValueSet/subscription-status\|4.0.0`) The status of a subscription.
Type	code
Is Modifier	true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Subscription.reason
Definition	A description of why this subscription is defined.
Short	Grund der SubscriptionDescription of why this subscription was created
Comments	Bedeutung: Beschreibung wieso diese Subscription erstellt wurde.
Control	1..1
Type	string
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Subscription.criteria
Definition	When using topic-based subscriptions, the primary criteria is always the topic, indicated by its canonical URL. The rules that the server should use to determine when to generate notifications for this subscription.
Short	Canonical URL des SubscriptionTopic welches man abonnieren möchte.Rule for server push
Comments	Enthält eines der in ISiK vereinbarten Subscription Topics. The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading "/".
Control	1..1
Binding	Unless not suitable, these codes SHALL be taken from For codes, see ISiKSubscriptionTopic ValueSet (extensible to `https://gematik.de/fhir/isik/ValueSet/ISiKSubscriptionTopicVS`)
Type	string
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Subscription.criteria.extension:filterCriteria
Slice Name	filterCriteria
Definition	Criteria for topic-based filtering (filter-by).
Short	Filterkriterium.
Comments	Bedeutung: Filterkriterium für die Subscription. Dieses Feld ist optional und kann genutzt werden, um die Subscription auf bestimmte Events zu filtern.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(Backported R5 FilterBy Criteria) (Extension Type: string)
Is Modifier	false
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. Subscription.criteria.extension:filterCriteria.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	ExtensionAdditional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..0*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Subscription.criteria.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
18. Subscription.criteria.extension:filterCriteria.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria`
20. Subscription.criteria.extension:filterCriteria.value[x]
Definition	Search-style filters to be applied to narrow the subscription topic stream. Keys can be either search parameters appropriate to the filtering resource or keys defined within the subscription topic. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Filtering critiera applied to eventsValue of extension
Comments	When multiple filters are applied, evaluates to true if all the conditions are met; otherwise it returns false. (i.e., logical AND).
Control	0..1
Type	string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Subscription.channel
Definition	Details where to send notifications when resources are received that meet the criteria.
Short	KommunikationskanalThe channel on which to report matches to the criteria
Comments	Bedeutung: Kommunikationskanal über den die Subscription Benachrichtigungen gesendet werden sollen.
Control	1..1
Type	BackboneElement
Is Modifier	false
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Subscription.channel.extension:heartbeatPeriod
Slice Name	heartbeatPeriod
Definition	Interval in seconds to send 'heartbeat' notifications.
Short	Heartbeat-Intervall
Comments	Bedeutung: Intervall in dem der Server prüft, ob der Kommunikationskanal noch aktiv ist.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(Backport R5 Subscription Heartbeat Period) (Extension Type: unsignedInt)
Is Modifier	false
Must Support	true
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. Subscription.channel.extension:heartbeatPeriod.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	ExtensionAdditional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..0*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Subscription.channel.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
28. Subscription.channel.extension:heartbeatPeriod.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period`
30. Subscription.channel.extension:heartbeatPeriod.value[x]
Definition	If present, a 'hearbeat' notification (keepalive) is sent via this channel with an the interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Interval in seconds to send 'heartbeat' notificationValue of extension
Control	0..1
Type	unsignedInt, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Subscription.channel.extension:timeout
Slice Name	timeout
Definition	If present, the maximum amount of time a server will allow before failing a notification attempt.
Short	Timeout in seconds to attempt notification delivery
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(Backport R5 Subscription Timeout) (Extension Type: unsignedInt)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. Subscription.channel.extension:maxCount
Slice Name	maxCount
Definition	If present, the maximum number of triggering resources that will be included in a notification bundle (e.g., a server will not include more than this number of trigger resources in a single notification). Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included.
Short	Maximum number of triggering resources included in notification bundles
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(Backported R5 Subscription MaxCount) (Extension Type: positiveInt)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. Subscription.channel.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short	Extensions that cannot be ignored even if unrecognized
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary	true
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names	extensions, user content, modifiers
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
38. Subscription.channel.type
Definition	The type of channel to send notifications on.
Short	Typ des Kommunikationskanalsrest-hook \| websocket \| email \| sms \| message
Comments	Bedeutung: Der Typ des Kommunikationskanals, über den Subscription-Benachrichtigungen gesendet werden sollen. In ISiK MUSS der Wert `rest-hook` unterstützt werden, weitere Werte KÖNNEN unterstützt werden.
Control	1..1
Binding	The codes SHALL be taken from SubscriptionChannelTypehttp://hl7.org/fhir/ValueSet/subscription-channel-type\|4.0.1 (required to `http://hl7.org/fhir/ValueSet/subscription-channel-type\|4.0.0`) The type of method used to execute a subscription.
Type	code
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Subscription.channel.type.extension:customChannelType
Slice Name	customChannelType
Definition	Additional channel types not defined before FHIR R5.
Short	Custom Channel Type
Comments	Bedeutung: Custom Channel Type welcher in ISiK aktuell nicht unterstützt wird.
Control	0..0 This element is affected by the following invariants: ele-1
Type	Extension(Backported R5 Additional Channel Types) (Extension Type: Coding)
Is Modifier	false
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
42. Subscription.channel.endpoint
Definition	The url that describes the actual end-point to send messages to.
Short	EndpunktWhere the channel points to
Comments	Bedeutung: Adresse des Kommunikationskanals/ Endpunkts, an den Subscription-Benachrichtigungen gesendet werden sollen. Dies ist nur für rest-hook Subscriptions relevant. For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs).
Control	0..1
Type	url
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Subscription.channel.payload
Definition	The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions.
Short	Format der NutzdatenMIME type to send, or omit for no payload
Comments	Bedeutung: Format in dem Subscription Notifications versendet werden sollen (JSON oder XML). Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.
Control	10..1
Binding	The codes SHALL be taken from FhirMimeTypeVShttp://hl7.org/fhir/ValueSet/mimetypes\|4.0.1 (required to `https://gematik.de/fhir/isik/ValueSet/FhirMimeTypeVS`)
Type	code
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Subscription.channel.payload.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	ExtensionAdditional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	10..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Subscription.channel.payload.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
48. Subscription.channel.payload.extension:content
Slice Name	content
Definition	How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.
Short	Inhalt der Nutzdaten
Comments	Bedeutung: Ressourceninhalt, der in der Nutzlast der Benachrichtigung geliefert wird. ISiK-konforme Subscription-Notifications MÜSSEN `id-only` verwenden. Die Notification enthält die ID der geänderten Ressource, jedoch keine vollständigen Ressourcendaten. Der Client kann anhand der ID gezielt die aktuelle Version der Ressource abrufen (Pull-Prinzip).
Control	1..1 This element is affected by the following invariants: ele-1
Type	Extension(Backport R5 Subscription Payload Content Information) (Extension Type: code)
Is Modifier	false
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
50. Subscription.channel.payload.extension:content.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	ExtensionAdditional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..0*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Subscription.channel.payload.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
52. Subscription.channel.payload.extension:content.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content`
54. Subscription.channel.payload.extension:content.value[x]
Definition	How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Notification content levelValue of extension
Comments	Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.
Control	0..1
Type	code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing	This element introduces a set of slices on `Subscription.channel.payload.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
56. Subscription.channel.payload.extension:content.value[x]:valueCode
Slice Name	valueCode
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	0..1
Binding	The codes SHALL be taken from For codes, see Backported R5 Subscription Content Value Set (required to `http://hl7.org/fhir/uv/subscriptions-backport/ValueSet/backport-content-value-set`)
Type	code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Fixed Value	`id-only`
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Subscription.channel.header
Definition	Additional headers / information to send as part of the notification.
Short	Falls eine REST-Enpunkt einen Authorization-Header benötigt, kann dieser hier gesetzt werdenUsage depends on the channel type
Comments	Bedeutung: HTTP-Header, der dazu genutzt werden kann, einen Authorization-Header zu setzen (z.B. für HTTP Basic Authentication mit statischem Secret). Hinweise: Dieses Feld ist Write-Only: Secrets können bei Erstellung/Aktualisierung übermittelt werden, MÜSSEN vom Server bei READ-Interaktionen jedoch maskiert werden (z.B. `Authorization: Basic ****last4`). In der Subscription DÜRFEN keine Klartext-Secrets dauerhaft gespeichert sein. Siehe R4 Subscriptions Exactly what these mean depend on the channel type. They can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions.
Control	0..*
Type	string
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Subscription
2. Subscription.id
Short	serverseitige, interne ID des Datensatzes
Comments	bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine `id` verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine `id`verfügen.
Must Support	true
4. Subscription.meta
6. Subscription.meta.versionId
Short	Eindeutiger Name der serverseitigen Version des Datensatzes
Comments	Alle von einem Server bereitgestellten Ressourcen SOLLEN über eine `versionID` verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine `versionID`verfügen.
8. Subscription.meta.lastUpdated
Short	Zeitpunkt der letzten Änderung
Comments	Alle von einem Server bereitgestellten Ressourcen SOLLEN über ein `lastUpdate` verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über ein `lastUpdate`verfügen.
10. Subscription.implicitRules
Short	Verweis auf die Regeln, nach denen die Ressource erstellt wurde
Comments	Begründung Constraint: In ISiK existiert kein Use-Case für dieses Element. Da es sich um ein Modifying Element handelt, wird es daher ausgeschlossen. Darüber hinaus werden die Regeln als URI vorgehalten. Dies führt dazu, dass sich hinter der URI eine beliebige Menge an Regeln befinden kann; wodurch nicht sichergestellt werden kann, dass alle Clients die Regeln korrekt interpretieren können.
Control	0..0
12. Subscription.status
Short	Status
Comments	Bedeutung: Der Status der Subscription, der den Serverstatus der Subscription angibt. Neue Subscriptions werden immer mit dem Status `requested` an den Server übergeben. Der Server ändert im Anschluss den Status auf `active` oder im Fehlerfall auf `error`.
Must Support	true
14. Subscription.reason
Short	Grund der Subscription
Comments	Bedeutung: Beschreibung wieso diese Subscription erstellt wurde.
Must Support	true
16. Subscription.criteria
Short	Canonical URL des SubscriptionTopic welches man abonnieren möchte.
Comments	Enthält eines der in ISiK vereinbarten Subscription Topics.
Binding	Unless not suitable, these codes SHALL be taken from ISiKSubscriptionTopic ValueSet (extensible to `https://gematik.de/fhir/isik/ValueSet/ISiKSubscriptionTopicVS`)
18. Subscription.criteria.extension:filterCriteria
Slice Name	filterCriteria
Short	Filterkriterium.
Comments	Bedeutung: Filterkriterium für die Subscription. Dieses Feld ist optional und kann genutzt werden, um die Subscription auf bestimmte Events zu filtern.
20. Subscription.criteria.extension:filterCriteria.value[x]
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Must Support	true
22. Subscription.channel
Short	Kommunikationskanal
Comments	Bedeutung: Kommunikationskanal über den die Subscription Benachrichtigungen gesendet werden sollen.
Must Support	true
24. Subscription.channel.extension:heartbeatPeriod
Slice Name	heartbeatPeriod
Short	Heartbeat-Intervall
Comments	Bedeutung: Intervall in dem der Server prüft, ob der Kommunikationskanal noch aktiv ist.
Must Support	true
26. Subscription.channel.extension:heartbeatPeriod.value[x]
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Must Support	true
28. Subscription.channel.type
Short	Typ des Kommunikationskanals
Comments	Bedeutung: Der Typ des Kommunikationskanals, über den Subscription-Benachrichtigungen gesendet werden sollen. In ISiK MUSS der Wert `rest-hook` unterstützt werden, weitere Werte KÖNNEN unterstützt werden.
Must Support	true
30. Subscription.channel.type.extension:customChannelType
Slice Name	customChannelType
Short	Custom Channel Type
Comments	Bedeutung: Custom Channel Type welcher in ISiK aktuell nicht unterstützt wird.
Control	0..0
32. Subscription.channel.endpoint
Short	Endpunkt
Comments	Bedeutung: Adresse des Kommunikationskanals/ Endpunkts, an den Subscription-Benachrichtigungen gesendet werden sollen. Dies ist nur für rest-hook Subscriptions relevant.
Must Support	true
34. Subscription.channel.payload
Short	Format der Nutzdaten
Comments	Bedeutung: Format in dem Subscription Notifications versendet werden sollen (JSON oder XML).
Binding	The codes SHALL be taken from FhirMimeTypeVS (required to `https://gematik.de/fhir/isik/ValueSet/FhirMimeTypeVS`)
Must Support	true
36. Subscription.channel.payload.extension:content
Slice Name	content
Short	Inhalt der Nutzdaten
Comments	Bedeutung: Ressourceninhalt, der in der Nutzlast der Benachrichtigung geliefert wird. ISiK-konforme Subscription-Notifications MÜSSEN `id-only` verwenden. Die Notification enthält die ID der geänderten Ressource, jedoch keine vollständigen Ressourcendaten. Der Client kann anhand der ID gezielt die aktuelle Version der Ressource abrufen (Pull-Prinzip).
38. Subscription.channel.payload.extension:content.value[x]:valueCode
Slice Name	valueCode
Type	code
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Fixed Value	`id-only`
40. Subscription.channel.header
Short	Falls eine REST-Enpunkt einen Authorization-Header benötigt, kann dieser hier gesetzt werden
Comments	Bedeutung: HTTP-Header, der dazu genutzt werden kann, einen Authorization-Header zu setzen (z.B. für HTTP Basic Authentication mit statischem Secret). Hinweise: Dieses Feld ist Write-Only: Secrets können bei Erstellung/Aktualisierung übermittelt werden, MÜSSEN vom Server bei READ-Interaktionen jedoch maskiert werden (z.B. `Authorization: Basic ****last4`). In der Subscription DÜRFEN keine Klartext-Secrets dauerhaft gespeichert sein. Siehe R4 Subscriptions
Must Support	true

Guidance on how to interpret the contents of this table can be foundhere

0. Subscription

Definition

The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.

Short Server push subscription criteria

Control 0..*

Is Modifier false

Must Support false

Summary false

Alternate Names WebHook, Hook, Routing Rule

Invariants dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())

2. Subscription.id

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Short serverseitige, interne ID des Datensatzes

Comments

bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine id verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine idverfügen.

Control 0..1