Skip to main content

Python representation of FHIR® https://www.hl7.org/fhir/ specification.

Project description

https://img.shields.io/pypi/v/fhirspec.svg Supported Python Versions https://img.shields.io/travis/com/nazrulworld/fhirspec.svg Test Coverage Language grade: Python License https://img.shields.io/badge/code%20style-black-000000.svg HL7® FHIR®

Python representation of FHIR® https://www.hl7.org/fhir/ specification. Idea and class structure based on https://github.com/smart-on-fhir/fhir-parser.

Usages

fhirspec.Configuration

A class that is controlling the behavior of fhirspec.FHIRSpec, powerful but very convenient. In several ways it is possible to construct the instance, ie. from JSON file (has support for json5), from python module, from TOML file, from plain text file, and so on. Only capital letter’s variables are accepted

>>> import pathlib
>>> import os
>>> from foo.module import bar
>>> from fhirspec import Configuration
>>> config1 = Configuration.from_module(bar)
>>> config2 = Configuration.from_json_file(pathlib.Path("/json/file/location"))
>>> data_dict = {
... "BASE_URL": pathlib.Path(os.path.abspath(__file__))
... }
>>> config3 = Configuration(data_dict=data_dict)

fhirspec.FHIRSpec

The main loader class, to construct this instance, Configuration: is required parameter and additionally source of json files. Bellows variables should have to be present in configuration.

required_variables = [

“WRITE_RESOURCES”, “CLASS_MAP”, “REPLACE_MAP”, “NATIVES”, “JSON_MAP”, “JSON_MAP_DEFAULT”, “RESERVED_MAP”, “ENUM_MAP”, “ENUM_NAME_MAP”, “DEFAULT_BASES”, “MANUAL_PROFILES”, “CAMELCASE_CLASSES”, “CAMELCASE_ENUMS”, “BACKBONE_CLASS_ADDS_PARENT”, “RESOURCE_MODULE_LOWERCASE”,]

>>> from fhirspec import Configuration
>>> from fhirspec import FHIRSpec
>>> config = Configuration(
... {
...   "BASE_PATH": "",
      "WRITE_RESOURCES": True
... }
... )
>>> spec = FHIRSpec(config)
>>> "patient" in spec.profiles
True

download

A perfect tool to download any file from server, no dependency on third-party library.

>>> from fhirspec import download
>>> url = "http://www.africau.edu/images/default/sample.pdf"
>>> download_directory = pathlib.Path(os.path.expanduser("~/Downloads"))
>>> download(url, download_directory)
>>> (download_directory / "sample.pdf").exists()
True

History

0.4.0 (22-12-2022)

  • FHIR R4B specification support has been added.

0.3.0 (18-03-2021)

  • Now each FHIRClass contains original sequence of it’s properties(elements) defined in specification.

  • Additionally FHIRClass.expanded_properties_sequence returns all available properties (combined with parent) sequentially.

0.2.5 (02-11-2020)

  • This release contains full fixes of FHIRStructureDefinitionElement.represents_class issues.

0.2.4 (02-11-2020)

  • No more improvements, just same release of 0.2.1 and overrides to the faulty release of 0.2.3.

0.2.3 (24-09-2020)

Update to version ``0.2.4`` is recommended

  • use FHIRStructureDefinitionElement.is_main_profile_element instead of FHIRStructureDefinitionElement.represents_class

0.2.1 (15-06-2020)

  • Minor improvement on FHIRUnitTest handling empty value.

0.2.0 (06-06-2020)

  • FHIRClass.known property has been changed to FHIRClass.__know_classes__ and FHIRClass.is_known_class.

  • Make supports for Python 3.6 and 3.9

0.1.0 (28-04-2020)

  • Initial release [nazrulworld]


© Copyright HL7® logo, FHIR® logo and the flaming fire are registered trademarks owned by Health Level Seven International

“FHIR® is the registered trademark of HL7 and is used with the permission of HL7. Use of the FHIR trademark does not constitute endorsement of this product by HL7”

Project details


Download files

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

Source Distribution

fhirspec-0.4.0.tar.gz (27.3 kB view details)

Uploaded Source

Built Distribution

fhirspec-0.4.0-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

Details for the file fhirspec-0.4.0.tar.gz.

File metadata

  • Download URL: fhirspec-0.4.0.tar.gz
  • Upload date:
  • Size: 27.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.24.0

File hashes

Hashes for fhirspec-0.4.0.tar.gz
Algorithm Hash digest
SHA256 02a0524c8f58fa01d9c5640529025fff5a77fb013726b45b5a2cc5d3f8d305b4
MD5 86d9efced5e71c922614b831c5b36432
BLAKE2b-256 3cd5b09b748709cc4b8b1134307871952ba049d225e8bdd82539b97c62437f86

See more details on using hashes here.

File details

Details for the file fhirspec-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: fhirspec-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 21.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.24.0

File hashes

Hashes for fhirspec-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 43b6dc4914c41a7c5a8440132c5fe835c1c9712ab9ee6c40044ecd88fdd798f1
MD5 fcf744b3413b03364c99e02081d1a3f8
BLAKE2b-256 047bbeb1c5961f2b4192fab283ca4b254722578055a161709f0651bb51651536

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