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.

API console, click here

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.",
        "template": "A custom template for your use case"
    },
    custom_metadata={
        "custom_metadata": "Some custom metadata for your use case"
    }
)

# Get job ID
job_id = response["job_id"]

# Check status - ( Or better, use the webhook implementation )
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.10.tar.gz (34.9 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.10-py3-none-any.whl (39.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: notedx_sdk-0.1.10.tar.gz
  • Upload date:
  • Size: 34.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.11.12 Linux/6.11.0-1015-azure

File hashes

Hashes for notedx_sdk-0.1.10.tar.gz
Algorithm Hash digest
SHA256 b5af2e4dba4f545d6e051d06259189d0b936e6aa97c0b128e71a57a09da335a8
MD5 c7fb3ac94d24c08ca925276ac5303b27
BLAKE2b-256 4155924465ceb22c1603cc9fcdd84f7cdaa7f32d18747dd46c8fbc1afc5ce9e2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: notedx_sdk-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 39.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.11.12 Linux/6.11.0-1015-azure

File hashes

Hashes for notedx_sdk-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 3e05879d262903c2e3bf690d2592a70496b8bcbec9c6661217ea04cea6bf003f
MD5 8a144cc3673eb6bfd4b8fc11d2d8b2e5
BLAKE2b-256 b63f1cc5209f25ea64f9a8008ae0c1a20c67d5af57871d385072f057a4659f25

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