fhirstore
Python library to manipulate fhir resources leveraging mongoDB as storage layer.
Installation
pip install fhirstore
Usage
from pymongo import MongoClient
from fhirstore import FHIRStore
client = MongoClient()
store = FHIRStore(client, "<my_database>")
# Dropping collections
store.reset()
# Parse json schema and create collections
store.bootstrap(depth=5)
# OR
# Get existing collections from the database
store.resume(depth=5)
# Create resources
store.create({
"resourceType": "Patient",
"id": "pat1",
"gender": "male"
})
# Read resources
patient = store.read("Patient", "pat1")
# Update resources
updated_patient = store.update("Patient", "pat1", {"gender": "other"})
# Delete resources
deleted_patients_count = store.delete("Patient", "pat1")
deleted_patients_count = store.delete("Patient", resource_id="pyrogResouceId")
Bootstrap the database
- Start the database
- Drop and re-create all collections based on the provided schema
docker-compose up -d
python main.py
Development setup
- Create a virtual environment and enter it
- Install python dependncies
virtualenv .
. ./bin/activate
pip install -r requirements.txt
pip install -r requirements-dev.txt
Test
Test can be run using :
python -m pytest
Make sure dev dependencies are installed.
Benchmark
A benchmark based on example FHIR resources publicly available at can be run using :
python benchmark/benchmark.py
Note that you will need to have a MongoDB up in order for the benchmark to run. You can use the docker-compose file of this repository by running docker-compose up before launching the benchmark.
On a machine with 16GB RAM and an i7 (2.5GHz) processor, the results of the benchamrk were:
--- WRITES ---
insertions per second (on average): 267.17
average: 3.74 milliseconds
median: 1.66 milliseconds
min: 1.07 milliseconds
max: 724.65 milliseconds
spread: 0.00028004697751347234
--- READS ---
reads per second (on average): 378.93
average: 2.63 milliseconds
median: 1.50 milliseconds
min: 0.88 milliseconds
max: 481.18 milliseconds
spread: 0.0002154728657872756
On the same machine, here are the results for the same benchmark using a different library, fhirbase. The latter relies on postgreSQL rather than MongoDB as its storage layer. Also, it only supports FHIR resources 3.3.0 and below.
--- WRITES ---
insertions per second (on average): 152.38
average: 6.56 milliseconds
median: 4.43 milliseconds
min: 3.08 milliseconds
max: 158.88 milliseconds
spread: 7.568139030481407e-05
--- READS ---
reads per second (on average): 261.07
average: 3.83 milliseconds
median: 3.03 milliseconds
min: 2.17 milliseconds
max: 102.06 milliseconds
spread: 1.4565324857334904e-05
Publish
First, you need to have twine installedd
pip install --user --upgrade twine
Make sure you have bumped the version number in setup.py, then run the following:
python setup.py sdist bdist_wheel
python -m twine upload dist/*
1 maintainer
Metadata
1 maintainer
Release files for fhirstore 0.4.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| fhirstore-0.4.8.tar.gz | 309.2 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fhirstore-0.4.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 621.5 kB
Release files / fhirstore-0.4.8.tar.gz
| Download URL | fhirstore-0.4.8.tar.gz |
|---|---|
| Size | 309.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2b43462e6a4d65e0690ba63ac44479e63bd3be9dff97aa2641568a53044ea0b1
|
|
BLAKE2b-256 checksum How to use checksums |
72f3bc5ebb52c1f6851c80469349d49adb3a942048e08f51a11a0c50c944f31c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/42.0.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.9
|
Release files / fhirstore-0.4.8-py3-none-any.whl
| Download URL | fhirstore-0.4.8-py3-none-any.whl |
|---|---|
| Size | 312.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c3c6f67f043f080f8a6c5d24d958199bb1a4e08f13568c2efa4d35ab2b971f87
|
|
BLAKE2b-256 checksum How to use checksums |
5f3d34e7c22d8076207170f69a136feb1dba69901d75f713f22a790c3cb20164
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/42.0.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.9
|
Security for fhirstore 0.4.8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
