Skip to main content

Generates synthetic FHIR resources.

Project description

codecov Pipeline PyPI version

FHIR Kindling

Synthetic FHIR resource generator and FHIR server data management tool. Documentation

Features

  • CLI for step by step data set/FHIR resource creation
  • Bundle creation, validation and data management on a FHIR server via the REST API
  • Supports Hapi, Blaze and IBM FHIR servers

Installation

In a virtual environment clone the project and install it using pip:

cd fhir_kindling
pip install .

The fhir_kindling command should now be available in your shell (with the venv activated) test it with fhir_kindling --help

Usage

With the virtual environment activated you can use the CLI directly in the terminal directly

CLI - Uploading a bundle to a server

fhir_kindling upload <path-to-bundle.json> --url <base-url-fhir-api> -u <username> -p <password> --token <token>

CLI - Querying a server

For an overview of the options of the CLI query command

fhir_kindling query --help

Examples

To query all instances of a resource use the -r option. This command queries all Patients from the server and stores the results as csv into the query_results.json file.

fhir_kindling query -r Patient --url <base-url-fhir-api> -u <username> -p <password> --token <token> -f "query_results.csv" -o csv

This example uses the -q option to execute a predefined url query string against the server and also stores the output as csv in a file called query_results.csv

fhir_kindling query -q "/MolecularSequence?patient.organization.name=DEMO_HIV&_format=json" --url <base-url-fhir-api> -u <username> -p <password> --token <token> -f "query_results.csv" -o csv

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[0.1.0] - 2021-08-24

Initial cli

Added

Changed

Fixed

Hashing order guarantees the right index of the query.json file in the hash

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fhir_kindling-0.3.0.tar.gz (34.9 kB view hashes)

Uploaded Source

Built Distribution

fhir_kindling-0.3.0-py2.py3-none-any.whl (41.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page