Package org.dellroad.hl7

Class XMLConverter

java.lang.Object

org.dellroad.hl7.XMLConverter

public class XMLConverter
extends Object

Converts HL7Message(s) to and from XML.

Example of what the XML looks like:

 <HL7>
  <MESSAGE>
    <MSH>
      <MSH.1>|</MSH.1>
      <MSH.2>^~\&amp;</MSH.2>
      <MSH.3>ST01</MSH.3>
      <MSH.4>B</MSH.4>
      <MSH.5>IM</MSH.5>
      <MSH.6>B</MSH.6>
      <MSH.7>20191203131805</MSH.7>
      <MSH.9>
        <MSH.9.1>ADT</MSH.9.1>
        <MSH.9.2>A04</MSH.9.2>
      </MSH.9>
      <MSH.10>99479783</MSH.10>
      <MSH.11>P</MSH.11>
      <MSH.12>2.2</MSH.12>
      <MSH.13>99479783</MSH.13>
      <MSH.15>AL</MSH.15>
      <MSH.22>2.2b</MSH.22>
    </MSH>
    <EVN>
      <EVN.1>A04</EVN.1>
      <EVN.2>20160815131805</EVN.2>
      <EVN.5>
        <EVN.5.1>DMB</EVN.5.1>
        <EVN.5.2>WASHINGTON</EVN.5.2>
        <EVN.5.3>GEORGE</EVN.5.3>
        <EVN.5.4>M</EVN.5.4>
      </EVN.5>
    </EVN>
    <PID>
      <PID.1>1</PID.1>
      <PID.2>344356467</PID.2>
      <PID.3>345345456</PID.3>
      <PID.4>123132423</PID.4>
      <PID.5>
        <PID.5.1>HAMILTON</PID.5.1>
        <PID.5.2>ALEXANDER</PID.5.2>
      </PID.5>
    ...
 

Field Summary

Fields

Modifier and Type	Field	Description
protected DocumentBuilderFactory	documentBuilderFactory
static String	HL7_NAMESPACE_URI	HL7 message XML namespace.
static String	HL7_TAG	XML tag name used by toXML(org.dellroad.hl7.HL7Message, boolean).
static String	MESSAGE_TAG	XML tag name used for one XML-encoded message.

Constructor Summary

Constructors

Constructor	Description
XMLConverter()	Default constructor.
XMLConverter(DocumentBuilderFactory documentBuilderFactory)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	appendMessage(XMLStreamWriter writer, HL7Message message, boolean omitEmpty)	Convert a message to XML and append it to the given XMLStreamWriter.
void	appendMessage(Node parent, HL7Message message, boolean omitEmpty)	Convert a message to XML and append it to the given element.
void	appendSegment(XMLStreamWriter writer, HL7Segment segment, boolean omitEmpty)	Convert a segment to XML and write it to the given XMLStreamWriter.
void	appendSegment(Node parent, HL7Segment segment, boolean omitEmpty)	Convert a segment to XML and append it to the given element.
Document	createDocument()	Create an empty XML document for HL7 messages.
static void	main(String[] args)	Test routine.
void	stream(TransformerFactory transformerFactory, Document doc, OutputStream out)	Serialize the XML document and write it to the given output.
void	stream(Document doc, OutputStream out)	Serialize the XML document and write it to the given output.
Document	toXML(HL7Message message, boolean omitEmpty)	Convert an HL7 message message to an XML document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HL7_NAMESPACE_URI

public static final String HL7_NAMESPACE_URI

HL7 message XML namespace.

HL7_TAG

public static final String HL7_TAG

XML tag name used by toXML(org.dellroad.hl7.HL7Message, boolean).

See Also:

Constant Field Values

MESSAGE_TAG

public static final String MESSAGE_TAG

XML tag name used for one XML-encoded message.

See Also:

Constant Field Values

documentBuilderFactory

protected final DocumentBuilderFactory documentBuilderFactory

Constructor Detail

XMLConverter

public XMLConverter()

Default constructor.

XMLConverter

public XMLConverter(DocumentBuilderFactory documentBuilderFactory)

Constructor.

Parameters:

documentBuilderFactory - factory for creating new XML documents

Throws:

IllegalArgumentException - if documentBuilderFactory is null

Method Detail

createDocument

public Document createDocument()

Create an empty XML document for HL7 messages.

Returns:

XML document consisting of one empty <HL7/> tag

toXML

public Document toXML(HL7Message message,
                      boolean omitEmpty)

Convert an HL7 message message to an XML document. The document element will be <HL7> and contain one child which is the XML encoding of the message.

Parameters:

message - HL7 message

omitEmpty - Omit empty tags (other than the last one)

Returns:

HL7 message encoded as an XML document

appendMessage

public void appendMessage(Node parent,
                          HL7Message message,
                          boolean omitEmpty)

Convert a message to XML and append it to the given element.

Parameters:

parent - an XML Element or Document node

message - HL7 message to append

omitEmpty - Omit empty tags (other than the last one)

appendMessage

public void appendMessage(XMLStreamWriter writer,
                          HL7Message message,
                          boolean omitEmpty)
                   throws XMLStreamException

Convert a message to XML and append it to the given XMLStreamWriter.

Parameters:

writer - XML output

message - HL7 message to append

omitEmpty - Omit empty tags (other than the last one)

Throws:

XMLStreamException - if an XML error occurs

appendSegment

public void appendSegment(Node parent,
                          HL7Segment segment,
                          boolean omitEmpty)

Convert a segment to XML and append it to the given element.

Parameters:

parent - an XML Element or Document node

segment - HL7 segment to append

omitEmpty - Omit empty tags (other than the last one)

appendSegment

public void appendSegment(XMLStreamWriter writer,
                          HL7Segment segment,
                          boolean omitEmpty)
                   throws XMLStreamException

Convert a segment to XML and write it to the given XMLStreamWriter.

Parameters:

writer - XML output

segment - HL7 segment to append

omitEmpty - Omit empty tags (other than the last one)

Throws:

XMLStreamException - if an XML error occurs

stream

public void stream(Document doc,
                   OutputStream out)
            throws IOException

Serialize the XML document and write it to the given output.

Parameters:

doc - XML document to output

out - output desination

Throws:

IOException - if an I/O error occurs

stream

public void stream(TransformerFactory transformerFactory,
                   Document doc,
                   OutputStream out)
            throws IOException

Serialize the XML document and write it to the given output.

Parameters:

transformerFactory - factory for XSL transformers

doc - XML document to output

out - output desination

Throws:

IOException - if an I/O error occurs

main

public static void main(String[] args)
                 throws Exception

Test routine. Reads HL7 messages in "file format" and outputs them in an XML document.

Parameters:

args - command line arguments

Throws:

Exception - if an error occurs