Subscriptions

Subscriptions are defined with a target resource (such as Patient, Act, Entity, Person, Place, etc.)

What are Subscriptions?

📝The subscription defines one or more events and a series of filters which will trigger the issuance of a notification to the receiver.

Subscription Operations

The following operations can be done by a user regarding subscriptions:

Subscription Events

The following notification events can be subscribed to:

Event
Description

Create

Triggered when a subscribed resource's Inserted event is fired. This reflects new data that is added to the system

Update

Triggered when the subscribed resource's Updated event is fired. This reflects data that is updated in the system

Delete

Triggered when the subscribed resource's Obsoleted event is fired. This reflects data that is deleted from the system. Consider this more of a soft delete where the record remains but is marked as obsolete

Merge

Triggered when the subscribed resource's merging service fires the Merged event. This reflects data that is merged with another record of data in the system.

UnMerged

Triggered when the subscribed resource's merging service fires the UnMerged event. This reflects data which is split from other records in the system.

Triggering of Notifications

📝The notifications for each event are triggered by any internal update/change to data in the iCDR.

🎬This means that events will trigger notifications. (e.g. updates, merges, etc. received via FHIR, HL7v2, or even the user interfaces)

Subscription Channels

📢A channel defines the mechanism to notify the receiver of the publish notification.

📩The channel specifies the endpoint URL (mailto:, sms:, http:, llp:, etc.) which the dispatcher will use, and any settings.

🗒️Settings are stored as key/value pairs which, depending on the dispatcher, are used to determine the channel format, authorization, etc.

Last updated