Getting Started with Noa Notes Integration

Introduction to Noa Notes Integrations

Noa Notes Integration enables Practice Management Systems (PMSes) to seamlessly connect with Noa Notes — an AI-powered tool that helps doctors record and summarize patient appointments in a structured, efficient way.

With the Noa Notes Integration API, you can embed Noa Notes directly into your workflows, allowing clinics to:

• Launch Noa Notes from within your system
• Receive structured summaries after each visit
• Automatically populate EHR modules with doctor notes

Why Integrate?

Integrating your PMS with Noa Notes brings significant value to doctors, patients, and developers:

• 🧠 Save time – Eliminate manual note-taking with AI-generated summaries
• ✅ Ensure quality – Use standardized documentation to reduce errors
• 🔁 Enable automation – Automate workflows between systems
• 📦 Deliver better UX – Let doctors stay in one interface while using Noa Notes

Use Cases

• Recording appointments – Open Noa Notes from your app
• Automated note-taking – Retrieve structured summaries generated by Noa Notes
• EHR population – Send summaries directly into patient records
• Custom workflows – Configure defaults (language, templates, webhook) per client

Workflow Overview

1. Integrate our NOA Notes widget within your system.
2. Provide a customized template to receive structured transaction data.
3. Start a recording session through the widget.
4. Automatically generate a transcription for review and acceptance by the doctor.
5. Receive a summarized version of the session with notes populated in the provided template.

Prerequisites

Before starting development, ensure that you:

• Have access to live and test credentials (provided by Docplanner)
• Know your assigned clientId and secret
• Have a backend capable of making HTTPS API calls and of receiving and processing HTTPS webhooks
• Have a frontend that supports HTML and JavaScript to render the Noa Notes widget

Integration Process Overview

To get started with your NOA Notes integration, follow these steps:

1. Request Access
   Reach out to us at integrations@docplanner.com to obtain your sandbox and live credentials (clientId and secret).

2. Schedule a Kick-Off Meeting
   Book a session with our integration specialist to align on project scope, timelines, and technical requirements.

3. Explore the API
   Review our API documentation and import the provided Postman collection to explore and test available endpoints.

4. Develop in the Sandbox
   Use our sandbox environment to begin development and safely test your integration.

5. Validate with Our Team
   Work closely with our Integrations team to review your implementation and ensure everything functions as expected.

6. Go Live
   Once your integration is validated, switch to the live environment and finalize deployment.

📥 Download Postman Collection
You can import our pre-configured Postman collection to begin testing right away:
noa_notes_integration.postman_collection.json

Acceptance Testing

Before moving to production, we’ll schedule a joint acceptance session with a Docplanner specialist. During this session:

• We’ll review the implemented integration flows
• We’ll walk through the official testing protocol
• Upon successful review, you’ll receive approval for production deployment

---

API Type & Methods

The NOA Notes Integration API is a RESTful API, adhering to standard HTTP method semantics:

HTTP Verb	Purpose
GET	Retrieve data or resources
POST	Create new resources or trigger actions
PUT	Fully update or replace a resource
PATCH	Partially update a resource
DELETE	Remove a resource