Skip to content

Latest commit

 

History

History
100 lines (76 loc) · 8.37 KB

README.md

File metadata and controls

100 lines (76 loc) · 8.37 KB

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

open-ortho terminology

A collection of codes and terms from various terminologies, specifically tailored for software development within the orthodontic domain.
Explore the docs »

View Demo · Report Bug · Request Feature

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.

The primary aim of this project is to implement in FHIR Terminology the views and view sets defined in AMERICAN NATIONAL STANDARD INSTITUTE/AMERICAN DENTAL ASSOCIATION STANDARD NO. 1100 – 2D and 3D Orthodontic/Craniofacial/Forensic Photographic Views and View Sets. By adhering to the ADA1100 standard, we ensure that the codes and terminologies used in orthodontic software are consistent, accurate, and interoperable across different systems. This is not an official FHIR CodeSystem. The purpose for this site is to provide developers codes necessary to move forward with their development, while the codes get added and approved in official nomenclatures (like SNOMED-CT).

Using The Codes

The codes systems and code values should be built by the Makefile and deployed in /docs, where github can serve them. This should serve as a static service, for CodeSystem definitions.

The codesystems are availble through the following official URLs:

Python

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

pip install open-ortho-terminology

Then

from terminology.resources.code_systems.extraoral_3d_visible_light_views import EV3D01, EV3D02, EV3D03 

print(EV3D01.code)
print(EV3D01.display)
print(EV3D01.definition)

Convert codes to JSON

print(EV3D01.model_dump())

Import the entire codesystem:

>>> from terminology.resources.code_systems.extraoral_3d_visible_light_views import Extraoral3DVisibleLightScheduledProtocolCodeSystem
>>> ev = Extraoral3DVisibleLightScheduledProtocolCodeSystem()
>>> ev.model_dump()
{'resourceType': 'CodeSystem', 'url': 'http://terminology.open-ortho.org/fhir/extraoral-3d-visible-light-views', 'version': '1.0.0', 'name': 'Extraoral3DVisibleLightViews', 'title': 'Extraoral 3D Visible Light Views', 'status': 'draft', 'experimental': True, 'date': '2025-01-14', 'publisher': 'Open Ortho', 'description': "Common extraoral 3D visible light views used in an orthodontic provider's practice, producing a 3D surface of the head and neck", 'caseSensitive': True, 'content': 'complete', 'concept': [{'code': 'EV3D01', 'display': 'EV3D-01 EO.WH.LC.CO', 'definition': 'Whole head, lips closed, centric occlusion'}, {'code': 'EV3D02', 'display': 'EV3D-02 EO.WH.LC.CR', 'definition': 'Whole head, lips closed, centric relation'}, {'code': 'EV3D03', 'display': 'EV3D-03 EO.WH.LR.CO', 'definition': 'Whole head, lips relaxed, centric occlusion'}, {'code': 'EV3D04', 'display': 'EV3D-04 EO.WH.LR.CR', 'definition': 'Whole head, lips relaxed, centric relation'}, {'code': 'EV3D05', 'display': 'EV3D-05 EO.WH.FS.CO', 'definition': 'Whole head, full smile, centric occlusion'}, {'code': 'EV3D06', 'display': 'EV3D-06 EO.WH.FS.CR', 'definition': 'Whole head, full smile, centric relation'}]}
>>> ev.concept[0].model_dump()
{'code': 'EV3D01', 'display': 'EV3D-01 EO.WH.LC.CO', 'definition': 'Whole head, lips closed, centric occlusion'}
>>> ev.concept
[CodeSystemConcept(fhir_comments=None, extension=None, id=None, modifierExtension=None, code='EV3D01', code__ext=None, concept=None, definition='Whole head, lips closed, centric occlusion', definition__ext=None, designation=None, display='EV3D-01 EO.WH.LC.CO', display__ext=None, property=None), CodeSystemConcept(fhir_comments=None, extension=None, id=None, modifierExtension=None, code='EV3D02', code__ext=None, concept=None, definition='Whole head, lips closed, centric relation', definition__ext=None, designation=None, display='EV3D-02 EO.WH.LC.CR', display__ext=None, property=None), CodeSystemConcept(fhir_comments=None, extension=None, id=None, modifierExtension=None, code='EV3D03', code__ext=None, concept=None, definition='Whole head, lips relaxed, centric occlusion', definition__ext=None, designation=None, display='EV3D-03 EO.WH.LR.CO', display__ext=None, property=None), CodeSystemConcept(fhir_comments=None, extension=None, id=None, modifierExtension=None, code='EV3D04', code__ext=None, concept=None, definition='Whole head, lips relaxed, centric relation', definition__ext=None, designation=None, display='EV3D-04 EO.WH.LR.CR', display__ext=None, property=None), CodeSystemConcept(fhir_comments=None, extension=None, id=None, modifierExtension=None, code='EV3D05', code__ext=None, concept=None, definition='Whole head, full smile, centric occlusion', definition__ext=None, designation=None, display='EV3D-05 EO.WH.FS.CO', display__ext=None, property=None), CodeSystemConcept(fhir_comments=None, extension=None, id=None, modifierExtension=None, code='EV3D06', code__ext=None, concept=None, definition='Whole head, full smile, centric relation', definition__ext=None, designation=None, display='EV3D-06 EO.WH.FS.CR', display__ext=None, property=None)]

Releases

  • Each new release must be git tagged with v*... This triggers the Github actions to publish to PyPi and release in GitHub releases.
  • Project version should only be stored in the pyproject.toml file in project.version, and imported accordingly when needed.
  • Each CodeSystem and CodeValue has its own version which depends on changes to that: remember to bump those individually.
  • No need for Github actions: just build with make build, which will build in docs/ which is configured by github-pages to serve to http://terminology.open-ortho.org and http://open-ortho.org/terminology.