Subscription Interface
Topic Discovery
MAIA implements FHIR Subscriptions using the R4/R5 Subscriptions Backport IG.
The supported topic is advertised in the CapabilityStatement via the backport extension
capabilitystatement-subscriptiontopic-canonical:
| Field | Value |
|---|---|
| Topic canonical | https://tiplu.de/fhir/maia/SubscriptionTopic/maia-alert-accepted |
| Trigger | A clinician accepts a rule-based evaluation (MaiaVerdachtsdiagnose); the MaiaRuleBasedEvaluationReviewStatus extension transitions to #accepted |
| Alert type | MaiaVerdachtsdiagnose (TRBE) only |
Subscription Registration
| MaiaSubscription (Subscription) | C | ISiKSubscription | There are no (further) constraints on this element Element idSubscriptionShort description Server push subscription criteria Alternate namesWebHook, Hook, Routing Rule DefinitionThe 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.
| |||
| id | S Σ | 0..1 | string | There are no (further) constraints on this element Element idSubscription.idShort description serverseitige, interne ID des Datensatzes DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idSubscription.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idSubscription.meta.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSubscription.meta.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idSubscription.meta.versionIdShort description Eindeutiger Name der serverseitigen Version des Datensatzes DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. Alle von einem Server bereitgestellten Ressourcen SOLLEN über eine The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idSubscription.meta.lastUpdatedShort description Zeitpunkt der letzten Änderung DefinitionWhen the resource last changed - e.g. when the version changed. Alle von einem Server bereitgestellten Ressourcen SOLLEN über ein The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idSubscription.meta.sourceShort description Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| profile | Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element idSubscription.meta.profileShort description Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. canonical(StructureDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idSubscription.meta.securityShort description Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idSubscription.meta.tagShort description Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idSubscription.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idSubscription.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idSubscription.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idSubscription.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSubscription.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSubscription.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idSubscription.statusShort description Status DefinitionThe status of the subscription, which marks the server state for managing the subscription. Bedeutung: Der Status der Subscription, der den Serverstatus der Subscription angibt.
Neue Subscriptions werden immer mit dem Status The status of a subscription. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | Σ C | 0..* | ContactPoint | There are no (further) constraints on this element Element idSubscription.contactShort description Contact details for source (e.g. troubleshooting) DefinitionContact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| end | Σ | 0..1 | instant | There are no (further) constraints on this element Element idSubscription.endShort description When to automatically delete the subscription DefinitionThe time for the server to turn the subscription off. The server is permitted to deviate from this time but should observe it. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reason | S Σ | 1..1 | string | There are no (further) constraints on this element Element idSubscription.reasonShort description Grund der Subscription DefinitionA description of why this subscription is defined. Bedeutung: Beschreibung wieso diese Subscription erstellt wurde. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| criteria | S Σ | 1..1 | stringBinding | Element idSubscription.criteriaShort description Canonical URL des SubscriptionTopic welches man abonnieren möchte. DefinitionWhen using topic-based subscriptions, the primary criteria is always the topic, indicated by its canonical URL. MAIA only supports the subscription topic MaiaSubscriptionTopicVS (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idSubscription.criteria.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSubscription.criteria.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| filterCriteria | S Σ C | 0..* | Extension(string) | There are no (further) constraints on this element Element idSubscription.criteria.extension:filterCriteriaShort description Filterkriterium. Alternate namesextensions, user content DefinitionSearch-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. Bedeutung: Filterkriterium für die Subscription. Dieses Feld ist optional und kann genutzt werden, um die Subscription auf bestimmte Events zu filtern. http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idSubscription.criteria.extension:filterCriteria.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idSubscription.criteria.extension:filterCriteria.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idSubscription.criteria.extension:filterCriteria.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteriaMappings
| |||
| value[x] | S | 0..1 | There are no (further) constraints on this element Element idSubscription.criteria.extension:filterCriteria.value[x]Short description Filtering critiera applied to events DefinitionSearch-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. When multiple filters are applied, evaluates to true if all the conditions are met; otherwise it returns false. (i.e., logical AND). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| valueString | string | There are no (further) constraints on this element Data type | ||||
| value | 0..1 | System.String | There are no (further) constraints on this element Element idSubscription.criteria.valueShort description Primitive value for string DefinitionPrimitive value for string System.String Maximum string length1048576 | |||
| error | Σ | 0..1 | string | There are no (further) constraints on this element Element idSubscription.errorShort description Latest error note DefinitionA record of the last error that occurred when the server processed a notification. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| channel | S Σ | 1..1 | BackboneElement | There are no (further) constraints on this element Element idSubscription.channelShort description Kommunikationskanal DefinitionDetails where to send notifications when resources are received that meet the criteria. Bedeutung: Kommunikationskanal über den die Subscription Benachrichtigungen gesendet werden sollen. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idSubscription.channel.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSubscription.channel.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| heartbeatPeriod | S C | 0..1 | Extension(unsignedInt) | Element idSubscription.channel.extension:heartbeatPeriodShort description Heartbeat-Intervall Alternate namesextensions, user content DefinitionIf 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. ISiK Comment: Bedeutung: Intervall in dem der Server prüft, ob der Kommunikationskanal noch aktiv ist.
http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idSubscription.channel.extension:heartbeatPeriod.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idSubscription.channel.extension:heartbeatPeriod.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idSubscription.channel.extension:heartbeatPeriod.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-periodMappings
| |||
| value[x] | S | 0..1 | There are no (further) constraints on this element Element idSubscription.channel.extension:heartbeatPeriod.value[x]Short description Interval in seconds to send 'heartbeat' notification DefinitionIf 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| valueUnsignedInt | unsignedInt | There are no (further) constraints on this element Data type | ||||
| timeout | C | 0..1 | Extension(unsignedInt) | There are no (further) constraints on this element Element idSubscription.channel.extension:timeoutShort description Timeout in seconds to attempt notification delivery Alternate namesextensions, user content DefinitionIf present, the maximum amount of time a server will allow before failing a notification attempt. 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. http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| maxCount | C | 0..1 | Extension(positiveInt) | There are no (further) constraints on this element Element idSubscription.channel.extension:maxCountShort description Maximum number of triggering resources included in notification bundles Alternate namesextensions, user content DefinitionIf 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. 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. http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSubscription.channel.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | S Σ | 1..1 | codeBindingPattern | Element idSubscription.channel.typeShort description Typ des Kommunikationskanals DefinitionThe type of channel to send notifications on. Bedeutung: Der Typ des Kommunikationskanals, über den Subscription-Benachrichtigungen gesendet werden sollen. The type of method used to execute a subscription. SubscriptionChannelType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
rest-hookMappings
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idSubscription.channel.type.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSubscription.channel.type.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| customChannelType | S Σ C | 0..0 | Extension(Coding) | There are no (further) constraints on this element Element idSubscription.channel.type.extension:customChannelTypeShort description Custom Channel Type Alternate namesextensions, user content DefinitionThe type of channel to send notifications on. Bedeutung: Custom Channel Type welcher in ISiK aktuell nicht unterstützt wird. http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value | 0..1 | System.String | There are no (further) constraints on this element Element idSubscription.channel.type.valueShort description Primitive value for code DefinitionPrimitive value for code System.String Maximum string length1048576 | |||
| endpoint | S Σ | 0..1 | url | There are no (further) constraints on this element Element idSubscription.channel.endpointShort description Endpunkt DefinitionThe url that describes the actual end-point to send messages to. Bedeutung: Adresse des Kommunikationskanals/ Endpunkts, an den Subscription-Benachrichtigungen gesendet werden sollen. Dies ist nur für rest-hook Subscriptions relevant. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| payload | S Σ | 1..1 | codeBindingPattern | Element idSubscription.channel.payloadShort description Format der Nutzdaten DefinitionThe 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. Bedeutung: Format in dem Subscription Notifications versendet werden sollen (JSON oder XML). The mime type of an attachment. Any valid mime type is allowed. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
application/fhir+jsonMappings
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idSubscription.channel.payload.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 1..* | Extension | There are no (further) constraints on this element Element idSubscription.channel.payload.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| content | S Σ C | 1..1 | Extension(code) | There are no (further) constraints on this element Element idSubscription.channel.payload.extension:contentShort description Inhalt der Nutzdaten Alternate namesextensions, user content DefinitionHow 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. Bedeutung: Welcher Ressourceninhalt in der Nutzlast der Benachrichtigung geliefert werden soll. http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idSubscription.channel.payload.extension:content.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idSubscription.channel.payload.extension:content.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idSubscription.channel.payload.extension:content.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-contentMappings
| |||
| value[x] | 0..1 | There are no (further) constraints on this element Element idSubscription.channel.payload.extension:content.value[x]Short description Notification content level DefinitionHow 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. Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured. Unordered, Open, by $this(Type) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| valueCode | 0..1 | codeBindingPattern | Element idSubscription.channel.payload.extension:content.value[x]:valueCodeShort description Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
full-resourceMappings
| |||
| value | 0..1 | System.String | There are no (further) constraints on this element Element idSubscription.channel.payload.valueShort description Primitive value for code DefinitionPrimitive value for code System.String Maximum string length1048576 | |||
| header | S Σ | 0..* | string | Element idSubscription.channel.headerShort description Falls eine REST-Enpunkt einen Authorization-Header benötigt, kann dieser hier gesetzt werden DefinitionAdditional headers / information to send as part of the notification. MAIA only accepts the header The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Create a Subscription resource via POST /fhir/Subscription. Constraint violations return HTTP 422.
Authentication header (write-only)
channel.header is accepted on create/update (only the first element is stored) but masked on read to prevent token disclosure.
Subscription Lifecycle
See REST-Hook channel in the Backport IG for the full specification.
If the handshake POST receives a non-2xx response, status is set to error. A subsequent PUT (with status = "requested" or "error") re-triggers the handshake.