On this page:
   34.44    FHIR Repository Validation 34.46    FHIR Subscription Delivery   

34.45FHIR 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

  • Websocket Subscription Enabled

34.45.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

34.45.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

34.45.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

34.45.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

34.45.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

34.45.6Property: 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
   34.44    FHIR Repository Validation 34.46    FHIR Subscription Delivery