cmpd-pharm1 component

The cmpd-pharm1 component provides interfaces for actors of the Query Pharmacy Documents IHE transaction (PHARM-1), which is described in the IHE Pharmacy Technical Framework Supplement Community Medication Prescription and Dispense, Section 3.1.

Actors

The transaction defines the following actors:

PHARM-1 actors
PHARM-1 transaction and actors

Producer side corresponds to the Querying Actor actor. Consumer side corresponds to the Community Pharmacy Manager actor.

Dependencies

In a Maven-based environment, the following dependency must be registered in pom.xml:

    <dependency>
        <groupId>org.openehealth.ipf.platform-camel</groupId>
        <artifactId>ipf-platform-camel-ihe-xds</artifactId>
        <version>${ipf-version}</version>
    </dependency>

Endpoint URI Format

Producer

The endpoint URI format of the cmpd-pharm1 component producers is:

cmpd-pharm1://hostname:port/path/to/service[?parameters]

where hostname is either an IP address or a domain name, port is a port number, and path/to/service represents additional path elements of the remote service. URI parameters are optional and control special features as described in the corresponding section below.

Consumer

The endpoint URI format of cmpd-pharm1 component consumers is:

cmpd-pharm1:serviceName[?parameters]

The resulting URL of the exposed IHE Web Service endpoint depends on both the configuration of the deployment container and the serviceName parameter provided in the Camel endpoint URI.

For example, when a Tomcat container on the host eHealth.server.org is configured in the following way:

port = 8888
contextPath = /IHE
servletPath = /xds/*

and serviceName equals to pharm1, then the cmpd-pharm1 consumer will be available for external clients under the URL http://eHealth.server.org:8888/IHE/xds/pharm1

Additional URI parameters are optional and control special features as described in the corresponding section below.

Example

This is an example on how to use the component on the consumer side:

    from("cmpd-pharm1:pharm1?audit=true")
      .process(myProcessor)
      // process the incoming request and create a response

Basic Common Component Features

Basic Web Service Component Features

Basic XDS Component Features

Advanced Web Service Component Features

Advanced XDS Component Features