Introduction

Informasjon fra Kommunal Journal (IKJ) offers an API for submitting and retrieving patient-related data from municipalities' health records on a per-municipality basis. The types of information includes patients, health care services, visitation schedules etc. The figure below shows the typical information flow.

1. Health workers adds or updates patient-related information in the municipality's EHR system.
2. The EHR system synchronizes with IKJ, adding new information to the health records.
3. Other health systems in the municipality read information from IKJ, through periodic updates and/or user requests.

API

The IKJ API include endpoints for submitting and retrieving patient-related data, represented using the FHIR standard, version R4. FHIR resources used to represent health data are:

• Patient: Patient information, such as NIN, name, address etc.
• EpisodeOfCare: Patients' health care services.
• CarePlan: Patients' visitation schedules.

Authentication with HelseID

Accessing the IKJ APIs requires clients to be authenticated using HelseID and DPoP (Demonstrating Proof-of-Possession):

1. Scope: Clients must request access to scopes nhn:ikj/api.read / nhn:ikj/api.write for read / write access, respectively.
2. Claim: Access token must include claim helseid://claims/client/claims/orgnr_parent.
3. DPoP required: Only requests including DPoP tokens are accepted.
4. Authorization header: Access token must be sent using the DPoP prefix (i.e., not Bearer).
5. DPoP-Proof: Requests must include a DPoP header with a signed proof generated by the client.

See HelseID documentation for implementation details.

Getting started

The following resources might help you to get started using IKJ API:

• Step-by-step getting started guide
• Overview of how to use the API
• OpenAPI documentation, try it out!
• HelseID documentation