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

Class BAR_P12

java.lang.Object

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

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

public final class BAR_P12
extends Message

BAR_P12 - Update Diagnosis/Procedure (Event P12). This event is used to communicate diagnosis and/or procedures in update mode.

Represents a BAR_P12 message structure (see chapter 6.4.9). 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: PID (Patient Identification Segment) SINGLE_COMPULSARY
5: PV1 (Patient Visit Segment) SINGLE_COMPULSARY
6: DG1 (Diagnosis Segment) MULTIPLE_OPTIONAL
7: DRG (Diagnosis Related Group Segment) SINGLE_OPTIONAL
8: PROCEDURE (a Group of segments in BAR_P12 message) MULTIPLE_OPTIONAL
9: OBX (Observation Result Segment) SINGLE_OPTIONAL
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_P12 objP12 = (BAR_P12)MessageFactory.createInstance().createSendSupportedMessage("BAR", "P12");

Method Summary

Methods

Modifier and Type	Method and Description
void	addDiagnosisSegment(DG1 objDG1) Adds Diagnosis Segment(DG1) to this message.
void	addDiagnosisSegments(ISingleCollection<DG1> objDG1SegmentCollection) Adds collection of Diagnosis(DG1) to this message.
void	addProcedureGroup(IGroup objGroup) Adds Procedure Group to this message.
void	addProcedureGroups(ISingleCollection<IGroup> objSingleCollection) Adds collection of Procedure Segment 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.
DRG	getDiagnosisRelatedGroupSegment() Retrieves Diagnosis Related Group(DRG ) segment present in this message.
ISingleCollection<DG1>	getDiagnosisSegments() Retrieves Collection of Diagnosis(DG1) present in this message.
EVN	getEventTypeSegment() Retrieves Event Type(EVN) segment present in this message
OBX	getObservationResultSegment() Retrieves Observation Result(OBX) Segment present in this message.
PID	getPatientIdentificationSegment() Retrieves Patient Identification(PID) segment present in this message.
PV1	getPatientVisitSegment() Retrieves Patient Visit(PV1) segment present in this message.
ISingleCollection<IGroup>	getProcedureGroups() Retrieves Collection of Procedure 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	setDiagnosisRelatedGroupSegment(DRG objDRG) Sets value of Diagnosis Related Group segment(DRG) for this message,overwrites if already present.
void	setEventTypeSegment(EVN objEVN) Sets value of Event Type segment for this message,overwrites if already present.
void	setObservationResultSegment(OBX objOBX) Sets value of Observation Result(OBX) segment for this message, overwrites if already present.
void	setPatientIdentificationSegment(PID objPID) Sets value of PID segment for this message,overwrites if already present.
void	setPatientVisitSegment(PV1 objPV1) Sets value of PV1 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

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

getPatientIdentificationSegment

public PID getPatientIdentificationSegment()

Retrieves Patient Identification(PID) segment present in this message.

Returns:

PID - the Patient Identification Segment present in this message or null if unavailable.

setPatientIdentificationSegment

public void setPatientIdentificationSegment(PID objPID)

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

Parameters:

objPID - Specified PID Segment

getPatientVisitSegment

public PV1 getPatientVisitSegment()

Retrieves Patient Visit(PV1) segment present in this message.

Returns:

PV1 - Patient Visit Segment present in this message or null if unavailable.

setPatientVisitSegment

public void setPatientVisitSegment(PV1 objPV1)

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

Parameters:

objPV1 - Specified PV1 Segment

addDiagnosisSegment

public void addDiagnosisSegment(DG1 objDG1)

Adds Diagnosis Segment(DG1) to this message.

Parameters:

objDG1 - Specified Diagnosis(DG1) segment

addDiagnosisSegments

public void addDiagnosisSegments(ISingleCollection<DG1> objDG1SegmentCollection)

Adds collection of Diagnosis(DG1) to this message.

Parameters:

objDG1SegmentCollection - Collection of Diagnosis(DG1) segments

getDiagnosisSegments

public ISingleCollection<DG1> getDiagnosisSegments()

Retrieves Collection of Diagnosis(DG1) present in this message.

Returns:

ISingleCollection - Collection of Diagnosis(DG1) segments

getDiagnosisRelatedGroupSegment

public DRG getDiagnosisRelatedGroupSegment()

Retrieves Diagnosis Related Group(DRG ) segment present in this message.

Returns:

DRG - Diagnosis Related Group Segment present in this message or null if unavailable.

setDiagnosisRelatedGroupSegment

public void setDiagnosisRelatedGroupSegment(DRG objDRG)

Sets value of Diagnosis Related Group segment(DRG) for this message,overwrites if already present.

Parameters:

objDRG - Specified DRG Segment

addProcedureGroup

public void addProcedureGroup(IGroup objGroup)

Adds Procedure Group to this message.

Parameters:

objGroup - Specified Procedure Group

addProcedureGroups

public void addProcedureGroups(ISingleCollection<IGroup> objSingleCollection)

Adds collection of Procedure Segment to this message.

Parameters:

objSingleCollection - Collection of Software Segments

getProcedureGroups

public ISingleCollection<IGroup> getProcedureGroups()

Retrieves Collection of Procedure Group present in this message.

Returns:

ISingleCollection - Collection of Procedure Group

getObservationResultSegment

public OBX getObservationResultSegment()

Retrieves Observation Result(OBX) Segment present in this message.

Returns:

OBX - the Observation Result(OBX) Segment present in this message or null if unavailable.

setObservationResultSegment

public void setObservationResultSegment(OBX objOBX)

Sets value of Observation Result(OBX) segment for this message, overwrites if already present.

Parameters:

objOBX - Specified OBX Segment