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
| Name | Type | Required | Description |
|---|---|---|---|
resource_id | text | No | Resource ID for read/update/delete |
resource | json | No | FHIR resource for create/update |
search_params | json | No | Search parameters as key-value pairs |
bundle | fhir-bundle | No | FHIR Bundle for batch operation |
Output ports
| Name | Type | Required | Description |
|---|---|---|---|
result | json | No | Main result data from the FHIR operation |
status | text | No | Operation status |
success | boolean | No | Whether the operation succeeded |
Settings
Basic
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| FHIR Server URL | fhir_url | string | Yes | Base URL of the FHIR server | ||
| Operation | operation | enum | No | search | search, read, create, update, delete, batch, capabilities | FHIR operation to perform |
| Resource Type | resource_type | string | No | Patient | FHIR resource type |
Auth
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| Auth Type | auth_type | enum | No | none | none, basic, bearer, oauth2 | Authentication method |
| Username | username | string | No | Username for basic auth | ||
| Password | password | secret | No | Password for basic auth | ||
| Bearer Token | token | secret | No | Token for bearer auth | ||
| Client ID | client_id | secret | No | Client ID for OAuth2 | ||
| Client Secret | client_secret | secret | No | Client secret for OAuth2 | ||
| Token URL | token_url | string | No | OAuth2 token endpoint URL |
Advanced
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| Resource ID | resource_id | string | No | Resource ID for read/delete | ||
| Search Parameters | search_params | json | No | Default search parameters | ||
| Count | count | number | No | Number of results to return | ||
| Custom Headers | headers | json | No | Additional HTTP headers |
Errors
| Code | Description |
|---|---|
FHIR_URL_REQUIRED | fhir_url configuration is missing |
AUTH_FAILED | Authentication credentials are invalid or missing |
OAUTH2_TOKEN_FAILED | Failed to obtain OAuth2 access token |
UNSUPPORTED_OPERATION | The 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.
Etwas unklar? Senden Sie Feedback zur Dokumentation per E-Mail..