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

Class OML_O39

java.lang.Object

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

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

public final class OML_O39
extends Message

OML_O39 - Specimen shipment centric laboratory order (event O39). The function of this message is to apply an order to all specimens in a shipment or a package within a shipment.

Represents a OML_O39 message structure (see chapter 4.4.4 ) 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 OML_O39 message) SINGLE_OPTIONAL
5: ORDER (a Group in OML_O39 message) MULTIPLE_COMPULSARY
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.

OML_O39 objO19 = (OML_O39)MessageFactory.createInstance().createSendSupportedMessage("OML", "O39");

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	addOrderGroup(IGroup objGroup) Adds ORDER GROUP to this message.
void	addOrderGroups(ISingleCollection<IGroup> objSingleCollection) Adds Collection of ORDER 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>	getOrderGroups() Retrieves Collection of ORDER 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
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, populate, 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

getOrderGroups

public ISingleCollection<IGroup> getOrderGroups()

Retrieves Collection of ORDER GROUP present in this message.

Returns:

ISingleCollection - Collection of ORDER Group present in this Message.

addOrderGroups

public void addOrderGroups(ISingleCollection<IGroup> objSingleCollection)

Adds Collection of ORDER GROUP to this message.

Parameters:

objSingleCollection - Specified ORDER GROUP Collection.

addOrderGroup

public void addOrderGroup(IGroup objGroup)

Adds ORDER GROUP to this message.

Parameters:

objGroup - Specified ORDER GROUP.