A flexible client for FHIR servers supporting the SMART on FHIR protocol
Project description
SMART FHIR Client
=================
This is _fhirclient_, a flexible Python client for [FHIR][] servers supporting the [SMART on FHIR][smart] protocol.
The client is compatible with Python 2.7, possibly earlier, and Python 3.
Installation
------------
pip install fhirclient
Documentation
-------------
Technical documentation is available at [docs.smarthealthit.org/client-py/][docs].
#### Flask App
Take a look at [`flask_app.py`][flask_app] to see how you can use the client in a simple (Flask) app.
This app starts a webserver, listening on [_localhost:8000_](http://localhost:8000), and prompts you to login to our sandbox server and select a patient.
It then goes on to retrieve the selected patient's demographics and med prescriptions and lists them in a simple HTML page.
The Flask demo app has separate requirements.
To go about installing needed packages (using _virtualenv_) and running the app you can issue these commands to your shell:
virtualenv -p python3 env
. env/bin/activate
pip install -r requirements_flask_app.txt
python flask_app.py
Building Distribution
---------------------
pip install -r requirements.txt
python setup.py sdist
python setup.py bdist_wheel
### Incrementing the lib version
bumpversion patch
bumpversion minor
bumpversion major
Docs Generation
---------------
Docs are generated with [Doxygen][] and [doxypypy][].
You will need to install doxypypy the old-fashioned way, checking out the repo and issuing `python setup.py install`.
Then you can just run Doxygen, configuration is stored in the `Doxyfile`.
Running Doxygen will put the generated documentation into `docs`, the HTML files into `docs/html`.
Those files make up the content of the `gh-pages` branch.
I usually perform a second checkout of the _gh-pages_ branch and copy the html files over, with:
doxygen
rsync -a docs/html/ ../client-py-web/
[fhir]: http://www.hl7.org/implement/standards/fhir/
[smart]: http://docs.smarthealthit.org
[docs]: https://smart-on-fhir.github.io/client-py
[flask_app]: https://github.com/smart-on-fhir/client-py/blob/master/flask_app.py
[doxygen]: http://www.stack.nl/~dimitri/doxygen
[doxypypy]: https://github.com/Feneric/doxypypy
Credits
=======
“fhirclient” is written and maintained by the SMART Platforms Team / Boston Children's Hospital.
Contributors
------------
The following wonderful people contributed directly or indirectly to this project:
- Josh Mandel <https://github.com/jmandel>
- Nikolai Schwertner <https://github.com/nschwertner>
- Pascal Pfiffner <https://github.com/p2>
Please add yourself here alphabetically when you submit your first pull request.
=================
This is _fhirclient_, a flexible Python client for [FHIR][] servers supporting the [SMART on FHIR][smart] protocol.
The client is compatible with Python 2.7, possibly earlier, and Python 3.
Installation
------------
pip install fhirclient
Documentation
-------------
Technical documentation is available at [docs.smarthealthit.org/client-py/][docs].
#### Flask App
Take a look at [`flask_app.py`][flask_app] to see how you can use the client in a simple (Flask) app.
This app starts a webserver, listening on [_localhost:8000_](http://localhost:8000), and prompts you to login to our sandbox server and select a patient.
It then goes on to retrieve the selected patient's demographics and med prescriptions and lists them in a simple HTML page.
The Flask demo app has separate requirements.
To go about installing needed packages (using _virtualenv_) and running the app you can issue these commands to your shell:
virtualenv -p python3 env
. env/bin/activate
pip install -r requirements_flask_app.txt
python flask_app.py
Building Distribution
---------------------
pip install -r requirements.txt
python setup.py sdist
python setup.py bdist_wheel
### Incrementing the lib version
bumpversion patch
bumpversion minor
bumpversion major
Docs Generation
---------------
Docs are generated with [Doxygen][] and [doxypypy][].
You will need to install doxypypy the old-fashioned way, checking out the repo and issuing `python setup.py install`.
Then you can just run Doxygen, configuration is stored in the `Doxyfile`.
Running Doxygen will put the generated documentation into `docs`, the HTML files into `docs/html`.
Those files make up the content of the `gh-pages` branch.
I usually perform a second checkout of the _gh-pages_ branch and copy the html files over, with:
doxygen
rsync -a docs/html/ ../client-py-web/
[fhir]: http://www.hl7.org/implement/standards/fhir/
[smart]: http://docs.smarthealthit.org
[docs]: https://smart-on-fhir.github.io/client-py
[flask_app]: https://github.com/smart-on-fhir/client-py/blob/master/flask_app.py
[doxygen]: http://www.stack.nl/~dimitri/doxygen
[doxypypy]: https://github.com/Feneric/doxypypy
Credits
=======
“fhirclient” is written and maintained by the SMART Platforms Team / Boston Children's Hospital.
Contributors
------------
The following wonderful people contributed directly or indirectly to this project:
- Josh Mandel <https://github.com/jmandel>
- Nikolai Schwertner <https://github.com/nschwertner>
- Pascal Pfiffner <https://github.com/p2>
Please add yourself here alphabetically when you submit your first pull request.
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
fhirclient-0.5.1.tar.gz
(200.2 kB
view hashes)
Built Distribution
fhirclient-0.5.1-py2.py3-none-any.whl
(330.5 kB
view hashes)
Close
Hashes for fhirclient-0.5.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a37eeae686899ce68e6710b51c1309f26ca9776fa8feab7ef887446ece75b52e |
|
MD5 | 2c0257c5733a5b132ba1023eee71aed3 |
|
BLAKE2b-256 | d52cb4bf524fb094dd0e13e1ba8681b56785a69b8faa4daa744053d48f2c7d3f |