Skip to content

Commit

Permalink
updated fhir docs (#609)
Browse files Browse the repository at this point in the history
* updated fhir docs

* fix header

* update standards page
  • Loading branch information
aleksa-krolls authored Dec 1, 2024
1 parent a62f9d2 commit ec216a9
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 8 deletions.
15 changes: 15 additions & 0 deletions adaptors/fhir-fr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: FHIR-FR IG Adaptor
---

## Custom FHIR Adaptor: fhir-fr
Note❗: This is a custom adaptor generated from this France FHIR Implementation Guide: https://hl7.fr/ig/fhir/core/2.0.0/index.html

Custom FHIR adaptors generate a suite of helper functions specific to their source Implementation Guides.

See the generic [fhir adaptor](/adaptors/fhir) and our [docs on standards](/documentation/get-started/standards) for more general guidance on OpenFn + FHIR.

## Build your own FHIR Adaptor
See the [Adaptors Wiki](https://github.com/OpenFn/adaptors/wiki/Generating-Fhir-Adaptors) to build your own adaptor for _your_ implementation guide by trying out our fhir-adaptor-generator (which is a new tool still in testing).

Please share any questions or feedback on [community.openfn.org](https://community.openfn.org).
15 changes: 15 additions & 0 deletions adaptors/fhir-ndr-et.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: FHIR-NDR-ET IG Adaptor
---

## Custom FHIR Adaptor: fhir-ndr-et
Note❗: This is a custom adaptor generated from this Implementation Guide `Ethiopia FHIR Implementation Guide - HIV Treatment & Care Services` authored by Jembi Health Systems: https://build.fhir.org/ig/jembi/ethiopia-hiv/branches/master/index.html

Custom FHIR adaptors generate a suite of helper functions specific to their source Implementation Guides.

See the generic [fhir adaptor](/adaptors/fhir) and our [docs on standards](/documentation/get-started/standards) for more general guidance on OpenFn + FHIR.

## Build your own FHIR Adaptor
See the [Adaptors Wiki](https://github.com/OpenFn/adaptors/wiki/Generating-Fhir-Adaptors) to build your own adaptor for _your_ implementation guide by trying out our fhir-adaptor-generator (which is a new tool still in testing).

Please share any questions or feedback on [community.openfn.org](https://community.openfn.org).
16 changes: 11 additions & 5 deletions adaptors/fhir.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,12 @@ title: FHIR Adaptor

[FHIR](https://www.hl7.org/fhir/overview.html) stands for Fast Healthcare Interoperability Resources. It is a standard for representing and exchanging healthcare data electronically.

::: info New adaptor coming soon!

FHIR version-specific adaptors (e.g., `fhir-r4`) with enhanced functionality are coming soon to fast-track integration setup with more helper functions, templates, and docs than this simple adaptor. See the [Adaptors Wiki](https://github.com/OpenFn/adaptors/wiki/Generating-Fhir-Adaptors) for how to build an adaptor specific to your FHIR Implementation Guide.
:::tip About this adaptor and features coming soon!

This adaptor is very basic and generic, used mostly to integrate demo FHIR servers. It's a work-in-progress, so share questions and feedback on [community.openfn.org](https://community.openfn.org).

**FHIR version-specific adaptors (e.g., `fhir-r4`) with enhanced functionality are coming soon** to fast-track integration setup with more helper functions, templates, and docs than this simple adaptor. See the [Adaptors Wiki](https://github.com/OpenFn/adaptors/wiki/Generating-Fhir-Adaptors) for how to build an adaptor specific to your FHIR Implementation Guide.

:::

Expand All @@ -28,15 +31,18 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag

```
{
"baseUrl": "https://hapi.fhir.org",
"apiPath": "baseR4"
"baseUrl": "https://hapi.fhir.org", //fhir endpoint
"apiPath": "baseR4" //fhir version
}
```

### Helpful Links

1. [API documentation](https://www.hl7.org/fhir/http.html)
2. [Digital Square on FHIR](https://digitalsquare.org/resourcesrepository/digital-square-on-fhir-4c78p)
3. [Basic guide to interacting with FHIR Server](https://smilecdr.com/docs/fhir_standard/fhir_introduction.html)
4. [Creating your first FHIR resource](https://medblocks.com/blog/fhir-101-creating-your-first-patient-resource-like-a-pro)
5. Google's [Open Health Stack](https://developers.google.com/open-health-stack) tooling for working with FHIR


Have resources or links to share? Submit a PR to edit this page or post on [community.openfn.org](https://community.openfn.org).

14 changes: 11 additions & 3 deletions docs/get-started/standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,21 +147,29 @@ OpenFn solutions are:

OpenFn is used by health organizations to connect multiple FHIR- and non-FHIR compliant systems in a secure, stable, and scalable manner. OpenFn can facilitate 2 categories of FHIR workflows:

### 1. Non-FHIR to FHIR
### 1. Non-FHIR to FHIR Data Exchange

OpenFn users can configure Workflows to convert non-FHIR data to FHIR-compliant formats, and then route to FHIR systems.
OpenFn users can configure workflows to convert non-FHIR data to FHIR-compliant formats, and then route to FHIR systems.

For example, get data from CommCare mobile app, convert to FHIR, and send to national health system's FHIR store.
![nonFHIR Workflow](/img/workflow_nonfhir_fhir.png)

### 2.FHIR to FHIR
### 2. FHIR to FHIR Data Exchange

OpenFn users can also configure Workflows to automate the exchange and routing of _already_ FHIR-compliant data to other FHIR-compliant systems.

For example, get data from OpenMRS's FHIR API, and forward to the national health system's FHIR store (no data transformation needed).

![FHIR Workflow](/img/workflow_fhir_fhir.png)

## FHIR Adaptors
OpenFn [adaptors](/adaptors) aim to fast-track integration setup with target applications (including FHIR endpoints!). The core team is currently working on a suite of FHIR-specific adaptors to enable interoperability with FHIR systems.

- See [existing adaptors](/adaptors/fhir)
- See [Adaptors Wiki](https://github.com/OpenFn/adaptors/wiki/Generating-Fhir-Adaptors) for how to build your own FHIR adpator specific to your target FHIR Implementation Guide

Version-specific adaptors (fhir-r4, fhir-r5) are coming soon!

## Other Data Standards

OpenFn Workflows can automate data transformation, cleaning, and formatting rules to ensure compliance with _your_ organization's specific standards.
Expand Down

0 comments on commit ec216a9

Please sign in to comment.