fhirstarter

Enhancements

• Bump version of urllib3 to resolve a moderate security vulnerability
• Bump version of various other dependencies

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/2.4.0...2.4.1

Breaking changes

• FastAPI 0.111.0 pulls in orjson as a dependency, which may change the behavior of serialization methods on fhir.resources. This caused some FHIRStarter test failures related to pretty-printing.

Enhancements

• FastAPI upgrade to 0.111.0

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/2.3.0...2.4.0

Enhancements

• Enhanced the parse_fhir_request helper function so that it can identify and parse FHIR operation requests

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/2.2.2...2.3.0

Enhancements

• Dependency version bumps

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/2.2.1...2.2.2

Bug fixes

• Fix uvicorn dependency on Windows

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/2.2.0...2.2.1

Enhancements

• Added support for patch and delete interactions

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/2.1.0...2.2.0

Enhancements

• Enabled support for Python 3.8, 3.9, 3.10, and 3.12 (3.11 already supported)

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/2.0.0...2.1.0

This release contains bug fixes, corrections to adhere more closely to the FHIR specification, and deprecations. Some of these corrections necessitate breaking changes, hence the major version update. See below for details.

Breaking changes

• Update to the latest version of FastAPI. There may be breaking changes depending on your usage, so please review recent FastAPI releases for more information: https://github.com/tiangolo/fastapi/releases
• Location header in create responses is now relative rather than absolute, i.e. it only will contain the URL path rather than also including the hostname. This can be added back with middleware if desired.
• Location header in create responses now excludes the resource version, because FHIRStarter does not currently support versioning. This corrects a mistake that was due to a previous misreading of the FHIR specification. For more information, see: https://hl7.org/fhir/R5/http.html#create
• Create and update responses that do not return a resource in the response body will now return an empty response rather than the string "null".
• Deprecated helper function categorize_fhir_request has been removed.
• Deprecated parameter config_file_name on FHIRStarter.__init__ has been removed.

Bug fixes

• Location header in create responses now excludes the resource version, because FHIRStarter does not currently support versioning. This corrects a mistake due to a previous misreading of the FHIR specification. For more information, see: https://hl7.org/fhir/R5/http.html#create
• Create and update responses that do not return a resource in the response body will now return an empty response rather than the string "null".

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/1.5.0...2.0.0

Enhancements

• Added exception classes for most status codes mentioned in the FHIR spec
• Version bumps for FastAPI and other packages

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/1.4.2...1.5.0

Enhancements

• Version bumps for FastAPI and other packages

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/1.4.1...1.4.2

Enhancements

• Not user-facing: Refactored OpenAPI schema modifications so that they are in their own module and also broken up into smaller functions
• Not user-facing: Added a comprehensive test suite for OpenAPI schema modifications

Bug fixes

• Resources that only have a search endpoint will now have schemas loaded
• Resources that only have a search endpoint will now have a proper example; previously the schema wasn't getting loaded at all and as a result examples wouldn't get loaded either
• A function that creates bundle examples needed a deepcopy; without it, a bundle example for one resource type would overwrite the bundle example for a differerent resource type

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/1.4.0...1.4.1

Enhancements

• All resource examples provided by the FHIR specification can now be viewed from a dropdown menu; this was enabled via the multiple examples OpenAPI feature

Bug fixes

• Some small changes so that the unit tests will run on Windows
• Store the capability statement date as a string instead of a datetime so requests to /metadata produce the same exact date every time; this avoids some float precision issues that produced inconsistent results

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/1.3.0...1.4.0

Breaking changes

• It's not necessarily a breaking change per se, but the hard dependency on uvloop has been removed. uvloop is a drop-in replacement for the default asyncio event loop, so they are compatible. Instructions for how to continue using uvloop are in the README.

Bug fixes

• Make request body required for create and update interactions. Previously, empty request bodies would just pass through to handlers, but with this change, the Pydantic validators will activate and complain about the missing body.

New Contributors

• @llob made their first contribution in https://github.com/canvas-medical/fhirstarter/pull/118

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/1.2.1...1.3.0

Bug Fixes

• Restrict Pydantic version to <2.0.0. Later versions of fhir.resources restrict Pydantic to <2.0.0, so FHIRStarter will as well in order to cover the case where someone is using fhir.resources 6.4.0, which does not restrict. This ensures that a user won't encounter a scenario where they are using fhir.resources 6.4.0 (because they want to use FHIR R4) and end up getting Pydantic >=2.0.0, which is not currently compatible.

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/1.2.0...1.2.1

Breaking changes

• There are no FHIRStarter-related breaking changes with this release, however it does include an upgrade to the latest version of FastAPI. If you add routes with FastAPI decorators, be mindful of this.

Enhancements

• Bumped to latest version of dependencies, namely FastAPI 0.101.0
• Typing corrections and simplifications for the upgrade to Mypy 1.5.0

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/1.1.0...1.2.0

Enhancements

• More flexibility for config file loading; can now load from a path or from a file
• Corrected example in README showing how to set FHIR version with an environment variable

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/1.0.0...1.1.0

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/0.13.4...0.13.5

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/0.13.5...0.13.6

Full Changelog: https://github.com/canvas-medical/fhirstarter/compare/0.13.6...0.13.7