Skip to main content

FHIR CRUD

Category: Healthcare Standards
Node id: fhir-crud

Standards: HIPAA, GDPR, SOC2

Performs Search, Read, Create, Update, Delete, and Transaction operations on FHIR R4 resources

What it does​

  • FHIR R4 Search, Read, Create, Update, and Delete operations
  • Resource input as JSON object or JSON string
  • Auto-detection of resourceType from resource data
  • Bearer token authentication
  • Custom HTTP header injection

Use cases​

  • Create new patient records in a FHIR server
  • Update clinical observations after data enrichment
  • Delete test or duplicate resources during data cleanup
  • Upsert FHIR resources in an ETL pipeline

Runtime​

  • Performance tier: variable
  • Effect: write

Input ports​

NameTypeRequiredDescription
resourcejsonNoFHIR resource object
resource_jsontextNoFHIR resource as JSON string
resource_idtextNoResource ID (for update/delete)
bundlefhir-bundleNoTransaction/batch Bundle to POST (for operation=transaction); a map or JSON string

Output ports​

NameTypeRequiredDescription
resultjsonNoCRUD result (resource, resource_json, resource_type, resource_id, operation, deleted)
successbooleanNoWhether the operation succeeded

Settings​

Basic​

SettingNameTypeRequiredDefaultAllowed valuesDescription
FHIR Server URLfhir_urlstringYesBase URL of the FHIR server
OperationoperationenumNosearchsearch, read, create, update, delete, transactionFHIR operation to perform
Search Parameterssearch_paramsjsonNoKey-value pairs for FHIR search (e.g. {"name": "Smith", "birthdate": "1990-01-01"})
Resource Typeresource_typestringNoFHIR resource type
Resource IDresource_idstringNoResource ID for update/delete

Auth​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Auth Tokenauth_tokensecretNoBearer token for FHIR server authentication

Advanced​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Custom HeadersheadersjsonNoAdditional HTTP headers

Errors​

CodeDescription
FHIR_URL_REQUIREDfhir_url configuration is missing
FHIR_CREATE_FAILEDFHIR server rejected the create operation
FHIR_UPDATE_FAILEDFHIR server rejected the update operation
FHIR_DELETE_FAILEDFHIR server rejected the delete operation
RESOURCE_REQUIREDResource input is missing for create/update

Runtime notes​

  • Output shape varies by operation: search returns resources[] array + bundle; read/create/update return a single resource; delete returns {deleted:true} with no resource.
  • For search, result contains resources (array of extracted entries), bundle (raw), total, count, resource_type, and operation.
  • Either resource (object) or resource_json (string) input is accepted — you do not need both. resource takes priority.
  • resource_id can come from the input port OR config; input port overrides config when both are set.
  • For operation=transaction, provide a transaction/batch Bundle via the 'bundle' input; the server resolves intra-bundle references and returns a response Bundle in result.bundle.

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.