Smile CDR v2023.02.PRE
On this page:
   39.27    FHIR Binary Storage
  • 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.29    Capability Statement   
       Table of Contents

    FHIR Bulk Operations

    39.28FHIR Bulk Operations

     

    The FHIR Bulk Operations configuration category includes the following configurable options:

    • Enable Bulk Export batch job reuse

    • FHIR Bulk Export Enabled

    • Maximum Bulk Export file capacity

    • Bulk Export file retention (hours)

    • Normalize Terminology on Bulk Export

    • FHIR Bulk Import Enabled

    39.28.1Property: Enable Bulk Export batch job reuse

     
    Property Name Enable Bulk Export batch job reuse
    Property Key
    Property Type BOOLEAN
    Description If this is enabled, the bulk export operation will check whether a batch job already exists with identical parameters, and if so, will reuse that batch job. If disabled, the bulk export operation will always create a new batch job. Defaults to enabled.
    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.bulk_export.enable_job_reuse = true

    39.28.2Property: FHIR Bulk Export Enabled

     
    Property Name FHIR Bulk Export Enabled
    Property Key
    Property Type BOOLEAN
    Description If enabled, this server will support the FHIR Bulk Export protocol. See FHIR Bulk Export for more information.
    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.bulk_export.enabled = false

    39.28.3Property: Maximum Bulk Export file capacity

     
    Property Name Maximum Bulk Export file capacity
    Property Key
    Property Type INTEGER
    Description If set, provides the maximum number of resources that will be stored in each binary file created by a bulk export. Defaults to 1000 resources per binary file.
    Applies to Modules
    • FHIR Storage (DSTU2 Relational)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value 1000
    Example Property 
    module.[MODULE_ID].config.bulk_export.file_max_capacity = 1000

    39.28.4Property: Bulk Export file retention (hours)

     
    Property Name Bulk Export file retention (hours)
    Property Key
    Property Type INTEGER
    Description Files related to a bulk export job will be purged after this many hours from the point at which the job started. If set to 0 or less, the files will never be removed.
    Applies to Modules
    • FHIR Storage (DSTU2 Relational)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 Relational)
    • FHIR Storage (R4 Relational)
    Default Value 24
    Example Property 
    module.[MODULE_ID].config.bulk_export.file_retention_hours = 24

    39.28.5Property: Normalize Terminology on Bulk Export

     
    Property Name Normalize Terminology on Bulk Export
    Property Key
    Property Type BOOLEAN
    Description If enabled, Smile CDR will attempt to normalize codes in generated bulk export files.
    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.bulk_export.normalize_terminology.enabled = false

    39.28.6Property: FHIR Bulk Import Enabled

     
    Property Name FHIR Bulk Import Enabled
    Property Key
    Property Type BOOLEAN
    Description If enabled, this server will support the FHIR Bulk Import protocol. See FHIR Bulk Import for more information.
    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.bulk_import.enabled = false
       39.27    FHIR Binary Storage
  • 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.29    Capability Statement