Overview
The node provides integration with a FHIR (Fast Healthcare Interoperability Resources) server, allowing users to perform various operations on FHIR resources. Specifically, for the "Default" resource and the "History" operation, it retrieves the history of a specified FHIR resource instance by its ID. This is useful in healthcare scenarios where tracking changes or audit trails of patient data or other clinical information is necessary.
Common use cases include:
- Auditing changes to patient records.
- Retrieving version history of clinical documents or observations.
- Compliance and regulatory reporting requiring access to resource change logs.
Example: Fetching the full history of a Patient resource with a given ID to review all modifications over time.
Properties
| Name | Meaning |
|---|---|
| Authentication | The method used to authenticate requests 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 are sent. |
| Resource Type | The type of FHIR resource to operate on (e.g., Patient, Observation, Encounter). |
| Custom Resource Type | If "Resource Type" is set to custom, this string specifies the custom resource type name. |
| ID | The unique identifier of the specific resource instance for operations that require it (e.g., History). |
| Specify Query Parameters | How query parameters are specified: either as key-value pairs or as raw JSON. |
| Query Parameters | Key-value pairs for query parameters when specifying them individually. |
| JSON Query | Raw JSON object representing query parameters if specifying them as JSON. |
| FHIR Path | A FHIRPath expression to extract specific data from the response output. |
| Ignore SSL Issues | Whether to allow connections even if SSL certificate validation fails (useful for self-signed certs). |
For the "Patch" operation (not directly relevant to History but included in properties):
- Specify Patch Body: Choose between key-value pairs or raw JSON for patch content.
- Patch Parameters: Collection of patch operations (add, copy, move, remove, replace, test) with paths and values.
Output
The node outputs an array of items, each containing a json field with the FHIR resource data returned from the server. For the "History" operation, this will be a Bundle resource containing the historical versions of the specified resource.
If a FHIRPath expression is provided, the output is filtered accordingly, returning only the extracted data.
No binary data output is indicated.
Dependencies
- Requires a valid FHIR server accessible via HTTP(S).
- Supports multiple authentication methods; appropriate credentials must be configured in n8n.
- Uses internal utilities for HTTP requests with authentication handling.
- Optional FHIRPath evaluation library is used to filter output based on expressions.
- No external environment variables beyond standard n8n credential configuration are required.
Troubleshooting
- More than one result error: When performing a Search operation with "Error if More than One Result" enabled, if the search returns multiple entries, the node throws an error. To fix, either refine the search query or disable this option.
- Invalid JSON in query or body: If JSON input fields contain invalid JSON, the node will throw a parsing error. Ensure JSON syntax correctness.
- SSL issues: If connecting to a server with self-signed certificates, enable "Ignore SSL Issues" to avoid connection failures.
- Authentication errors: Verify that the selected authentication method matches the server's requirements and that credentials are correctly configured.
- Resource not found: For operations requiring an ID (like History), ensure the resource exists at the specified Base URL and Resource Type.
Links and References
This summary focuses on the "Default" resource and "History" operation as requested, describing the node's capabilities, inputs, outputs, dependencies, and common troubleshooting points.