FHIR1 input → 1 output

Bulk Export Kickoff

Initiates a FHIR bulk data export for a specified group.

Inputs

payload.groupId string: The FHIR Group ID to export data for (required)
accessToken string: Optional: Provide your own access token. If not provided, backend token will be fetched automatically
_type string: Comma-separated list of resource types to export
_since string: ISO 8601 date to export data modified after

Outputs

payload object: Complete response from bulk export initiation
payload.requestId string: Bulk export request ID for status checking
payload.requestUrl string: Full URL for checking export status
bulkExport object: Bulk export metadata for downstream nodes

Details

This node initiates a FHIR bulk data export operation. The export runs asynchronously and returns a request ID that can be used to check the export status.

The node requires an active integration context. It will automatically fetch a backend access token using the integration's credentials.

Examples

Basic Export Flow:

┌────────┐   ┌─────────────────┐   ┌─────────────────┐   ┌──────────────────┐
│ inject │──▶│ Bulk Export     │──▶│ Bulk Export     │──▶│ Bulk Export      │
│        │   │ Kickoff         │   │ Status          │   │ Retrieve         │
└────────┘   └─────────────────┘   └─────────────────┘   └──────────────────┘

Input Message Example:

msg.payload = {
    groupId: "epic.fhir.group.123"
};
msg._type = "Patient,Encounter,Observation";
msg._since = "2024-01-01T00:00:00Z";

Output Example:

{
    "requestId": "abc123-def456",
    "requestUrl": "/BulkRequest/abc123-def456",
    "status": "accepted"
}

Best Practices

Always specify resource types (_type) to reduce export size
Use _since for incremental exports to reduce data volume
Connect to Status node with auto-polling for large exports
Handle export failures by checking error responses
Consider rate limiting for frequent export operations

┌────────┐ ┌─────────────────┐ ┌─────────────────┐ ┌──────────────────┐ │ inject │──▶│ Bulk Export │──▶│ Bulk Export │──▶│ Bulk Export │ │ │ │ Kickoff │ │ Status │ │ Retrieve │ └────────┘ └─────────────────┘ └─────────────────┘ └──────────────────┘