Python-based non-minimalistic OWL to FHIR converter.
Project description
OWL-on-FHIR
A Python-based non-minimalistic OWL to FHIR converter.
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 | For fhirjson only. 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 | For fhirjson only. 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. |
-t | --intermediary-type | False | Which type of intermediary to use? First, we convert OWL to that intermediary format, and then we convert that to FHIR. |
-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.
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
Built Distribution
Hashes for owl_on_fhir-0.1.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | abacd865226afa540ac4f582f1d8926f5ebb77053f732ee54eebd4451e5371f8 |
|
MD5 | c3f5beb8b7d81a674b16703027a82d9b |
|
BLAKE2b-256 | 2515dc1e3edf84a947760fb5010d3a999bbe081c7ec70cd6454615b2ee8f72d3 |