Authorization

In order to be authorized to use the service the client must first be authenticated using HelseID or Helsenorge.

See curl examples of API requests to the service.

HelseID

A HelseID Bearer access token is required for authorization of organization and health care personell.

Note that the EPJ system must provide the org. nr. of the actual work place (point of care) of the health care personell when requesting the access token. This will make sure that the request is connected to the correct organization.

Claims

The client must do a token refresh/exchange with HelseID to set correct audience and scope for this service.

Claims for HelseID can be found here.

Documentation to set single audience can be found here

Headers

hit-user-role

Information about the role of the logged in user. Must be a valid JSON data structure. We require that the content of the header is always URL encoded to make sure all types of characters are transmitted correctly to the server.

Example:

{
    "system": "urn:oid:2.16.578.1.12.4.1.1.9060",
    "code": "LE"
}

The content of the "system" field is the coding system (kodeverk) for the type of role the user got.

The content of the "code" field is the role of the user. For HPR all roles must be according to Volven kodeverk 9060. Example HPR roles:

hit-access-basis

Which basis for access (grunnlag/tjenstlig behov) the user has to get access to data. "Forhøyet" must be used if requesting access to data which the patient has restricted access (sperring).

Note:
If the patient has not set restriction and the "Forhøyet"-values are used in this header, then you will recive an error. Overrule of restriction must only be done when the patient have actually set restriction. See status-endpoint.

hit-source-system

The name and version of the EPJ system, 3-512 characters. If the name contains Norwegian characters then the header content should be URL encoded to make sure all types of characters are transmitted correctly to the server.

Machine to machine token

A HelseID machine to machine token is a regular HelseID access token, but it does not contain the user pid claim or any other user data.

The main use case is to request certain endpoints without requiring the user to log into the EPJ or HelseID first. Whether to use it or not is up to the EPJ based on how the API is used.

The token must contain the following claims when HelseID machine to machine authorization:

Note that a machine to machine token must not contain the claim "helseid://claims/identity/pid". If so you will get an error.

Only the headers "hit-patient-pid" and "hit-source-system" are required for machine to machine tokens. The "content-type" header must also be set depending on the HTTP method used (see above).

Machine to machine authorization is used in the /status endpoint.

Helsenorge

For an inhabitant an Helsenorge access token is required.

Read about inhabitant authentication - Helsenorge as OpenID Connect provider here.

Claims

Overview claims for Helsenorge is found here.

Headers

Error codes authorization

We're sending all error codes related to authorization in the response header nhn-error-code. These error codes has prefix "AUTH".