Welcome to the Noa Notes Integration REST API!
This API is used to integrate Noa Notes with your existing systems. It allows you to create sessions, retrieve session statuses, and summaries.
Here is the available OpenAPI that you can import to Postman: noa_notes_integration.postman_collection.json.
Authentication is based on clients of the API. The new client is set up by the Docplanner Team and provided to the development team of the client.
Authenticates a client and returns an access token.
A client is a service that wants to use the Noa Notes API.
| clientId | string <uuid> |
| secret | string or null |
{- "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
- "secret": "string"
}A consumer is an external system that consumes the Noa Notes Integration API.
Each client is meant to be a separate consumer.
The default configuration of the business logic for the other endpoints (e.g. default WebHook, Language, Speciality, Template) is being configured on the consumer level.
Creates a new session.
In this endpoint, episodeId, doctorId, and facilityId are IDs coming directly from your software. We consider them as external IDs on our side.
If a session already exists for the given episodeId, doctorId, and facilityId tuple, and its status is not a final nor an error one, the existing session will be returned. It can allow you to resume a session UI-wise in the widget.
| api-version | string |
| episodeId required | string or null |
| doctorId required | string or null |
| webhookUrl | string or null |
object or null | |
| visitType | string or null Enum: "FirstVisit" "FollowUpVisit" null
|
object or null | |
| facilityId | string or null |
| language | string or null Enum: "en-US" "pl-PL" "pt-BR" "pt-PT" "es-MX" "es-ES" "es-AR" "es-CO" "es-CL" "es-PE" "it-IT" "de-DE" "cs-CZ" "tr-TR" null |
| speciality | string or null |
{- "episodeId": "episode-123",
- "doctorId": "doctor-456",
- "template": {
- "value": {
- "Personal Information": "Include patient demographics and insurance information",
- "Reason for the Visit": "Detailed description of the presenting problem"
}
}, - "visitType": "FirstVisit",
- "metadata": {
- "key1": "value1",
- "key2": "value2"
}, - "facilityId": "facility-789",
- "language": "en-US",
- "speciality": "psychiatrist"
}Retrieves the summary of a specific session. Returned data contains the content of the summary and information if a doctor approved its content in the Edit/Confirm Summary page.
| sessionId required | string <uuid> |
| api-version | string |
Recover the original summary content from the recorder. The completion of the recovery will be notified via webhook. Recovered summary needs to be verified again.
| sessionId required | string <uuid> |
| api-version | string |
Regenerate the original summary content from the recorder. The completion of the regeneration will be notified via webhook. Regenerated summary needs to be verified again.
| sessionId required | string <uuid> |
| api-version | string |
A session is meant to serve as a single usage of Noa Notes with a specific expiration time. The client needs to create a new session to receive a Noa Notes Recorder URL enabling the doctor to open the Noa Notes Recorder. The result of a session is a summary of the appointment, which should be used to populate EHR data in the client application.
Each session can be created with specific optional parameters, if not provided then default configuration from the consumer configuration will be applied.
Metadata parameters may contain any additional data that you want to share.
Retrieves the status of a specific session.
This endpoint might be used proactively by the client to check statuses of a given session. An alternative scenario is for the client to expose a webhook that will be used by the Noa Notes Integration API to notify about status changes of the sessions.
| sessionId required | string <uuid> |
| api-version | string |
| externalFacilityId required | string |
| name required | string or null |
| externalDoctorId required | string or null |
{- "name": "string",
- "externalDoctorId": "string"
}| externalFacilityId required | string |
| externalDoctorId required | string |
| name required | string or null |
{- "name": "string"
}