Skip to main content

helix.fhir.client.sdk

Project description

from typing_extensions import Optionalfrom helix_fhir_client_sdk.responses.fhir_get_response import FhirGetResponsefrom build.lib.helix_fhir_client_sdk.responses.fhir_get_response import FhirGetResponsefrom helix_fhir_client_sdk.responses.fhir_get_response import FhirGetResponse

helix.fhir.client.sdk

Continuous Integration Latest Release GitHub license

Fluent API to call the FHIR server that handles:

  1. Authentication to FHIR server
  2. Renewing access token when they expire
  3. Retry when there are transient errors
  4. Un-bundling the resources received from FHIR server
  5. Paging
  6. Streaming
  7. Logging
  8. Simulating a $graph call when the server does not support it

Usage

pip install helix.fhir.client.sdk

Documentation

https://icanbwell.github.io/helix.fhir.client.sdk/

Test Project using this

https://github.com/icanbwell/fhir-server-performance

Python Version Support

  • 1.x supports python 3.7+
  • 2.x supports python 3.10+
  • 3.x supports python 3.12+

Asynchronous Support

When communicating with FHIR servers, a lot of time is spent waiting for the server to respond. This is a good use case for using asynchronous programming. This SDK supports asynchronous programming using the async and await keywords.

The return types are Python AsyncGenerators. Python makes it very easy to work with AsyncGenerators.

For example, if the SDK provides a function like this:

async def get_resources(self) -> AsyncGenerator[FhirGetResponse, None]:
    ...

You can iterate over the results as they become available:

response: Optional[FhirGetResponse]
async for response in client.get_resources():
    print(response.resource)

Or you can get a list of responses (which will return AFTER all the responses are received:

responses: List[FhirGetResponse] = [response async for response in client.get_resources()]

Or you can aggregate the responses into one response (which will return AFTER all the responses are received:

response: Optional[FhirGetResponse] = await FhirGetResponse.from_async_generator(client.get_resources())

Data Streaming

For FHIR servers that support data streaming (e.g., b.well FHIR server), you can just set the use_data_streaming parameter to stream the data as it i received. The data will be streamed in AsyncGenerators as described above.

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

helix_fhir_client_sdk-3.0.19.tar.gz (96.4 kB view details)

Uploaded Source

Built Distribution

helix.fhir.client.sdk-3.0.19-py3-none-any.whl (182.3 kB view details)

Uploaded Python 3

File details

Details for the file helix_fhir_client_sdk-3.0.19.tar.gz.

File metadata

File hashes

Hashes for helix_fhir_client_sdk-3.0.19.tar.gz
Algorithm Hash digest
SHA256 be8a8b82cbdcc78fd1fab2220299796274435175dae4078d9e1adba657e5af54
MD5 9a0bac1ca329fc532f7869736cfd0838
BLAKE2b-256 5403b0767cdc6129518b533992d934ead499363b4f5d077d610bf49f443332cf

See more details on using hashes here.

File details

Details for the file helix.fhir.client.sdk-3.0.19-py3-none-any.whl.

File metadata

File hashes

Hashes for helix.fhir.client.sdk-3.0.19-py3-none-any.whl
Algorithm Hash digest
SHA256 75e14e4f9ef87ce2dda726346bb4a89654685934d60427d9de705febdb59ae9e
MD5 37c25be7418d4024b32f602c796ba180
BLAKE2b-256 91c007f175e8e1640512ddb23893df085d47e503dd5c9e5d2519f6f78ef21bb5

See more details on using hashes here.

Supported by

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