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.7.tar.gz (33.5 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.7-py3-none-any.whl (38.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: notedx_sdk-0.1.7.tar.gz
  • Upload date:
  • Size: 33.5 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.7.tar.gz
Algorithm Hash digest
SHA256 db102b00d049decf7a42054c3b5397cfbf7c98743acc860c0d92585dd6c642e7
MD5 9532fc8fcfaf5e188b43a370d3c12e5a
BLAKE2b-256 8d3822c038ff254eae37eb78c09656d166302162c200014d7c0136509a75bdb3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: notedx_sdk-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 38.5 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 46b998007db9c798cc50c2c4cbde08d427c02f21add6b20d4977745c7f9cf057
MD5 b00e4637c892f5e232a930684a8e2b1d
BLAKE2b-256 0afd37b9aad782234067785ed9061f6580b7d3c91ad5b9e8c508935c59d384e5

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