Smile CDR v2024.08.PRE
On this page:
   49.68    FHIR Storage Package Registry 49.70    Versioned References   

49.69.1FHIR Storage Partitioning

 

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

  • Block resource updates changing Patient compartment

  • Cross-Partition Reference Mode

  • Default Partition ID

  • Partitioning Enabled

  • Partition Naming Mode

  • Partition Selection Mode

  • Partition Seed File

  • Partitioning Security Enabled

49.69.2Property: Block resource updates changing Patient compartment

 
Property Name Block resource updates changing Patient compartment
Property Key
Property Type ENUM
Values
  • ALWAYS
  • DEFAULT
  • NEVER
Description Specifies if resource updates which change the resource's Patient Compartment should be blocked. The default value is to block when Partition Selection Mode is PATIENT_ID.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value DEFAULT
Example Property
module.[MODULE_ID].config.partitioning.block_patient_compartment_update_mode = DEFAULT

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

49.69.4Property: 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 = 

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

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

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

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

49.69.9Property: 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
   49.68    FHIR Storage Package Registry 49.70    Versioned References