cdac.medinfo.sdk.hl7282.hl7model.messages.orderentry

Class OMD_O03

java.lang.Object

cdac.medinfo.sdk.hl7282.baselibs.messages.Message

cdac.medinfo.sdk.hl7282.hl7model.messages.orderentry.OMD_O03

public final class OMD_O03
extends Message

OMD_O03 - Dietary OrderDiet (Event O03). This message needs to receive specific information, the most important being the diet order itself.

Represents a OMD_O03 message structure (see chapter 4.7.1 ) This structure contains the following elements:

0: MSH (Message Header segment) SINGLE_COMPULSARY
1: SFT (Software Segment) MULTIPLE_OPTIONAL
2: UAC (User Authentication Credential) SINGLE_OPTIONAL
3: NTE (Notes and Comments Segment) MULTIPLE_OPTIONAL
4: PATIENT (a Group in OMD_O03 message) SINGLE_OPTIONAL
5: ORDER_DIET (a Group in OMD_O03 message) MULTIPLE_COMPULSARY
6: ORDER_TRAY (a Group in OMD_O03 message) MULTIPLE_OPTIONAL
This class provides mechanism to validate message against HL7 v 2.5 standard. The class provides accessors & mutators for the elements mentioned above. These elements can be easily populated & populated values can be easily retrieved. The class has validate method which validates Message against HL7 v 2.5 standard.

Following is the step to create message
Before that, respective Message Source and Message Recipient to be set on Message Factory.

OMD_O03 objO03 = (OMD_O03)MessageFactory.createInstance().createSendSupportedMessage("OMD", "O03");

Method Summary

Methods

Modifier and Type	Method and Description
void	addNotesAndCommentsSegment(ISingleCollection<NTE> objNTESegmentCollection) Adds collection of Notes and Comments Segment(NTE) to this message.
void	addNotesAndCommentsSegment(NTE objNTE) Adds Notes and Comments Segment(NTE) to this message.
void	addOrderDietGroup(IGroup objGroup) Adds ORDER_DIET GROUP to this message.
void	addOrderDietGroups(ISingleCollection<IGroup> objSingleCollection) Adds Collection of ORDER_DIET GROUP to this message.
void	addOrderTrayGroup(IGroup objGroup) Adds ORDER_TRAY GROUP to this message.
void	addOrderTrayGroups(ISingleCollection<IGroup> objSingleCollection) Adds Collection of ORDER_TRAY GROUP to this message.
void	addSoftwareSegment(ISingleCollection<SFT> objSFTSegmentCollection) Adds collection of Software Segment(SFT) to this message.
void	addSoftwareSegment(SFT objSFT) Adds Software Segment(SFT) to this message.
ISingleCollection<NTE>	getNotesAndCommentsSegments() Retrieves Collection of Notes and Comments Segments(NTE) present in this message.
ISingleCollection<IGroup>	getOrderDietGroups() Retrieves Collection of ORDER_DIET GROUP present in this message.
ISingleCollection<IGroup>	getOrderTrayGroups() Retrieves Collection of ORDER_TRAY GROUP present in this message.
IGroup	getPatientGroup() Retrieves Patient Group present in this message.
ISingleCollection<SFT>	getSoftwareSegments() Retrieves Collection of Software Segments(SFT) present in this message.
UAC	getUserAuthenticationCredentialSegment() Retrieves User Authentication Credential(UAC) segment present in this message
int	populate(ISegmentSet objSegmentSet) Populates Message using provided SegmentSet according to Message Structure specified by HL7 standard.
void	setPatientGroup(IGroup objGroup) Sets value of Patient Group for this message,overwrites if already present.
void	setUserAuthenticationCredentialSegment(UAC objUAC) Sets value of User Authentication Credential segment for this message,overwrites if already present.

Methods inherited from class cdac.medinfo.sdk.hl7282.baselibs.messages.Message

contains, dumpMessage, dumpMessage, getACKMode, getGroup, getGroupMap, getHeader, getMessageCode, getMessageControlID, getMessageStructure, getQueryUserParameters, getSegment, getSegmentSet, getSubscriptionType, getTriggerEvent, isQuery, isResponse, removeGroup, removeSegment, removeSegment, removeSegmentAttribute, removeSegmentAttribute, removeSegmentAttribute, removeSegments, setHeader, setSubscriptionType, updateSegmentAttribute, updateSegmentAttribute, validate, writeToXML, writeToXML

Methods inherited from class java.lang.Object

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

Method Detail

getSoftwareSegments

public ISingleCollection<SFT> getSoftwareSegments()

Retrieves Collection of Software Segments(SFT) present in this message.

Returns:

ISingleCollection - Collection of Software Segments(SFT) present in this message.

addSoftwareSegment

public void addSoftwareSegment(SFT objSFT)

Adds Software Segment(SFT) to this message.

Parameters:

objSFT - Specified Software Segment(SFT) to be added in this messageto this message.

addSoftwareSegment

public void addSoftwareSegment(ISingleCollection<SFT> objSFTSegmentCollection)

Adds collection of Software Segment(SFT) to this message.

Parameters:

objSFTSegmentCollection - Collection of Software Segments to add in this message

getUserAuthenticationCredentialSegment

public UAC getUserAuthenticationCredentialSegment()

Retrieves User Authentication Credential(UAC) segment present in this message

Returns:

UAC - Specified UAC Segment

setUserAuthenticationCredentialSegment

public void setUserAuthenticationCredentialSegment(UAC objUAC)

Sets value of User Authentication Credential segment for this message,overwrites if already present.

Parameters:

objUAC - Specified UAC Segment

getNotesAndCommentsSegments

public ISingleCollection<NTE> getNotesAndCommentsSegments()

Retrieves Collection of Notes and Comments Segments(NTE) present in this message.

Returns:

ISingleCollection - Collection of Notes and Comments Segments(NTE) present in this message.

addNotesAndCommentsSegment

public void addNotesAndCommentsSegment(NTE objNTE)

Adds Notes and Comments Segment(NTE) to this message.

Parameters:

objNTE - Specified Notes and Comments Segment(NTE)to add in this message.

addNotesAndCommentsSegment

public void addNotesAndCommentsSegment(ISingleCollection<NTE> objNTESegmentCollection)

Adds collection of Notes and Comments Segment(NTE) to this message.

Parameters:

objNTESegmentCollection - Collection of Notes and Comments Segments to add in this message

getPatientGroup

public IGroup getPatientGroup()

Retrieves Patient Group present in this message.

Returns:

Group - Patient Group present in this message.

setPatientGroup

public void setPatientGroup(IGroup objGroup)

Sets value of Patient Group for this message,overwrites if already present.

Parameters:

objGroup - Specified Patient Group

getOrderDietGroups

public ISingleCollection<IGroup> getOrderDietGroups()

Retrieves Collection of ORDER_DIET GROUP present in this message.

Returns:

ISingleCollection - Collection of ORDER_DIET Group present in this Message.

addOrderDietGroups

public void addOrderDietGroups(ISingleCollection<IGroup> objSingleCollection)

Adds Collection of ORDER_DIET GROUP to this message.

Parameters:

objSingleCollection - Specified ORDER_DIET GROUP Collection.

addOrderDietGroup

public void addOrderDietGroup(IGroup objGroup)

Adds ORDER_DIET GROUP to this message.

Parameters:

objGroup - Specified ORDER_DIET GROUP.

getOrderTrayGroups

public ISingleCollection<IGroup> getOrderTrayGroups()

Retrieves Collection of ORDER_TRAY GROUP present in this message.

Returns:

ISingleCollection - Collection of ORDER_TRAY Group present in this Message.

addOrderTrayGroups

public void addOrderTrayGroups(ISingleCollection<IGroup> objSingleCollection)

Adds Collection of ORDER_TRAY GROUP to this message.

Parameters:

objSingleCollection - Specified ORDER_TRAY GROUP Collection.

addOrderTrayGroup

public void addOrderTrayGroup(IGroup objGroup)

Adds ORDER_TRAY GROUP to this message.

Parameters:

objGroup - Specified ORDER_TRAY GROUP.

populate

public int populate(ISegmentSet objSegmentSet)
             throws InvalidMessageException

Populates Message using provided SegmentSet according to Message Structure specified by HL7 standard.

Overrides:

populate in class Message

Parameters:

objSegmentSet - instance of SegmentSet

Returns:

int - shows status as success or failure

Throws:

InvalidMessageException - If message validation fails.