Skip to main content

FHIR Client

Category: Healthcare Standards
Node id: fhir-client

Standards: HIPAA, GDPR, SOC2

Universal FHIR R4 client supporting search, read, create, update, delete, batch, and capabilities operations with multiple auth types

What it does​

  • Seven FHIR operations: search, read, create, update, delete, batch, capabilities
  • Four auth modes: none, basic, bearer, OAuth2 client credentials
  • Custom HTTP header injection
  • Batch/transaction Bundle support
  • CapabilityStatement discovery via /metadata
  • Configurable search result count

Use cases​

  • Connect to any FHIR R4 server with flexible authentication
  • Discover server capabilities before building pipelines
  • Submit transaction Bundles for bulk data operations
  • Perform CRUD operations across multi-vendor FHIR environments

Runtime​

  • Performance tier: variable
  • Effect: write

Input ports​

NameTypeRequiredDescription
resource_idtextNoResource ID for read/update/delete
resourcejsonNoFHIR resource for create/update
search_paramsjsonNoSearch parameters as key-value pairs
bundlefhir-bundleNoFHIR Bundle for batch operation

Output ports​

NameTypeRequiredDescription
resultjsonNoMain result data from the FHIR operation
statustextNoOperation status
successbooleanNoWhether the operation succeeded

Settings​

Basic​

SettingNameTypeRequiredDefaultAllowed valuesDescription
FHIR Server URLfhir_urlstringYesBase URL of the FHIR server
OperationoperationenumNosearchsearch, read, create, update, delete, batch, capabilitiesFHIR operation to perform
Resource Typeresource_typestringNoPatientFHIR resource type

Auth​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Auth Typeauth_typeenumNononenone, basic, bearer, oauth2Authentication method
UsernameusernamestringNoUsername for basic auth
PasswordpasswordsecretNoPassword for basic auth
Bearer TokentokensecretNoToken for bearer auth
Client IDclient_idsecretNoClient ID for OAuth2
Client Secretclient_secretsecretNoClient secret for OAuth2
Token URLtoken_urlstringNoOAuth2 token endpoint URL

Advanced​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Resource IDresource_idstringNoResource ID for read/delete
Search Parameterssearch_paramsjsonNoDefault search parameters
CountcountnumberNoNumber of results to return
Custom HeadersheadersjsonNoAdditional HTTP headers

Errors​

CodeDescription
FHIR_URL_REQUIREDfhir_url configuration is missing
AUTH_FAILEDAuthentication credentials are invalid or missing
OAUTH2_TOKEN_FAILEDFailed to obtain OAuth2 access token
UNSUPPORTED_OPERATIONThe requested FHIR operation is not supported

Runtime notes​

  • Output 'result' shape varies by operation: search has bundle/total/entry_count, read has resource/resource_id, create returns the created resource, delete has resource_type/resource_id only
  • Output 'status' is a string (success/created/updated/deleted/completed) — distinct from the boolean 'success'
  • Search params from inputs merge with config search_params; config 'count' sets _count on the FHIR search
  • OAuth2 auth uses client_credentials flow — token is fetched fresh on each execution

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.