Official Python SDK for the NoteDx API - a powerful medical note generation service, fully compliant to healthcare regulations in the US and Canada.
Project description
NoteDx API Python Client
Official Python SDK for the NoteDx API - a powerful medical note generation service that converts audio recordings into structured medical notes, fully compliant with data privay laws in Canada and the US.
Beta release!
Features
- Audio to medical note conversion
- Support for multiple languages (English, French)
- Multiple medical note templates
- Real-time job status tracking
- Webhook integration
- Usage monitoring
Installation
pip install notedx-sdk
Quick Start
from notedx_sdk import NoteDxClient
# Initialize client
client = NoteDxClient(api_key="your-api-key")
# Process audio file
response = client.notes.process_audio(
file_path="visit.mp3",
visit_type="initialEncounter",
recording_type="dictation",
patient_consent=True,
template="primaryCare"
)
# Get job ID
job_id = response["job_id"]
# Check status
status = client.notes.fetch_status(job_id)
# Get note when ready
if status["status"] == "completed":
note = client.notes.fetch_note(job_id)
Supported Audio Formats
- MP3 (.mp3)
- MP4/M4A (.mp4, .m4a)
- AAC (.aac)
- WAV (.wav)
- FLAC (.flac)
- PCM (.pcm)
- OGG (.ogg)
- Opus (.opus)
- WebM (.webm)
Development
# Install Poetry (if not already installed)
curl -sSL https://install.python-poetry.org | python3 -
# Install dependencies
poetry install
# Run tests
poetry run pytest
Documentation
For complete documentation, visit NoteDx API Documentation.
License
Copyright © 2025 Technologies Medicales JLA Shiftpal inc. All rights reserved.
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file notedx_sdk-0.1.3.tar.gz.
File metadata
- Download URL: notedx_sdk-0.1.3.tar.gz
- Upload date:
- Size: 31.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.0.1 CPython/3.11.11 Linux/6.8.0-1017-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5919156dcba7859d80c4a4981fc6d893204e7e35bf00f0fa8def616baf35a05f
|
|
| MD5 |
85d9156efe82c06ecf37dcb3fac9101d
|
|
| BLAKE2b-256 |
3ed30b6890eb62bde48a08bd7996319589eda06abe572455c3e7ba92dfb5ab18
|
File details
Details for the file notedx_sdk-0.1.3-py3-none-any.whl.
File metadata
- Download URL: notedx_sdk-0.1.3-py3-none-any.whl
- Upload date:
- Size: 36.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.0.1 CPython/3.11.11 Linux/6.8.0-1017-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
df5457e157cfb341cae86860785b9bfffb83f7c4f3b6816565cf43cce40b2b50
|
|
| MD5 |
89218ad45813f64a533481d40191a2bb
|
|
| BLAKE2b-256 |
3f9af554745eedae860727ac2d90e2f9339ebbf2e3d3604f55c1a68e51eb0c41
|