Skip to content

Configuring bulk-export operation

Duration of Availability for Downloading Exported FHIR Resources

To change the default value for time while exported resources are accessible for downloading (time-to-live or TTL) by bulk-export operation the Kodjin's cluster administrator should override the default value. The configuration file's path is: etc/kodjin/{environment}/values/fhir-server-search-export.yaml.gotmpl. Then add or modify value: OBJECT_TTL: 10

If OBJECTS_TTL value was changed after the cluster has been created all the fhir-server-search-export release should be deployed using rmk tool
rmk release sync -l app=fhir-server-search-export

How to configure the export for indirect referenced resources for Patient and Group level export

To define how resources that are not directly referenced by the Patient should be processed for export, navigate to the configuration file at etc/kodjin/<environment>/values/fhir-config/export-additional-included-resources.json.

This configuration section specifies the FHIR resources that should be analyzed during the export process. There are two options for each resource:

  • allowedForGroupExport: Determines if the resource is allowed for Group-level export. The default value is true.
  • allowedForPatientExport: Determines if the resource is allowed for Patient-level export. The default value is false.

Additionally, it is required to specify a FHIRPath expression for the attribute that contains a reference to the resource without a direct Patient reference and the resource type.

For more information about the Bulk Export operation, see the Bulk Data Export page.

Example of the export-additional-included-resources.json file

  {
    "MedicationRequest": [
        {
            "allowedForGroupExport": true,
            "allowedForPatientExport": false,
            "path": "$.medicationReference.reference",
            "resourceTypes": [
                "Medication"
            ]
        }
    ],
    "Encounter": [
        {
            "allowedForGroupExport": true,
            "allowedForPatientExport": false,
            "path": "$.location[*].location.reference",
            "resourceTypes": [
                "Location"
            ]
        },
        {
            "allowedForGroupExport": true,
            "allowedForPatientExport": false,
            "path": "$.serviceProvider.reference",
            "resourceTypes": [
                "Organization"
            ]
        }
    ],
    "CareTeam": [
        {
            "allowedForGroupExport": true,
            "allowedForPatientExport": false,
            "path": "$.participant[*].member.reference",
            "resourceTypes": [
                "Practitioner"
            ]
        }
    ]
  }