Smile CDR v2024.08.PRE
On this page:
   46.70    FHIR Subscription Delivery 46.72    Amazon HealthLake REST Endpoint   

46.71.1FHIR Subscription Persistence

 

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

  • Consumers Per Delivery Queue

  • Matching Queue Consumers

  • Cross-Partition Subscription Enabled

  • Email Subscription Enabled

  • Message Subscription Enabled

  • Qualify subscription matching channel name

  • REST Hook Subscription Enabled

  • Trigger Subscriptions on Non-Versioning Changes

  • Websocket Subscription Enabled

46.71.2Property: 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 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value 2
Example Property
module.[MODULE_ID].config.subscription.consumers_per_delivery_queue = 2

46.71.3Property: 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 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value 5
Example Property
module.[MODULE_ID].config.subscription.consumers_per_matching_queue = 5

46.71.4Property: Cross-Partition Subscription Enabled

 
Property Name Cross-Partition Subscription Enabled
Property Key
Property Type BOOLEAN
Description Requires a Subscription Matching module. If enabled, the server will allow a subscription in the default partition to work across all partitions. See Subscription documentation for more information.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value true
Example Property
module.[MODULE_ID].config.subscription.cross_partition.enabled = true

46.71.5Property: 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 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.subscription.email.enabled = false

46.71.6Property: 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 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.subscription.message.enabled = false

46.71.7Property: Qualify subscription matching channel name

 
Property Name Qualify subscription matching channel name
Property Key
Property Type BOOLEAN
Description If disabled, the name of the subscription matching channel will not be suffixed with the node and module id.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value true
Example Property
module.[MODULE_ID].config.subscription.qualify_subscription_matching_channel_name = true

46.71.8Property: 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 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.subscription.rest_hook.enabled = false

46.71.9Property: 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 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value true
Example Property
module.[MODULE_ID].config.subscription.trigger_on_non_versioning_changes = true

46.71.10Property: 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 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.subscription.websocket.enabled = false
   46.70    FHIR Subscription Delivery 46.72    Amazon HealthLake REST Endpoint