Skip to main content

OWL-on-FHIR

owl-on-fhir logo

A Python-based non-minimalistic OWL to FHIR converter.

Prerequisite

Installation

pip install owl-on-fhir

Usage

Syntax

owl-on-fhir --input-path-or-url FILENAME --code-system-id ID --native-uri-stems "URL_1,...,URL_N" --code-system-url URL [NON_REQUIRED_OPTIONS]

Examples

owl-on-fhir --input-path-or-url comploinc.owl --code-system-id comploinc --native-uri-stems "https://loinc.org/" --code-system-url https://github.com/loinc/comp-loinc/releases/latest/download/merged_reasoned_loinc.owl

CLI options

Short Flag Long Flag Required Description
-h --help Show this help message and exit.
-i --input-path-or-url True URL or path to OWL file to convert.
-s --code-system-id True The code system ID to use for identification on the server uploaded to. See: https://hl7.org/fhir/resource-definitions.html#Resource.id
-S --code-system-url True Canonical URL for the code system. See: https://hl7.org/fhir/codesystem-definitions.html#CodeSystem.url
-u --native-uri-stems True A comma-separated list of URI stems that will be used to determine whether a concept is native to the CodeSystem. For example, for OMIM, the following URI stems are native: https://omim.org/entry/,https://omim.org/phenotypicSeries/PS". As of 2023-01-15, there is still a bug in the Obographs spec and/or robot where certain nodes are not being converted. This converter adds back the nodes, but to know which ones belong to the CodeSystem itself and are not foreign concepts, this parameter is necessary. OAK also makes use of this parameter. See also: https://github.com/geneontology/obographs/issues/90
-o --out-dir False The directory where results should be saved.
-n --out-filename False Filename for the primary file converted, e.g. CodeSystem.
-p --include-only-critical-predicates False If present, includes only critical predicates (is_a/parent) rather than all predicates in CodeSystem.property and CodeSystem.concept.property.
-c --use-cached-intermediaries False Use cached intermediaries if they exist?
-r --retain-intermediaries False Retain intermediary files created during conversion process (e.g. Obograph JSON)?
-I --convert-intermediaries-only False Convert intermediaries only?
-d --dev-oak-path False If you want to use a local development version of OAK, specify the path to the OAK directory here. Must be used with --dev-oak-interpreter-path.
-D --dev-oak-interpreter-path False If you want to use a local development version of OAK, specify the path to the Python interpreter where its dependencies are installed (i.e. its virtual environment). Must be used with --dev-oak-path.

More

Alternative OWL to FHIR converters

FHIR-OWL

https://github.com/aehrc/fhir-owl
Takes a minimalistic approach. Can convert top-level CodeSystem properties, concepts, and also supports some predicates, such as synonyms. Uses Java owl-api.

Ontology Access Kit (OAK)

https://github.com/INCATools/ontology-access-kit/ OWL-on-FHIR is largely a wrapper around Ontology Access Kit (OAK)'s FHIR converter. It adds some extra automation such as an intermediary conversion to Obographs JSON, which is currently a required input for OAK for most ontologies, given the current state of development.

Metadata

Release files for owl-on-fhir 1.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for owl-on-fhir 1.1.5
File Size Uploaded
owl-on-fhir-1.1.5.tar.gz 80.7 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for owl-on-fhir 1.1.5
File Interpreter ABI Platform
owl_on_fhir-1.1.5-py3-none-any.whl Python 3 none any Details

Total release size: 161.4 MB

Release files / owl-on-fhir-1.1.5.tar.gz

Download URL owl-on-fhir-1.1.5.tar.gz
Size 80.7 MB
Tags Source
SHA-256 checksum
How to use checksums
5f52b8db26e3e003c2d97688f64ae3fbd7233f12a511ca4f888059443e16a5ed
BLAKE2b-256 checksum
How to use checksums
a51a8acb4eb8c7b2c25c1766048b7ecd3821bdea5e077628a7fb4f760a95a2cb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.4

Release files / owl_on_fhir-1.1.5-py3-none-any.whl

Download URL owl_on_fhir-1.1.5-py3-none-any.whl
Size 80.7 MB
Tags Python 3
SHA-256 checksum
How to use checksums
2d3ba1a67640547918b358d8f6fc81cd11c1e326f32324a9e52beeb323b51b19
BLAKE2b-256 checksum
How to use checksums
388551dbf122fb14c95b5bd24ff05c80bdc357de88a5417a68d020b866423d25
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.4

Release history Release notifications | RSS feed

This release

1.1.5 This release

2 release files

1.1.4

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.1.14

2 release files

0.1.13

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page