Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.vmdb.hl7
Class RSPMessage  view RSPMessage download RSPMessage.java

java.lang.Object
  extended byorg.vmdb.hl7.HL7Object
      extended byorg.vmdb.hl7.HL7SegmentContainer
          extended byorg.vmdb.hl7.HL7Message
              extended byorg.vmdb.hl7.RSPMessage

public class RSPMessage
extends HL7Message

Query By Pattern Response (RSP) Message.

Description: HL7 Network Connectivity For VMDB.

Copyright: Copyright (c) 2002-2003.

Company: M&M Informatics.

This is a quickly assembled message type used to demonstrate extensibility of the general library model. A more production ready solution would have been to develope a full, general purpose QBP/RSP pair of messages and extend them to the specific case of the QBP-Z01 defined here, but the point was to show a quick and easy extension example.

Version:
1.0

Field Summary
private static java.lang.String EVENT_TYPE
           
private static java.lang.String MESSAGE_TYPE
           
private  java.lang.String sNm
           
private  java.lang.String sRl
           
 
Fields inherited from class org.vmdb.hl7.HL7Message
 
Fields inherited from class org.vmdb.hl7.HL7SegmentContainer
slData, stState, vSegments
 
Fields inherited from class org.vmdb.hl7.HL7Object
COMP_SEP, ESC_SEP, FIELD_SEP, REP_SEP, sName, sRule, sSeparators, SUB_SEP
 
Constructor Summary
RSPMessage()
          Construct an empty RSP Message with type and event set.
 
Method Summary
 java.lang.String getAcknowledgmentCode()
          Get the message Acknowledgment Code.
 ERRSegment getERR()
          Get the Error segment from this message
 MSASegment getMSA()
          Get the Message Acknowledgment segment from this message
 OBXSegment getOBX()
          Get the Observation segment (containing results) from this message
 java.lang.String getOriginalMessageControlId()
          Get the message control id in the MSA (ie sender's mcId).
 double getPrevalenceRate()
          Get the value in the observation segment which in this case is defined to include the prevalence of the submitted diagnosis in animals like the one described in the submitted PID segment.
 QAKSegment getQAK()
          Get the Query Acknowledgment segment from this message
 QPDSegment getQPD()
          Get the Input Parameter Field Description and Commentary segment from this message
private  void initialize()
          This is a brute-force intialization routine to create a populated message.
 void setAcknowledgmentCode(java.lang.String sAcknowledgmentCode)
          Set the message Acknowledgment Code.
 void setOriginalMessageControlId(java.lang.String sMessageControlId)
          Set the message control id in the MSA (ie sender's mcId).
 void setPrevalenceRate(double dPrev)
          Set the value in the observation segment which in this case is defined to include the prevalence of the submitted diagnosis in animals like the one described in the submitted PID segment.
 
Methods inherited from class org.vmdb.hl7.HL7Message
addSegment, getDTD, getMessageControlId, getMessageName, getMSH, getReceivingFacility, getReceivingFacilityId, getReceivingFacilityName, getSendingFacility, getSendingFacilityId, getSendingFacilityName, getStyleSheet, printRule, readHL7, setDTD, setMessageControlId, setMessageName, setReceivingFacility, setReceivingFacility, setSendingFacility, setSendingFacility, setStyleSheet, toXML, toXML
 
Methods inherited from class org.vmdb.hl7.HL7SegmentContainer
addSegment, findSegment, iterator, listsSegments, messageComplete, pop, processLoop, processSegment, push, readString, setData, setSeparators, toString
 
Methods inherited from class org.vmdb.hl7.HL7Object
getName, getRule, getSeparator, getSeparators, setName, setRule
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sNm

private java.lang.String sNm

sRl

private java.lang.String sRl

MESSAGE_TYPE

private static final java.lang.String MESSAGE_TYPE
See Also:
Constant Field Values

EVENT_TYPE

private static final java.lang.String EVENT_TYPE
See Also:
Constant Field Values
Constructor Detail

RSPMessage

public RSPMessage()
Construct an empty RSP Message with type and event set. This object is ready to either build via a series of set and add calls, or to read in an HL7 or XML (future) message.

Method Detail

initialize

private void initialize()
This is a brute-force intialization routine to create a populated message. This is faster and easier than implementing the full getXXX() logic used in "production" message classes. Note that the getXXX() method implementation could be extended without changing the interface.


getMSA

public MSASegment getMSA()
Get the Message Acknowledgment segment from this message


getERR

public ERRSegment getERR()
Get the Error segment from this message


getQAK

public QAKSegment getQAK()
Get the Query Acknowledgment segment from this message


getQPD

public QPDSegment getQPD()
Get the Input Parameter Field Description and Commentary segment from this message


getOBX

public OBXSegment getOBX()
Get the Observation segment (containing results) from this message


setAcknowledgmentCode

public void setAcknowledgmentCode(java.lang.String sAcknowledgmentCode)
Set the message Acknowledgment Code.


getAcknowledgmentCode

public java.lang.String getAcknowledgmentCode()
Get the message Acknowledgment Code.


setOriginalMessageControlId

public void setOriginalMessageControlId(java.lang.String sMessageControlId)
Set the message control id in the MSA (ie sender's mcId).


getOriginalMessageControlId

public java.lang.String getOriginalMessageControlId()
Get the message control id in the MSA (ie sender's mcId).


setPrevalenceRate

public void setPrevalenceRate(double dPrev)
Set the value in the observation segment which in this case is defined to include the prevalence of the submitted diagnosis in animals like the one described in the submitted PID segment.


getPrevalenceRate

public double getPrevalenceRate()
Get the value in the observation segment which in this case is defined to include the prevalence of the submitted diagnosis in animals like the one described in the submitted PID segment.