On this page:

57.41 External Object Storage 57.43 FHIR Bulk Operations

57.143.1FHIR Binary Storage

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

Binary Access Operations Enabled
Automatically inflate binaries.
Binary inflation maximum size (bytes)
Filesystem Mode: Base Directory
Binary Storage Mode
Maximum Size (bytes)
Minimum Size (bytes)

57.143.2Property: 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 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.binary_storage.access_operations.enabled = true`

57.143.3Property: Automatically inflate binaries.

Property Name	Automatically inflate binaries.
Property Key
Property Type	BOOLEAN
Description	If set to true, binaries stored in external binary storage will be fetched and populated into the resource body automatically upon resource access. If set to false, resources will show a binary ID with which you can manually fetch the binary.
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.binary_storage.auto_inflation.enabled = true`

57.143.4Property: Binary inflation maximum size (bytes)

Property Name	Binary inflation maximum size (bytes)
Property Key
Property Type	POSITIVE_INTEGER
Description	At most this many bytes will be fetched from external binary storage per request. If your request contains more binary data than this, anything over this threshold will be returned as a binary ID for later fetching.
Applies to Modules	FHIR Storage (DSTU2 RDBMS) FHIR Storage (MongoDB) FHIR Storage (R3 RDBMS) FHIR Storage (R4 RDBMS) FHIR Storage (R5 RDBMS)
Default Value	`10485760`
Example Property	`module.[MODULE_ID].config.binary_storage.auto_inflation.max_bytes = 10485760`

57.143.5Property: 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 RDBMS) FHIR Storage (MongoDB) FHIR Storage (R3 RDBMS) FHIR Storage (R4 RDBMS) FHIR Storage (R5 RDBMS)
Default Value	(no default)
Example Property	`module.[MODULE_ID].config.binary_storage.filesystem.directory =`

57.143.6Property: Binary Storage Mode

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

57.143.7Property: 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 RDBMS) FHIR Storage (MongoDB) FHIR Storage (R3 RDBMS) FHIR Storage (R4 RDBMS) FHIR Storage (R5 RDBMS)
Default Value	`104857600`
Example Property	`module.[MODULE_ID].config.binary_storage.size.max = 104857600`

57.143.8Property: 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 RDBMS) FHIR Storage (MongoDB) FHIR Storage (R3 RDBMS) FHIR Storage (R4 RDBMS) FHIR Storage (R5 RDBMS)
Default Value	`10000`
Example Property	`module.[MODULE_ID].config.binary_storage.size.min = 10000`

57.41 External Object Storage 57.43 FHIR Bulk Operations