Skip to main content

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.smartplatforms.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.


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.smartplatforms.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


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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fhirclient-0.0.2-py2.py3-none-any.whl (225.4 kB view details)

Uploaded Python 2Python 3

File details

Details for the file fhirclient-0.0.2.tar.gz.

File metadata

  • Download URL: fhirclient-0.0.2.tar.gz
  • Upload date:
  • Size: 164.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for fhirclient-0.0.2.tar.gz
Algorithm Hash digest
SHA256 8f430dd0ed7b3ae0a98212f75aa6b0b91793e90d45f400d0bbb58b1a9d51b60a
MD5 c5a8465f3dd8e24a152b948178033f1e
BLAKE2b-256 55c3c08303c92b57b48bab1f893191a7a3d063605f443e9052af8e491fc81aac

See more details on using hashes here.

File details

Details for the file fhirclient-0.0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for fhirclient-0.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5497916dd9928cb2e3bc5f9efa9fda5e45fe3cf75b36f4e63cc26dd59eb80459
MD5 e62b176b0b0bc9fccc054cb381724e22
BLAKE2b-256 1ee3c7506a7b4b490b2eceee459855972eafcd38e8b13c9c547c1f9419118dda

See more details on using hashes here.

Supported by

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