Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Jupyter SMART on FHIR

Prototype extensions for loading credentials in Jupyter contexts via SMART on FHIR.

This package contains two implementations:

  • server_extension: a Jupyter server extension that acts as public client for a SMART server.
  • hub_service: a JupyterHub service that acts as confidential client for a SMART server and performs asymmetric authentication.

Check the READMEs in the example folders for more information.

This package is very much a work in progress.

Server Extension

The Server extension is enabled by default on install. It registers the following handlers:

  • {base_url}/smart-on-fhir/launch - the launch URL to provide
  • {base_url}/smart-on-fhir/login (an intermediate implementation-detail handler that may go away)
  • {base_url}/smart-on-fhir/callback - the OAuth callback you'll want to register

When deployed in JupyterHub, register the URLs https://jupyterhub.example.org/hub/user-redirect/smart-on-fhir/launch as the launch URL and https://jupyterhub.example.org/hub/user-redirect/smart-on-fhir/callback as the oauth callback URL.

After SMART launch, the token info will be stored in jupyter_runtime_dir() / "smart_token.json" (also available to notebooks as $SMART_TOKEN_FILE), and in $SMART_TOKEN. $SMART_TOKEN will only be available to notebooks started after

Currently, only one token is stored at a time, so if there are multiple smart launches to a single notebook server, only the latest will be persisted.

Configure SMARTExtensionApp in jupyter_server_config.py:

c.SMARTExtensionApp.scopes = ["openid", "fhirUser", "launch", "patient/*.*"]
c.SMARTExtensionApp.client_id = "your-client-id"

see sourcecode in server_extension.py for now for more options.

JupyterHub Service

The JupyterHub service is a bare proof of concept which completes the SMART flow and fetches some sample data, it is not useful yet.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyter_smart_on_fhir-0.1.0a4.tar.gz (20.3 kB view details)

Uploaded Source

Built Distribution

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

jupyter_smart_on_fhir-0.1.0a4-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_smart_on_fhir-0.1.0a4.tar.gz.

File metadata

  • Download URL: jupyter_smart_on_fhir-0.1.0a4.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for jupyter_smart_on_fhir-0.1.0a4.tar.gz
Algorithm Hash digest
SHA256 4fbfd289222401f56b60f3c9b877dd28f1ecfff768f96c95c1a7c99110e025e3
MD5 542d059bcc232be7ee1db7ef45bde157
BLAKE2b-256 6fa9caf84337bb52da6250811b3ddf71c46ad5c485631627b748280ea492eace

See more details on using hashes here.

Provenance

The following attestation bundles were made for jupyter_smart_on_fhir-0.1.0a4.tar.gz:

Publisher: release.yaml on jupyterhealth/jupyter-smart-on-fhir

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file jupyter_smart_on_fhir-0.1.0a4-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_smart_on_fhir-0.1.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 2310a02fa28e7fcb4faa853eb1208d52211585adeae483370a218bcf2c304ba1
MD5 93e2b22dad8fd48b40300f8898af40b5
BLAKE2b-256 b8990eddb7a359e960e3b995fe461e737ca62473c87c9d6ba16dfd0013539bc6

See more details on using hashes here.

Provenance

The following attestation bundles were made for jupyter_smart_on_fhir-0.1.0a4-py3-none-any.whl:

Publisher: release.yaml on jupyterhealth/jupyter-smart-on-fhir

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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