pam-iti31 component

The pam-iti31 component provides interfaces for actors of the Patient Encounter Management IHE transaction (ITI-31), which is described in the IHE IT Infrastructure Technical Framework, Volume 2b , Section 3.31..


The transaction defines the following actors:

ITI-31 actors
ITI-31 transaction and actors

Producer side corresponds to the Patient Encounter Source actor. Consumer side corresponds to both Patient Encounter Consumer actor.


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


Endpoint URI Format

The endpoint URI format of the pam-iti31 component is identical for producers and consumers:


where hostname is either an IP address or a domain name, and port is a number. For the consumer side, the host name allows the access from any remote host. These two obligatory URI parts represent the address of the MLLP(S) endpoint which is to be served by the given consumer or accessed by the given producer. URI parameters controlling the transaction features are described below.

HL7v2 Codec

Until IPF 4.3.x, all HL7v2-based transactions are realized using the camel-mina and camel-hl7 components and requires that an HL7v2 Mina Codec is available in the Camel registry.

As of IPF 4.4.x, all HL7v2-based transactions are realized using the camel-netty and camel-hl7 components and requires that an HL7v2 Netty Codec is available in the Camel registry.

Transaction Options

This transaction defines the following options; at least one of them must be chosen to be supported:

  • BASIC (default)

The options are represented as enumeration in the class Iti31Options.

Support for one or more options is configured using the optional options parameter, followed by a comma-separated list of options to be supported. If options is provided, the default option (see above) is used. The endpoint will reject event types that are outside the scope of the configured option.


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

      // process the incoming request and create a response

Basic Common Component Features

Basic MLLP Component Features

Advanced MLLP Component Features