cdac.medinfo.sdk.hl7282.hl7model.messages.financialmanagement

Class BAR_P02

java.lang.Object

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

cdac.medinfo.sdk.hl7282.hl7model.messages.financialmanagement.BAR_P02

public final class BAR_P02
extends Message

BAR_P02 - A Purge Patient Accounts (Event P02). This event is use to eliminate of all billing/accounts, a need to correct an account, or a series of accounts, a notice of account deletion be sent from another sub-system and processed , for example, by the patient accounting or financial system.

Represents a BAR_P02 message structure (see chapter 6.4.2). This structure contains the following elements:

0: MSH (Message Header segment)
1: SFT (Software Segment) MULTIPLE_OPTIONAL
2: UAC (User Authentication Credential Segment) SINGLE_OPTIONAL
3: EVN (Event Type Segment) SINGLE_COMPULSARY
4: PATIENT (a Group of segments in BAR_P02 message) MULTIPLE_COMPULSARY
This class provides mechanism to validate message against HL7 v 2.8.2 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.8.2 standard.

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

BAR_P02 objP02 = (BAR_P02)MessageFactory.createInstance().createSendSupportedMessage("BAR", "P02");

Method Summary

Methods

Modifier and Type	Method and Description
void	addPatientGroup(IGroup objGroup) Adds PATIENT GROUP to this message.
void	addPatientGroups(ISingleCollection<IGroup> objSingleCollection) Adds Collection of PATIENT 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.
EVN	getEventTypeSegment() Retrieves Event Type(EVN) segment present in this message
ISingleCollection<IGroup>	getPatientGroups() 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	setEventTypeSegment(EVN objEVN) Sets value of Event Type segment for this message,overwrites if already present.
void	setUserAuthenticationCredentialSegment(UAC objUAC) Sets value of User Authentication Credential(UAC) 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

addSoftwareSegment

public void addSoftwareSegment(SFT objSFT)

Adds Software Segment(SFT) to this message.

Parameters:

objSFT - Specified Software Segment(SFT) to be added in 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

getSoftwareSegments

public ISingleCollection<SFT> getSoftwareSegments()

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

Returns:

ISingleCollection - Collection of Software Segments(SFT)

getUserAuthenticationCredentialSegment

public UAC getUserAuthenticationCredentialSegment()

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

Returns:

UAC - the User Authentication Credential Segment present in this message or null if unavailable.

setUserAuthenticationCredentialSegment

public void setUserAuthenticationCredentialSegment(UAC objUAC)

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

Parameters:

objUAC - Specified UAC Segment

getEventTypeSegment

public EVN getEventTypeSegment()

Retrieves Event Type(EVN) segment present in this message

Returns:

EVN - the EVN Segment present in this message or null if unavailable.

setEventTypeSegment

public void setEventTypeSegment(EVN objEVN)

Sets value of Event Type segment for this message,overwrites if already present.

Parameters:

objEVN - Specified EVN Segment

getPatientGroups

public ISingleCollection<IGroup> getPatientGroups()

Retrieves Patient Group present in this message.

Returns:

Group - Patient Group present in this message.

addPatientGroups

public void addPatientGroups(ISingleCollection<IGroup> objSingleCollection)

Adds Collection of PATIENT GROUP to this message.

Parameters:

objSingleCollection - Specified PATIENT GROUP Collection.

addPatientGroup

public void addPatientGroup(IGroup objGroup)

Adds PATIENT GROUP to this message.

Parameters:

objGroup - Specified PATIENT GROUP.