Delivery API

The delivery API supports the following functions:

• Let the report areas list and download adverse incident reports with attachments
• Notify the report areas when new reports have arrived and is ready for download

The API consists of five endpoints:

• Events
  Endpoint for client events. Server notifies (SSE) client when new reports arrive
• List reports
  List all unread reports for a specified report area
• Get report
  Get a specific report
• Get attachment
  Get a specific attachment for a specific report
• Mark as read
  Mark the report as read

Authentication

Clients must be authenticated by HelseId in order to call the API. DPoP must be used. For dotnet clients the Nuget package, HelseId library, is recommended. Take a look here

Authorization

In order to call delivery API endpoints, the following criteria must be met:

• The client must be authenticated by HelseId
• The client id must be registered in the Melde system and associated with the correct report area
• The client must have a valid delivery API scope, allowing access to the delivery API

Test client

A test client has been made to make it easier to get started developing API clients. Can be found on GitHub

You will need a JSON web key (JWK) in order to use the test client. Please see here on how to get started.