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

    FHIR Subscription Persistence

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

    • REST Hook Subscription Enabled

    • Trigger Subscriptions on Non-Versioning Changes

    • Websocket Subscription Enabled

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

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

    41.58.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 Relational)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value false
    Example Property 
    module.[MODULE_ID].config.subscription.cross_partition.enabled = false

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

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

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

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

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