Blue Button Sample Client Application - Django Version
This client demonstrates authenticating to the Blue Buttom API and subsequent FHIR API calls.
It demonstrates the OAuth2 Server Side web application flow where a
client_secret is used.
This client has been upgraded to Django 1.11.22.
Status and Contributing
The application is in active development so check back often for updates. Please consider improving this code with your contributions. Pull requests welcome ;)
git clone https://github.com/cmsgov/bluebutton-sample-client-django.git cd django_blubutton_client/bbc
While not required, using
virtualenv is a good idea.
The following commands work for Python 3+. Please search
to fine eqivilent commands to install and setup
virtualenv for Python 2.7.
python -m venv env source env/bin/activate
The following command assumes a
virtualenv was created and activated.
If you aren't using
virtualenv, then you may need to put
front of the following
pip install --upgrade pip pip install -r requirements/requirements.txt cp bbc/settings/local_sample.py bbc/settings/local.py python manage.py migrate --settings bbc.settings.local python manage.py createsuperuser --settings bbc.settings.local
Configuring Your Development Application
By default, your application will be set up to use the public OAuth service at https://sandbox.bluebutton.cms.gov/. In order to use this version of the service, you'll need to request an account on that site. So select Account -> "Request an Invite," fill out the form, setting user type to "Developer," and we'll get back to you as soon as possible.
Once you have your developer account created and you've verified your email address, you'll need to set up an application. Log in to your new account, and select "Applications" -> "Applications You Created" -> "Register New Application". From here, you can fill out the form with the following options:
Scope: [you likely want to select all available] Name: [your choice] Client type: Confidential Authorization grant type: Authorization Code Redirect uris: http://localhost:8000/social-auth/complete/oauth2io/
Once you submit the form, you should receive an application key and secret that can be be added to the bbc/settings/local.py file you created above, overwriting the values for:
Finally, you're ready to execute
python manage.py runserver --settings bbc.settings.local --insecure
And from here, you can navigate to http://localhost:8000 and test your application.
OAUTH2IO_HOST- the default is
EXTERNAL_AUTH_NAME- the default is
If you change the
OAUTH2IO_HOST to something non https (for testing), then you need to
tell the oauthlib to operate in an insecure mode like so.
import os os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1'
Running the Tests
To run the tests against https://sandbox.bluebutton.cms.gov use:
python manage.py test --settings=bbc.settings.test
To run the tests against a local OAuth2/FHIR server instance (http://localhost:8000) use:
python manage.py test --settings=bbc.settings.test_local