On this page:
   35.47    FHIR Repository Validation 35.49    FHIR Subscription Delivery   

35.48FHIR Subscription Persistence

 

The FHIR Subscription Persistence configuration category includes the following configurable options:

  • Consumers Per Delivery Queue

  • Matching Queue Consumers

  • Email Subscription Enabled

  • Message Subscription Enabled

  • REST Hook Subscription Enabled

  • Trigger Subscriptions on Non-Versioning Changes

  • Websocket Subscription Enabled

35.48.1Property: Consumers Per Delivery Queue

 
Property Name Consumers Per Delivery Queue
Property Key
Property Type POSITIVE_INTEGER
Description The number of listener threads created per subscription. These threads deliver subscription matches to subscription endpoints.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value 2
Example Property
module.[MODULE_ID].config.subscription.consumers_per_delivery_queue = 2

35.48.2Property: Matching Queue Consumers

 
Property Name Matching Queue Consumers
Property Key
Property Type POSITIVE_INTEGER
Description The number of listener threads that match new resources against active subscriptions.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value 5
Example Property
module.[MODULE_ID].config.subscription.consumers_per_matching_queue = 5

35.48.3Property: Email Subscription Enabled

 
Property Name Email Subscription Enabled
Property Key
Property Type BOOLEAN
Description Requires a Subscription Matching module. If enabled, the server will activate FHIR Subscriptions with the Email channel delivery type. See Subscription documentation for more information.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value false
Example Property
module.[MODULE_ID].config.subscription.email.enabled = false

35.48.4Property: Message Subscription Enabled

 
Property Name Message Subscription Enabled
Property Key
Property Type BOOLEAN
Description Requires a Subscription Matching module. If enabled, the server will activate FHIR Subscriptions with the Message channel delivery type. See Subscription documentation for more information.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value false
Example Property
module.[MODULE_ID].config.subscription.message.enabled = false

35.48.5Property: REST Hook Subscription Enabled

 
Property Name REST Hook Subscription Enabled
Property Key
Property Type BOOLEAN
Description Requires a Subscription Matching module. If enabled, the server will activate FHIR Subscriptions with the REST Hook channel delivery type. See Subscription documentation for more information.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value false
Example Property
module.[MODULE_ID].config.subscription.rest_hook.enabled = false

35.48.6Property: Trigger Subscriptions on Non-Versioning Changes

 
Property Name Trigger Subscriptions on Non-Versioning Changes
Property Key
Property Type BOOLEAN
Description If enabled, resource changes that do not trigger a new version (e.g. $meta-add) can still result in subscription triggering. If disabled, these changes will not result in any subscription processing.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value true
Example Property
module.[MODULE_ID].config.subscription.trigger_on_non_versioning_changes = true

35.48.7Property: Websocket Subscription Enabled

 
Property Name Websocket Subscription Enabled
Property Key
Property Type BOOLEAN
Description Requires a Subscription Matching module. If enabled, the server will activate FHIR Subscriptions with the Websocket channel delivery type. See Subscription documentation for more information.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value false
Example Property
module.[MODULE_ID].config.subscription.websocket.enabled = false
   35.47    FHIR Repository Validation 35.49    FHIR Subscription Delivery