Publisert - 05.12.2025

Patient information API

A patient info record is a json-object, consisting of a patient info "root" object, with sub-objects containing information about the patient. The different sub-objects are documented in the resources file.

Any changes to any of the sub-objects are stored as events, creating new versions of the updated resources. This makes it possible to keep track of all changes, when they happened, and who made them, creating a versioned history of the patient information.

The information about the updates are stored as metadata for each of the resources. More information about the metadata can be found the metadata documentation.

For all endpoints, the patient is specified in the header nhn-patient-nin, so no other parameters are needed.

Endpoints

Available endpoints are listed below

URL Method Description
/patientInfo GET Get all resources with information about a patient
/communicationNeeds GET Get a list of all communication needs for a patient
/communicationNeeds POST Create communication needs for a patient
/communicationNeeds PUT Update communication needs for a patient

Authorization

To call the patient information API, a HelseID user token is required. See the authorizations-docs for details.

Creating patient information

In order to create a patientInfo record for a patient, one or more resources should be created. There is no endpoint for creating a patientInfo record, since this is automatically added if a resource for the patient is created.

The patient information record is just a shell, containing all other resources.

Søk i Utviklerportalen

Søket er fullført!