Smile CDR v2023.08.PRE
On this page:
   41.64    FHIR Subscription Delivery
  • Configuration Categories
  • 41.0 Web Admin Console Settings
  • 41.1 appSphere
  • 41.2 Payer Config
  • 41.3 Initial appSphere Seeding
  • 41.4 Authentication Callback Scripts
  • 41.5 Auth: General for APIs
  • 41.6 User Authentication
  • 41.7 Auth: HTTP Basic
  • 41.8 Auth: OpenID Connect
  • 41.9 Browser Syntax Highlighting
  • 41.10 Camel
  • 41.11 Capability Statement (metadata)
  • 41.12 Care Gaps
  • 41.13 CDA Generation
  • 41.14 CDA Import
  • 41.15 CDA JavaScript Execution Scripts
  • 41.16 CDS Hooks Definitions
  • 41.17 Channel Import
  • 41.18 Channel Retry
  • 41.19 Kafka
  • 41.20 Cluster Manager Maintenance
  • 41.21 Message Broker
  • 41.22 Cluster Level Security
  • 41.23 CQL
  • 41.24 Credentials
  • 41.25 Cross-Origin Resource Sharing (CORS)
  • 41.26 Database
  • 41.27 Da Vinci Health Record Exchange
  • 41.28 DQM
  • 41.29 DTR
  • 41.30 Email Configuration
  • 41.31 MDM UI
  • 41.32 ETL Import: CSV Properties
  • 41.33 ETL Import: Source
  • 41.34 FHIR Binary Storage
  • 41.35 FHIR Bulk Operations
  • 41.36 Capability Statement
  • 41.37 FHIR Configuration
  • 41.38 Consent Service
  • 41.39 FHIR Endpoint Conversion
  • 41.40 Interceptors
  • 41.41 FHIR Endpoint Partitioning
  • 41.42 Resource Providers
  • 41.43 FHIR Endpoint Security
  • 41.44 Endpoint Terminology
  • 41.45 FHIR Gateway Configuration
  • 41.46 FHIR Interceptors
  • 41.47 LiveBundle Service
  • 41.48 FHIR MDM Server
  • 41.49 FHIR Performance
  • 41.50 FHIR Performance Tracing
  • 41.51 FHIR Realtime Export
  • 41.52 Repository Validation
  • 41.53 FHIR Resource Types
  • 41.54 FHIR REST Endpoint
  • 41.55 FHIR Search
  • 41.56 Custom Resource Types
  • 41.57 IG Support
  • 41.58 MegaScale
  • 41.59 FHIR Storage Module Scheduled Tasks
  • 41.60 FHIR Validation Services
  • 41.61 FHIR Storage Package Registry
  • 41.62 FHIR Storage Partitioning
  • 41.63 Versioned References
  • 41.64 FHIR Subscription Delivery
  • 41.65 FHIR Subscription Persistence
  • 41.66 Amazon HealthLake REST Endpoint
  • 41.67 HL7 v2.x Mapper - Contained Resource
  • 41.68 HL7 v2.x Mapper - DG1
  • 41.69 HL7 v2.x Mapper - Forced Namespace Mode
  • 41.70 HL7 v2.x Mapper - General
  • 41.71 HL7 v2.x Mapper - Medications
  • 41.72 HL7 v2.x Mapper - OBR
  • 41.73 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 41.74 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 41.75 HL7 v2.x Mapper - PID
  • 41.76 HL7 v2.x Mapper - PV1
  • 41.77 Listener Interceptors
  • 41.78 HL7 v2.x Listener Script
  • 41.79 HL7 v2.x MLLP Listener
  • 41.80 HL7 v2.x MLLP Sender
  • 41.81 FHIR to HL7 v2.x Mapper Script
  • 41.82 HL7 v2.x Outbound Mapping
  • 41.83 Da Vinci Health Record Exchange (HRex)
  • 41.84 HTTP Access Log
  • 41.85 HTTP Listener
  • 41.86 HTTP Request Pool
  • 41.87 HTTP Security
  • 41.88 Hybrid Providers Definitions
  • 41.89 Initial User Seeding
  • 41.90 JavaScript Execution Environment
  • 41.91 JSON Web KeySet (JWKS)
  • 41.92 LDAP Authentication
  • 41.93 Smile CDR License
  • 41.94 Lucene FullText Indexing
  • 41.95 MDM
  • 41.96 Narrative Generator
  • 41.97 OpenID Connect Token Validation
  • 41.98 OpenID Connect (OIDC)
  • 41.99 Payer to Payer
  • 41.100 Privacy Security Notice
  • 41.101 Provenance Injection
  • 41.102 Realtime Export
  • 41.103 Endpoint Validation: Request Validating
  • 41.104 Scheduler Configuration
  • 41.105 Search Parameter Seeding
  • 41.106 SAML Provider
  • 41.107 Security Inbound Script
  • 41.108 Inbound SMART on FHIR Authentication
  • 41.109 Inbound SMART on FHIR Endpoints
  • 41.110 OAuth2/OIDC Federation
  • 41.111 SMART Callback Script
  • 41.112 Cross-Organizational Data Access Profile
  • 41.113 SMART Login Skin
  • 41.114 SMART Login Terms of Service
  • 41.115 SMART Authorization
  • 41.116 SMART Definitions Seeding
  • 41.117 Sessions
  • 41.118 Two Factor Authentication
  • 41.119 TLS / SSL (Encryption)
  • 41.120 Transaction Log
  • 41.121 Trusted Client
  • 41.122 User Self Registration
    • 41.66    Amazon HealthLake REST Endpoint   
       Table of Contents

    FHIR Subscription Persistence

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

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

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

    41.65.3Property: 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 false
    Example Property 
    module.[MODULE_ID].config.subscription.cross_partition.enabled = false

    41.65.4Property: 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

    41.65.5Property: 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

    41.65.6Property: 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

    41.65.7Property: 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

    41.65.8Property: 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

    41.65.9Property: 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
       41.64    FHIR Subscription Delivery
  • Configuration Categories
  • 41.0 Web Admin Console Settings
  • 41.1 appSphere
  • 41.2 Payer Config
  • 41.3 Initial appSphere Seeding
  • 41.4 Authentication Callback Scripts
  • 41.5 Auth: General for APIs
  • 41.6 User Authentication
  • 41.7 Auth: HTTP Basic
  • 41.8 Auth: OpenID Connect
  • 41.9 Browser Syntax Highlighting
  • 41.10 Camel
  • 41.11 Capability Statement (metadata)
  • 41.12 Care Gaps
  • 41.13 CDA Generation
  • 41.14 CDA Import
  • 41.15 CDA JavaScript Execution Scripts
  • 41.16 CDS Hooks Definitions
  • 41.17 Channel Import
  • 41.18 Channel Retry
  • 41.19 Kafka
  • 41.20 Cluster Manager Maintenance
  • 41.21 Message Broker
  • 41.22 Cluster Level Security
  • 41.23 CQL
  • 41.24 Credentials
  • 41.25 Cross-Origin Resource Sharing (CORS)
  • 41.26 Database
  • 41.27 Da Vinci Health Record Exchange
  • 41.28 DQM
  • 41.29 DTR
  • 41.30 Email Configuration
  • 41.31 MDM UI
  • 41.32 ETL Import: CSV Properties
  • 41.33 ETL Import: Source
  • 41.34 FHIR Binary Storage
  • 41.35 FHIR Bulk Operations
  • 41.36 Capability Statement
  • 41.37 FHIR Configuration
  • 41.38 Consent Service
  • 41.39 FHIR Endpoint Conversion
  • 41.40 Interceptors
  • 41.41 FHIR Endpoint Partitioning
  • 41.42 Resource Providers
  • 41.43 FHIR Endpoint Security
  • 41.44 Endpoint Terminology
  • 41.45 FHIR Gateway Configuration
  • 41.46 FHIR Interceptors
  • 41.47 LiveBundle Service
  • 41.48 FHIR MDM Server
  • 41.49 FHIR Performance
  • 41.50 FHIR Performance Tracing
  • 41.51 FHIR Realtime Export
  • 41.52 Repository Validation
  • 41.53 FHIR Resource Types
  • 41.54 FHIR REST Endpoint
  • 41.55 FHIR Search
  • 41.56 Custom Resource Types
  • 41.57 IG Support
  • 41.58 MegaScale
  • 41.59 FHIR Storage Module Scheduled Tasks
  • 41.60 FHIR Validation Services
  • 41.61 FHIR Storage Package Registry
  • 41.62 FHIR Storage Partitioning
  • 41.63 Versioned References
  • 41.64 FHIR Subscription Delivery
  • 41.65 FHIR Subscription Persistence
  • 41.66 Amazon HealthLake REST Endpoint
  • 41.67 HL7 v2.x Mapper - Contained Resource
  • 41.68 HL7 v2.x Mapper - DG1
  • 41.69 HL7 v2.x Mapper - Forced Namespace Mode
  • 41.70 HL7 v2.x Mapper - General
  • 41.71 HL7 v2.x Mapper - Medications
  • 41.72 HL7 v2.x Mapper - OBR
  • 41.73 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 41.74 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 41.75 HL7 v2.x Mapper - PID
  • 41.76 HL7 v2.x Mapper - PV1
  • 41.77 Listener Interceptors
  • 41.78 HL7 v2.x Listener Script
  • 41.79 HL7 v2.x MLLP Listener
  • 41.80 HL7 v2.x MLLP Sender
  • 41.81 FHIR to HL7 v2.x Mapper Script
  • 41.82 HL7 v2.x Outbound Mapping
  • 41.83 Da Vinci Health Record Exchange (HRex)
  • 41.84 HTTP Access Log
  • 41.85 HTTP Listener
  • 41.86 HTTP Request Pool
  • 41.87 HTTP Security
  • 41.88 Hybrid Providers Definitions
  • 41.89 Initial User Seeding
  • 41.90 JavaScript Execution Environment
  • 41.91 JSON Web KeySet (JWKS)
  • 41.92 LDAP Authentication
  • 41.93 Smile CDR License
  • 41.94 Lucene FullText Indexing
  • 41.95 MDM
  • 41.96 Narrative Generator
  • 41.97 OpenID Connect Token Validation
  • 41.98 OpenID Connect (OIDC)
  • 41.99 Payer to Payer
  • 41.100 Privacy Security Notice
  • 41.101 Provenance Injection
  • 41.102 Realtime Export
  • 41.103 Endpoint Validation: Request Validating
  • 41.104 Scheduler Configuration
  • 41.105 Search Parameter Seeding
  • 41.106 SAML Provider
  • 41.107 Security Inbound Script
  • 41.108 Inbound SMART on FHIR Authentication
  • 41.109 Inbound SMART on FHIR Endpoints
  • 41.110 OAuth2/OIDC Federation
  • 41.111 SMART Callback Script
  • 41.112 Cross-Organizational Data Access Profile
  • 41.113 SMART Login Skin
  • 41.114 SMART Login Terms of Service
  • 41.115 SMART Authorization
  • 41.116 SMART Definitions Seeding
  • 41.117 Sessions
  • 41.118 Two Factor Authentication
  • 41.119 TLS / SSL (Encryption)
  • 41.120 Transaction Log
  • 41.121 Trusted Client
  • 41.122 User Self Registration
    • 41.66    Amazon HealthLake REST Endpoint