org.vmdb.hl7
Class QBPMessage

java.lang.Object
  |
  +--org.vmdb.hl7.HL7Object
        |
        +--org.vmdb.hl7.HL7SegmentContainer
              |
              +--org.vmdb.hl7.HL7Message
                    |
                    +--org.vmdb.hl7.QBPMessage

public class QBPMessage

extends HL7Message

Query By Parameters (QBP) 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

QBPMessage()
Construct an empty QBP Message with type and event set.

Method Summary

CEElement	getBreed() Get the breed as a predefined CE Element.
java.lang.String	getBreedText() Get the breed text.
java.lang.String	getDateOfBirth() Get the date of birth.
CEElement	getDiagnosis() Set the Diagnosis as a predefined CE Element.
java.lang.String	getMedicalRecordNumber() Get the Medical record number.
OBXSegment	getOBX() Get the Observation segment (containing results) from this message
java.lang.String	getPatientZipcode() Get the postal code.
PIDSegment	getPID() Get the PID segment from this message.
QPDSegment	getQPD() Get the Input Parameter Field Description and Commentary segment from this message
RCPSegment	getRCP() Get the Response Control Parameter segment from this message
java.lang.String	getSex() Get the gender.
CEElement	getSpecies() Get the species as a predefined CE Element.
java.lang.String	getSpeciesText() Get the species text.
void	setBreed(CEElement ceBreed) Set the breed as a predefined CE Element.
void	setBreed(java.lang.String sBreedCode, java.lang.String sBreedText, java.lang.String sCodeSystem) Set the breed as the individual components of a CE Element.
void	setDateOfBirth(java.lang.String sBDate) Set the date of birth as ISO format data string YYYYMMDD
void	setDateOfBirth(TSElement tsBDate) Set the date of birth as ISO format data string YYYYMMDD
void	setDiagnosis(CEElement ceDiagnosis) Set the Diagnosis for which we want the prevalence as a predefined CE Element.
void	setMedicalRecordNumber(java.lang.String sMRN) Set the Medical record number.
void	setPatientZipcode(java.lang.String sZipcode) Set the postal code of animal's residence.
void	setSex(java.lang.String sSex) Set the gender.
void	setSpecies(CEElement ceSpecies) Set the species as a predefined CE Element.
void	setSpecies(java.lang.String sSpeciesCode, java.lang.String sSpeciesText, java.lang.String sCodeSystem) Set the species as the individual components of a CE Element

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

QBPMessage

public QBPMessage()

Construct an empty QBP 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

getQPD

public QPDSegment getQPD()

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

Returns:

QPDSegment object

getPID

public PIDSegment getPID()

Get the PID segment from this message.

Returns:

A reference to the PIDSegment object located at the appropriate place.

getOBX

public OBXSegment getOBX()

Get the Observation segment (containing results) from this message

Returns:

OBXSegment object

getRCP

public RCPSegment getRCP()

Get the Response Control Parameter segment from this message

Returns:

RCPSegment object

setMedicalRecordNumber

public void setMedicalRecordNumber(java.lang.String sMRN)

Set the Medical record number.

Medical record is defined in this logic as the identifier assigned by the sending facility. To work correctly, the sending facility identifier must be set before actions involving MRN.

Parameters:

sMRN - String with facility's MRN

getMedicalRecordNumber

public java.lang.String getMedicalRecordNumber()

Get the Medical record number.

Medical record is defined in this logic as the identifier assigned by the sending facility. To work correctly, the sending facility identifier must be set before actions involving MRN.

Returns:

String with facility's MRN

setSpecies

public void setSpecies(CEElement ceSpecies)

Set the species as a predefined CE Element.

Often uses one of the set of predefined constants.
Note: If populated with a constant, subsequent calls to getSpecies() will return a reference to the constant (final static object) and cannot be modified through calls to the CEElement's methods. But why would you want to?

Parameters:

ceSpecies - CEElement populated with the coded species

setSpecies

public void setSpecies(java.lang.String sSpeciesCode,
                       java.lang.String sSpeciesText,
                       java.lang.String sCodeSystem)

Set the species as the individual components of a CE Element

Parameters:

sSpeciesCode - String with the code for species

sSpeciesText - String with the species spelled out

sCodeSystem - String, usually "SCT," with the type of code

getSpecies

public CEElement getSpecies()

Get the species as a predefined CE Element.

Often uses one of the set of predefined constants.
Note: If setSpecies was called with a constant, subsequent calls to getSpecies() will return a reference to the constant (final static object) and cannot be modified through calls to the CEElement's methods. But why would you want to?

Returns:

A reference to the CEElement populated with species

getSpeciesText

public java.lang.String getSpeciesText()

Get the species text.

Returns:

String species spelled out

setBreed

public void setBreed(CEElement ceBreed)

Set the breed as a predefined CE Element.

Often uses one of the set of predefined constants.
Note: If populated with a constant, subsequent calls to getBreed() will return a reference to the constant (final static object) and cannot be modified through calls to the CEElement's methods. But why would you want to?

Parameters:

ceBreed - CEElement populated with breed

setBreed

public void setBreed(java.lang.String sBreedCode,
                     java.lang.String sBreedText,
                     java.lang.String sCodeSystem)

Set the breed as the individual components of a CE Element.

Parameters:

sBreedCode - String snomed code for breed

sBreedText - String breed spelled out

sCodeSystem - String usually SCT with type of code

getBreed

public CEElement getBreed()

Get the breed as a predefined CE Element.

Often uses one of the set of predefined constants.
Note: If populated with a constant, subsequent calls to getBreed() will return a reference to the constant (final static object) and cannot be modified through calls to the CEElement's methods. But why would you want to?

Returns:

A reference to the CEElement populated with breed

getBreedText

public java.lang.String getBreedText()

Get the breed text.

Returns:

String breed spelled out

setDateOfBirth

public void setDateOfBirth(java.lang.String sBDate)

Set the date of birth as ISO format data string YYYYMMDD

setDateOfBirth

public void setDateOfBirth(TSElement tsBDate)

Set the date of birth as ISO format data string YYYYMMDD

getDateOfBirth

public java.lang.String getDateOfBirth()

Get the date of birth.

Returns:

String with date of birth as YYYYMMDD

setSex

public void setSex(java.lang.String sSex)

Set the gender.

Parameters:

sSex - String with gender as M, C, T, F, S, O, U, H, or X

getSex

public java.lang.String getSex()

Get the gender.

Returns:

String with gender code

setPatientZipcode

public void setPatientZipcode(java.lang.String sZipcode)

Set the postal code of animal's residence.

getPatientZipcode

public java.lang.String getPatientZipcode()

Get the postal code.

Returns:

String with Zipcode or other postal code

setDiagnosis

public void setDiagnosis(CEElement ceDiagnosis)

Set the Diagnosis for which we want the prevalence as a predefined CE Element.

Often uses one of the set of predefined constants

Parameters:

ceDiagnosis - CEElement populated with the coded Diagnosis

getDiagnosis

public CEElement getDiagnosis()

Set the Diagnosis as a predefined CE Element.

Often uses one of the set of predefined constants