org.vmdb.hl7
Class RSPMessage

java.lang.Object
  |
  +--org.vmdb.hl7.HL7Object
        |
        +--org.vmdb.hl7.HL7SegmentContainer
              |
              +--org.vmdb.hl7.HL7Message
                    |
                    +--org.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: Veterinary Medical Database (VMDB).

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.

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
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

getDTD, getMessageControlId, getMessageName, getMSH, getReceivingFacility, getReceivingFacilityId, getReceivingFacilityName, getSendingFacility, getSendingFacilityId, getSendingFacilityName, getStyleSheet, printRule, readHL7, setDTD, setMessageControlId, setMessageName, setMessageName, setReceivingFacility, setReceivingFacility, setSendingFacility, setSendingFacility, setStyleSheet, toXML, toXML

Methods inherited from class org.vmdb.hl7.HL7SegmentContainer

findSegment, listsSegments, setSeparators, toString

Methods inherited from class org.vmdb.hl7.HL7Object

getRule

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getMSA

public MSASegment getMSA()

Get the Message Acknowledgment segment from this message

Returns:

MSASegment object

getERR

public ERRSegment getERR()

Get the Error segment from this message

Returns:

ErrSegment object

getQAK

public QAKSegment getQAK()

Get the Query Acknowledgment segment from this message

Returns:

QAKSegment object

getQPD

public QPDSegment getQPD()

Get the Input Parameter Field Description and Commentary segment from this message

Returns:

QPDSegment object

getOBX

public OBXSegment getOBX()

Get the Observation segment (containing results) from this message

Returns:

OBXSegment object

setAcknowledgmentCode

public void setAcknowledgmentCode(java.lang.String sAcknowledgmentCode)

Set the message Acknowledgment Code.

getAcknowledgmentCode

public java.lang.String getAcknowledgmentCode()

Get the message Acknowledgment Code.

Returns:

String with unique identifier

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).

Returns:

String with unique identifier

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.

Parameters:

dPrev - The prevalence rate as a double type numeric.

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.

Returns:

The prevalence rate as a double type numeric. Returns negative one for errors or no value.