Smile CDR v2023.02.PRE
On this page:
   39.51    FHIR Storage Package Registry
  • Configuration Categories
  • 39.0 Web Admin Console Settings
  • 39.1 appSphere
  • 39.2 Payer Config
  • 39.3 Initial appSphere Seeding
  • 39.4 Authentication Callback Scripts
  • 39.5 Auth: General for APIs
  • 39.6 User Authentication
  • 39.7 Auth: HTTP Basic
  • 39.8 Auth: OpenID Connect
  • 39.9 Browser Syntax Highlighting
  • 39.10 Capability Statement (metadata)
  • 39.11 CDA Generation
  • 39.12 CDA Import
  • 39.13 CDS Hooks Definitions
  • 39.14 Channel Import
  • 39.15 Channel Retry
  • 39.16 Kafka
  • 39.17 Smile CDR License
  • 39.18 Cluster Manager Maintenance
  • 39.19 Message Broker
  • 39.20 Cluster Level Security
  • 39.21 Credentials
  • 39.22 Cross-Origin Resource Sharing (CORS)
  • 39.23 Database
  • 39.24 Email Configuration
  • 39.25 ETL Import: CSV Properties
  • 39.26 ETL Import: Source
  • 39.27 FHIR Binary Storage
  • 39.28 FHIR Bulk Operations
  • 39.29 Capability Statement
  • 39.30 FHIR Configuration
  • 39.31 Consent Service
  • 39.32 FHIR Endpoint Conversion
  • 39.33 Interceptors
  • 39.34 FHIR Endpoint Partitioning
  • 39.35 Resource Providers
  • 39.36 FHIR Endpoint Security
  • 39.37 Endpoint Terminology
  • 39.38 FHIR Gateway Configuration
  • 39.39 FHIR Interceptors
  • 39.40 LiveBundle Service
  • 39.41 FHIR MDM Server
  • 39.42 FHIR Performance
  • 39.43 FHIR Performance Tracing
  • 39.44 FHIR Realtime Export
  • 39.45 Repository Validation
  • 39.46 FHIR Resource Types
  • 39.47 FHIR REST Endpoint
  • 39.48 FHIR Search
  • 39.49 FHIR Storage Module Scheduled Tasks
  • 39.50 FHIR Validation Services
  • 39.51 FHIR Storage Package Registry
  • 39.52 FHIR Storage Partitioning
  • 39.53 Versioned References
  • 39.54 FHIR Subscription Delivery
  • 39.55 FHIR Subscription Persistence
  • 39.56 Amazon HealthLake REST Endpoint
  • 39.57 HL7 v2.x Mapper - Contained Resource
  • 39.58 HL7 v2.x Mapper - DG1
  • 39.59 HL7 v2.x Mapper - Forced Namespace Mode
  • 39.60 HL7 v2.x Mapper - General
  • 39.61 HL7 v2.x Mapper - Medications
  • 39.62 HL7 v2.x Mapper - OBR
  • 39.63 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 39.64 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 39.65 HL7 v2.x Mapper - PID
  • 39.66 HL7 v2.x Mapper - PV1
  • 39.67 HL7 v2.x Listener Script
  • 39.68 HL7 v2.x MLLP Listener
  • 39.69 HL7 v2.x MLLP Sender
  • 39.70 FHIR to HL7 v2.x Mapper Script
  • 39.71 HL7 v2.x Outbound Mapping
  • 39.72 Da Vinci Health Record Exchange (HRex)
  • 39.73 HTTP Access Log
  • 39.74 HTTP Listener
  • 39.75 HTTP Request Pool
  • 39.76 HTTP Security
  • 39.77 Hybrid Providers Definitions
  • 39.78 Initial User Seeding
  • 39.79 JavaScript Execution Environment
  • 39.80 JSON Web KeySet (JWKS)
  • 39.81 LDAP Authentication
  • 39.82 Lucene FullText Indexing
  • 39.83 MDM
  • 39.84 Narrative Generator
  • 39.85 OpenID Connect Token Validation
  • 39.86 OpenID Connect (OIDC)
  • 39.87 Payer to Payer
  • 39.88 Privacy Security Notice
  • 39.89 Provenance Injection
  • 39.90 Realtime Export
  • 39.91 Endpoint Validation: Request Validating
  • 39.92 Search Parameter Seeding
  • 39.93 SAML Provider
  • 39.94 Security Inbound Script
  • 39.95 Inbound SMART on FHIR Authentication
  • 39.96 Inbound SMART on FHIR Endpoints
  • 39.97 OAuth2/OIDC Federation
  • 39.98 SMART Callback Script
  • 39.99 Cross-Organizational Data Access Profile
  • 39.100 SMART Login Skin
  • 39.101 SMART Login Terms of Service
  • 39.102 SMART Authorization
  • 39.103 SMART Definitions Seeding
  • 39.104 Sessions
  • 39.105 Two Factor Authentication
  • 39.106 TLS / SSL (Encryption)
  • 39.107 Transaction Log
  • 39.108 Trusted Client
  • 39.109 User Self Registration
    • 39.53    Versioned References   
       Table of Contents

    FHIR Storage Partitioning

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

    39.52.1Property: 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 Relational)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value NOT_ALLOWED
    Example Property 
    module.[MODULE_ID].config.partitioning.cross_partition_reference_mode = NOT_ALLOWED

    39.52.2Property: 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 Relational)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.partitioning.default_partition_id =

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

    39.52.4Property: 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 Relational)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value NAMED
    Example Property 
    module.[MODULE_ID].config.partitioning.naming_mode = NAMED

    39.52.5Property: 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 Relational)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value MANUAL
    Example Property 
    module.[MODULE_ID].config.partitioning.partition_selection_mode = MANUAL

    39.52.6Property: 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 Relational)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.partitioning.seed.file = classpath:/config_seeding/fhir-partitions.json

    39.52.7Property: 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 Relational)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value true
    Example Property 
    module.[MODULE_ID].config.partitioning_security.enabled = true
       39.51    FHIR Storage Package Registry
  • Configuration Categories
  • 39.0 Web Admin Console Settings
  • 39.1 appSphere
  • 39.2 Payer Config
  • 39.3 Initial appSphere Seeding
  • 39.4 Authentication Callback Scripts
  • 39.5 Auth: General for APIs
  • 39.6 User Authentication
  • 39.7 Auth: HTTP Basic
  • 39.8 Auth: OpenID Connect
  • 39.9 Browser Syntax Highlighting
  • 39.10 Capability Statement (metadata)
  • 39.11 CDA Generation
  • 39.12 CDA Import
  • 39.13 CDS Hooks Definitions
  • 39.14 Channel Import
  • 39.15 Channel Retry
  • 39.16 Kafka
  • 39.17 Smile CDR License
  • 39.18 Cluster Manager Maintenance
  • 39.19 Message Broker
  • 39.20 Cluster Level Security
  • 39.21 Credentials
  • 39.22 Cross-Origin Resource Sharing (CORS)
  • 39.23 Database
  • 39.24 Email Configuration
  • 39.25 ETL Import: CSV Properties
  • 39.26 ETL Import: Source
  • 39.27 FHIR Binary Storage
  • 39.28 FHIR Bulk Operations
  • 39.29 Capability Statement
  • 39.30 FHIR Configuration
  • 39.31 Consent Service
  • 39.32 FHIR Endpoint Conversion
  • 39.33 Interceptors
  • 39.34 FHIR Endpoint Partitioning
  • 39.35 Resource Providers
  • 39.36 FHIR Endpoint Security
  • 39.37 Endpoint Terminology
  • 39.38 FHIR Gateway Configuration
  • 39.39 FHIR Interceptors
  • 39.40 LiveBundle Service
  • 39.41 FHIR MDM Server
  • 39.42 FHIR Performance
  • 39.43 FHIR Performance Tracing
  • 39.44 FHIR Realtime Export
  • 39.45 Repository Validation
  • 39.46 FHIR Resource Types
  • 39.47 FHIR REST Endpoint
  • 39.48 FHIR Search
  • 39.49 FHIR Storage Module Scheduled Tasks
  • 39.50 FHIR Validation Services
  • 39.51 FHIR Storage Package Registry
  • 39.52 FHIR Storage Partitioning
  • 39.53 Versioned References
  • 39.54 FHIR Subscription Delivery
  • 39.55 FHIR Subscription Persistence
  • 39.56 Amazon HealthLake REST Endpoint
  • 39.57 HL7 v2.x Mapper - Contained Resource
  • 39.58 HL7 v2.x Mapper - DG1
  • 39.59 HL7 v2.x Mapper - Forced Namespace Mode
  • 39.60 HL7 v2.x Mapper - General
  • 39.61 HL7 v2.x Mapper - Medications
  • 39.62 HL7 v2.x Mapper - OBR
  • 39.63 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 39.64 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 39.65 HL7 v2.x Mapper - PID
  • 39.66 HL7 v2.x Mapper - PV1
  • 39.67 HL7 v2.x Listener Script
  • 39.68 HL7 v2.x MLLP Listener
  • 39.69 HL7 v2.x MLLP Sender
  • 39.70 FHIR to HL7 v2.x Mapper Script
  • 39.71 HL7 v2.x Outbound Mapping
  • 39.72 Da Vinci Health Record Exchange (HRex)
  • 39.73 HTTP Access Log
  • 39.74 HTTP Listener
  • 39.75 HTTP Request Pool
  • 39.76 HTTP Security
  • 39.77 Hybrid Providers Definitions
  • 39.78 Initial User Seeding
  • 39.79 JavaScript Execution Environment
  • 39.80 JSON Web KeySet (JWKS)
  • 39.81 LDAP Authentication
  • 39.82 Lucene FullText Indexing
  • 39.83 MDM
  • 39.84 Narrative Generator
  • 39.85 OpenID Connect Token Validation
  • 39.86 OpenID Connect (OIDC)
  • 39.87 Payer to Payer
  • 39.88 Privacy Security Notice
  • 39.89 Provenance Injection
  • 39.90 Realtime Export
  • 39.91 Endpoint Validation: Request Validating
  • 39.92 Search Parameter Seeding
  • 39.93 SAML Provider
  • 39.94 Security Inbound Script
  • 39.95 Inbound SMART on FHIR Authentication
  • 39.96 Inbound SMART on FHIR Endpoints
  • 39.97 OAuth2/OIDC Federation
  • 39.98 SMART Callback Script
  • 39.99 Cross-Organizational Data Access Profile
  • 39.100 SMART Login Skin
  • 39.101 SMART Login Terms of Service
  • 39.102 SMART Authorization
  • 39.103 SMART Definitions Seeding
  • 39.104 Sessions
  • 39.105 Two Factor Authentication
  • 39.106 TLS / SSL (Encryption)
  • 39.107 Transaction Log
  • 39.108 Trusted Client
  • 39.109 User Self Registration
    • 39.53    Versioned References