Error Handling

In the event that the critical-information API returns an error, the response body will contain a error message in JSON format in accordance with the OperationOutcome FHIR standard.

We're also sending all error codes in the response header nhn-error-code (see below). You can use this header if you're only interested in the error code to avoid parsing the response body. When error response the HTTP status will be in the range 3xx-5xx. When ok response the HTTP status will be in the 2xx range.

The error code, and other details, can also be found in OperationOutcome.issue.details.coding by searching for the relevant coding system shown in the example below.

The error message can be found in OperationOutcome.issue.diagnostics, and the event ID for the request in OperationOutcome.id.

The FHIR path in which the error occured is in OperationOutcome.issue.location. It may be empty.

Example of a error response body returned from the API:

{
  "resourceType": "OperationOutcome",
  "id": "c65f8f64-2c9c-4624-a4f0-3dbc4bde3300",
  "issue": [
    {
      "severity": "fatal",
      "code": "invariant",
      "diagnostics": "Invalid element content - max: 500",
      "location": [
        "Condition.note"
      ],
      "details": {
        "coding": [
          {
            "system": "http://nhn.no/hit/fhir/error/CodeSystem/ErrorCode",
            "code": "KI-0014"
          },
          {
            "system": "http://nhn.no/hit/fhir/error/CodeSystem/ErrorCodeKjLegacy",
            "code": "KI-0014"
          },
          {
            "system": "http://nhn.no/hit/fhir/error/CodeSystem/ApiVersion",
            "code": "v1"
          },
          {
            "system": "http://nhn.no/hit/fhir/error/CodeSystem/ApplicationVersion",
            "code": "8527aa3a"
          },
          {
            "system": "http://nhn.no/hit/fhir/error/CodeSystem/Environment",
            "code": "test1"
          },
          {
            "system": "http://nhn.no/hit/fhir/error/CodeSystem/ServiceName",
            "code": "critical-information"
          }
        ]
      }
    }
  ]
}

Error Codes

Authorization

For errors related to authorization go here.

Application Error Codes

As mentioned above we're sending all error codes in the response header nhn-error-code. Error codes has prefix "KI" (capital i).

In order to support Kjernejournal backwards compatibility we've kept some of the old error codes (prefix KJF). We're also sending all error codes in the response header X-KJ-Feilkode to keep backwards compatibility. Other Kjernejournal error codes which are not listed below are no longer in use for critical-information. Note that both the old Kjernejournal error codes and response header will be phased out in future API-versions.