bonFHIR icon

bonFHIR

Perform operations on FHIR resources

Overview

This node provides integration with a FHIR (Fast Healthcare Interoperability Resources) server, allowing users to perform various operations on FHIR resources. Specifically, the "Delete" operation enables the deletion of a specified FHIR resource by its type and ID.

Common scenarios for this node include:

  • Removing obsolete or incorrect patient records.
  • Deleting outdated clinical documents or observations.
  • Managing lifecycle of healthcare data by removing resources no longer needed.

Practical example:

  • A healthcare workflow that automatically deletes a patient's allergy record when it is marked as resolved or erroneous.

Properties

Name Meaning
Authentication Method of authentication to use when connecting to the FHIR server. Options: Basic Auth, Custom Auth, Digest Auth, Header Auth, None, OAuth1, OAuth2, Query Auth.
Base URL The base URL of the FHIR server API to which requests will be sent.
Resource Type The type of FHIR resource to operate on (e.g., Patient, Observation, MedicationRequest).
Custom Resource Type If "Resource Type" is set to custom, specify the custom resource type string here.
ID The unique identifier of the resource instance to delete.
Patch Parameters (Not applicable for Delete operation) Parameters for patching resources if used in other operations.
Specify Query Parameters How to specify query parameters: either using key-value pairs or JSON.
Query Parameters Key-value pairs for query parameters if "Using Fields Below" is selected.
JSON JSON object for query parameters if "Using JSON" is selected.
FHIR Path Optional FHIRPath expression to extract specific data from the response output.
Ignore SSL Issues Whether to ignore SSL certificate validation errors when connecting to the FHIR server.

Output

The node outputs the JSON response from the FHIR server after performing the delete operation. This typically includes confirmation of deletion or error details if the operation failed.

If the response contains FHIR Bundles (e.g., in search operations), the node extracts individual resources from the bundle entries.

No binary data output is produced by this node.

Dependencies

  • Requires access to a FHIR server endpoint specified by the Base URL.
  • Supports multiple authentication methods; appropriate credentials must be configured in n8n.
  • Uses internal HTTP request utilities with authentication support.
  • Optionally uses FHIRPath evaluation for extracting data from responses.
  • No external npm packages are explicitly required beyond those bundled with n8n.

Troubleshooting

  • Invalid Resource Type or ID: Ensure the resource type and ID are correct and exist on the FHIR server.
  • Authentication Errors: Verify that the chosen authentication method and credentials are valid and have sufficient permissions to delete resources.
  • SSL Certificate Issues: If connecting to servers with self-signed certificates, enable "Ignore SSL Issues" to bypass validation.
  • Multiple Results Error: When searching with "Error if More than One Result" enabled, the node throws an error if more than one resource matches. Adjust search parameters or disable this option.
  • Malformed Query Parameters: When specifying query parameters as JSON, ensure valid JSON syntax.
  • Network or Server Errors: Check network connectivity and FHIR server availability.

Common error messages:

  • "The operation 'Delete' is not supported": Indicates an unsupported operation was requested.
  • "The search returned more than one result": Occurs if the search yields multiple resources but only one is expected.
  • JSON parsing errors for invalid input in body or query parameters.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

Discussion