Skip to content

Commit

Permalink
Update fhir.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aleksa-krolls authored Nov 29, 2024
1 parent 13a741e commit 724ddaf
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions adaptors/fhir.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ FHIR version-specific adaptors (e.g., `fhir-r4`) with enhanced functionality are

## Integration Options

**1. Rest API:** The FHIR specification includes a REST API that enables external services like OpenFn to pull data from the FHIR server, or push data from external apps to FHIR servers. This option is suited for scheduled, bulk syncs or workflows that must update data with external information. See [functions](https://docs.openfn.org/adaptors/packages/fhir-docs) for more on how to use this adaptor to work with the API.
**1. Rest API:** The FHIR specification includes a REST API that enables external services like OpenFn to pull data from the FHIR server, or push data from external apps to FHIR servers. This option is suited for scheduled, bulk syncs or workflows that must update data with external information. See [functions](/adaptors/packages/fhir-docs) for more on how to use this adaptor to work with the API.

**2. Webhook:** The FHIR specification does not inherently define a webhook or data-forwarding mechanism. However, many FHIR implementations and platforms offer extensions or configurations that support similar functionality. This option is suited for real-time, event-based data integration. Check out the FHIR `Subscription` resource [documentation](https://build.fhir.org/subscription-definitions.html) to learn more about one way this might be implemented.

## Authentication

The FHIR standard does not directly prescribe authentication and authorization methods. Instead, it provides security guidelines and leaves the choice of implementation to the developers of FHIR servers and clients. See the FHIR [docs](https://www.hl7.org/fhir/security.html) for the latest security-related recommendations. Depending on the FHIR systems being integrated via OpenFn, you might employ a Basic Auth, API key, or OAuth authentication scheme.

See this adaptor's [Configuration docs](https://docs.openfn.org/adaptors/packages/fhir-configuration-schema) for more on the required authentication parameters.
See this adaptor's [Configuration docs](/adaptors/packages/fhir-configuration-schema) for more on the required authentication parameters.

See platform docs on [managing credentials](https://github.com/OpenFn/docs/blob/main/documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this to define your target endpoint and FHIR version:
See platform docs on [managing credentials](/documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this to define your target endpoint and FHIR version:

```
{
Expand Down

0 comments on commit 724ddaf

Please sign in to comment.