On this page:
   34.19    ETL Import: Source 34.21    FHIR Bulk Operations   

34.20FHIR Binary Storage

 

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

  • Binary Access Operations Enabled

  • Filesystem Mode: Base Directory

  • Binary Storage Mode

  • Maximum Size (bytes)

  • Minimum Size (bytes)

34.20.1Property: Binary Access Operations Enabled

 
Property Name Binary Access Operations Enabled
Property Key
Property Type BOOLEAN
Description This setting enables the binary access read/write operations. See Binary Access Operations for more information.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value true
Example Property
module.[MODULE_ID].config.binary_storage.access_operations.enabled = true

34.20.2Property: Filesystem Mode: Base Directory

 
Property Name Filesystem Mode: Base Directory
Property Key
Property Type LOCAL_FILEDIR
Description When operating in FILESYSTEM binary storage mode, this setting provides the base path in which to store large binary objects.
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.binary_storage.filesystem.directory = 

34.20.3Property: Binary Storage Mode

 
Property Name Binary Storage Mode
Property Key
Property Type ENUM
Values
  • DATABASE
  • DATABASE_BLOB
  • FILESYSTEM
Description This setting sets a storage mechanism for large binary objects. See Externalized Binary Storage for more information.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value DATABASE
Example Property
module.[MODULE_ID].config.binary_storage.mode = DATABASE

34.20.4Property: Maximum Size (bytes)

 
Property Name Maximum Size (bytes)
Property Key
Property Type POSITIVE_INTEGER
Description This setting provides the maximum size of a binary object to be stored in binary storage. Binaries larger than this cutoff will be rejected and may not be stored.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value 104857600
Example Property
module.[MODULE_ID].config.binary_storage.size.max = 104857600

34.20.5Property: Minimum Size (bytes)

 
Property Name Minimum Size (bytes)
Property Key
Property Type NON_NEGATIVE_INTEGER
Description This setting provides the minimum size of a binary object before it is stored in binary storage. Any binaries smaller than this size will still be stored, but may be stored inline within resource bodies as base 64 encoded content.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value 10000
Example Property
module.[MODULE_ID].config.binary_storage.size.min = 10000
   34.19    ETL Import: Source 34.21    FHIR Bulk Operations