uk.nhs.interoperability.consumer

Interface ITKMessageConsumer

All Known Implementing Classes:

CDARepository, ConsumerApplicationEmulator, NotificationRepository, RoutedApplicationEmulator, SimpleApplicationEmulator

public interface ITKMessageConsumer

API contract for between the transport and application layers for a message/document consumer application. In this context the message/document consumer may be the receiver of a clinical correspondence message such as a discharge advice or it may be the service provider in a query/response pattern such as Spine Mini Services.

It is anticipated that clinical applications will either implement this interface directly - or use an an adaptor that is compliant with this interface

Since:

version 0.1

Author:

Michael Odling-Smee, Nicholas Jones

Method Summary

Methods

Modifier and Type	Method and Description
void	onMessage(ITKMessage request) Call to process a request message where no application response is returned synchronously.
ITKMessage	onSyncMessage(ITKMessage request) Call to process a request message where the application response is returned synchronously (in the same thread)

Method Detail

onSyncMessage

@Requirement(traceTo="WS-PAT-01")
ITKMessage onSyncMessage(ITKMessage request)
                         throws ITKMessagingException

Call to process a request message where the application response is returned synchronously (in the same thread)

Parameters:

request - The itk request message to process. Examples might include an Spine Mini Services getPatientDetailsByNHSNumberRequest-v1-0 message

Returns:

an ITKMessage representing the application/business response to the provided request. The response may represent business processing success or failure depending on the contents of the request and the implementation of the underlying service.

Throws:

ITKMessagingException - if there are any syntactic, semantic or more general application processing issues when processing the request or constructing the response. In this context the ITKMessagingException should not be used to represent business processing failures such as a query returned no results - in general the underlying messaging specifications support "error" business response to support these types of failure.

onMessage

@Requirement(traceTo="WS-PAT-02")
void onMessage(ITKMessage request)
               throws ITKMessagingException

Call to process a request message where no application response is returned synchronously. This may be because no application response is expected, or because the resulting response will be sent back to the request originator asynchronously.

Parameters:

request - The itk request message to process. Examples might include an Spine Mini Services nonCodedCDADocument-v2-0 message

Throws:

ITKMessagingException - if there are any syntactic, semantic or more general application processing issues when processing the request or constructing the response. In general it is recommended that full syntactic and as much business level validation as practical is performed against the request prior to the method returning such that faults can be raised and reported back via the underlying transport. In this context the ITKMessagingException should not be used to represent business processing failures such as a query returned no results - in general the underlying messaging specifications support "error" business response to support these types of failure.