Smile CDR v2024.05.PRE
On this page:
   45.39    FHIR Binary Storage 45.41    Capability Statement   

45.40.1FHIR 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

  • Restrict Download to Initiating User

  • FHIR Bulk Import Enabled

45.40.2Property: 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 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.bulk_export.enable_job_reuse = true

45.40.3Property: 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 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.bulk_export.enabled = false

45.40.4Property: 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. If set to 1000, then up to 1000 resources will be included per NDJSON file in the output. The complete contents of individual files are held in memory while they are being created, so large values may require additional RAM to be available.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value 1000
Example Property
module.[MODULE_ID].config.bulk_export.file_max_capacity = 1000

45.40.5Property: 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 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value 24
Example Property
module.[MODULE_ID].config.bulk_export.file_retention_hours = 24

45.40.6Property: 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 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.bulk_export.normalize_terminology.enabled = false

45.40.7Property: Restrict Download to Initiating User

 
Property Name Restrict Download to Initiating User
Property Key
Property Type BOOLEAN
Description If enabled, generated Bulk Export Binary files will only be readable by the specific user who initiated the export. See Accessing Bulk Export Files 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.bulk_export.restrict_download_to_initiating_user.enabled = true

45.40.8Property: 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 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.bulk_import.enabled = false
   45.39    FHIR Binary Storage 45.41    Capability Statement