Response codes, their associated FHIR elements and value sets.
Overview
This section details how the ITK3 response codes are carried in the FHIR MessageHeader and OperationOutcome resources.
The MessageHeader carries a code to indicate success or failure. The ITK3 response codes must be mapped to the high-level element codes carried in the severity, code and details elements of the OperationOutcome. The mapping Table below shows how the three levels of codes should be utilised.
Note: When a bundle is incorrectly constructed or received so that the value of the acknowledgement flags cannot be determined, receiving systems must default to always return a response wherever possible.
Mapping FHIR Error or Warning Codes to ITK3 Response Codes
The following sections show how the ITK3 response codes are used with the FHIR required codes within the ITK3 MessageHeader and OperationOutcome.
Infrastructure (Technical) Level Response Codes
These responses will be returned using the ITK3 Response message if requested by sender, using the appropriate handling key.
Minimum requirements that MUST be supported by receiving systems.
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome elements |
| issue.severity |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
processing |
Processing Failure |
Processing issues. These are expected to be final e.g. there is no point resubmitting the same content unchanged. |
| issue.details.code |
ITK-Response-Codes |
10001 |
Handling Specification Error |
A generic error code which gives a minimum level
of assurance that systems can share the minimum information
relating to Handling Specification faults. |
Requirement that SHOULD be supported by receiving systems.
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome elements |
| issue.severity.code |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
processing |
Processing Failure |
Processing issues. These are expected to be final e.g. there is no point resubmitting the same content unchanged. |
|
A code from the list below which is applicable for the handling specification which has an error. Example usage is for incorrect or unreadable values.
|
| issue.details.code |
ITK-Response-Codes |
10002 |
Infrastructure Level Response Value - Processing Error |
The handling specification flag for infrastructure level response is present but cannot be processed. For example may be unreadable or contain an incorrect value |
| issue.details.code |
ITK-Response-Codes |
10003 |
Business Level Response Value - Processing Error |
The handling specification flag for business level response is present but cannot be processed. For example may be unreadable or contain an incorrect value |
| issue.details.code |
ITK-Response-Codes |
10004 |
Message Definition Value – Processing Error |
The handling specification value for Message Definition is present but cannot be processed. For example may be unreadable or contain an incorrect value. The handling specification for Message Definition is present but cannot be processed. For example, may be unreadable or contain an incorrect value. This may also be returned when the message type is not supported (known) by the receiving system. |
| issue.details.code |
ITK-Response-Codes |
10005 |
Message Definition Version Value – Processing Error |
The handling specification for Message Definition is present but the version is not supported by the receiving system. |
| issue.details.code |
ITK-Response-Codes |
10007 |
Sender Reference Value - Processing Error |
The handling specification string for Sender Reference is present but cannot be processed. For example may be unreadable, contain an incorrect value or the use of Sender Reference is not supported by receiving system |
| issue.details.code |
ITK-Response-Codes |
10008 |
Handling Specification Business Rule Error |
The Handling Specification usage does not match business rules for included Payload. For example an acknowledgement flag defined as mandatory by the Payload specification is missing. |
| issue.details.code |
ITK-Response-Codes |
10009 |
Unreadable message received |
A message has been received that is either corrupted or malformed and cannot be read by the receiving system. |
| issue.details.code |
ITK-Response-Codes |
10010 |
Recipient Type - Processing Error |
The handling specification for Recipient Type is present but cannot be processed. For example, may be unreadable or contain an incorrect value. |
These responses will be returned using the ITK3 Response message if requested by sender, using the appropriate handling key.
The system SHOULD support the extension values as below
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
ok |
OK |
The message was accepted and processed without error. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
information |
Information |
The issue has no relation to the degree of success of the action. |
| issue.code |
IssueType |
informational |
Informational Note |
A message unrelated to the processing success of the completed operation |
| issue.details.code |
ITK-Response-Codes |
20013 |
Success |
The Message has been processed successfully. An response will be returned stating the fact. However, the message may still fail after further processing and result in another response if the business level response request flag has been sent to “true”. |
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
not-found |
Not Found |
The reference provided was not found. In a pure RESTful environment, this would be an HTTP 404 error, but this code may be used where the content is not found further into the application architecture. |
| issue.details.code |
ITK-Response-Codes |
200001 |
Unrecognised Recipient Person |
The person referred to as the recipient in the ITK3 MessageHeader is not recognised. |
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
not-found |
Not Found |
The reference provided was not found. In a pure RESTful environment, this would be an HTTP 404 error, but this code may be used where the content is not found further into the application architecture. |
| issue.details.code |
ITK-Response-Codes |
20002 |
Unrecognised Recipient Organisation |
The organization referred to as the recipient in the ITK3 MessageHeader is not recognised. |
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
not-found |
Not Found |
The reference provided was not found. In a pure RESTful environment, this would be an HTTP 404 error, but this code may be used where the content is not found further into the application architecture. |
| issue.details.code |
ITK-Response-Codes |
20003 |
Unrecognised Sender |
The organization or person referred to as the sender in the ITK3 MessageHeader is not recognised. Note: This code should not be used where the domain makes use of the “GP look-up” functionality in MESH. |
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
security |
Security |
An authentication/authorization/permissions issue of some kind. |
| issue.details.code |
ITK-Response-Codes |
20004 |
Non Approved file type received as an attachment |
The Receiving system has received an attached file whose file type is not approved for the business domain. |
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
security |
Security |
An authentication/authorization/permissions issue of some kind. |
| issue.details.code |
ITK-Response-Codes |
20005 |
Unsupported file type received as an attachment |
The Receiving system has received an attached file which it does not support. |
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
- invalid
- structure
- required
- value
- processing
- code-invalid
- extension
|
|
Dependent of the type of content error. invalid is the high level code, lower level codes should be used to further identify the type of content validation error wherever possible. See IssueType for further information.
|
| issue.details.code |
ITK-Response-Codes |
20006 |
ITK3 header validation failure |
The ITK3 header resources or elements are not correct or understandable. For example, the ITK3 Bundle or ITK3 MessageHeader. |
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
duplicate |
Duplicate |
An attempt was made to create a duplicate record. |
| issue.details.code |
ITK-Response-Codes |
20007 |
Duplicate Message received |
Bundle with this message identifier has already been processed. A Payload with this message identifier has already been received and processed by this recipient. |
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
duplicate |
Duplicate |
An attempt was made to create a duplicate record. |
| issue.details.code |
ITK-Response-Codes |
20008 |
Duplicate Document received |
Bundle with this document identifier has already been processed. A Payload with this document identifier has already been received and processed by this recipient. |
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
- invalid
- structure
- required
- value
- invariant
- processing
- not-supported
- code-invalid
- extension
- business-rule
|
|
Dependent of the type of content error. invalid is the high level code, lower level codes should be used to further identify the type of content validation error wherever possible. See IssueType for further information.
|
| issue.details.code |
ITK-Response-Codes |
20009 |
Payload validation failure |
Content validation has failed |
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
not-found |
Not Found |
The reference provided was not found. In a pure RESTful environment, this would be an HTTP 404 error, but this code may be used where the content is not found further into the application architecture. |
| issue.details.code |
ITK-Response-Codes |
20010 |
Unrecognised Payload Recipient Organisation |
The Recipient Organisation identified in the Payload, is not supported by this End Point (Receiving System). |
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
not-found |
Not Found |
The reference provided was not found. In a pure RESTful environment, this would be an HTTP 404 error, but this code may be used where the content is not found further into the application architecture. |
| issue.details.code |
ITK-Response-Codes |
20011 |
Unrecognised Payload Recipient Person |
The Recipient person identified in the Payload, is not supported by this End Point (Receiving System). |
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
security |
Security Problem |
An authentication/authorization/permissions issue of some kind. |
| issue.details.code |
ITK-Response-Codes |
20012 |
Unauthorised Sender |
The Receiving system identified in the Payload is configured to reject messages from unauthorised senders. This code should not be used where the domain makes use of the “GP look-up” functionality in MESH. |
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
processing |
Processing Failure |
Processing issues. These are expected to be final e.g. there is no point resubmitting the same content unchanged. |
| issue.details.code |
ITK-Response-Codes |
20014 |
Unable to Process Replacement Document |
A replacement document was received, but the receiver could not process the new document correctly and has therefore marked the new and original documents as "bad" on its system. |
ITK3 Business Level Response Codes
These responses will be returned using the ITK3 Response message if requested by sender, using the appropriate handling key.
Minimum requirements that MUST be supported.
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
ok |
OK |
The message was accepted and processed without error. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
information |
Information |
The issue has no relation to the degree of success of the action. |
| issue.code |
IssueType |
informational |
Informational Note |
A message unrelated to the processing success of the completed operation. |
| issue.details.code |
ITK-Response-Codes |
30001 |
Patient known here. (e.g. Patient is registered here) |
|
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
not-found |
Not Found |
The reference provided was not found. In a pure RESTful environment, this would be an HTTP 404 error, but this code may be used where the content is not found further into the application architecture. |
| issue.details.code |
ITK-Response-Codes |
30002 |
Patient not known here. (aka ‘patient record not present in system’) |
|
| Element |
CodeSystem |
Value |
Display |
Definition |
| MessageHeader |
| response.code |
ResponseType |
fatal-error |
Fatal Error |
The message was rejected because of a problem with the content. There is no point in re-sending without change. |
| OperationOutcome |
| issue.severity.code |
IssueSeverity |
fatal |
Fatal |
The issue caused the action to fail, and no further checking could be performed. |
| issue.code |
IssueType |
business-rule |
Business Rule Violation |
The content/operation failed to pass some business rule, and so could not proceed. |
| issue.details.code |
ITK-Response-Codes |
30003 |
Patient no longer at this clinical setting |
|
