XCPD Client - Development Guide
- Luis Pinto (Unlicensed)
- Marcelo Fonseca
Content of the Protocol Terminators
XCPD CLIENT - DEVELOPMENT GUIDE
This page presents a development guide for the XCPD 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
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 XCPD Component, highlighted as blue, in the previous picture.
The next diagram shows a more closer and isolated look over the XCPD Component and all the components that it uses.
XCPD Client Simple Class Diagram
(Click the picture to enlarge)
This diagram illustrates the three main classes of the XCPD Client project.
The IniGateway represents the entry point for this component and it contains the following operation(s):
| Operation Name | Description |
|---|---|
| patientDiscovery | Represents the main function of the XCPD IHE Profile. It main purpose is to allow the discovery of a valid patient identifier from an ID assigning authority by providing given identifiers and/or demographic data that is sufficient for patient identification. All of this is done in a higher, abstract level. |
The RespondingGateway_RequestSender also contains the following XCPD related operation(s):
| Operation Name | Description |
|---|---|
| respondingGateway_PRPA_IN201305UV02 | This operations lowers the functional level of the XCPD Profile implementation It directly implements and encapsulates some of the IHE requirements for the XCPD Profile operations. |
The RespondingGateway_ServiceStub contains the next operation(s):
| Operation Name | Description |
|---|---|
| respondingGateway_PRPA_IN201305UV02 | Directly handles XCPD IHE Profile content and it main goal is to establish the communications with the NCP-A side, acting as the final frontier of the XCPD client. |
You can find more extensive and complete information about the XCPD Client classes and their operations in the JavaDoc, available bellow.
JAVADOC
You can find a first version of the JavaDoc in the following file list:
REFERENCES
WP3.4 Deliverable D3.4.2 - Common Components Specification v2.2
IHE International: IHE IT Infrastructure (ITI) Technical Framework. Volume 1: Integration Profiles. August 2011.