API for the Exchange of Medicinal Product Information (APIX), published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/APIX---API-Exchange-for-Medicinal-Products/ and changes regularly. See the Directory of published versions

SubscriptionNotification Bundle/SubscriptionStatus

Page standards status: Informative

SubscriptionNotification Bundle and SubscriptionStatus

When a Subscription is triggered in APIX, the FHIR server sends a SubscriptionNotification Bundle to the subscriber’s configured endpoint. This Bundle contains two essential components:

1. A SubscriptionStatus resource that explains why the notification was sent — including which Subscription fired, which SubscriptionTopic was matched, and how many times the Subscription has triggered.
2. A set of event payload resources (e.g., the updated Task) determined by the SubscriptionTopic and Subscription configuration.

Together, the SubscriptionNotification Bundle and SubscriptionStatus provide a complete picture of both the triggering event and the associated metadata, enabling APIX clients to react immediately and reliably to regulatory workflow changes.

Example Bundle

---

SubscriptionNotification Bundle

Element	Cardinality (APIX)	Value / Example	Purpose / Notes
Bundle.type	1..1	subscription-notification	Indicates that this Bundle was generated as the result of a triggered Subscription
Bundle.entry[0]	1..1	SubscriptionStatus resource	The first entry always contains the SubscriptionStatus, which describes the triggering event and the Subscription involved
Bundle.entry[1..*]	0..*	Resources determined by the SubscriptionTopic and Subscription e.g. Task, DocumentReference	Contains the event payload; the specific resources included depend on the topic’s notification shape and the Subscription’s configuration
FHIR Definition	—	SubscriptionNotificationBundle	Formal definition of the notification Bundle structure in FHIR R5

---

SubscriptionStatus

Element	Cardinality (APIX)	Value / Example	Purpose / Notes
SubscriptionStatus.type	1..1	event-notification	Indicates the type of notification; event-notification is used when a Subscription is triggered. Other types exist for different phases of the FHIR R5 Subscription lifecycle.
SubscriptionStatus.eventsSinceSubscriptionStart	0..1	Integer count	Number of times this Subscription has been triggered since it was created; useful for monitoring and debugging
SubscriptionStatus.subscription	1..1	Reference to Subscription	Identifies the Subscription instance that fired and caused this notification
SubscriptionStatus.topic	1..1	Canonical URL of the SubscriptionTopic	Indicates which SubscriptionTopic defined the trigger that produced this notification