Generates synthetic FHIR resources.
Project description
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file fhir_kindling-0.3.0.tar.gz
.
File metadata
- Download URL: fhir_kindling-0.3.0.tar.gz
- Upload date:
- Size: 34.9 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
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd5a9de7648fea93bd34d2bd46832627e91bf65b013048bdc8023634016cd405 |
|
MD5 | 99102d3fdf205237a0cbc728771e074a |
|
BLAKE2b-256 | 86d66c683221022cebd0ff909915ee22b6487c6228cab368aabc80598adb7006 |
File details
Details for the file fhir_kindling-0.3.0-py2.py3-none-any.whl
.
File metadata
- Download URL: fhir_kindling-0.3.0-py2.py3-none-any.whl
- Upload date:
- Size: 41.0 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
Algorithm | Hash digest | |
---|---|---|
SHA256 | da6c50aee1a1b3a57711ded535775d77f1bc4ca36faca61cd0ba8da8ae272cb2 |
|
MD5 | 5b7b461b7adc58311ce555b39740f15a |
|
BLAKE2b-256 | ea588e973f59f02a35151708e4f53481a7391eae6f4e835b81631ea9d2ccf597 |