Purpose of the API

The API can simplify the work of healthcare professionals related to an overview of patients' medicines by notifying healthcare professionals in the clinical system if the patient has received new drug information in kjernejournal.

The API is used to notify if the patient has received new drug information in kjernejournal. This enables the clinical system to check whether there have been changes in medication since the last health personnel downloaded information about medicines from kjernejournal.

The clinical system must be able to request kjernejournal for information for one or more patients. Maximum number of patients that can be included in the query.

When the clinical system asks kjernejournal if there are any changes, the time for the previous query must be sent along. Kjernejournal responds with the following information:

• Whether the patient has a kjernejournal or not

• Whether there has been new drug information since the previous query (true / false)

• Timestamp for the query (which the clinical system can take care of and send with at the next query)

Whether new drug information has been received or not should be based on whether one of the following message types has been created on the patient in kjernejournal after the time of the previous query:

• E-prescription (M1)

• Recall of prescription (M5)

• LIB message from doctor (M25.1)

• Delivery (M8.1) on a new paper prescription (new prescription = prescription ID for which there are no deliveries before)

• Application response rejected from Statens legemiddelverk (SLV) (M15)

Information about the API

Type API

REST

Swagger

https://api.st2.kjernejournal-test.no:8000/v1/legemiddelvarsling/swagger-ui.html

Authentication

Organization authentication with HelseID.

Versioning and changes

Versioning is indicated in the API URL: / v1 /

Norsk helsenett plans to support at least 2-3 versions of an API. Details of their release schedule, support and documentation will be published later.

Integration guide

See integration guide for Rest API for all details, includes information about errorcodes and messages:

Integration Guide: Kjernejournal REST API using HelseID as authenticator