Smile CDR v2023.11.PRE
On this page:
   43.66    FHIR Storage Package Registry
  • Configuration Categories
  • 43.0 Web Admin Console Settings
  • 43.1 appSphere
  • 43.2 Payer Config
  • 43.3 Initial appSphere Seeding
  • 43.4 Authentication Callback Scripts
  • 43.5 Auth: General for APIs
  • 43.6 User Authentication
  • 43.7 Auth: HTTP Basic
  • 43.8 Auth: OpenID Connect
  • 43.9 Browser Syntax Highlighting
  • 43.10 Camel
  • 43.11 Capability Statement (metadata)
  • 43.12 Care Gaps
  • 43.13 CDA Generation
  • 43.14 CDA Import
  • 43.15 CDA Interceptors
  • 43.16 CDA JavaScript Execution Scripts
  • 43.17 CDA Terminology
  • 43.18 CDS Hooks Definitions
  • 43.19 Channel Import
  • 43.20 Channel Retry
  • 43.21 Kafka
  • 43.22 Cluster Manager Maintenance
  • 43.23 Message Broker
  • 43.24 Cluster Level Security
  • 43.25 CQL
  • 43.26 Credentials
  • 43.27 Cross-Origin Resource Sharing (CORS)
  • 43.28 Database
  • 43.29 Da Vinci Health Record Exchange
  • 43.30 DQM
  • 43.31 DTR
  • 43.32 Email Configuration
  • 43.33 Encounter Start CDS hook configuration
  • 43.34 MDM UI
  • 43.35 ETL Import: CSV Properties
  • 43.36 ETL Import: Source
  • 43.37 FHIR Binary Storage
  • 43.38 FHIR Bulk Operations
  • 43.39 Capability Statement
  • 43.40 FHIR Configuration
  • 43.41 Consent Service
  • 43.42 FHIR Endpoint Conversion
  • 43.43 FHIR Endpoint HFQL Support
  • 43.44 Interceptors
  • 43.45 FHIR Endpoint Partitioning
  • 43.46 Resource Providers
  • 43.47 FHIR Endpoint Security
  • 43.48 Endpoint Terminology
  • 43.49 FHIR Gateway Configuration
  • 43.50 FHIR Interceptors
  • 43.51 LiveBundle Service
  • 43.52 FHIR MDM Server
  • 43.53 FHIR Performance
  • 43.54 FHIR Performance Tracing
  • 43.55 FHIR Realtime Export
  • 43.56 Repository Validation
  • 43.57 FHIR Resource Types
  • 43.58 FHIR REST Endpoint
  • 43.59 FHIR Search
  • 43.60 Custom Resource Types
  • 43.61 IG Support
  • 43.62 MegaScale
  • 43.63 FHIR Storage Module Conditional Updates
  • 43.64 FHIR Storage Module Scheduled Tasks
  • 43.65 FHIR Validation Services
  • 43.66 FHIR Storage Package Registry
  • 43.67 FHIR Storage Partitioning
  • 43.68 Versioned References
  • 43.69 FHIR Subscription Delivery
  • 43.70 FHIR Subscription Persistence
  • 43.71 Amazon HealthLake REST Endpoint
  • 43.72 HL7 v2.x Mapper - Contained Resource
  • 43.73 HL7 v2.x Mapper - DG1
  • 43.74 HL7 v2.x Mapper - Forced Namespace Mode
  • 43.75 HL7 v2.x Mapper - General
  • 43.76 HL7 v2.x Mapper - Medications
  • 43.77 HL7 v2.x Mapper - OBR
  • 43.78 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 43.79 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 43.80 HL7 v2.x Mapper - PID
  • 43.81 HL7 v2.x Mapper - PV1
  • 43.82 Listener Interceptors
  • 43.83 HL7 v2.x Listener Script
  • 43.84 HL7 v2.x MLLP Listener
  • 43.85 HL7 v2.x MLLP Sender
  • 43.86 FHIR to HL7 v2.x Mapper Script
  • 43.87 HL7 v2.x Outbound Mapping
  • 43.88 Da Vinci Health Record Exchange (HRex)
  • 43.89 HTTP Access Log
  • 43.90 HTTP Listener
  • 43.91 HTTP Request Pool
  • 43.92 HTTP Security
  • 43.93 Hybrid Providers Definitions
  • 43.94 Initial User Seeding
  • 43.95 JavaScript Execution Environment
  • 43.96 JSON Web KeySet (JWKS)
  • 43.97 LDAP Authentication
  • 43.98 Smile CDR License
  • 43.99 Lucene FullText Indexing
  • 43.100 MDM
  • 43.101 Narrative Generator
  • 43.102 OpenID Connect Token Validation
  • 43.103 OpenID Connect (OIDC)
  • 43.104 Order Sign CDS hook configuration
  • 43.105 Payer to Payer
  • 43.106 Prior Authorization Coverage Requirement Discovery
  • 43.107 Privacy Security Notice
  • 43.108 Provenance Injection
  • 43.109 Realtime Export
  • 43.110 Endpoint Validation: Request Validating
  • 43.111 Scheduler Configuration
  • 43.112 Search Parameter Seeding
  • 43.113 SAML Provider
  • 43.114 Security Inbound Script
  • 43.115 Inbound SMART on FHIR Authentication
  • 43.116 Inbound SMART on FHIR Endpoints
  • 43.117 OAuth2/OIDC Federation
  • 43.118 SMART Callback Script
  • 43.119 Cross-Organizational Data Access Profile
  • 43.120 SMART Login Skin
  • 43.121 SMART Login Terms of Service
  • 43.122 SMART Authorization
  • 43.123 SMART Definitions Seeding
  • 43.124 Sessions
  • 43.125 Two Factor Authentication
  • 43.126 TLS / SSL (Encryption)
  • 43.127 Transaction Log
  • 43.128 Trusted Client
  • 43.129 User Self Registration
    • 43.68    Versioned References   
       Table of Contents

    FHIR Storage Partitioning

    43.67.1FHIR Storage Partitioning

     

    The FHIR Storage Partitioning configuration category includes the following configurable options:

    • Cross-Partition Reference Mode

    • Default Partition ID

    • Partitioning Enabled

    • Partition Naming Mode

    • Partition Selection Mode

    • Partition Seed File

    • Partitioning Security Enabled

    43.67.2Property: Cross-Partition Reference Mode

     
    Property Name Cross-Partition Reference Mode
    Property Key
    Property Type ENUM
    Values
    • NOT_ALLOWED
    • ALLOWED_UNQUALIFIED
    Description If enabled, references between resources in different partitions are allowed under certain circumstances. See Cross-Partition References for more information.
    Applies to Modules
    • FHIR Storage (DSTU2 RDBMS)
    • FHIR Storage (R3 RDBMS)
    • FHIR Storage (R4 RDBMS)
    • FHIR Storage (R5 RDBMS)
    Default Value NOT_ALLOWED
    Example Property 
    module.[MODULE_ID].config.partitioning.cross_partition_reference_mode = NOT_ALLOWED

    43.67.3Property: Default Partition ID

     
    Property Name Default Partition ID
    Property Key
    Property Type INTEGER
    Description If set, specifies an integer value to place in the PARTITION_ID column for resources in the default partition. If left blank (the default) the null value will be used.
    Applies to Modules
    • FHIR Storage (DSTU2 RDBMS)
    • FHIR Storage (R3 RDBMS)
    • FHIR Storage (R4 RDBMS)
    • FHIR Storage (R5 RDBMS)
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.partitioning.default_partition_id =

    43.67.4Property: Partitioning Enabled

     
    Property Name Partitioning Enabled
    Property Key
    Property Type BOOLEAN
    Description Enable data partitioning: If this is not enabled, all other settings in this category are ignored. FHIR Storage Partitioning can be used to logically segregate data into distinct logical pools. See Partitioning for more information on this feature.
    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.partitioning.enabled = false

    43.67.5Property: Partition Naming Mode

     
    Property Name Partition Naming Mode
    Property Key
    Property Type ENUM
    Values
    • NAMED
    • UNNAMED
    Description This setting controls whether partitions are numbered and named (and must be declared in advance) or are only numbered (and do not need to be declared in advance).
    Applies to Modules
    • FHIR Storage (DSTU2 RDBMS)
    • FHIR Storage (R3 RDBMS)
    • FHIR Storage (R4 RDBMS)
    • FHIR Storage (R5 RDBMS)
    Default Value NAMED
    Example Property 
    module.[MODULE_ID].config.partitioning.naming_mode = NAMED

    43.67.6Property: Partition Selection Mode

     
    Property Name Partition Selection Mode
    Property Key
    Property Type ENUM
    Values
    • MANUAL
    • REQUEST_TENANT
    • PATIENT_ID
    Description Determines whether the request partition selection is determined from the incoming request in the FHIR Endpoint module
    Applies to Modules
    • FHIR Storage (DSTU2 RDBMS)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 RDBMS)
    • FHIR Storage (R4 RDBMS)
    • FHIR Storage (R5 RDBMS)
    Default Value MANUAL
    Example Property 
    module.[MODULE_ID].config.partitioning.partition_selection_mode = MANUAL

    43.67.7Property: Partition Seed File

     
    Property Name Partition Seed File
    Property Key
    Property Type Resource Path
    Description This setting can be used to supply a set of partition definitions to seed when the server first starts up. See Seeding Partitions for more information.
    Applies to Modules
    • FHIR Storage (DSTU2 RDBMS)
    • FHIR Storage (R3 RDBMS)
    • FHIR Storage (R4 RDBMS)
    • FHIR Storage (R5 RDBMS)
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.partitioning.seed.file = classpath:/config_seeding/fhir-partitions.json

    43.67.8Property: Partitioning Security Enabled

     
    Property Name Partitioning Security Enabled
    Property Key
    Property Type BOOLEAN
    Description Restrict access to resources based on partitioning permissions of the user (default true)
    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.partitioning_security.enabled = true
       43.66    FHIR Storage Package Registry
  • Configuration Categories
  • 43.0 Web Admin Console Settings
  • 43.1 appSphere
  • 43.2 Payer Config
  • 43.3 Initial appSphere Seeding
  • 43.4 Authentication Callback Scripts
  • 43.5 Auth: General for APIs
  • 43.6 User Authentication
  • 43.7 Auth: HTTP Basic
  • 43.8 Auth: OpenID Connect
  • 43.9 Browser Syntax Highlighting
  • 43.10 Camel
  • 43.11 Capability Statement (metadata)
  • 43.12 Care Gaps
  • 43.13 CDA Generation
  • 43.14 CDA Import
  • 43.15 CDA Interceptors
  • 43.16 CDA JavaScript Execution Scripts
  • 43.17 CDA Terminology
  • 43.18 CDS Hooks Definitions
  • 43.19 Channel Import
  • 43.20 Channel Retry
  • 43.21 Kafka
  • 43.22 Cluster Manager Maintenance
  • 43.23 Message Broker
  • 43.24 Cluster Level Security
  • 43.25 CQL
  • 43.26 Credentials
  • 43.27 Cross-Origin Resource Sharing (CORS)
  • 43.28 Database
  • 43.29 Da Vinci Health Record Exchange
  • 43.30 DQM
  • 43.31 DTR
  • 43.32 Email Configuration
  • 43.33 Encounter Start CDS hook configuration
  • 43.34 MDM UI
  • 43.35 ETL Import: CSV Properties
  • 43.36 ETL Import: Source
  • 43.37 FHIR Binary Storage
  • 43.38 FHIR Bulk Operations
  • 43.39 Capability Statement
  • 43.40 FHIR Configuration
  • 43.41 Consent Service
  • 43.42 FHIR Endpoint Conversion
  • 43.43 FHIR Endpoint HFQL Support
  • 43.44 Interceptors
  • 43.45 FHIR Endpoint Partitioning
  • 43.46 Resource Providers
  • 43.47 FHIR Endpoint Security
  • 43.48 Endpoint Terminology
  • 43.49 FHIR Gateway Configuration
  • 43.50 FHIR Interceptors
  • 43.51 LiveBundle Service
  • 43.52 FHIR MDM Server
  • 43.53 FHIR Performance
  • 43.54 FHIR Performance Tracing
  • 43.55 FHIR Realtime Export
  • 43.56 Repository Validation
  • 43.57 FHIR Resource Types
  • 43.58 FHIR REST Endpoint
  • 43.59 FHIR Search
  • 43.60 Custom Resource Types
  • 43.61 IG Support
  • 43.62 MegaScale
  • 43.63 FHIR Storage Module Conditional Updates
  • 43.64 FHIR Storage Module Scheduled Tasks
  • 43.65 FHIR Validation Services
  • 43.66 FHIR Storage Package Registry
  • 43.67 FHIR Storage Partitioning
  • 43.68 Versioned References
  • 43.69 FHIR Subscription Delivery
  • 43.70 FHIR Subscription Persistence
  • 43.71 Amazon HealthLake REST Endpoint
  • 43.72 HL7 v2.x Mapper - Contained Resource
  • 43.73 HL7 v2.x Mapper - DG1
  • 43.74 HL7 v2.x Mapper - Forced Namespace Mode
  • 43.75 HL7 v2.x Mapper - General
  • 43.76 HL7 v2.x Mapper - Medications
  • 43.77 HL7 v2.x Mapper - OBR
  • 43.78 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 43.79 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 43.80 HL7 v2.x Mapper - PID
  • 43.81 HL7 v2.x Mapper - PV1
  • 43.82 Listener Interceptors
  • 43.83 HL7 v2.x Listener Script
  • 43.84 HL7 v2.x MLLP Listener
  • 43.85 HL7 v2.x MLLP Sender
  • 43.86 FHIR to HL7 v2.x Mapper Script
  • 43.87 HL7 v2.x Outbound Mapping
  • 43.88 Da Vinci Health Record Exchange (HRex)
  • 43.89 HTTP Access Log
  • 43.90 HTTP Listener
  • 43.91 HTTP Request Pool
  • 43.92 HTTP Security
  • 43.93 Hybrid Providers Definitions
  • 43.94 Initial User Seeding
  • 43.95 JavaScript Execution Environment
  • 43.96 JSON Web KeySet (JWKS)
  • 43.97 LDAP Authentication
  • 43.98 Smile CDR License
  • 43.99 Lucene FullText Indexing
  • 43.100 MDM
  • 43.101 Narrative Generator
  • 43.102 OpenID Connect Token Validation
  • 43.103 OpenID Connect (OIDC)
  • 43.104 Order Sign CDS hook configuration
  • 43.105 Payer to Payer
  • 43.106 Prior Authorization Coverage Requirement Discovery
  • 43.107 Privacy Security Notice
  • 43.108 Provenance Injection
  • 43.109 Realtime Export
  • 43.110 Endpoint Validation: Request Validating
  • 43.111 Scheduler Configuration
  • 43.112 Search Parameter Seeding
  • 43.113 SAML Provider
  • 43.114 Security Inbound Script
  • 43.115 Inbound SMART on FHIR Authentication
  • 43.116 Inbound SMART on FHIR Endpoints
  • 43.117 OAuth2/OIDC Federation
  • 43.118 SMART Callback Script
  • 43.119 Cross-Organizational Data Access Profile
  • 43.120 SMART Login Skin
  • 43.121 SMART Login Terms of Service
  • 43.122 SMART Authorization
  • 43.123 SMART Definitions Seeding
  • 43.124 Sessions
  • 43.125 Two Factor Authentication
  • 43.126 TLS / SSL (Encryption)
  • 43.127 Transaction Log
  • 43.128 Trusted Client
  • 43.129 User Self Registration
    • 43.68    Versioned References