FHIR1 input → 1 output

Bulk Export Retrieve

Downloads FHIR bulk export files and formats them for S3 upload.

Inputs

payload.output array: Array of export output files from Status node (required)
accessToken string: Optional: Provide your own access token. If not provided, backend token will be fetched automatically
bucket string: S3 bucket name for compatibility

Outputs (Single Mode)

bucket string: S3 bucket name
filename string: File name
localFilename string: Full path to temporary file
payload string|null: File content (if includeContent is enabled)
contentType string: MIME type (application/ndjson)

Outputs (Batch Mode)

payload.files array: Array of all retrieved files
payload.summary object: Summary of retrieval operation

Details

This node downloads FHIR bulk export files to a temporary directory and formats the output to be compatible with S3 upload nodes.

Files are stored in /tmp/temp-export/ by default and are automatically cleaned up after 1 hour.

In single mode, the node outputs one message per file, perfect for direct connection to an S3 upload node. In batch mode, all files are included in a single message.

Examples

S3 Upload Flow (Single Mode):

┌─────────────────┐   ┌──────────────────┐   ┌──────────┐
│ Bulk Export     │──▶│ Bulk Export      │──▶│ S3 PUT   │
│ Status          │   │ Retrieve (single)│   │          │
└─────────────────┘   └──────────────────┘   └──────────┘

Single Mode Output:

{
    "bucket": "my-fhir-exports",
    "filename": "Patient_20240101.ndjson",
    "localFilename": "/tmp/temp-export/Patient_20240101.ndjson",
    "contentType": "application/ndjson"
}

Batch Mode Output:

{
    "files": [
        {"type": "Patient", "localFilename": "/tmp/.../Patient.ndjson"},
        {"type": "Encounter", "localFilename": "/tmp/.../Encounter.ndjson"}
    ],
    "summary": {
        "totalFiles": 2,
        "totalBytes": 1048576
    }
}

Best Practices

Use single mode when connecting directly to S3 upload node
Use batch mode when processing all files together
Filter by resource type to reduce download volume
Disable includeContent for very large files
Ensure adequate disk space in temp directory
Implement error handling for network failures

┌─────────────────┐ ┌──────────────────┐ ┌──────────┐ │ Bulk Export │──▶│ Bulk Export │──▶│ S3 PUT │ │ Status │ │ Retrieve (single)│ │ │ └─────────────────┘ └──────────────────┘ └──────────┘

{ "files": [ {"type": "Patient", "localFilename": "/tmp/.../Patient.ndjson"}, {"type": "Encounter", "localFilename": "/tmp/.../Encounter.ndjson"} ], "summary": { "totalFiles": 2, "totalBytes": 1048576 } }