Skip to main content

Generates synthetic FHIR resources.

Project description

Documentation Status codecov Pipeline

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.2.6.tar.gz (31.3 kB view details)

Uploaded Source

Built Distribution

fhir_kindling-0.2.6-py2.py3-none-any.whl (32.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fhir_kindling-0.2.6.tar.gz.

File metadata

  • Download URL: fhir_kindling-0.2.6.tar.gz
  • Upload date:
  • Size: 31.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for fhir_kindling-0.2.6.tar.gz
Algorithm Hash digest
SHA256 5dc4b3bc65b3fe72ea13b45109f5f9b63f99b8c80fc1c796bccb59e55690d652
MD5 d0bdaf2012012c67cffa9617fec8299a
BLAKE2b-256 8796f3907b103e9b3450f9c01a9b083ac1d55c946713f9f767de83a5bd20cd9c

See more details on using hashes here.

File details

Details for the file fhir_kindling-0.2.6-py2.py3-none-any.whl.

File metadata

  • Download URL: fhir_kindling-0.2.6-py2.py3-none-any.whl
  • Upload date:
  • Size: 32.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for fhir_kindling-0.2.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1c298f0f679509f16f7bdaa1a395d42654855952dd1f44317f1e76d28fc6948e
MD5 d8517aa87a4e393b7d9e8e0cad96fd7b
BLAKE2b-256 1cee1003ac6e9a71f1701a0e6dabf37c4439bdc392d6e460b04546ed7b99964b

See more details on using hashes here.

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