While Aidbox SubSubscriptions are stable and fully functional, they will no longer receive active development or new features. For enhanced capabilities and ongoing support, please use . This newer implementation offers improved performance, flexibility, and will continue to be developed to meet future needs.
Aidbox subscriptions module is a way to subscribe and get notifications about updating resources on the server. It is a common denominator of FHIR R4/R5 subscriptions specification with some extensions.
This module introduces two new resources into Aidbox:
SubsSubscription — meta-resource which binds events (create/update/delete resource) with a communication channel through which subscriber is notified about changes.
SubsNotification — resource which represents notification with its status (sent or not).
Aidbox doesn't delete SubsNotification resources by itself. The simple way to implement a retention policy is to create a cron job. if there is a more clear way.
See tutorial
Your service can register subscription by POST SubsSubscription resource:
POST /SubsSubscription
Accept: text/yaml
Content-Type: text/yaml
id: myservice-subs
status: active # 'active' is default, if 'off' - subscription is disabled
# Subscribe to all changes of Patient and Person resources
trigger:
# resource type
Patient:
event: ['all'] # can be all | create | update | delete
# collection of filters
filter:
# use matcho engine to filter resources
- matcho: { active: true }
Person:
event: ['all']
# how to deliver notifications
channel:
type: rest-hook
# url to send hook
endpoint: https://myservice/subs/patient
# headers to add to request (for consistency use lowercase names)
headers:
Authorization: Bearer <......>
# recomended timeout for web hook in ms, server may use it's own
timeout: 1000
payload:
# this is default value, you can use id-only
content: full-resource # full-resource | id-only
# means aidbox format, or fhir+json to get resource in FHIR format
contentType: json # json | fhir+json
Filter matches if at least one of item in the collection matches, i.e. collection has or semantic.
Protocol
After you registered subscription, Aidbox sends on channel.endpoint handshake notification in json format. It's good if your service responds with status: 200
You can subscribe one instance of Aidbox to notifications from another instance and replicate data between boxes by using /subs/webhook/<source-id> endpoint:
Subscription.trigger is a key-value object, where key is resource type and each value can contain a collection of events (values can be 'all', 'create', 'update', 'delete') and .filter collection. For now filter support engine (FHIRPath and FHIR Search filters are coming soon):
