Skip to content

BBMRI-cz/fhir-module

Repository files navigation

FHIR module

CI build codecov Python 3.11 Linter: pylint

The BBMRI-ERIC FHIR module is a container based application connecting biobanks to other IT tools and services in our ecosystem on a local level.

Goal

The goal of this project is to create a highly customizable data integration tool for biobanks that are a part of BBMRI-ERIC. This tool should support ETL processes by providing the following functionality:

  • Data harmonization to HL7 FHIR (under development)
  • Data quality validation (coming soon)
  • Reporting and monitoring (coming soon)

State

Supports syncing of patients between a Blaze FHIR store and a repository of XML or CSV files stored on a regular filesystem. Currently, the XML files must have the same structure as this test file. This module cannot work with different types of files at the same time, so the records needs to be in either XML or CSV format, not both.

Quick Start

Docker

Prerequisites:

To spin up an instance of the FHIR module along with Blaze, clone the repository and run the following command:

docker compose --profile dev up -d

For additional information about deployment, refer to the Deployment documentation.

Contributing

Because the FHIR module is an open source software pull requests are of course welcome! For further information, please read our contributing guidelines!

Found a security vulnerability? Please refer to our security policy.

For instructions on how to set up the development environment, refer to the corresponding chapter.

License

Copyright 2023 BBMRI community.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an " AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.