Skip to content

Releases: migraf/fhir-kindling

v1.0.0

09 Jul 16:16
373413c
Compare
Choose a tag to compare

Improve packaging with poetry to slim down library size with optional extras for datascience features. Record linkage
for transfer functionality. Add support for Python 3.9+. Code base cleanup and refactoring. Added retry and benchmark functionality
Big upgrades to the documentation 👀.

Changed

  • Breaking: Renamed FHIRQuery classes to FhirQuerySync and FhirQueryAsync for naming consistency.
  • Breaking: Renamed FHIRQueryParameters class to FhirQueryParameters for naming consistency.
  • Breaking: Query response .save() method now only supports saving as XML or JSON file. To serialize resources and bundles use
    the flatten function from the serde package. Requires installation of the ds extra.
  • Breaking: Moved ServerSummary and summary functionality into separate module.
  • Breaking: Unified has() and where() parameter args into a single argument that accepts either a dict or a
    parameter object. Removed _dict arguments.
  • Improve packaging with poetry and optional extras for datascience features and web app.
  • Optional dependencies for [ds, app] can be installed using pip install fhir_kindling[{extra}].
  • Split batch transactions into separate module to slim down FhirServer class.
  • Split transfer functionality into separate module to slim down FhirServer class.

Added

  • Optional progress bar for summary, get_many, add_all and transfer methods.
  • Additional property resource_list on FhirQueryResponse to get a list of all resources (even included ones) from the response.
  • summary_async() method for asynchronous server summary.
  • total property on QueryResponse to get the total number of resources returned by the query.
  • record_linkage functionality for transfer() method and split transfer functionality into separate module.
  • Retry functionality for the FhirServer class. Allowing for retrying failed requests based on the configured status codes and methods. Configurable with backoff and jitter.
  • Benchmark functionality for FhirServers that run a comprehensive set of tests against the server and measure the time it takes to complete them. Available only when the ds extra is installed.

Removed

  • Removed to_dfs() method on query response object. Use flatten function from the serde package instead.
    Requires installation of the ds extra.
  • Removed requests-oauthlib in favor of authlib.