APIs and Events
This is a description of the overall eHealth Infrastructures Application Programming Interfaces (API) and business and technical events produced by the eHealth Infrastructure.
Content
Subpages
- Reporting API — Reporting API for extracting statistics, management & usage reports as well as complete reports about individuals.
- Key Value Store API — The Key/Value store is available for storing properties and configuration values that does not fit into the FHIR based infrastructure.
- Key Service API
- HTTP Error Codes - Clinical and Administrative Domain — Description of the HTTP error codes returned by the Clinical Domain and Administrative Domain when exceptions occur. The intended audience is solution developers who develop eHealth applications or solutions on the eHealth infrastructure.
- Common Workplace API
- Notifications Published by the Infrastructure to the National Notification Service — This page describes how the eHealth Infrastructure communicates key healthcare events to Denmark’s National Notification Service (NAS). It outlines the types of notifications published—such as new care plans, updated patient measurements, or task creation—and provides examples of the JSON payloads used. These notifications enable external systems to stay synchronized by subscribing to specific topics and reacting to real-time updates in patient care workflows.
- Event Model — This page describes the types of event messages that are published to destinations (topic/queue) on the message broker for the eHealth Infrastructure
- Storage Service API
- Assisted Login API
API and Events
Unless stated explicitly otherwise, the operations of the APIs described in the following are:
Protected by the security mechanism described in Security Mechanisms . Per the particular operation of the API, the Access Control in eHealth Services entry for that operation should be noted and adhered to.
entailing a transaction scope that encompasses the REST operation
An overview of past and present versions of the APIs is available here.
Clinical Administrative Domain
The Clinical Administrative Domain API is described in:
Clinical Domain
The Clinical Domain API is described in:
Reporting API
For statistics, management reports and individual reports are part of the eHealth Infrastructure Implementation Guide.
Common Workplace API
The Common Workplace API (in Danish: Fælles arbejdsplads) is a framework for making user applications based on micro frontends.
Additional APIs
Key Value Store API, see Key Value Store API . This API has its security model, also described on Key Value Store API .
Events
Invoking certain operations in the Clinical Administrative Domain and Clinical Domain causes the publishing of event messages. Details on events published are described in Service Event Messages.