Package ca.cdr.api.pub.hl7v2.out

Interface IHl7V2OutboundCustomMapper

public interface IHl7V2OutboundCustomMapper

This interface is intended to be implemented by custom HL7v2 outbound mapper classes. Implementations receive a focal resource (which was the target of a Subscription) and produce a MappingTarget containing an HL7v2 message to send.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IHl7V2OutboundCustomMapper.ConversionContext	This class contains parameters for the IHl7V2OutboundCustomMapper.ConversionContext method.

Method Summary

Modifier and Type	Method	Description
List<MappingTarget<?>>	convert(IHl7V2OutboundCustomMapper.ConversionContext theConversionContext)	Convert a resource into a collection of HL7v2 message(s) to send.

Method Details

convert

List<MappingTarget<?>> convert(IHl7V2OutboundCustomMapper.ConversionContext theConversionContext)
                        throws ca.uhn.hl7v2.HL7Exception

Convert a resource into a collection of HL7v2 message(s) to send.

Note that transmission of the generated messages to the receiving system will happen synchronously, in the order that the messages are returned in the list. If multiple messages are returned and a message fails to be sent (i.e. because the receiving system rejects it or is unreachable), the entire collection may be resent, including messages which have already previously been sent.

Parameters:

theConversionContext - An object containing various information about the requested conversion

Returns:

A collection of MappingTarget instances containing HL7v2 message(s) to send. Implementations return an empty list or null if they wish to not send any message.

Throws:

ca.uhn.hl7v2.HL7Exception