Skip to main content

FHIR Bulk Export

Category: Healthcare Standards
Node id: fhir-bulk-export-connector

Export data from a FHIR server using the Bulk Data Access IG ($export). Read-only.

Input ports​

NameTypeRequiredDescription
recordsjsonNoRecords to send when operation=write; ignored by read-only drivers
service_paramsjsonNoParameters for operation=service; merged over the service_params config, so a pipeline can page a sweep by feeding back a cursor

Output ports​

NameTypeRequiredDescription
recordsjsonNoRecords returned by the read operation; the record shape depends on the connector driver
countnumberNoNumber of records read (operation=read)
cursorstringNoContinuation cursor (operation=read)
donebooleanNoWhether reading has finished (operation=read); with paginate, true only when the source's last page was read
pagesnumberNoPages read (operation=read with paginate)
bytesnumberNoJSON-encoded size of the records returned (operation=read with paginate)
truncatedbooleanNoA cap or a source defect stopped the walk before the last page (operation=read with paginate); the records are NOT the complete set
truncated_reasonstringNoWhy the walk stopped early: max_pages, max_items, max_page_bytes, timeout, cursor_repeated or no_cursor
cursor_skipnumberNoRecords at the start of the page cursor fetches that were already returned; skip them when resuming
writtennumberNoNumber of records written (operation=write)
errorsjsonNoPer-record failures (operation=write); inspect before acknowledging completion
service_idstringNoInvoked service identifier (operation=service)
resultjsonNoResult of operation=service; the shape depends on the service (e.g. schema_explorer returns schemas, or a page with next_cursor when limit is set)

Settings​

Basic​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Connectorconnector_idconnector-selectNoUse a saved connector for the connection + credentials. Leave empty to configure inline below.
OperationoperationenumYesread, write, serviceread/write move records; service calls one of the driver's named services (e.g. schema_explorer, table_preview, sql_query).
Serviceservice_idstringNoService to call when operation=service. This driver exposes no services.
Service Parametersservice_paramsjsonNoParameters for the service, as JSON. May also be supplied on the service_params input port.

Connection​

SettingNameTypeRequiredDefaultAllowed valuesDescription
auth_typeauth_typeenumYesnone, bearer, basic, client_credentialsAuthentication method Ignored when connector_id is set.
bearer_tokenbearer_tokensecretNoBearer token (auth_type = bearer) Ignored when connector_id is set.
client_idclient_idstringNoOAuth2 client id (auth_type = client_credentials) Ignored when connector_id is set.
client_secretclient_secretsecretNoOAuth2 client secret (auth_type = client_credentials) Ignored when connector_id is set.
fhir_server_urlfhir_server_urlstringYesFHIR server base URL Ignored when connector_id is set.
passwordpasswordsecretNoPassword (auth_type = basic) Ignored when connector_id is set.
poll_interval_secondspoll_interval_secondsnumberNoPoll interval in seconds (default: 5) Ignored when connector_id is set.
resource_typesresource_typesstringNoComma-separated resource types to export (e.g. Patient,Condition). Leave blank for all Ignored when connector_id is set.
scopescopestringNoOAuth2 scopes, space-separated (auth_type = client_credentials; SMART backend often system/*.read) Ignored when connector_id is set.
sincesincestringNoISO 8601 timestamp — only export resources modified after this date Ignored when connector_id is set.
timeout_minutestimeout_minutesnumberNoMax wait time in minutes (default: 60) Ignored when connector_id is set.
token_urltoken_urlstringNoOAuth2 token endpoint (auth_type = client_credentials) Ignored when connector_id is set.
usernameusernamestringNoUsername (auth_type = basic) Ignored when connector_id is set.

Advanced​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Read Operationread_operationstringNo
Write Operationwrite_operationstringNo
Allow Non-Read-Only Serviceallow_write_servicebooleanNofalseRequired to run a service the driver does not declare read-only. Off by default so a catalogue or discovery step cannot mutate a source system by misconfiguration.
Page SizelimitnumberNoRecords per page for operation=read, where the driver supports it (e.g. S3 list MaxKeys).
CursorcursorstringNoContinuation cursor to start the read from (a previous run's cursor output).
Read All PagespaginatebooleanNofalseoperation=read: follow the source's continuation cursor page after page until the last page, bounded by the caps below. Output truncated is true (with truncated_reason) when a cap stopped the walk first.
Max Pagesmax_pagesnumberNo100min 1; max 10000Hard cap on pages per run when paginate is on.
Max Itemsmax_itemsnumberNo100000min 1; max 1000000Hard cap on records per run when paginate is on.
Max Page Bytesmax_page_bytesnumberNo67108864min 1; max 268435456Hard cap on the JSON-encoded size of the records kept when paginate is on. Not the object-store max_bytes, which caps the size of a downloaded file.
Paging Timeout (s)paging_timeout_secondsnumberNo120min 1; max 3600Overall time budget for the walk; when it runs out the pages read so far are returned as truncated. Keep it below the node timeout.

See Build any workflow for how to put nodes together and Ports, types and data flow for how port types connect.

Something unclear? Send documentation feedback by email.