Skip to main content

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

Tests codecov PyPI Last Commit PyPI - Downloads

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
  • HIPAA and PIPEDA compliant

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",
    template="primaryCare",
    lang="en",
    documentation_style="problemBased",
    output_language="fr",
    custom={
        "context": "Patient is 30 years old, male, with a history of hypertension and diabetes."
    }
)

# 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

notedx_sdk-0.1.6.tar.gz (34.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

notedx_sdk-0.1.6-py3-none-any.whl (39.7 kB view details)

Uploaded Python 3

File details

Details for the file notedx_sdk-0.1.6.tar.gz.

File metadata

  • Download URL: notedx_sdk-0.1.6.tar.gz
  • Upload date:
  • Size: 34.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.11.11 Linux/6.8.0-1020-azure

File hashes

Hashes for notedx_sdk-0.1.6.tar.gz
Algorithm Hash digest
SHA256 479134bab13105a190a5235ae27d9f5c2e4995a19e10f6adea3dee3b3f9d075c
MD5 333b49a10d5d04c333edd7dcf1eaf31f
BLAKE2b-256 b286ac6c512c1f10d4010b83d2adf216712ead06426771cbf44c4dab1e99dc7a

See more details on using hashes here.

File details

Details for the file notedx_sdk-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: notedx_sdk-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 39.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.11.11 Linux/6.8.0-1020-azure

File hashes

Hashes for notedx_sdk-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 76548f894d2f0970164df777c6b3ee8df797f79caea409e8ffa95a0b50c49d19
MD5 b20f2a95518cc0c59651caad5ae26b0a
BLAKE2b-256 6a99af432278a250e8fe86f4e8f40959d3b5d19c2a2232763a8eb0348a84f87f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page