Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Content of the Protocol Terminators

Page Tree
root@none
sortcreation
searchBoxtrue

XDR CLIENT - DEVELOPMENT GUIDE

This page presents a development guide for the XDR Client Component.

The main purpose is to help the developers understand the way it interacts with the other components, so that it could be better integrated in more complex solutions.


DIAGRAMS

Note

Work in progress!

General Diagram of Components

(Click the picture to enlarge)

This is a global diagram of components for the B side of the OpenNCP. There we can see all the functional components and a high level view of the way they interact with each other.

In this particular situation we should focus in the XCA Component, highlighted as blue, in the previous picture.

The next diagram shows a more closer and isolated look over the XCA Component and all the components that it uses.

XDR Client Simple Class Diagram

(Click the picture to enlarge)

This diagram illustrates the three main classes of the XDR Client project.

The XdrocumentSource represents the entry point for this component and it contains the following operation(s):

Operation Name
Description
initialize

This particular method represents the initialize() operation for the epSOS Dispensation Service.

And it main purpose is to notify the patient’s country of affiliation on a successful dispensation of an ePrescription.

provideAndRegisterDocSetProvides a way to submit documents and it represents the XDR IHE Profile Provide and Register Document Set-b transaction [ITI-41].

The XDSbRepositoryServiceInvoker contains the same XCA operations, but now at a lower level lowers the level of the XDR Profile operations:

Operation Name
Description
respondingGateway_CrossGatewayQuery

Also represents the XCA IHE Profile Cross Gateway Query transaction [ITI-38], but this time at a lower level, directly managing IHE defined objects and more closely related with the communication stack.

respondingGateway_CrossGatewayRetrieveAlso represents the XCA IHE Profile Cross Gateway Retrieve transaction [ITI-39], but this time at a lower level, directly managing IHE defined objects and more closely related with the communication stack.

 

The RespondingGateway_ServiceStub contains the same XCA operations, but now at a lower level
provideAndRegisterDocumentSet

This operation also represents XDR IHE Profile Provide and Register Document Set-b transaction [ITI-41] but at a lower level.

The DocumentRecipient_ServiceStub lowers the XDR IHE Profile Operations one level more:

Also represents the XCA IHE Profile Cross Gateway Retrieve transaction [ITI-39], but this time at a lower level, directly managing IHE defined objects and more closely related with the communication stack
Operation Name
Description
respondingGatewaydocumentRecipient_CrossGatewayQueryAlso represents the XCA IHE Profile Cross Gateway Query transaction ProvideAndRegisterDocument

This operation also represents XDR IHE Profile Provide and Register Document Set-b transaction [ITI-3841], but this time at a an even lower level, directly managing IHE defined objects and more closely related with the communication stack.

respondingGateway_CrossGatewayRetrieve

. This time directly handling the communication with the NCP-A side.

You can find more extensive and complete information about the XCA XDR Client classes and their operations in the JavaDoc, available bellow.

JAVADOC

Note

Work in progress!