/android-fhir

The Android FHIR SDK is a Kotlin library for building offline-capable, mobile-first healthcare applications using FHIR resources on Android.

Primary LanguageKotlinOtherNOASSERTION

Android FHIR SDK (Pre-beta release) master codecov

The Android FHIR SDK (the SDK) is an Android library for building offline-capable, mobile-first healthcare applications using FHIR resources on Android. The overall goal is to simplify the process of incorporating support for FHIR into new or existing mobile solutions and to accelerate the adoption of FHIR standards as part of broader interoperability efforts in healthcare.

Usage

The SDK is designed to support Android 21 (lollipop) and above. Android Studio 4.0 is required for Java 8 library desugaring.

Libraries

The repository is organised into the following libraries:

Library Status Notes
Data Capture Library Stable Approaching beta release
FHIR Engine Mostly stable Finalizing sync API subject to change. Other APIs stable
Workflow Library In development Pending alpha release

FHIR engine library Google Maven

This is the main library for building a mobile based clinical data repository using FHIR. It provides:

  • SQLite database for FHIR resources
  • APIs for accessing (create, read, update, and delete) FHIR resources in the database
  • APIs for searching FHIR resources in the database
  • Sync API for synchronization of resources with a FHIR server

To use this library in your Android application, see FHIR Engine Library User's Guide.

Structured data capture (SDC) library Google Maven

This library is a partial implementation of the Structured Data Capture FHIR IG on Android. It includes the UI components and APIs to capture healthcare data using FHIR questionnaires.

To use this library in your Android application, see Structured Data Capture Library User's Guide.

Workflow library

This library provides APIs that use digital clinical guidelines to support decision making and analytics in clinical workflows.

It supports the following operations:

Operation Status Notes
Measure/$evaluate-measure Alpha See https://www.hl7.org/fhir/measure-operation-evaluate-measure.html
PlanDefinition/$apply In development See https://www.hl7.org/fhir/plandefinition-operation-apply.html

Future features of the library will provide support for Tasking and other Workflow related requirements

Sample Applications

Two sample applications are provided that demonstrate different features of the SDK.

These applications are provided for demonstration purposes only and are not for use in production. Do NOT use in production.

Reference Application

This is the initial demo application for showcasing core SDK features and CQL proof of concept. The demo uses synthea generated data that has been loaded into the HAPI FHIR server public demo site.

To run this application, clone the codebase and run the reference module.

SDC Gallery App

This app includes a number of pre-loaded sample FHIR Questionnaires.

It uses the SDC library to create data capture forms using FHIR questionnaires. For supported widgets, features and known bugs, see the latest release notes.

To run this application, clone the codebase and run the datacapturegallery module.

Contributing

The SDK is being developed by a consortium of application developers. We welcome contributions. Please see How to Contribute and Developer's Guide for more information.

Feedback

If you want to provide any feedback, discuss use cases, raise feature requests, or simply want to get involved, please use the Discussions section, or email us at android-fhir-sdk-feedback@google.com.

Disclaimer

This is not an officially supported Google product.

This product is not intended to be a medical device.