Powered by Smile CDR v2025.02.PRE
Showing documentation for 2025.02.PRE
On this page:
  • Module Dependencies
  • 50.0 Module Dependencies
    •    Table of Contents

    Module Dependencies

    50.0.1Module Dependencies

     

    Within a node, a module can depend on other modules for functionality it needs. This is a list of dependencies, and which modules they apply to. See the Module Dependencies page for more information on module dependencies.

    50.0.2Dependency: ADMIN_JSON

     
    Property Name JSON Admin API
    Property Key
    Description The JSON Admin API exposes endpoints for MDM and Smile Module Configuration.
    Applies to Modules
    • MDM UI (optional)
    Example Property 
    module.[MODULE_ID].requires.ADMIN_JSON = [ADMIN_JSON_MODULE_ID]

    50.0.3Dependency: BOOT_AFTER

     
    Property Name Boot After
    Property Key
    Description Module that must start before this module is started.
    Applies to Modules
    • Hybrid Providers REST Endpoint (optional)
    Example Property 
    module.[MODULE_ID].requires.BOOT_AFTER = [BOOT_AFTER_MODULE_ID]

    50.0.4Dependency: CDA_EXCHANGE

     
    Property Name CDA Exchange+ Module
    Property Key
    Description The CDA Exchange+ module is used for processing CDA documents received in the channel.
    Applies to Modules
    • Channel Import (optional)
    Example Property 
    module.[MODULE_ID].requires.CDA_EXCHANGE = [CDA_EXCHANGE_MODULE_ID]

    50.0.5Dependency: CONSENT

     
    Property Name The Consent Module
    Property Key
    Description The Consent Module uses Consent resources to allow or deny access to FHIR resources.
    Applies to Modules
    • FHIR Gateway REST Endpoint (optional)
    • FHIR REST Endpoint (All FHIR Versions) (optional)
    • FHIR REST Endpoint (DSTU2 - Deprecated) (optional)
    • FHIR REST Endpoint (R3 - Deprecated) (optional)
    • FHIR REST Endpoint (R4 - Deprecated) (optional)
    • FHIRWeb Console (optional)
    Example Property 
    module.[MODULE_ID].requires.CONSENT = [CONSENT_MODULE_ID]

    50.0.6Dependency: CQL

     
    Property Name CQL
    Property Key
    Description The CQL module is used for evaluating CQL Libraries
    Applies to Modules
    • CDS Hooks REST Endpoint (optional)
    • Digital Quality Measures (DQM) (required)
    • Prior Auth DTR (required)
    Example Property 
    module.[MODULE_ID].requires.CQL = [CQL_MODULE_ID]

    50.0.7Dependency: EASYSHARE_PUBLIC

     
    Property Name EasyShare Public
    Property Key
    Description The EasyShare Public module to use for storage and retrieval of shared links
    Applies to Modules
    • EasyShare SHL Endpoint (Admin) (required)
    Example Property 
    module.[MODULE_ID].requires.EASYSHARE_PUBLIC = [EASYSHARE_PUBLIC_MODULE_ID]

    50.0.8Dependency: ENDPOINT_CDS_HOOKS

     
    Property Name Endpoint CDS Hooks
    Property Key
    Description The CDS hook Endpoint to register this plugin against.
    Applies to Modules
    • Prior Auth CRD (required)
    Example Property 
    module.[MODULE_ID].requires.ENDPOINT_CDS_HOOKS = [ENDPOINT_CDS_HOOKS_MODULE_ID]

    50.0.9Dependency: ENDPOINT_FHIR

     
    Property Name FHIR Endpoint
    Property Key
    Description The underlying FHIR endpoint for this module.
    Applies to Modules
    • CDS Hooks REST Endpoint (optional)
    • Digital Quality Measures (DQM) (required)
    • FHIRWeb Console (required)
    • MDM UI (required)
    • Prior Auth DTR (required)
    • Prior Auth Support (required)
    • appSphere (optional)
    Example Property 
    module.[MODULE_ID].requires.ENDPOINT_FHIR = [ENDPOINT_FHIR_MODULE_ID]

    50.0.10Dependency: ENDPOINT_FHIR_SANDBOX

     
    Property Name Sandbox FHIR Endpoint
    Property Key
    Description The FHIR Endpoint for connecting to test data for sandbox testing.
    Applies to Modules
    • appSphere (optional)
    Example Property 
    module.[MODULE_ID].requires.ENDPOINT_FHIR_SANDBOX = [ENDPOINT_FHIR_SANDBOX_MODULE_ID]

    50.0.11Dependency: ENDPOINT_HL7V2_IN

     
    Property Name HL7 v2.x Listening Endpoint
    Property Key
    Description The HL7 v2.x Listening Endpoint module is used for processing Hl7v2 messages received in the channel.
    Applies to Modules
    • Channel Import (optional)
    Example Property 
    module.[MODULE_ID].requires.ENDPOINT_HL7V2_IN = [ENDPOINT_HL7V2_IN_MODULE_ID]

    50.0.12Dependency: ETL_IMPORTER

     
    Property Name ETL Import
    Property Key
    Description The ETL Import module is used for processing CSVs received in the channel.
    Applies to Modules
    • Channel Import (optional)
    Example Property 
    module.[MODULE_ID].requires.ETL_IMPORTER = [ETL_IMPORTER_MODULE_ID]

    50.0.13Dependency: MDM

     
    Property Name MDM
    Property Key
    Description The Master Data Management (MDM) module is used for linking resources from multiple source systems.
    Applies to Modules
    • MDM UI (required)
    Example Property 
    module.[MODULE_ID].requires.MDM = [MDM_MODULE_ID]

    50.0.14Dependency: NARRATIVE_GENERATOR

     
    Property Name Narrative Generator
    Property Key
    Description The Narrative Generator module is used to create FHIR narrative content based on the structured contents of resources.
    Applies to Modules
    • CDA Exchange (optional)
    • CDA Exchange+ (optional)
    • FHIR Storage (MongoDB) (optional)
    Example Property 
    module.[MODULE_ID].requires.NARRATIVE_GENERATOR = [NARRATIVE_GENERATOR_MODULE_ID]

    50.0.15Dependency: PACKAGE_CACHE

     
    Property Name Package Cache
    Property Key
    Description The package storage engine that this endpoint connects to.
    Applies to Modules
    • Package Registry Endpoint (required)
    Example Property 
    module.[MODULE_ID].requires.PACKAGE_CACHE = [PACKAGE_CACHE_MODULE_ID]

    50.0.16Dependency: PERSISTENCE_ALL

     
    Property Name FHIR Storage Module (any FHIR version)
    Property Key
    Description The FHIR Storage module to associate with this module.
    Applies to Modules
    • Amazon HealthLake Outbound REST Connector (required)
    • CDA Exchange (required)
    • CDA Exchange+ (required)
    • CDS Hooks REST Endpoint (optional)
    • Camel (optional)
    • Channel Import (required)
    • Consent (required)
    • ETL Importer (required)
    • FHIR REST Endpoint (All FHIR Versions) (required)
    • HL7 v2.x Listening Endpoint (Deprecated) (optional)
    • HL7 v2.x Listening Endpoint (optional)
    • HL7 v2.x Sending Endpoint (required)
    • LDAP Inbound Security (optional)
    • Local Inbound Security (optional)
    • Payer to Payer (required)
    • Realtime Export (required)
    • SAML Inbound Security (optional)
    • SMART Inbound Security (optional)
    • SMART Outbound Security (optional)
    • Scripted Inbound Security (optional)
    • Subscription Matcher (All FHIR Versions) (required)
    • System to System Data Exchange (required)
    Example Property 
    module.[MODULE_ID].requires.PERSISTENCE_ALL = [PERSISTENCE_ALL_MODULE_ID]

    50.0.17Dependency: PERSISTENCE_DSTU2

     
    Property Name FHIR DSTU2 Storage
    Property Key
    Description The FHIR DSTU2 Storage engine to use as a manager for this module.
    Applies to Modules
    • FHIR REST Endpoint (DSTU2 - Deprecated) (required)
    Example Property 
    module.[MODULE_ID].requires.PERSISTENCE_DSTU2 = [PERSISTENCE_DSTU2_MODULE_ID]

    50.0.18Dependency: PERSISTENCE_DSTU3

     
    Property Name FHIR R3 Storage
    Property Key
    Description The FHIR R3 Storage engine to use as a manager for this module.
    Applies to Modules
    • FHIR REST Endpoint (R3 - Deprecated) (required)
    • HL7 v2.x Listening Endpoint (Deprecated) (optional)
    • HL7 v2.x Listening Endpoint (optional)
    Example Property 
    module.[MODULE_ID].requires.PERSISTENCE_DSTU3 = [PERSISTENCE_DSTU3_MODULE_ID]

    50.0.19Dependency: PERSISTENCE_R4

     
    Property Name FHIR R4 Storage
    Property Key
    Description The FHIR R4 Storage engine to use as a manager for this module.
    Applies to Modules
    • FHIR REST Endpoint (R4 - Deprecated) (required)
    Example Property 
    module.[MODULE_ID].requires.PERSISTENCE_R4 = [PERSISTENCE_R4_MODULE_ID]

    50.0.20Dependency: SECURITY_IN_ANONYMOUS

     
    Property Name Anonymous Authentication
    Property Key
    Description This dependency may optionally be used to specify a security module to use for anonymous authentication (essentially this means that the given provider will provide the account containing permissions to be assigned to anonymous requests).
    Applies to Modules
    • CDS Hooks REST Endpoint (optional)
    • EasyShare SHL Endpoint (Public) (optional)
    • FHIR Gateway REST Endpoint (optional)
    • FHIR REST Endpoint (All FHIR Versions) (optional)
    • FHIR REST Endpoint (DSTU2 - Deprecated) (optional)
    • FHIR REST Endpoint (R3 - Deprecated) (optional)
    • FHIR REST Endpoint (R4 - Deprecated) (optional)
    • FHIRWeb Console (optional)
    • HL7 v2.x Listening Endpoint (optional)
    • Hybrid Providers REST Endpoint (optional)
    • JSON Admin API (optional)
    • MDM UI (optional)
    • Package Registry Endpoint (optional)
    • Payer to Payer (optional)
    • Product Portal (optional)
    Example Property 
    module.[MODULE_ID].requires.SECURITY_IN_ANONYMOUS = [SECURITY_IN_ANONYMOUS_MODULE_ID]

    50.0.21Dependency: SECURITY_IN_OIC

     
    Property Name OpenID Connect Authentication
    Property Key
    Description The inbound security module (or outbound security module if using internal access tokens) to use for authenticating and authorizing users to this module using OpenID Connect Authentication.
    Applies to Modules
    • CDS Hooks REST Endpoint (optional)
    • EasyShare SHL Endpoint (Public) (optional)
    • FHIR Gateway REST Endpoint (optional)
    • FHIR REST Endpoint (All FHIR Versions) (optional)
    • FHIR REST Endpoint (DSTU2 - Deprecated) (optional)
    • FHIR REST Endpoint (R3 - Deprecated) (optional)
    • FHIR REST Endpoint (R4 - Deprecated) (optional)
    • Hybrid Providers REST Endpoint (optional)
    • JSON Admin API (optional)
    • MDM UI (optional)
    • Package Registry Endpoint (optional)
    • Payer to Payer (optional)
    • Product Portal (optional)
    • appSphere (required)
    Example Property 
    module.[MODULE_ID].requires.SECURITY_IN_OIC = [SECURITY_IN_OIC_MODULE_ID]

    50.0.22Dependency: SECURITY_IN_SAML

     
    Property Name SAML Authentication
    Property Key
    Description The SAML Inbound Security module to use when performing a SAML user authentication.
    Applies to Modules
    • EasyShare SHL Endpoint (Admin) (optional)
    • FHIRWeb Console (optional)
    • SMART Outbound Security (optional)
    • Web Admin Console (optional)
    Example Property 
    module.[MODULE_ID].requires.SECURITY_IN_SAML = [SECURITY_IN_SAML_MODULE_ID]

    50.0.23Dependency: SECURITY_IN_UP

     
    Property Name Username/Password Authentication
    Property Key
    Description The inbound security module to use for authenticating and authorizing users to this module where authentication requires a username and password.
    Applies to Modules
    • CDS Hooks REST Endpoint (optional)
    • EasyShare SHL Endpoint (Admin) (optional)
    • EasyShare SHL Endpoint (Public) (optional)
    • FHIR Gateway REST Endpoint (optional)
    • FHIR REST Endpoint (All FHIR Versions) (optional)
    • FHIR REST Endpoint (DSTU2 - Deprecated) (optional)
    • FHIR REST Endpoint (R3 - Deprecated) (optional)
    • FHIR REST Endpoint (R4 - Deprecated) (optional)
    • FHIRWeb Console (optional)
    • HL7 v2.x Listening Endpoint (optional)
    • Hybrid Providers REST Endpoint (optional)
    • JSON Admin API (optional)
    • MDM UI (optional)
    • Package Registry Endpoint (optional)
    • Payer to Payer (optional)
    • Product Portal (optional)
    • SMART Outbound Security (optional)
    • Web Admin Console (optional)
    Example Property 
    module.[MODULE_ID].requires.SECURITY_IN_UP = [SECURITY_IN_UP_MODULE_ID]

    50.0.24Dependency: SECURITY_USER_SELF_REGISTRATION

     
    Property Name User Self Registration Provider
    Property Key
    Description This can be supplied to some interactive modules in order to support self-registration of users.
    Applies to Modules
    • SMART Outbound Security (optional)
    Example Property 
    module.[MODULE_ID].requires.SECURITY_USER_SELF_REGISTRATION = [SECURITY_USER_SELF_REGISTRATION_MODULE_ID]

    50.0.25Dependency: SUBSCRIPTION

     
    Property Name Subscription Matcher
    Property Key
    Description The subscription matcher matches new and updated resources against active subscriptions and sends matches to endpoints.
    Applies to Modules
    • MDM (required)
    • Subscription Websocket Endpoint (required)
    Example Property 
    module.[MODULE_ID].requires.SUBSCRIPTION = [SUBSCRIPTION_MODULE_ID]

    50.0.26Dependency: VALIDATION_SUPPORT

     
    Property Name Validation Support
    Property Key
    Description This dependency supplies validation artifacts (StructureDefinitions, ValueSets, etc.) and provides terminology services used by the validator.
    Applies to Modules
    • CDA Exchange+ (optional)
    • FHIR Gateway REST Endpoint (optional)
    • FHIR REST Endpoint (All FHIR Versions) (optional)
    • FHIR REST Endpoint (DSTU2 - Deprecated) (optional)
    • FHIR REST Endpoint (R3 - Deprecated) (optional)
    • FHIR REST Endpoint (R4 - Deprecated) (optional)
    • FHIR Storage (MongoDB) (optional)
    • FHIR Storage (R3 RDBMS) (optional)
    • FHIR Storage (R4 RDBMS) (optional)
    • FHIR Storage (R5 RDBMS) (optional)
    • HL7 v2.x Listening Endpoint (Deprecated) (optional)
    • HL7 v2.x Listening Endpoint (optional)
    Example Property 
    module.[MODULE_ID].requires.VALIDATION_SUPPORT = [VALIDATION_SUPPORT_MODULE_ID]
  • Module Dependencies
  • 50.0 Module Dependencies