From ec216a92fc067934259a11ec6be606f856d89b37 Mon Sep 17 00:00:00 2001 From: Aleksa Krolls Date: Sun, 1 Dec 2024 13:02:22 +0300 Subject: [PATCH] updated fhir docs (#609) * updated fhir docs * fix header * update standards page --- adaptors/fhir-fr.md | 15 +++++++++++++++ adaptors/fhir-ndr-et.md | 15 +++++++++++++++ adaptors/fhir.md | 16 +++++++++++----- docs/get-started/standards.md | 14 +++++++++++--- 4 files changed, 52 insertions(+), 8 deletions(-) create mode 100644 adaptors/fhir-fr.md create mode 100644 adaptors/fhir-ndr-et.md diff --git a/adaptors/fhir-fr.md b/adaptors/fhir-fr.md new file mode 100644 index 000000000000..38ac51106d25 --- /dev/null +++ b/adaptors/fhir-fr.md @@ -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). \ No newline at end of file diff --git a/adaptors/fhir-ndr-et.md b/adaptors/fhir-ndr-et.md new file mode 100644 index 000000000000..2a42c6a3ab2e --- /dev/null +++ b/adaptors/fhir-ndr-et.md @@ -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). \ No newline at end of file diff --git a/adaptors/fhir.md b/adaptors/fhir.md index 4d656cee1e93..91d22834dcb9 100644 --- a/adaptors/fhir.md +++ b/adaptors/fhir.md @@ -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. ::: @@ -28,8 +31,8 @@ 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 } ``` @@ -37,6 +40,9 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag 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). diff --git a/docs/get-started/standards.md b/docs/get-started/standards.md index 9972963b4212..bdac96dc0c0c 100644 --- a/docs/get-started/standards.md +++ b/docs/get-started/standards.md @@ -147,14 +147,14 @@ 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. @@ -162,6 +162,14 @@ For example, get data from OpenMRS's FHIR API, and forward to the national healt ![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.