Smile CDR v2023.02.PRE
On this page:
   39.27    FHIR Binary Storage 39.29    Capability Statement   

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 39.29    Capability Statement