bonFHIR icon

bonFHIR

Perform operations on FHIR resources

Overview

This node enables updating a FHIR (Fast Healthcare Interoperability Resources) resource on a specified FHIR server. It supports various authentication methods and allows users to specify the resource type, resource ID, and the update content in JSON format. The node is useful for healthcare integration scenarios where existing FHIR resources need to be modified or replaced with new data, such as updating patient records, observations, or other clinical information.

Practical examples include:

  • Updating a Patient resource with new contact information.
  • Modifying an Observation resource to correct measurement values.
  • Changing metadata of a CarePlan resource.

The node handles HTTP PUT requests to the FHIR server's REST API endpoint corresponding to the resource and ID provided.

Properties

Name Meaning
Authentication Method used to authenticate with 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 (e.g., http://example.com/fhir). Required.
Resource Type The type of FHIR resource to update (e.g., Patient, Observation). Required.
Custom Resource Type If "Resource Type" is set to "- Custom -", this string specifies the custom resource type name.
ID The ID of the resource to update. Required for Update operation.
Body The JSON body containing the updated resource data. Required for Update operation.
Specify Query Parameters Option 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 A FHIRPath expression to extract specific data from the output. Optional.
Ignore SSL Issues Whether to ignore SSL certificate validation issues when connecting to the FHIR server. Default is false.

Output

The node outputs the response from the FHIR server after performing the update operation. The output is structured as JSON and typically contains the updated resource representation returned by the server. If a FHIRPath expression is specified, the output will be the result of evaluating that expression against the response.

Binary data is not produced by this node.

Dependencies

  • Requires access to a FHIR server with appropriate permissions to update resources.
  • Requires configuration of authentication credentials depending on the chosen authentication method.
  • Uses standard HTTP methods and headers to communicate with the FHIR server.
  • Supports optional SSL certificate validation bypass via the "Ignore SSL Issues" property.

Troubleshooting

  • Common Issues:

    • Incorrect or missing resource ID will cause the update to fail.
    • Malformed JSON in the "Body" property can lead to request errors.
    • Authentication failures due to incorrect credentials or unsupported auth methods.
    • SSL certificate errors if the server uses self-signed or invalid certificates and "Ignore SSL Issues" is not enabled.
    • Server-side validation errors if the resource data does not conform to FHIR specifications.
  • Error Messages:

    • "The operation 'Update' is not supported": Indicates an invalid operation selection.
    • "The search returned more than one result": Occurs if a search operation returns multiple results but the node expects only one.
    • HTTP 4xx or 5xx errors: Indicate client or server errors; check the request details and server logs.
  • Resolutions:

    • Ensure the resource ID and type are correct.
    • Validate JSON syntax before inputting into the "Body" field.
    • Verify authentication credentials and method.
    • Enable "Ignore SSL Issues" if connecting to servers with problematic SSL certificates.
    • Review FHIR server documentation for resource constraints and validation rules.

Links and References

Discussion