ISiK Subscription Implementierungsleitfaden
Version 6.0.0-rc - STU1

Resource Profile: ISiK Subscription

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

ISiK Subscription

Motivation

Subscription 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.

Um als Subsystem über ein Subsription-Event informiert zu werden, KANN der FHIR Subscription Mechanismus gemäß des Subscriptions R5 Backport IGs von HL7 genutzt werden.

Kompatibilität

Das Profil ISiKSubscription basiert auf dem Backport-Subscription Profil. Der SubscriptionStatus, sowie das Subscription Notification Bundle werden unverändert direkt aus dem Subscriptions R5 Backport IG genutzt.

Hinweise zu Inkompatibilitäten können über die Portalseite gemeldet werden.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Subscription 0..* BackportSubscription Server push subscription criteria
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... reason SΣ 1..1 string Grund der Subscription
... criteria SΣ 1..1 string Canonical URL des SubscriptionTopic welches man abonnieren möchte.
Binding: ISiKSubscriptionTopic ValueSet (extensible)
.... Slices for extension Content/Rules for all slices
..... extension:filterCriteria SΣ 0..* (Complex) Filterkriterium.
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria"
...... value[x] S 0..1 string Filtering critiera applied to events
... channel SΣ 1..1 BackboneElement Kommunikationskanal
.... Slices for extension Content/Rules for all slices
..... extension:heartbeatPeriod S 0..1 (Complex) Heartbeat-Intervall
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period"
...... value[x] S 0..1 unsignedInt Interval in seconds to send 'heartbeat' notification
..... extension:timeout 0..1 unsignedInt Timeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
..... extension:maxCount 0..1 positiveInt Maximum number of triggering resources included in notification bundles
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 1..1 code Typ des Kommunikationskanals
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
..... Slices for extension Content/Rules for all slices
.... endpoint SΣ 0..1 url Endpunkt
.... payload SΣ 1..1 code Format der Nutzdaten
Binding: FhirMimeTypeVS (required)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:content SΣ 1..1 code Inhalt der Nutzdaten
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Binding: Backported R5 Subscription Content Value Set (required)
.... header SΣ 0..* string Falls eine REST-Enpunkt einen Authorization-Header benötigt, kann dieser hier gesetzt werden

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Subscription.status Base required SubscriptionStatus 📍4.0.1 → 4.0.0 FHIR Std.
Subscription.criteria Base extensible ISiKSubscriptionTopic ValueSet 📦6.0.0-rc This IG
Subscription.channel.​type Base required SubscriptionChannelType 📍4.0.1 → 4.0.0 FHIR Std.
Subscription.channel.​payload Base required FhirMimeTypeVS 📦6.0.0-rc This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Subscription If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Subscription 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 error Subscription 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 error Subscription If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Subscription A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from BackportSubscription

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Subscription 0..* BackportSubscription Server push subscription criteria
... id S 0..1 id serverseitige, interne ID des Datensatzes
... meta
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
... status S 1..1 code Status
... criteria 1..1 string Canonical URL des SubscriptionTopic welches man abonnieren möchte.
Binding: ISiKSubscriptionTopic ValueSet (extensible)
.... Slices for extension Content/Rules for all slices
..... extension:filterCriteria 0..* BackportFilterCriteria Filterkriterium.
...... value[x] S 0..1 string Filtering critiera applied to events
... channel S 1..1 BackboneElement Kommunikationskanal
.... Slices for extension Content/Rules for all slices
..... extension:heartbeatPeriod S 0..1 BackportHeartbeatPeriod Heartbeat-Intervall
...... value[x] S 0..1 unsignedInt Interval in seconds to send 'heartbeat' notification
.... type S 1..1 code Typ des Kommunikationskanals
..... Slices for extension Content/Rules for all slices
...... extension:customChannelType 0..0 Custom Channel Type
.... endpoint S 0..1 url Endpunkt
.... payload S 1..1 code Format der Nutzdaten
Binding: FhirMimeTypeVS (required)
..... Slices for extension Content/Rules for all slices
...... extension:content 1..1 BackportPayloadContent Inhalt der Nutzdaten
.... header S 0..* string Falls eine REST-Enpunkt einen Authorization-Header benötigt, kann dieser hier gesetzt werden

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Subscription.criteria Base extensible ISiKSubscriptionTopic ValueSet 📦6.0.0-rc This IG
Subscription.channel.​payload Base required FhirMimeTypeVS 📦6.0.0-rc This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Subscription 0..* BackportSubscription Server push subscription criteria
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code Status
Binding: SubscriptionStatus (required): The status of a subscription.
... contact Σ 0..* ContactPoint Contact details for source (e.g. troubleshooting)
... end Σ 0..1 instant When to automatically delete the subscription
... reason SΣ 1..1 string Grund der Subscription
... criteria SΣ 1..1 string Canonical URL des SubscriptionTopic welches man abonnieren möchte.
Binding: ISiKSubscriptionTopic ValueSet (extensible)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:filterCriteria SΣ 0..* (Complex) Filterkriterium.
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria"
...... value[x] S 0..1 string Filtering critiera applied to events
.... value 0..1 string Primitive value for string
Max Length:1048576
... error Σ 0..1 string Latest error note
... channel SΣ 1..1 BackboneElement Kommunikationskanal
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:heartbeatPeriod S 0..1 (Complex) Heartbeat-Intervall
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period"
...... value[x] S 0..1 unsignedInt Interval in seconds to send 'heartbeat' notification
..... extension:timeout 0..1 unsignedInt Timeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
..... extension:maxCount 0..1 positiveInt Maximum number of triggering resources included in notification bundles
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 1..1 code Typ des Kommunikationskanals
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... value 0..1 code Primitive value for code
.... endpoint SΣ 0..1 url Endpunkt
.... payload SΣ 1..1 code Format der Nutzdaten
Binding: FhirMimeTypeVS (required)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:content SΣ 1..1 code Inhalt der Nutzdaten
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Binding: Backported R5 Subscription Content Value Set (required)
..... value 0..1 code Primitive value for code
.... header SΣ 0..* string Falls eine REST-Enpunkt einen Authorization-Header benötigt, kann dieser hier gesetzt werden

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Subscription.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Subscription.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Subscription.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Subscription.status Base required SubscriptionStatus 📍4.0.1 → 4.0.0 FHIR Std.
Subscription.criteria Base extensible ISiKSubscriptionTopic ValueSet 📦6.0.0-rc This IG
Subscription.channel.​type Base required SubscriptionChannelType 📍4.0.1 → 4.0.0 FHIR Std.
Subscription.channel.​payload Base required FhirMimeTypeVS 📦6.0.0-rc This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Subscription If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Subscription 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 error Subscription 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 error Subscription If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Subscription A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning Subscription.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ElementShort descriptionNotes
Subscription.channel Kommunikationskanal

Bedeutung: Kommunikationskanal über den die Subscription Benachrichtigungen gesendet werden sollen.
Subscription.channel.endpoint Endpunkt

Bedeutung: Adresse des Kommunikationskanals/ Endpunkts, an den Subscription-Benachrichtigungen gesendet werden sollen. Dies ist nur für rest-hook Subscriptions relevant.
Subscription.channel.extension:heartbeatPeriod Heartbeat-Intervall

Bedeutung: Intervall in dem der Server prüft, ob der Kommunikationskanal noch aktiv ist.
Subscription.channel.extension:heartbeatPeriod.value[x]
Subscription.channel.header Falls eine REST-Enpunkt einen Authorization-Header benötigt, kann dieser hier gesetzt werden

Bedeutung: http-Header welcher dazu genutzt werden kann einen Authorization-header zu setzen. Dies ist nur für rest-hook Subscriptions relevant.
Hinweise: ACHTUNG: dieses Datenfeld muss bei READ-Interaktionen maskiert werden! Siehe R4 Subscriptions
Subscription.channel.payload Format der Nutzdaten

Bedeutung: Format in dem Subscription Notifications versendet werden sollen (JSON oder XML).
Subscription.channel.type Typ des Kommunikationskanals

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.
Subscription.criteria.extension:filterCriteria.value[x]
Subscription.id serverseitige, interne ID des Datensatzes

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.
Subscription.reason Grund der Subscription

Bedeutung: Beschreibung wieso diese Subscription erstellt wurde.
Subscription.status Status

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.

This structure is derived from BackportSubscription

Summary

Must-Support: 11 elements
Prohibited: 1 element

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Subscription 0..* BackportSubscription Server push subscription criteria
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... reason SΣ 1..1 string Grund der Subscription
... criteria SΣ 1..1 string Canonical URL des SubscriptionTopic welches man abonnieren möchte.
Binding: ISiKSubscriptionTopic ValueSet (extensible)
.... Slices for extension Content/Rules for all slices
..... extension:filterCriteria SΣ 0..* (Complex) Filterkriterium.
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria"
...... value[x] S 0..1 string Filtering critiera applied to events
... channel SΣ 1..1 BackboneElement Kommunikationskanal
.... Slices for extension Content/Rules for all slices
..... extension:heartbeatPeriod S 0..1 (Complex) Heartbeat-Intervall
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period"
...... value[x] S 0..1 unsignedInt Interval in seconds to send 'heartbeat' notification
..... extension:timeout 0..1 unsignedInt Timeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
..... extension:maxCount 0..1 positiveInt Maximum number of triggering resources included in notification bundles
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 1..1 code Typ des Kommunikationskanals
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
..... Slices for extension Content/Rules for all slices
.... endpoint SΣ 0..1 url Endpunkt
.... payload SΣ 1..1 code Format der Nutzdaten
Binding: FhirMimeTypeVS (required)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:content SΣ 1..1 code Inhalt der Nutzdaten
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Binding: Backported R5 Subscription Content Value Set (required)
.... header SΣ 0..* string Falls eine REST-Enpunkt einen Authorization-Header benötigt, kann dieser hier gesetzt werden

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Subscription.status Base required SubscriptionStatus 📍4.0.1 → 4.0.0 FHIR Std.
Subscription.criteria Base extensible ISiKSubscriptionTopic ValueSet 📦6.0.0-rc This IG
Subscription.channel.​type Base required SubscriptionChannelType 📍4.0.1 → 4.0.0 FHIR Std.
Subscription.channel.​payload Base required FhirMimeTypeVS 📦6.0.0-rc This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Subscription If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Subscription 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 error Subscription 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 error Subscription If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Subscription A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from BackportSubscription

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Subscription 0..* BackportSubscription Server push subscription criteria
... id S 0..1 id serverseitige, interne ID des Datensatzes
... meta
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
... status S 1..1 code Status
... criteria 1..1 string Canonical URL des SubscriptionTopic welches man abonnieren möchte.
Binding: ISiKSubscriptionTopic ValueSet (extensible)
.... Slices for extension Content/Rules for all slices
..... extension:filterCriteria 0..* BackportFilterCriteria Filterkriterium.
...... value[x] S 0..1 string Filtering critiera applied to events
... channel S 1..1 BackboneElement Kommunikationskanal
.... Slices for extension Content/Rules for all slices
..... extension:heartbeatPeriod S 0..1 BackportHeartbeatPeriod Heartbeat-Intervall
...... value[x] S 0..1 unsignedInt Interval in seconds to send 'heartbeat' notification
.... type S 1..1 code Typ des Kommunikationskanals
..... Slices for extension Content/Rules for all slices
...... extension:customChannelType 0..0 Custom Channel Type
.... endpoint S 0..1 url Endpunkt
.... payload S 1..1 code Format der Nutzdaten
Binding: FhirMimeTypeVS (required)
..... Slices for extension Content/Rules for all slices
...... extension:content 1..1 BackportPayloadContent Inhalt der Nutzdaten
.... header S 0..* string Falls eine REST-Enpunkt einen Authorization-Header benötigt, kann dieser hier gesetzt werden

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Subscription.criteria Base extensible ISiKSubscriptionTopic ValueSet 📦6.0.0-rc This IG
Subscription.channel.​payload Base required FhirMimeTypeVS 📦6.0.0-rc This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Subscription 0..* BackportSubscription Server push subscription criteria
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code Status
Binding: SubscriptionStatus (required): The status of a subscription.
... contact Σ 0..* ContactPoint Contact details for source (e.g. troubleshooting)
... end Σ 0..1 instant When to automatically delete the subscription
... reason SΣ 1..1 string Grund der Subscription
... criteria SΣ 1..1 string Canonical URL des SubscriptionTopic welches man abonnieren möchte.
Binding: ISiKSubscriptionTopic ValueSet (extensible)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:filterCriteria SΣ 0..* (Complex) Filterkriterium.
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria"
...... value[x] S 0..1 string Filtering critiera applied to events
.... value 0..1 string Primitive value for string
Max Length:1048576
... error Σ 0..1 string Latest error note
... channel SΣ 1..1 BackboneElement Kommunikationskanal
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:heartbeatPeriod S 0..1 (Complex) Heartbeat-Intervall
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period"
...... value[x] S 0..1 unsignedInt Interval in seconds to send 'heartbeat' notification
..... extension:timeout 0..1 unsignedInt Timeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
..... extension:maxCount 0..1 positiveInt Maximum number of triggering resources included in notification bundles
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 1..1 code Typ des Kommunikationskanals
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... value 0..1 code Primitive value for code
.... endpoint SΣ 0..1 url Endpunkt
.... payload SΣ 1..1 code Format der Nutzdaten
Binding: FhirMimeTypeVS (required)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:content SΣ 1..1 code Inhalt der Nutzdaten
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Binding: Backported R5 Subscription Content Value Set (required)
..... value 0..1 code Primitive value for code
.... header SΣ 0..* string Falls eine REST-Enpunkt einen Authorization-Header benötigt, kann dieser hier gesetzt werden

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Subscription.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Subscription.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Subscription.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Subscription.status Base required SubscriptionStatus 📍4.0.1 → 4.0.0 FHIR Std.
Subscription.criteria Base extensible ISiKSubscriptionTopic ValueSet 📦6.0.0-rc This IG
Subscription.channel.​type Base required SubscriptionChannelType 📍4.0.1 → 4.0.0 FHIR Std.
Subscription.channel.​payload Base required FhirMimeTypeVS 📦6.0.0-rc This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Subscription If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Subscription 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 error Subscription 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 error Subscription If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Subscription A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning Subscription.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from BackportSubscription

Summary

Must-Support: 11 elements
Prohibited: 1 element

 

Other representations of profile: CSV, Excel, Schematron