|
reporting-api |
||
| ... | ||
| endpoints | ||
| readme-toplevel.md |
Reporting API
The API for adverse incident reporting consists of two endpoints, one for report validation only and one for dispatching reports. Both endpoints accepts identical request payloads, but the dispatch endpoint also accepts attachments. The endpoints support combined reporting, which means that one single report may contain reporting for multiple report areas. Calling the validation endpoint is optional, since the dispatch endpoint also will validate requests before accepting them.
Each request payload contains a header part and a report part. The header contains generic information common to all report areas. The report part is specific to each report area.
Endpoints:
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 reporting 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 reporting API scope, allowing access to the 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.