Saltar al contenido principal

FHIR Query

Category: Healthcare Standards
Node id: fhir-query

Standards: HIPAA, GDPR, SOC2

Queries FHIR R4 resources from any FHIR-compliant server with search parameter support

What it does​

  • FHIR R4 search with configurable parameters
  • Bearer token authentication
  • Custom HTTP header injection
  • Search parameter merging from inputs and config
  • Bundle pagination support

Use cases​

  • Query patient demographics from a FHIR server
  • Search clinical observations by date range or code
  • Retrieve medication lists for a patient cohort
  • Feed FHIR resources into downstream transformation nodes

Runtime​

  • Performance tier: variable
  • Effect: read

Input ports​

NameTypeRequiredDescription
paramsjsonNoSearch parameters as key-value pairs

Output ports​

NameTypeRequiredDescription
resultjsonNoQuery result (bundle, bundle_json, resource_type, resource_count, total)
successbooleanNoWhether the query succeeded

Settings​

Basic​

SettingNameTypeRequiredDefaultAllowed valuesDescription
FHIR Server URLfhir_urlstringYesBase URL of the FHIR server
Resource Typeresource_typestringYesPatientFHIR resource type to query

Auth​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Auth Tokenauth_tokensecretNoBearer token for FHIR server authentication

Advanced​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Custom HeadersheadersjsonNoAdditional HTTP headers as key-value pairs
Search ParametersparamsjsonNoDefault search parameters from config
Timeout (seconds)timeout_secondsnumberNo120HTTP request timeout in seconds (default: 120)

Errors​

CodeDescription
FHIR_URL_REQUIREDfhir_url configuration is missing
FHIR_SEARCH_FAILEDFHIR server returned an error during search
BUNDLE_MARSHAL_FAILEDFailed to serialize the returned FHIR Bundle

Runtime notes​

  • Output result.bundle is a full FHIR Bundle object; individual resources are in result.bundle.entry[].resource.
  • result.bundle_json is a pre-serialized JSON string of the bundle — use it when downstream nodes expect text, not an object.
  • Input params merge with config params; input params take precedence on key conflicts.
  • result.resource_count is the number of entries returned in this page, while result.total is the server-reported total across all pages.

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

¿Algo no está claro? Envíe sus comentarios sobre la documentación por correo electrónico..