Smile CDR v2022.08.PRE
On this page:
   37.26    ETL Import: Source
  • Configuration Categories
  • 37.0 Web Admin Console Settings
  • 37.1 appSphere
  • 37.2 Payer Config
  • 37.3 Initial appSphere Seeding
  • 37.4 Authentication Callback Scripts
  • 37.5 Auth: General for APIs
  • 37.6 User Authentication
  • 37.7 Auth: HTTP Basic
  • 37.8 Auth: OpenID Connect
  • 37.9 Browser Syntax Highlighting
  • 37.10 Capability Statement (metadata)
  • 37.11 CDA Generation
  • 37.12 CDA Import
  • 37.13 CDS Hooks Definitions
  • 37.14 Channel Import
  • 37.15 Channel Retry
  • 37.16 Kafka
  • 37.17 Smile CDR License
  • 37.18 Cluster Manager Maintenance
  • 37.19 Message Broker
  • 37.20 Cluster Level Security
  • 37.21 Credentials
  • 37.22 Cross-Origin Resource Sharing (CORS)
  • 37.23 Database
  • 37.24 Email Configuration
  • 37.25 ETL Import: CSV Properties
  • 37.26 ETL Import: Source
  • 37.27 FHIR Binary Storage
  • 37.28 FHIR Bulk Operations
  • 37.29 Capability Statement
  • 37.30 FHIR Configuration
  • 37.31 Consent Service
  • 37.32 FHIR Endpoint Conversion
  • 37.33 Interceptors
  • 37.34 FHIR Endpoint Partitioning
  • 37.35 Custom Resource Providers
  • 37.36 FHIR Endpoint Security
  • 37.37 Endpoint Terminology
  • 37.38 FHIR Gateway Configuration
  • 37.39 FHIR Interceptors
  • 37.40 LiveBundle Service
  • 37.41 FHIR MDM Server
  • 37.42 FHIR Performance
  • 37.43 FHIR Performance Tracing
  • 37.44 FHIR Realtime Export
  • 37.45 Repository Validation
  • 37.46 FHIR Resource Types
  • 37.47 FHIR REST Endpoint
  • 37.48 FHIR Search
  • 37.49 FHIR Storage Module Scheduled Tasks
  • 37.50 FHIR Validation Services
  • 37.51 FHIR Storage Package Registry
  • 37.52 FHIR Storage Partitioning
  • 37.53 Versioned References
  • 37.54 FHIR Subscription Delivery
  • 37.55 FHIR Subscription Persistence
  • 37.56 Amazon HealthLake REST Endpoint
  • 37.57 HL7 v2.x Mapper - Contained Resource
  • 37.58 HL7 v2.x Mapper - DG1
  • 37.59 HL7 v2.x Mapper - Forced Namespace Mode
  • 37.60 HL7 v2.x Mapper - General
  • 37.61 HL7 v2.x Mapper - Medications
  • 37.62 HL7 v2.x Mapper - OBR
  • 37.63 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 37.64 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 37.65 HL7 v2.x Mapper - PID
  • 37.66 HL7 v2.x Mapper - PV1
  • 37.67 HL7 v2.x Listener Script
  • 37.68 HL7 v2.x MLLP Listener
  • 37.69 HL7 v2.x MLLP Sender
  • 37.70 FHIR to HL7 v2.x Mapper Script
  • 37.71 HL7 v2.x Outbound Mapping
  • 37.72 HTTP Access Log
  • 37.73 HTTP Listener
  • 37.74 HTTP Request Pool
  • 37.75 HTTP Security
  • 37.76 Hybrid Providers Definitions
  • 37.77 Initial User Seeding
  • 37.78 JavaScript Execution Environment
  • 37.79 JSON Web KeySet (JWKS)
  • 37.80 LDAP Authentication
  • 37.81 Lucene FullText Indexing
  • 37.82 MDM
  • 37.83 Narrative Generator
  • 37.84 OpenID Connect Token Validation
  • 37.85 OpenID Connect (OIDC)
  • 37.86 Provenance Injection
  • 37.87 Realtime Export
  • 37.88 Endpoint Validation: Request Validating
  • 37.89 Search Parameter Seeding
  • 37.90 SAML Provider
  • 37.91 Security Inbound Script
  • 37.92 Inbound SMART on FHIR Authentication
  • 37.93 Inbound SMART on FHIR Endpoints
  • 37.94 OAuth2/OIDC Federation
  • 37.95 SMART Callback Script
  • 37.96 Cross-Organizational Data Access Profile
  • 37.97 SMART Login Skin
  • 37.98 SMART Login Terms of Service
  • 37.99 SMART Authorization
  • 37.100 SMART Definitions Seeding
  • 37.101 Sessions
  • 37.102 Two Factor Authentication
  • 37.103 TLS / SSL (Encryption)
  • 37.104 Transaction Log
  • 37.105 Trusted Client
  • 37.106 User Self Registration
    • 37.28    FHIR Bulk Operations   
       Table of Contents

    FHIR Binary Storage

    37.27FHIR 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)

    • Blob service access key

    • Blob service bucket name.

    • Endpoint URL for S3-compatible service

    • Blob Service Region

    • Blob service secret key

    • Filesystem Mode: Base Directory

    • Binary Storage Mode

    • Maximum Size (bytes)

    • Minimum Size (bytes)

    37.27.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 (MongoDB)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value true
    Example Property 
    module.[MODULE_ID].config.binary_storage.access_operations.enabled = true

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

    37.27.3Property: 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 Relational)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value 10485760
    Example Property 
    module.[MODULE_ID].config.binary_storage.auto_inflation.max_bytes = 10485760

    37.27.4Property: Blob service access key

     
    Property Name Blob service access key
    Property Key
    Property Type STRING
    Description This setting allows you to set a manual access key. This is optional for AWS, as it uses its own credential chain. This setting is required if you are using MinIO.
    Applies to Modules
    • FHIR Storage (DSTU2 Relational)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.binary_storage.blob_service.access_key =

    37.27.5Property: Blob service bucket name.

     
    Property Name Blob service bucket name.
    Property Key
    Property Type STRING
    Description This setting allows you to control which bucket objects are stored in on the blob service provider.
    Applies to Modules
    • FHIR Storage (DSTU2 Relational)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value smilecdr-binary-storage
    Example Property 
    module.[MODULE_ID].config.binary_storage.blob_service.bucket = smilecdr-binary-storage

    37.27.6Property: Endpoint URL for S3-compatible service

     
    Property Name Endpoint URL for S3-compatible service
    Property Key
    Property Type STRING
    Description Overrides the endpoint for an S3-compatible service. This is optional for AWS, but required if you are using MinIO.
    Applies to Modules
    • FHIR Storage (DSTU2 Relational)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.binary_storage.blob_service.endpoint_url =

    37.27.7Property: Blob Service Region

     
    Property Name Blob Service Region
    Property Key
    Property Type STRING
    Description This setting allows you to control which region S3/Minio buckets/objects are stored in.
    Applies to Modules
    • FHIR Storage (DSTU2 Relational)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value us-west-2
    Example Property 
    module.[MODULE_ID].config.binary_storage.blob_service.region = us-west-2

    37.27.8Property: Blob service secret key

     
    Property Name Blob service secret key
    Property Key
    Property Type PASSWORD
    Description This setting allows to set a manual secret key. This is optional for AWS, as it uses its own credential chain. This setting is required if you are using MinIO.
    Applies to Modules
    • FHIR Storage (DSTU2 Relational)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.binary_storage.blob_service.secret_key =

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

    37.27.10Property: Binary Storage Mode

     
    Property Name Binary Storage Mode
    Property Key
    Property Type ENUM
    Values
    • DATABASE
    • DATABASE_BLOB
    • FILESYSTEM
    • AWS_S3
    • MINIO
    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 (MongoDB)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value DATABASE
    Example Property 
    module.[MODULE_ID].config.binary_storage.mode = DATABASE

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

    37.27.12Property: 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 (MongoDB)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value 10000
    Example Property 
    module.[MODULE_ID].config.binary_storage.size.min = 10000
       37.26    ETL Import: Source
  • Configuration Categories
  • 37.0 Web Admin Console Settings
  • 37.1 appSphere
  • 37.2 Payer Config
  • 37.3 Initial appSphere Seeding
  • 37.4 Authentication Callback Scripts
  • 37.5 Auth: General for APIs
  • 37.6 User Authentication
  • 37.7 Auth: HTTP Basic
  • 37.8 Auth: OpenID Connect
  • 37.9 Browser Syntax Highlighting
  • 37.10 Capability Statement (metadata)
  • 37.11 CDA Generation
  • 37.12 CDA Import
  • 37.13 CDS Hooks Definitions
  • 37.14 Channel Import
  • 37.15 Channel Retry
  • 37.16 Kafka
  • 37.17 Smile CDR License
  • 37.18 Cluster Manager Maintenance
  • 37.19 Message Broker
  • 37.20 Cluster Level Security
  • 37.21 Credentials
  • 37.22 Cross-Origin Resource Sharing (CORS)
  • 37.23 Database
  • 37.24 Email Configuration
  • 37.25 ETL Import: CSV Properties
  • 37.26 ETL Import: Source
  • 37.27 FHIR Binary Storage
  • 37.28 FHIR Bulk Operations
  • 37.29 Capability Statement
  • 37.30 FHIR Configuration
  • 37.31 Consent Service
  • 37.32 FHIR Endpoint Conversion
  • 37.33 Interceptors
  • 37.34 FHIR Endpoint Partitioning
  • 37.35 Custom Resource Providers
  • 37.36 FHIR Endpoint Security
  • 37.37 Endpoint Terminology
  • 37.38 FHIR Gateway Configuration
  • 37.39 FHIR Interceptors
  • 37.40 LiveBundle Service
  • 37.41 FHIR MDM Server
  • 37.42 FHIR Performance
  • 37.43 FHIR Performance Tracing
  • 37.44 FHIR Realtime Export
  • 37.45 Repository Validation
  • 37.46 FHIR Resource Types
  • 37.47 FHIR REST Endpoint
  • 37.48 FHIR Search
  • 37.49 FHIR Storage Module Scheduled Tasks
  • 37.50 FHIR Validation Services
  • 37.51 FHIR Storage Package Registry
  • 37.52 FHIR Storage Partitioning
  • 37.53 Versioned References
  • 37.54 FHIR Subscription Delivery
  • 37.55 FHIR Subscription Persistence
  • 37.56 Amazon HealthLake REST Endpoint
  • 37.57 HL7 v2.x Mapper - Contained Resource
  • 37.58 HL7 v2.x Mapper - DG1
  • 37.59 HL7 v2.x Mapper - Forced Namespace Mode
  • 37.60 HL7 v2.x Mapper - General
  • 37.61 HL7 v2.x Mapper - Medications
  • 37.62 HL7 v2.x Mapper - OBR
  • 37.63 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 37.64 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 37.65 HL7 v2.x Mapper - PID
  • 37.66 HL7 v2.x Mapper - PV1
  • 37.67 HL7 v2.x Listener Script
  • 37.68 HL7 v2.x MLLP Listener
  • 37.69 HL7 v2.x MLLP Sender
  • 37.70 FHIR to HL7 v2.x Mapper Script
  • 37.71 HL7 v2.x Outbound Mapping
  • 37.72 HTTP Access Log
  • 37.73 HTTP Listener
  • 37.74 HTTP Request Pool
  • 37.75 HTTP Security
  • 37.76 Hybrid Providers Definitions
  • 37.77 Initial User Seeding
  • 37.78 JavaScript Execution Environment
  • 37.79 JSON Web KeySet (JWKS)
  • 37.80 LDAP Authentication
  • 37.81 Lucene FullText Indexing
  • 37.82 MDM
  • 37.83 Narrative Generator
  • 37.84 OpenID Connect Token Validation
  • 37.85 OpenID Connect (OIDC)
  • 37.86 Provenance Injection
  • 37.87 Realtime Export
  • 37.88 Endpoint Validation: Request Validating
  • 37.89 Search Parameter Seeding
  • 37.90 SAML Provider
  • 37.91 Security Inbound Script
  • 37.92 Inbound SMART on FHIR Authentication
  • 37.93 Inbound SMART on FHIR Endpoints
  • 37.94 OAuth2/OIDC Federation
  • 37.95 SMART Callback Script
  • 37.96 Cross-Organizational Data Access Profile
  • 37.97 SMART Login Skin
  • 37.98 SMART Login Terms of Service
  • 37.99 SMART Authorization
  • 37.100 SMART Definitions Seeding
  • 37.101 Sessions
  • 37.102 Two Factor Authentication
  • 37.103 TLS / SSL (Encryption)
  • 37.104 Transaction Log
  • 37.105 Trusted Client
  • 37.106 User Self Registration
    • 37.28    FHIR Bulk Operations