General

The API for Melde bidirectional dialog may be used by both healthcare personnel (reporting side) and case managers at the report receiving side.

The most common use case is like this:

• A case manager creates a dialog and sends a message to the reporter in order to request more information (for instance)
• Then the reporter replies to the message, either from melde.no or directly from the reporting system, if integrated with Melde.

Currently case managers only are allowed to create new dialogs.

Endpoints

The API consists of four endpoints for managing Melde dialogs.

Documentation

Detailed documentation for the different endpoints are mainly found in the Swagger generated documentation. Below is a list of endpoints documentation which contains information not found in the Swagger documentation.

• Get dialog info
• Create dialog
• Send message
• Fetch new messages

Authentication

Clients must be authenticated by HelseId in order to call the API.

Authorization

Communication via Melde dialogs may take place when the following criteria is met:

• The client id must be registered in the Melde system
• The access token must contain valid scope(s), allowing access to the dialog service.

Two scopes are available:

• nhn:melde/dialog/opprett (Grants access to create new dialogs)
• nhn:melde/dialog/melding: (Grants access to send and get messages)