Configuration options

In the Noa Notes Integration you may configure:

• Webhook
• Template
• Language
• Specialization

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

{
  "id": "string (uuid)",
  "name": "string",
  "isEnabled": "boolean",
  "createdAt": "string (date-time)",
  "updatedAt": "string (date-time)",
  "defaultWebhook": "string (url)",
  "defaultLanguage": "string (example: en-US)",
  "defaultSpeciality": "string",
  "defaultTemplate": "string"
}

• 400 Bad Request
• 401 Unauthorized
• 403 Forbidden
• 404 Not Found

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:

curl -X POST https://integration.notes.sandbox-europe.noa.ai/api/v1/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"
  }
}'

Example request

{
    "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"
}

Example response:

{
    "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
"
}