open-ortho-terminology


Nameopen-ortho-terminology JSON
Version 0.3.3 PyPI version JSON
download
home_pagehttps://github.com/open-ortho/codes
SummaryA package for managing orthodontic codes and namespaces.
upload_time2024-09-09 16:23:52
maintainerNone
docs_urlNone
authorToni Magni
requires_python>=3.6
licenseNone
keywords orthodontics codes fhir healthcare snomed
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]

<!-- PROJECT LOGO -->
<br />
<p align="center">
  <a href="https://github.com/open-ortho/terminology">
    <img src="https://raw.githubusercontent.com/open-ortho/dicom4ortho/master/images/open-ortho.png" alt="Logo" width="80" height="80">
  </a>

  <h3 align="center">open-ortho terminology</h3>

  <p align="center">
    A collection of codes and terms from various terminologies, specifically tailored for software development within the orthodontic domain.
    <br />
    <a href="https://open-ortho.github.io/terminology/"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/open-ortho/terminology">View Demo</a>
    ·
    <a href="https://github.com/open-ortho/terminology/issues">Report Bug</a>
    ·
    <a href="https://github.com/open-ortho/terminology/issues">Request Feature</a>
  </p>
</p>

## About The Project

This project serves as a centralized repository for orthodontic software developers, offering a curated collection of essential codes required for implementing healthcare standards like DICOM or HL7. Navigating through various terminologies to find the right codes can be challenging. Our project aims to simplify this process by providing a go-to source for these codes, readily available in JSON and CSV formats. Users can access these directly through GitHub releases or utilize them as a Python package on PyPI.

In addition, the repository can define its own codes in situations where the absence of specific codes in standardized nomenclatures and code sets impedes the development process. Codes generated here are temporary; as the inclusion process progresses, these codes may be replaced. Once officially approved by authoritative sources like HL7 or SNOMED, the terminology server will be updated accordingly, rendering these temporary codes obsolete and mapping them as synonyms to the newly approved codes.

## Using The Codes

### Python

If you want to use the codes directly in your Python project:

    pip install open-ortho-terminology

Then

    from open_ortho_terminology.terminology import hl7 as codes_hl7

    print(f"{codes_hl7.orthodontic.system}")
    print(codes_hl7.orthodontic.code)
    print(codes_hl7.orthodontic.display)

Convert codes to JSON

    from open_ortho_terminology.terminology import hl7 as codes_hl7

    print(f"{codes_hl7.orthodontic.to_json()}")

### JSON

Just point your code to any of the following:


## Releases

- Each new release must be git tagged with v*.*.*. This triggers the Github actions to publish to PyPi and release in GitHub releases.
- 

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/open-ortho/terminology.svg?style=for-the-badge
[contributors-url]: https://github.com/open-ortho/terminology/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/open-ortho/terminology.svg?style=for-the-badge
[forks-url]: https://github.com/open-ortho/terminology/network/members
[stars-shield]: https://img.shields.io/github/stars/open-ortho/terminology.svg?style=for-the-badge
[stars-url]: https://github.com/open-ortho/terminology/stargazers
[issues-shield]: https://img.shields.io/github/issues/open-ortho/terminology.svg?style=for-the-badge
[issues-url]: https://github.com/open-ortho/terminology/issues
[license-shield]: https://img.shields.io/github/license/open-ortho/terminology.svg?style=for-the-badge
[license-url]: https://github.com/open-ortho/terminology/blob/master/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/open-ortho
[product-screenshot]: images/screenshot.png
[example-csv-url]: resources/example/input_from.csv

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/open-ortho/codes",
    "name": "open-ortho-terminology",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "orthodontics codes fhir healthcare snomed",
    "author": "Toni Magni",
    "author_email": "open-ortho@case.edu",
    "download_url": "https://files.pythonhosted.org/packages/48/1e/274b5a7bdc97618cb2371c8874816be7806630f339aa2b2ea89b99dff45e/open_ortho_terminology-0.3.3.tar.gz",
    "platform": null,
    "description": "[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n[![LinkedIn][linkedin-shield]][linkedin-url]\n\n<!-- PROJECT LOGO -->\n<br />\n<p align=\"center\">\n  <a href=\"https://github.com/open-ortho/terminology\">\n    <img src=\"https://raw.githubusercontent.com/open-ortho/dicom4ortho/master/images/open-ortho.png\" alt=\"Logo\" width=\"80\" height=\"80\">\n  </a>\n\n  <h3 align=\"center\">open-ortho terminology</h3>\n\n  <p align=\"center\">\n    A collection of codes and terms from various terminologies, specifically tailored for software development within the orthodontic domain.\n    <br />\n    <a href=\"https://open-ortho.github.io/terminology/\"><strong>Explore the docs \u00bb</strong></a>\n    <br />\n    <br />\n    <a href=\"https://github.com/open-ortho/terminology\">View Demo</a>\n    \u00b7\n    <a href=\"https://github.com/open-ortho/terminology/issues\">Report Bug</a>\n    \u00b7\n    <a href=\"https://github.com/open-ortho/terminology/issues\">Request Feature</a>\n  </p>\n</p>\n\n## About The Project\n\nThis project serves as a centralized repository for orthodontic software developers, offering a curated collection of essential codes required for implementing healthcare standards like DICOM or HL7. Navigating through various terminologies to find the right codes can be challenging. Our project aims to simplify this process by providing a go-to source for these codes, readily available in JSON and CSV formats. Users can access these directly through GitHub releases or utilize them as a Python package on PyPI.\n\nIn addition, the repository can define its own codes in situations where the absence of specific codes in standardized nomenclatures and code sets impedes the development process. Codes generated here are temporary; as the inclusion process progresses, these codes may be replaced. Once officially approved by authoritative sources like HL7 or SNOMED, the terminology server will be updated accordingly, rendering these temporary codes obsolete and mapping them as synonyms to the newly approved codes.\n\n## Using The Codes\n\n### Python\n\nIf you want to use the codes directly in your Python project:\n\n    pip install open-ortho-terminology\n\nThen\n\n    from open_ortho_terminology.terminology import hl7 as codes_hl7\n\n    print(f\"{codes_hl7.orthodontic.system}\")\n    print(codes_hl7.orthodontic.code)\n    print(codes_hl7.orthodontic.display)\n\nConvert codes to JSON\n\n    from open_ortho_terminology.terminology import hl7 as codes_hl7\n\n    print(f\"{codes_hl7.orthodontic.to_json()}\")\n\n### JSON\n\nJust point your code to any of the following:\n\n\n## Releases\n\n- Each new release must be git tagged with v*.*.*. This triggers the Github actions to publish to PyPi and release in GitHub releases.\n- \n\n<!-- MARKDOWN LINKS & IMAGES -->\n<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->\n[contributors-shield]: https://img.shields.io/github/contributors/open-ortho/terminology.svg?style=for-the-badge\n[contributors-url]: https://github.com/open-ortho/terminology/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/open-ortho/terminology.svg?style=for-the-badge\n[forks-url]: https://github.com/open-ortho/terminology/network/members\n[stars-shield]: https://img.shields.io/github/stars/open-ortho/terminology.svg?style=for-the-badge\n[stars-url]: https://github.com/open-ortho/terminology/stargazers\n[issues-shield]: https://img.shields.io/github/issues/open-ortho/terminology.svg?style=for-the-badge\n[issues-url]: https://github.com/open-ortho/terminology/issues\n[license-shield]: https://img.shields.io/github/license/open-ortho/terminology.svg?style=for-the-badge\n[license-url]: https://github.com/open-ortho/terminology/blob/master/LICENSE\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555\n[linkedin-url]: https://linkedin.com/in/open-ortho\n[product-screenshot]: images/screenshot.png\n[example-csv-url]: resources/example/input_from.csv\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A package for managing orthodontic codes and namespaces.",
    "version": "0.3.3",
    "project_urls": {
        "Homepage": "https://github.com/open-ortho/codes"
    },
    "split_keywords": [
        "orthodontics",
        "codes",
        "fhir",
        "healthcare",
        "snomed"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2d95da9bdbeaa1ebda278821b53b8e7879d3a3efd400bd681f88708327210142",
                "md5": "1db44edc13eb23188608d7ff6f2d4cb7",
                "sha256": "9930b80b7272244458f2bd3041cf404b8947bd2a6337f0f08dcb4799196ee3d6"
            },
            "downloads": -1,
            "filename": "open_ortho_terminology-0.3.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1db44edc13eb23188608d7ff6f2d4cb7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 14691,
            "upload_time": "2024-09-09T16:23:50",
            "upload_time_iso_8601": "2024-09-09T16:23:50.835781Z",
            "url": "https://files.pythonhosted.org/packages/2d/95/da9bdbeaa1ebda278821b53b8e7879d3a3efd400bd681f88708327210142/open_ortho_terminology-0.3.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "481e274b5a7bdc97618cb2371c8874816be7806630f339aa2b2ea89b99dff45e",
                "md5": "1774b3809e6a10519f0b0740799e9226",
                "sha256": "9b1da0efad7b5e78e517707e824d4c20bd5b285022557f20982615e2209a4dfc"
            },
            "downloads": -1,
            "filename": "open_ortho_terminology-0.3.3.tar.gz",
            "has_sig": false,
            "md5_digest": "1774b3809e6a10519f0b0740799e9226",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 14189,
            "upload_time": "2024-09-09T16:23:52",
            "upload_time_iso_8601": "2024-09-09T16:23:52.316732Z",
            "url": "https://files.pythonhosted.org/packages/48/1e/274b5a7bdc97618cb2371c8874816be7806630f339aa2b2ea89b99dff45e/open_ortho_terminology-0.3.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-09 16:23:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "open-ortho",
    "github_project": "codes",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "open-ortho-terminology"
}
        
Elapsed time: 0.33343s