Aidbox topic-based subscriptions
This functionality is available in Aidbox versions 2409 and later.
Overview
This feature enables dynamic subscriptions to changes in FHIR resources, allowing users/systems to receive notifications through multiple channels, including Kafka.
For an application example, refer to Aidbox Subscriptions & Kafka AidboxTopicDestination
Key Components
AidboxSubscriptionTopic
is a custom Aidbox resource modeled after the FHIR R6 SubscriptionTopic resource. The resource allows defining a set of events that clients can subscribe to, such as changes in specific resources.
FHIR Compliance:
For FHIR R4: Use the
AidboxSubscriptionTopic
as it is, since FHIR does not include this functionality in R4.For FHIR R4b, R5, and R6: You can use either the
AidboxSubscriptionTopic
or the FHIR SubscriptionTopic resource, depending on the FHIR version used. These version-specific resources will be added in the upcoming releases.
AidboxTopicDestination
is a custom Aidbox resource that defines where and how the notifications triggered by anAidboxSubscriptionTopic
should be sent. This resource offers flexibility in specifying various types of destinations. And is considered as a system configuration resource.AidboxSubscriptionStatus
is a custom Aidbox resource which describes the notifications: what messages stored in the bundle, source and destination.
AidboxSubscriptionTopic
The AidboxSubscriptionTopic
resource describes the data sources for subscriptions. It allows clients to subscribe to events in Aidbox and filter them using user-defined triggers, which are specified by the trigger
element. Supported properties:
Property | Type | Description |
---|---|---|
| uri | Resource (reference to definition) for this trigger definition. It is binding to All Resource Types. |
| code | create | update | delete |
| string | FHIRPath based trigger rule. Only current resource state is allowed. |
| string | Text representation of the event trigger. |
* required.
Create AidboxSubscriptionTopic
resource
AidboxSubscriptionTopic
resourceAidboxTopicDestination
The AidboxTopicDestination
resource is used to define channel configurations for processing subscription data.
Create a TopicDestination
To start processing subscription data, create a AidboxTopicDestination
resource with a reference to the AidboxSubscriptionTopic
. Examples of AidboxTopicDestination
resources can be found in sub-sections.
Stop subscription data processing
To stop processing subscription data, delete the AidboxTopicDestination
resource.
AidboxTopicDestination Profile
Ensure that the resource metadata contains the kind-specific AidboxTopicDestination
profile.
Elements
Property | Type | Description |
---|---|---|
| code |
|
| string | Url of |
| code | Defines the destination for sending notifications. Supported values: |
| Defines the destination parameters for sending notifications. Parameters are restricted by profiles for each destination. |
* required.
Currently supported channels
Kafka AidboxTopicDestinationWebhook AidboxTopicDestinationNotification Shape
Notification is a FHIR Bundle resource with history
type, containing relevant resources in its entries. The first entry is a AidboxSubscriptionStatus
resource, which describes the payload.
Last updated