Uses of Interface
ca.uhn.hl7v2.model.Message

Packages that use Message

Package	Description
ca.uhn.hl7v2.app
ca.uhn.hl7v2.conf.check
ca.uhn.hl7v2.model
ca.uhn.hl7v2.model.composite
ca.uhn.hl7v2.model.primitive
ca.uhn.hl7v2.model.v21.datatype
ca.uhn.hl7v2.model.v22.datatype
ca.uhn.hl7v2.model.v23.datatype
ca.uhn.hl7v2.model.v231.datatype
ca.uhn.hl7v2.model.v24.datatype
ca.uhn.hl7v2.model.v25.datatype
ca.uhn.hl7v2.model.v251.datatype
ca.uhn.hl7v2.model.v26.datatype
ca.uhn.hl7v2.parser
ca.uhn.hl7v2.protocol
ca.uhn.hl7v2.protocol.impl
ca.uhn.hl7v2.util
ca.uhn.hl7v2.validation
ca.uhn.hl7v2.validation.app
ca.uhn.hl7v2.validation.impl
ca.uhn.hl7v2.view

Uses of Message in ca.uhn.hl7v2.app

Methods in ca.uhn.hl7v2.app that return Message

Modifier and Type	Method and Description
static Message	DefaultApplication.makeACK(Message message) Creates an ACK message with the minimum required information from an inbound message.
static Message	DefaultApplication.makeACK(Segment inboundHeader)
Message	MessageTypeRouter.processMessage(Message in) Forwards the given message to any Applications that have been registered to accept messages of that type and trigger event.
Message	DefaultApplication.processMessage(Message in) Creates and returns an acknowledgement -- the details are determined by fillDetails().
Message	Application.processMessage(Message in) Uses the contents of the message for whatever purpose the Application has for this message, and returns an appropriate response message.
Message	Initiator.sendAndReceive(Message out) Sends a message to a responder system, receives the reply, and returns the reply as a Message object.

Methods in ca.uhn.hl7v2.app with parameters of type Message

Modifier and Type	Method and Description
boolean	MessageTypeRouter.canProcess(Message in) Returns true if at least one application has been registered to accept this type of message.
boolean	DefaultApplication.canProcess(Message in) Returns true.
boolean	Application.canProcess(Message in) Returns true if this Application wishes to accept the message.
void	DefaultApplication.fillDetails(Message ack) Fills in the details of an Application Reject message, including response and error codes, and a text error message.
void	AcceptApplication.fillDetails(Message ack) Supplies details of application accept (AA) acknowledgement.
static Message	DefaultApplication.makeACK(Message message) Creates an ACK message with the minimum required information from an inbound message.
Message	MessageTypeRouter.processMessage(Message in) Forwards the given message to any Applications that have been registered to accept messages of that type and trigger event.
Message	DefaultApplication.processMessage(Message in) Creates and returns an acknowledgement -- the details are determined by fillDetails().
Message	Application.processMessage(Message in) Uses the contents of the message for whatever purpose the Application has for this message, and returns an appropriate response message.
Message	Initiator.sendAndReceive(Message out) Sends a message to a responder system, receives the reply, and returns the reply as a Message object.

Uses of Message in ca.uhn.hl7v2.conf.check

Methods in ca.uhn.hl7v2.conf.check with parameters of type Message

Modifier and Type	Method and Description
HL7Exception[]	Validator.validate(Message message, StaticDef profile) Validates the given message against the given static definition from a conformance profile.
HL7Exception[]	DefaultValidator.validate(Message message, StaticDef profile)

Uses of Message in ca.uhn.hl7v2.model

Classes in ca.uhn.hl7v2.model that implement Message

Modifier and Type	Class and Description
class	AbstractMessage A default implementation of Message.
class	GenericMessage A generic HL7 message, meant for parsing message with unrecognized structures into a flat list of segments.
static class	GenericMessage.UnknownVersion
static class	GenericMessage.V21
static class	GenericMessage.V22
static class	GenericMessage.V23
static class	GenericMessage.V231
static class	GenericMessage.V24
static class	GenericMessage.V25
static class	GenericMessage.V251
static class	GenericMessage.V26

Methods in ca.uhn.hl7v2.model that return Message

Modifier and Type	Method and Description
Message	Message.generateACK() Generates and returns an ACK message which would be used to acknowledge this message successfully, with an MSA-1 code of "AA".
Message	AbstractMessage.generateACK() Generates and returns an ACK message which would be used to acknowledge this message successfully, with an MSA-1 code of "AA".
Message	Message.generateACK(String theAcknowldegementCode, HL7Exception theException) Generates and returns an ACK message which would be used to acknowledge this message successfully.
Message	AbstractMessage.generateACK(String theAcknowledgementCode, HL7Exception theException) Generates and returns an ACK message which would be used to acknowledge this message successfully.
Message	Varies.getMessage()
Message	Type.getMessage()
Message	Structure.getMessage() Returns the Message object to which this structure belongs.
Message	AbstractType.getMessage()
Message	AbstractStructure.getMessage() Returns the parent group within which this structure exists (may be root message group).
Message	AbstractMessage.getMessage() Returns this Message object.

Methods in ca.uhn.hl7v2.model that return types with arguments of type Message

Modifier and Type	Method and Description
static Class<? extends Message>	GenericMessage.getGenericMessageClass(String version) Returns a subclass of GenericMessage corresponding to a certain version.

Constructors in ca.uhn.hl7v2.model with parameters of type Message

Constructor and Description
AbstractComposite(Message message)
AbstractPrimitive(Message message)
AbstractType(Message message) Creates a new instance of AbstractType
ExtraComponents(Message message) Creates a new instance of ExtraComponents
GenericComposite(Message message) Creates a new instance of GenericComposite
GenericPrimitive(Message message) Creates a new instance of GenericPrimitive
Varies(Message message) Creates new Varies.

Uses of Message in ca.uhn.hl7v2.model.composite

Constructors in ca.uhn.hl7v2.model.composite with parameters of type Message

Constructor and Description
AbstractPersonNameComposite(Message theMessage) Constructor

Uses of Message in ca.uhn.hl7v2.model.primitive

Constructors in ca.uhn.hl7v2.model.primitive with parameters of type Message

Constructor and Description
AbstractTextPrimitive(Message theMessage) Constructor
DT(Message theMessage)
ID(Message theMessage)
ID(Message theMessage, int theTable)
ID(Message message, Integer theTable)
IDWithNamespace(Message theMessage, String theHl7Version, String theNamespace, int theTable)
IDWithNamespace(Message theMessage, String theHl7Version, String theNamespace, Integer theTable)
IS(Message theMessage)
IS(Message theMessage, int theTable)
IS(Message theMessage, Integer theTable)
ISWithNamespace(Message theMessage, String theHl7Version, String theNamespace, int theTable) Constructor
ISWithNamespace(Message theMessage, String theHl7Version, String theNamespace, Integer theTable) Constructor
NULLDT(Message theMessage) Constructor
TM(Message theMessage)
TSComponentOne(Message theMessage)

Uses of Message in ca.uhn.hl7v2.model.v21.datatype

Constructors in ca.uhn.hl7v2.model.v21.datatype with parameters of type Message

Constructor and Description
CM(Message message)
DT(Message theMessage)
ID(Message theMessage)
ID(Message theMessage, int theTable)
ID(Message theMessage, Integer theTable)
TM(Message theMessage)
TS(Message theMessage)

Uses of Message in ca.uhn.hl7v2.model.v22.datatype

Constructors in ca.uhn.hl7v2.model.v22.datatype with parameters of type Message

Constructor and Description
DT(Message theMessage)
ID(Message theMessage)
ID(Message theMessage, int theTable)
ID(Message theMessage, Integer theTable)
IS(Message theMessage)
IS(Message theMessage, int theTable)
IS(Message theMessage, Integer theTable)
TM(Message theMessage)
TSComponentOne(Message theMessage)

Uses of Message in ca.uhn.hl7v2.model.v23.datatype

Constructors in ca.uhn.hl7v2.model.v23.datatype with parameters of type Message

Constructor and Description
DT(Message theMessage)
ID(Message theMessage)
ID(Message theMessage, int theTable)
ID(Message theMessage, Integer theTable)
IS(Message theMessage)
IS(Message theMessage, int theTable)
IS(Message theMessage, Integer theTable)
TM(Message theMessage)
TSComponentOne(Message theMessage)

Uses of Message in ca.uhn.hl7v2.model.v231.datatype

Constructors in ca.uhn.hl7v2.model.v231.datatype with parameters of type Message

Constructor and Description
DT(Message theMessage)
ID(Message theMessage)
ID(Message theMessage, int theTable)
ID(Message theMessage, Integer theTable)
IS(Message theMessage)
IS(Message theMessage, int theTable)
IS(Message theMessage, Integer theTable)
TM(Message theMessage)
TSComponentOne(Message theMessage)

Uses of Message in ca.uhn.hl7v2.model.v24.datatype

Constructors in ca.uhn.hl7v2.model.v24.datatype with parameters of type Message

Constructor and Description
DT(Message theMessage)
ID(Message theMessage)
ID(Message theMessage, int theTable)
ID(Message theMessage, Integer theTable)
IS(Message theMessage)
IS(Message theMessage, int theTable)
IS(Message theMessage, Integer theTable)
TM(Message theMessage)
TSComponentOne(Message theMessage)

Uses of Message in ca.uhn.hl7v2.model.v25.datatype

Constructors in ca.uhn.hl7v2.model.v25.datatype with parameters of type Message

Constructor and Description
DT(Message theMessage)
DTM(Message theMessage)
ID(Message theMessage)
ID(Message theMessage, int theTable)
ID(Message theMessage, Integer theTable)
IS(Message theMessage)
IS(Message theMessage, int theTable)
IS(Message theMessage, Integer theTable)
TM(Message theMessage)

Uses of Message in ca.uhn.hl7v2.model.v251.datatype

Constructors in ca.uhn.hl7v2.model.v251.datatype with parameters of type Message

Constructor and Description
DT(Message theMessage)
DTM(Message theMessage)
ID(Message theMessage)
ID(Message theMessage, int theTable)
ID(Message theMessage, Integer theTable)
IS(Message theMessage)
IS(Message theMessage, int theTable)
IS(Message theMessage, Integer theTable)
NULLDT(Message theMessage) Constructor
TM(Message theMessage)

Uses of Message in ca.uhn.hl7v2.model.v26.datatype

Constructors in ca.uhn.hl7v2.model.v26.datatype with parameters of type Message

Constructor and Description
DT(Message theMessage)
DTM(Message theMessage)
ID(Message theMessage)
ID(Message theMessage, int theTable)
ID(Message theMessage, Integer theTable)
IS(Message theMessage)
IS(Message theMessage, int theTable)
IS(Message theMessage, Integer theTable)
NULLDT(Message theMessage) Constructor
TM(Message theMessage)

Uses of Message in ca.uhn.hl7v2.parser

Methods in ca.uhn.hl7v2.parser that return Message

Modifier and Type	Method and Description
protected Message	XMLParser.doParse(String message, String version) Parses a message string and returns the corresponding Message object.
protected Message	PipeParser.doParse(String message, String version) Parses a message string and returns the corresponding Message object.
protected abstract Message	Parser.doParse(String message, String version) Called by parse() to perform implementation-specific parsing work.
protected Message	OldPipeParser.doParse(String message, String version) Deprecated. Parses a message string and returns the corresponding Message object.
protected Message	GenericParser.doParse(String message, String version) Parses a message string and returns the corresponding Message object.
protected Message	FastParser.doParse(String message, String version) Deprecated.
protected Message	XMLParser.doParseForSpecificPackage(String theMessage, String theVersion, String thePackageName) Throws unsupported operation exception
protected Message	PipeParser.doParseForSpecificPackage(String message, String version, String packageName) Attempt the parse a message using a specific model package
protected abstract Message	Parser.doParseForSpecificPackage(String message, String version, String packageName) Attempt the parse a message using a specific model package
protected Message	OldPipeParser.doParseForSpecificPackage(String theMessage, String theVersion, String thePackageName) Deprecated. Throws unsupported operation exception
protected Message	GenericParser.doParseForSpecificPackage(String theMessage, String theVersion, String thePackageName)
protected Message	FastParser.doParseForSpecificPackage(String theMessage, String theVersion, String thePackageName) Deprecated. Throws unsupported operation exception
protected Message	Parser.instantiateMessage(String theName, String theVersion, boolean isExplicit) Note that the validation context of the resulting message is set to this parser's validation context.
protected Message	Parser.instantiateMessageInASpecificPackage(String theName, String theVersion, boolean isExplicit, String packageName) Instantiate a message type using a specific package name
Message	PipeParser.parse(String message) Parses a message string and returns the corresponding Message object.
Message	Parser.parse(String message) Parses a message string and returns the corresponding Message object.
abstract Message	XMLParser.parseDocument(Document XMLMessage, String version) Creates and populates a Message object from an XML Document that contains an XML-encoded HL7 message.
Message	DefaultXMLParser.parseDocument(Document XMLMessage, String version) Creates and populates a Message object from an XML Document that contains an XML-encoded HL7 message.
Message	Parser.parseForSpecificPackage(String message, String packageName) Parse a message using a specific model package instead of the default, using ModelClassFactory.getMessageClassInASpecificPackage(String, String, boolean, String).

Methods in ca.uhn.hl7v2.parser that return types with arguments of type Message

Modifier and Type	Method and Description
Class<? extends Message>	ModelClassFactory.getMessageClass(String theName, String theVersion, boolean isExplicit)
Class<? extends Message>	DefaultModelClassFactory.getMessageClass(String theName, String theVersion, boolean isExplicit) Attempts to return the message class corresponding to the given name, by searching through default and user-defined (as per packageList()) packages.
Class<? extends Message>	CustomModelClassFactory.getMessageClass(String name, String version, boolean isExplicit)
Class<? extends Message>	CanonicalModelClassFactory.getMessageClass(String theName, String theVersion, boolean theIsExplicit) Attempts to return the message class corresponding to the given name, by searching through default and user-defined (as per packageList()) packages.
Class<? extends Message>	ModelClassFactory.getMessageClassInASpecificPackage(String theName, String theVersion, boolean isExplicit, String packageName) Retrieves and instantiates a message class by looking in a specific java package for the message type.
Class<? extends Message>	DefaultModelClassFactory.getMessageClassInASpecificPackage(String theName, String theVersion, boolean isExplicit, String packageName) Retrieves and instantiates a message class by looking in a specific java package for the message type.
Class<? extends Message>	CustomModelClassFactory.getMessageClassInASpecificPackage(String theName, String theVersion, boolean theIsExplicit, String thePackageName) Delegates calls to DefaultModelClassFactory.getMessageClassInASpecificPackage(String, String, boolean, String)

Methods in ca.uhn.hl7v2.parser with parameters of type Message

Modifier and Type	Method and Description
protected String	XMLParser.doEncode(Message source) Formats a Message object into an HL7 message string using this parser's default encoding (XML encoding).
protected String	PipeParser.doEncode(Message source) Formats a Message object into an HL7 message string using this parser's default encoding ("VB").
protected abstract String	Parser.doEncode(Message source) Called by encode(Message) to perform implementation-specific encoding work.
protected String	OldPipeParser.doEncode(Message source) Deprecated. Formats a Message object into an HL7 message string using this parser's default encoding ("VB").
protected String	GenericParser.doEncode(Message source) Formats a Message object into an HL7 message string using this parser's default encoding.
protected String	FastParser.doEncode(Message source) Deprecated.
protected String	XMLParser.doEncode(Message source, String encoding) Formats a Message object into an HL7 message string using the given encoding.
protected String	PipeParser.doEncode(Message source, String encoding) Formats a Message object into an HL7 message string using the given encoding.
protected abstract String	Parser.doEncode(Message source, String encoding) Called by encode(Message, String) to perform implementation-specific encoding work.
protected String	OldPipeParser.doEncode(Message source, String encoding) Deprecated. Formats a Message object into an HL7 message string using the given encoding.
protected String	GenericParser.doEncode(Message source, String encoding) Formats a Message object into an HL7 message string using the given encoding.
protected String	FastParser.doEncode(Message source, String encoding) Deprecated.
String	PipeParser.encode(Message source) Formats a Message object into an HL7 message string using this parser's default encoding.
String	Parser.encode(Message source) Formats a Message object into an HL7 message string using this parser's default encoding.
String	Parser.encode(Message source, String encoding) Formats a Message object into an HL7 message string using the given encoding.
abstract Document	XMLParser.encodeDocument(Message source) Creates an XML Document that corresponds to the given Message object.
Document	DefaultXMLParser.encodeDocument(Message source) Creates an XML Document that corresponds to the given Message object.
static EncodingCharacters	EncodingCharacters.getInstance(Message message) Returns an instance using the MSH-1 and MSH-2 values of the given message
void	PipeParser.parse(Message message, String string)
abstract void	Parser.parse(Message message, String string) Parses a particular message and returns the encoded structure
void	OldPipeParser.parse(Message message, String string) Deprecated.
void	GenericParser.parse(Message message, String string)
void	FastParser.parse(Message message, String string) Deprecated. Not supported, throws UnsupportedOperationException
void	DefaultXMLParser.parse(Message theMessage, String theString) Parses a particular message and returns the encoded structure

Constructors in ca.uhn.hl7v2.parser with parameters of type Message

Constructor and Description
MessageIterator(Message start, IStructureDefinition startDefinition, String direction, boolean handleUnexpectedSegments) Creates a new instance of MessageIterator
MessagePointer(PipeParser parser, Message message, EncodingCharacters encodingChars) Deprecated. Creates new GroupPointer

Uses of Message in ca.uhn.hl7v2.protocol

Methods in ca.uhn.hl7v2.protocol that return Message

Modifier and Type	Method and Description
Message	ReceivingApplication.processMessage(Message theMessage, Map<String,Object> theMetadata) Uses the contents of the message for whatever purpose the application has for this message, and returns an appropriate response message.
Message	Initiator.sendAndReceive(Message theMessage) Encodes a message, sends it to a remote system, awaits the response, parses it, and returns it.

Methods in ca.uhn.hl7v2.protocol with parameters of type Message

Modifier and Type	Method and Description
boolean	ReceivingApplication.canProcess(Message theMessage)
Message	ReceivingApplication.processMessage(Message theMessage, Map<String,Object> theMetadata) Uses the contents of the message for whatever purpose the application has for this message, and returns an appropriate response message.
Message	Initiator.sendAndReceive(Message theMessage) Encodes a message, sends it to a remote system, awaits the response, parses it, and returns it.

Uses of Message in ca.uhn.hl7v2.protocol.impl

Methods in ca.uhn.hl7v2.protocol.impl that return Message

Modifier and Type	Method and Description
Message	AppWrapper.processMessage(Message theMessage, Map<String,Object> theMetadata)
Message	InitiatorImpl.sendAndReceive(Message theMessage)

Methods in ca.uhn.hl7v2.protocol.impl with parameters of type Message

Modifier and Type	Method and Description
boolean	AppWrapper.canProcess(Message theMessage)
static void	ParseChecker.checkParse(String originalMessageText, Message parsedMessage, Parser parser) Encodes the given message and compares it to the given string.
static Map<String,String>	MetadataExtractor.getFields(Message theMessage, List<String> theTerserPaths)
Message	AppWrapper.processMessage(Message theMessage, Map<String,Object> theMetadata)
Message	InitiatorImpl.sendAndReceive(Message theMessage)

Uses of Message in ca.uhn.hl7v2.util

Methods in ca.uhn.hl7v2.util that return Message

Modifier and Type	Method and Description
static Message	ReflectionUtil.instantiateMessage(Class<? extends Message> theType, ModelClassFactory theModelClassFactory)
Message	Hl7InputStreamMessageIterator.next()

Methods in ca.uhn.hl7v2.util with parameters of type Message

Modifier and Type	Method and Description
static MessageQuery.Result	MessageQuery.query(Message theMessage, String theQuery) Deprecated.

Method parameters in ca.uhn.hl7v2.util with type arguments of type Message

Modifier and Type	Method and Description
static Message	ReflectionUtil.instantiateMessage(Class<? extends Message> theType, ModelClassFactory theModelClassFactory)

Constructors in ca.uhn.hl7v2.util with parameters of type Message

Constructor and Description
Terser(Message message) Creates a new instance of Terser

Uses of Message in ca.uhn.hl7v2.validation

Methods in ca.uhn.hl7v2.validation with parameters of type Message

Modifier and Type	Method and Description
ValidationException[]	MessageRule.test(Message msg) Tests the given (fully populated) message against the criteria defined by this rule class.
boolean	MessageValidator.validate(Message message)

Uses of Message in ca.uhn.hl7v2.validation.app

Methods in ca.uhn.hl7v2.validation.app that return Message

Modifier and Type	Method and Description
Message	TestApplication.processMessage(Message in) Deprecated. Calls test(Message in), routes resulting exceptions to configured destinations, and returns an ack (which should not normally be used since the test app is intended to operate in parallel with system-to-system communication).

Methods in ca.uhn.hl7v2.validation.app with parameters of type Message

Modifier and Type	Method and Description
abstract boolean	TestApplication.canProcess(Message in) Deprecated. Returns true if this Application wishes to accept the message.
boolean	ProfileTestApplication.canProcess(Message in) Deprecated. Returns true if this Application wishes to accept the message.
boolean	MultiTestApplication.canProcess(Message in) Deprecated. Returns true if ANY of the delegates can accept the message.
Message	TestApplication.processMessage(Message in) Deprecated. Calls test(Message in), routes resulting exceptions to configured destinations, and returns an ack (which should not normally be used since the test app is intended to operate in parallel with system-to-system communication).
abstract HL7Exception[]	TestApplication.test(Message in) Deprecated. Tests the message in some way (as defined by implementing class).
HL7Exception[]	ProfileTestApplication.test(Message in) Deprecated. Tests the message against a profile or profiles.
HL7Exception[]	MultiTestApplication.test(Message in) Deprecated. Tests the message by passing it to all test apps that have been registered using addTest().

Uses of Message in ca.uhn.hl7v2.validation.impl

Methods in ca.uhn.hl7v2.validation.impl with parameters of type Message

Modifier and Type	Method and Description
ValidationException[]	ConformanceProfileRule.test(Message msg)

Uses of Message in ca.uhn.hl7v2.view

Methods in ca.uhn.hl7v2.view that return Message

Modifier and Type	Method and Description
Message	TreePanel.getMessage() Deprecated. Returns the message that is currently displayed in the tree panel.

Methods in ca.uhn.hl7v2.view with parameters of type Message

Modifier and Type	Method and Description
void	TreePanel.setMessage(Message message) Deprecated. Updates the panel with a new Message.
static void	TreePanel.showInNewWindow(Message message) Deprecated. A convenience method for displaying a message by creating a new TreePanel and displaying the given message in a new window.