Status

The status-endpoint returns the privacy settings the patient may have set.

If the patient has set a kjernejournal reservation no patient health records (journaldokumenter) for the patient exists in kjernejournal. If the patient has set a restriction for access to kjernejournal or specifically for patient health records (journaldokumenter) an extra consent must be given for access.

Note that we prefer that clients requests the status-endpoint first for each session in order to determine whether the patient has set restriction or reservation. This will improve the user experience as extra consent must be given for access in that case. See the nhn-access-basis header for how to set consent.

Authorization

The endpoint requires a HelseID user token for authentication. DPoP must be used.

When a user token is used, the response contains a flag if the users HPR number is blocked or not (see below).

Also when a user token is used all the required headers must be set as usual. The "nhn-access-basis" header MUST in this case always be set to UNNTAK. Note that we do not do any audit logging for requests to the /status endpoint.

Input

Curl example: Request status for patient

curl --location --request POST 'https://api.pjd.test.nhn.no/status' \
--header 'Authorization: DPoP eyJhbGciOiJSUzI1NiI......<<DPoP authorization bearer token>' \
--header 'DPoP: <DPoP proof token>' \
--header 'nhn-source-system: My EPJ system name' \
--header 'nhn-patient-nin: 10086055555' \
--data '{"nin":"10086055555"}'

Response

Response example

{
    "patientNIN": "10086055555",    
    "privacySetting": {
        "hasReservationKjernejournal": false,
        "isRestricted": false,
        "isBlocked": false
    }
}