notedx-sdk


Namenotedx-sdk JSON
Version 0.1.9 PyPI version JSON
download
home_pagehttps://www.notedxai.com/contact-8-1
SummaryOfficial Python SDK for the NoteDx API - a powerful medical note generation service, fully compliant to healthcare regulations in the US and Canada.
upload_time2025-02-15 21:43:41
maintainerNone
docs_urlNone
authorJulien Martel
requires_python<4.0.0,>=3.8.2
licenseProprietary
keywords medical notes transcription healthcare api ai scribe ai-scribe pharmacy nursing radiology procedures medicalspecialties hipaa pipeda canada usa quebec
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Tests](https://github.com/martelman/NoteDx-API-Client/actions/workflows/test.yml/badge.svg)](https://github.com/martelman/NoteDx-API-Client/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/martelman/NoteDx-API-Client/graph/badge.svg?token=O64HJ8B0BF)](https://codecov.io/gh/martelman/NoteDx-API-Client)
![PyPI](https://img.shields.io/pypi/v/notedx-sdk)
![Last Commit](https://img.shields.io/github/last-commit/martelman/NoteDx-API-Client)
![PyPI - Downloads](https://img.shields.io/pypi/dm/notedx-sdk)


# 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](https://notedx-api.web.app/auth/login)

## 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

```bash
pip install notedx-sdk
```

## Quick Start

```python
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

```bash
# 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](https://martelman.github.io/NoteDx-API-Client/).

## License

Copyright © 2025 Technologies Medicales JLA Shiftpal inc. All rights reserved.
            

Raw data

            {
    "_id": null,
    "home_page": "https://www.notedxai.com/contact-8-1",
    "name": "notedx-sdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0.0,>=3.8.2",
    "maintainer_email": null,
    "keywords": "medical, notes, transcription, healthcare, api, AI, scribe, AI-scribe, pharmacy, nursing, radiology, procedures, medicalSpecialties, HIPAA, PIPEDA, Canada, USA, Quebec",
    "author": "Julien Martel",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/6d/22/5039bcdfe2fd20f125d45d9100ee2a7ee3cc7c5e95f45940236bf7b6597c/notedx_sdk-0.1.9.tar.gz",
    "platform": null,
    "description": "[![Tests](https://github.com/martelman/NoteDx-API-Client/actions/workflows/test.yml/badge.svg)](https://github.com/martelman/NoteDx-API-Client/actions/workflows/test.yml)\n[![codecov](https://codecov.io/gh/martelman/NoteDx-API-Client/graph/badge.svg?token=O64HJ8B0BF)](https://codecov.io/gh/martelman/NoteDx-API-Client)\n![PyPI](https://img.shields.io/pypi/v/notedx-sdk)\n![Last Commit](https://img.shields.io/github/last-commit/martelman/NoteDx-API-Client)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/notedx-sdk)\n\n\n# NoteDx API Python Client\n\nOfficial 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.\n\nAPI console, click [here](https://notedx-api.web.app/auth/login)\n\n## Features\n\n- Audio to medical note conversion\n- Support for multiple languages (English, French)\n- Multiple medical note templates\n- Real-time job status tracking\n- Webhook integration\n- Usage monitoring\n- HIPAA and PIPEDA compliant\n\n## Installation\n\n```bash\npip install notedx-sdk\n```\n\n## Quick Start\n\n```python\nfrom notedx_sdk import NoteDxClient\n\n# Initialize client\nclient = NoteDxClient(api_key=\"your-api-key\")\n\n# Process audio file\nresponse = client.notes.process_audio(\n    file_path=\"visit.mp3\",\n    visit_type=\"initialEncounter\",\n    recording_type=\"dictation\",\n    template=\"primaryCare\",\n    lang=\"en\",\n    documentation_style=\"problemBased\",\n    output_language=\"fr\",\n    custom={\n        \"context\": \"Patient is 30 years old, male, with a history of hypertension and diabetes.\",\n        \"template\": \"A custom template for your use case\"\n    },\n    custom_metadata={\n        \"custom_metadata\": \"Some custom metadata for your use case\"\n    }\n)\n\n# Get job ID\njob_id = response[\"job_id\"]\n\n# Check status - ( Or better, use the webhook implementation )\nstatus = client.notes.fetch_status(job_id)\n\n# Get note when ready\nif status[\"status\"] == \"completed\":\n    note = client.notes.fetch_note(job_id)\n```\n\n## Supported Audio Formats\n\n- MP3 (.mp3)\n- MP4/M4A (.mp4, .m4a)\n- AAC (.aac)\n- WAV (.wav)\n- FLAC (.flac)\n- PCM (.pcm)\n- OGG (.ogg)\n- Opus (.opus)\n- WebM (.webm)\n\n## Development\n\n```bash\n# Install Poetry (if not already installed)\ncurl -sSL https://install.python-poetry.org | python3 -\n\n# Install dependencies\npoetry install\n\n# Run tests\npoetry run pytest\n```\n\n## Documentation\n\nFor complete documentation, visit [NoteDx API Documentation](https://martelman.github.io/NoteDx-API-Client/).\n\n## License\n\nCopyright \u00a9 2025 Technologies Medicales JLA Shiftpal inc. All rights reserved.",
    "bugtrack_url": null,
    "license": "Proprietary",
    "summary": "Official Python SDK for the NoteDx API - a powerful medical note generation service, fully compliant to healthcare regulations in the US and Canada.",
    "version": "0.1.9",
    "project_urls": {
        "Documentation": "https://martelman.github.io/NoteDx-API-Client/",
        "Homepage": "https://www.notedxai.com/contact-8-1",
        "Repository": "https://github.com/martelman/NoteDx-API-Client"
    },
    "split_keywords": [
        "medical",
        " notes",
        " transcription",
        " healthcare",
        " api",
        " ai",
        " scribe",
        " ai-scribe",
        " pharmacy",
        " nursing",
        " radiology",
        " procedures",
        " medicalspecialties",
        " hipaa",
        " pipeda",
        " canada",
        " usa",
        " quebec"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "decf2515a24a9e4740f0420f38210d8cf8f8f426e4a8cb213b6e394db0883a0f",
                "md5": "c8ba60bf32ac11c1c9b8feceafca0534",
                "sha256": "33a3a060fd7d5f931178f4bfa811bc6416dd21d0e2b7d25320d32fc8cb01ffc8"
            },
            "downloads": -1,
            "filename": "notedx_sdk-0.1.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c8ba60bf32ac11c1c9b8feceafca0534",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0.0,>=3.8.2",
            "size": 38776,
            "upload_time": "2025-02-15T21:43:39",
            "upload_time_iso_8601": "2025-02-15T21:43:39.817031Z",
            "url": "https://files.pythonhosted.org/packages/de/cf/2515a24a9e4740f0420f38210d8cf8f8f426e4a8cb213b6e394db0883a0f/notedx_sdk-0.1.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6d225039bcdfe2fd20f125d45d9100ee2a7ee3cc7c5e95f45940236bf7b6597c",
                "md5": "c68ca7e8b1ceb347065983baf73ae80e",
                "sha256": "3b512633ebf820af3e4a85fbf2092af2fdb1810dde56e59b9a558ab3ab28a8f3"
            },
            "downloads": -1,
            "filename": "notedx_sdk-0.1.9.tar.gz",
            "has_sig": false,
            "md5_digest": "c68ca7e8b1ceb347065983baf73ae80e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0.0,>=3.8.2",
            "size": 33924,
            "upload_time": "2025-02-15T21:43:41",
            "upload_time_iso_8601": "2025-02-15T21:43:41.465648Z",
            "url": "https://files.pythonhosted.org/packages/6d/22/5039bcdfe2fd20f125d45d9100ee2a7ee3cc7c5e95f45940236bf7b6597c/notedx_sdk-0.1.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-15 21:43:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "martelman",
    "github_project": "NoteDx-API-Client",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "notedx-sdk"
}
        
Elapsed time: 0.44012s