Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
UMLS Client for interacting with UMLS APIs including Search, Source, CUI, Semantic Network, and Crosswalk APIs.
The UMLS Python Client is a comprehensive, modular, and user-friendly API client designed for healthcare developers and researchers. It offers seamless access to UMLS data, simplifying interactions with various healthcare terminologies and codes. Our client provides five distinct groups of APIs, encompassing every single REST API from UMLS with all query parameters and additional features.
Modular Design: Unlike other packages, our client is modular, providing separate APIs for each UMLS service. This modularity allows for easy integration and customization to meet your specific needs.
Comprehensive Coverage: A one-stop destination that includes every UMLS REST API, ensuring you have access to all necessary endpoints and functionalities.
Enhanced Functionality: Additional features like response formatting in RDF or JSON, file saving options, and extended functions built on top of existing endpoints enhance your development experience.
Best Practices Implementation: Built using the latest best practices, including type hinting for improved code readability and proper error logging for easier debugging.
Future-Proof: We promise support for all future changes to UMLS APIs, ensuring your projects remain up-to-date with the latest developments.
Comprehensive Documentation and Notebooks: We provide detailed documentation and interactive Jupyter notebooks, which are not offered by others, to help you get started quickly and efficiently.
Open Source Collaboration: Fully open for collaboration and improvement by the community. Your contributions are welcome to make this project even better.
Our client divides all REST APIs into five main parts for better organization and ease of use:
Search for concepts using various parameters such as words, exact matches, and codes across UMLS terminologies.
Retrieve information for Concept Unique Identifiers (CUIs) from the UMLS Metathesaurus.
Fetch detailed information about source-asserted concepts or descriptors.
Explore the UMLS Semantic Network and its relationships.
Map codes between different terminologies and vocabularies in healthcare.
Install the UMLS Python Client using pip:
pip install umls-python-client
Initialize the UMLSClient
with your API key:
from umls_python_client import UMLSClient
api_key = "YOUR_API_KEY"
umls_client = UMLSClient(api_key=api_key)
You can explore the available APIs below:
API Name | Description | Documentation Link | Colab Notebook Link |
---|---|---|---|
SearchAPI | Search the UMLS database for terms and concepts. | /searchAPI | Open in Colab |
CUIAPI | Retrieve Concept Unique Identifier information. | /CUIAPI | Open in Colab |
SourceAPI | Access source-specific content in UMLS. | /sourceAPI | Open in Colab |
SemanticNetworkAPI | Explore semantic relationships. | /semanticNetworkAPI | Open in Colab |
CrosswalkAPI | Map concepts across vocabularies. | /crosswalkAPI | Open in Colab |
Click on the documentation links to learn more about each API and use the Colab notebooks to try them out interactively.
Here's a quick example of how to use the SearchAPI to find information about "diabetes":
from umls_python_client import UMLSClient
api_key = "YOUR_API_KEY"
# Initialize the SearchAPI class with your API key
search_api = UMLSClient(api_key=api_key).searchAPI
#############################
# Perform a Basic Search
#############################
logger.info("Performing a basic search query for the term 'diabetes':")
search_results = search_api.search(
search_string="diabetes"
)
print(f"Search Results for 'diabetes': {search_results}")
We welcome contributions from the community! If you have any improvements or new ideas, feel free to open a pull request or an issue on our GitHub repository.
We are committed to maintaining and updating this client to support all future changes in the UMLS APIs. If you encounter any issues or have feature requests, please open an issue on our GitHub repository.
FAQs
UMLS Client for interacting with UMLS APIs including Search, Source, CUI, Semantic Network, and Crosswalk APIs.
We found that umls-python-client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.