Noa Notes Integration

Appearance

Configuration options ​

In the Noa Notes Integration you may configure:

  • Webhook
  • Template
  • Language
  • Specialization
  • Patient gender (per session only)

Consumer Level Configuration ​

Consumer configuration is configured by Docplanner Team when setting up the new PMS integration. The Docplanner Team can support you in adjusting the configuration for your needs. To understand the current configuration you may call:

Endpoint: GET /api/v1/consumers/me

Parameters:

  • api-version (query, optional): API version string

Headers required:

  • Authorization: Bearer <accesToken>

Response:

  • 200 OK
json
{
  "id": "string (uuid)",
  "name": "string",
  "isEnabled": "boolean",
  "isTermsAndConditionsEnabled": "boolean",
  "createdAt": "string (date-time, UTC without offset, e.g. 2026-09-09T08:41:07.482)",
  "updatedAt": "string (date-time, UTC without offset, e.g. 2026-09-09T08:41:07.482)",
  "defaultWebhook": "string (url)",
  "defaultLanguage": "string (example: en-US)",
  "defaultSpeciality": "string",
  "defaultTemplate": "string",
  "legalDocumentType": "string (TermsAndConditions | Eula)"
}
  • 400 Bad Request
  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not Found

Configuration options:

  • Legal document type (legalDocumentType: TermsAndConditions | Eula) — the legal document the doctor accepts in the widget. Set by Docplanner when the consumer is created; it cannot be changed afterwards.
  • Whether to require legal document acceptance (isTermsAndConditionsEnabled) — controls whether the doctor must accept the consumer's legal document (T&C or EULA, see legalDocumentType).

Session Level Configuration ​

When creating a new session, you may overwrite the default configuration for a given session. If your PMS supports doctors covering appointments in different languages or in a context of different medical specializations, you may require another specialization for a one-off episode. Also, the EHR template for the final notes in the PMS system may differ.

To meet the needs of a given session / episode / appointment, you can specify the configuration when creating the new session:

⚠️ Important: POST /api/v1/consumers/sessions returns HTTP 404 if template, language, and speciality are not provided in the request body and are not configured at the consumer level. Before going live, call GET /api/v1/consumers/me to verify that your consumer has default values set for these fields, or include them explicitly in every session creation request.

bash
curl -X POST https://integration.notes.sandbox-europe.noa.ai/api/v1/consumers/sessions \
-H "Authorization: Bearer {accessToken}" \
-H "Content-Type: application/json" \
-d '{
  "episodeId": "string", // *Required
  "doctorId": "string", // *Required
  "webhookUrl": "string",
  "template": "string",
  "visitType": "FirstVisit|FollowUpVisit",
  "metadata": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "facilityId": "string",
  "language": "string",
  "speciality": {
    "value": "string"
  },
  "patientGender": "Male|Female|Neutral"
}'

Example request

json
{
    "episodeId": "episode-2222",
    "doctorId": "doctor-42226",
    "template": {
        "value": {
            "Reason for the Visit": "Chief complaint and symptoms",
            "Medical History": "Relevant past conditions, medications, and allergies",
            "Physical Examination": "Key findings from the physical exam",
            "Assessment": "Clinical impression or diagnosis",
            "Plan": "Treatment plan, prescriptions, and follow-up steps"
        }
    },
    "webhookUrl": "https://webhook.site/753e30ec-308c-4b63-80b2-c05d8759a227",
    "visitType": "FollowUpVisit",
    "facilityId": "facility-789",
    "language": "es-ES",
    "speciality": "psychology",
    "patientGender": "Female"
}

Example response:

json
{
    "sessionToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJhMTIzZGVmLTg3NjUtNDU2Yi1iYmNmLWQxMjM0NTY3ODlhYiIsImlhdCI6IjE3NTMyMzAwMDAwMDAiLCJzZXNzaW9uSWQiOiJhYmNkZWYxMjMtNDU2Ny04OTBhLWJjZGYtZmVkY2JhOTBhNzg5IiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZWlkZW50aWZpZXIiOiJjNDU2NzgwLTEyMzQtNGFiZi1iYWJjLWRlZmdoaWprbGxtbiIsImRvY3RvcklkIjoiZG9jdG9yLTEyMzQ1IiwiZXBpc29kZUlkIjoiZXBpc29kZS0zMjE0IiwiZmFjaWxpdHlJZCI6ImZhY2lsaXR5LTEyMzQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOiJ1c2VyIiwibmJmIjoxNzUzMjMwMDAwLCJleHAiOjE3NTMzMTY0MDAsImlzcyI6Ik5vYU5vdGVzIn0.z-1Mx2qzPqKwEb5VoT-9YYQsmX2qFaYsFwtUQKKJ6RI",
    "sessionId": "0f0e023d-2a3a-42cd-9d64-9ed2eb2fbd16",
    "consumerId": "b23279c0-4831-4d17-b69a-2c3a815730ba",
    "expiresIn": 86399,
    "recorderUrl": "https://integration.notes.sandbox-europe.noa.ai/recorder/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJhMTIzZGVmLTg3NjUtNDU2Yi1iYmNmLWQxMjM0NTY3ODlhYiIsImlhdCI6IjE3NTMyMzAwMDAwMDAiLCJzZXNzaW9uSWQiOiJhYmNkZWYxMjMtNDU2Ny04OTBhLWJjZGYtZmVkY2JhOTBhNzg5IiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZWlkZW50aWZpZXIiOiJjNDU2NzgwLTEyMzQtNGFiZi1iYWJjLWRlZmdoaWprbGxtbiIsImRvY3RvcklkIjoiZG9jdG9yLTEyMzQ1IiwiZXBpc29kZUlkIjoiZXBpc29kZS0zMjE0IiwiZmFjaWxpdHlJZCI6ImZhY2lsaXR5LTEyMzQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOiJ1c2VyIiwibmJmIjoxNzUzMjMwMDAwLCJleHAiOjE3NTMzMTY0MDAsImlzcyI6Ik5vYU5vdGVzIn0.z-1Mx2qzPqKwEb5VoT-9YYQsmX2qFaYsFwtUQKKJ6RI
?language=es-ES&version=1&redirectUrl=https%3A%2F%2Fintegration.notes.sandbox-europe.noa.ai%2F%23%2Fsession",
    "doctorId": "doctor-42226",
    "episodeId": "episode-2222",
    "facilityId": "facility-789",
    "summaryUrl": "https://integration.notes.sandbox-europe.noa.ai/#/session/0f0e023d-2a3a-42cd-9d64-9ed2eb2fbd16?login-token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJhMTIzZGVmLTg3NjUtNDU2Yi1iYmNmLWQxMjM0NTY3ODlhYiIsImlhdCI6IjE3NTMyMzAwMDAwMDAiLCJzZXNzaW9uSWQiOiJhYmNkZWYxMjMtNDU2Ny04OTBhLWJjZGYtZmVkY2JhOTBhNzg5IiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZWlkZW50aWZpZXIiOiJjNDU2NzgwLTEyMzQtNGFiZi1iYWJjLWRlZmdoaWprbGxtbiIsImRvY3RvcklkIjoiZG9jdG9yLTEyMzQ1IiwiZXBpc29kZUlkIjoiZXBpc29kZS0zMjE0IiwiZmFjaWxpdHlJZCI6ImZhY2lsaXR5LTEyMzQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOiJ1c2VyIiwibmJmIjoxNzUzMjMwMDAwLCJleHAiOjE3NTMzMTY0MDAsImlzcyI6Ik5vYU5vdGVzIn0.z-1Mx2qzPqKwEb5VoT-9YYQsmX2qFaYsFwtUQKKJ6RI
"
}

Patient Gender ​

Makes Noa write the summary in the correct grammatical gender. Optional, per session only — there is no consumer-level default.

Values are strings: "Male", "Female", or "Neutral" for a non-binary or unspecified gender. An unrecognised value returns 400.

Omit it and Noa infers gender from the transcription, as before. An omitted value is never substituted with a default, and the response does not echo the field back.

Copyright © 2007 - 2026 Docplanner