public class PMT extends Segment
Represents an HL7 PMT message segment. This segment has the following fields:
PMT-1 : Payment/Remittance Advice Number (EI) Required
PMT-2 : Payment/Remittance Effective Date/Time (DTM) Required
PMT-3 : Payment/Remittance Expiration Date/Time (DTM) Required
PMT-4 : Payment Method (CWE) Required
PMT-5 : Payment/Remittance Date/Time (DTM) Required
PMT-6 : Payment/Remittance Amount (CP) Required
PMT-7 : Check Number (EI)Optional
PMT-8 : Payee Bank Identification (XON)Optional
PMT-9 : Payee Transit Number (ST)Optional
PMT-10 : Payee Bank Account ID (CX)optional
User can also create Segment through SegmentFactory
| Constructor and Description |
|---|
PMT()
Constructs the PMT segment.
|
| Modifier and Type | Method and Description |
|---|---|
EI |
getCheckNumber()
Retrieve Check Number (EI)
This field is Unique check number from the Payer's application system.
|
ST |
getESR_Code_Line()
Retrieve ESR-Code-Line (ST)
This field is about Invoice Reference used with electronic banking methods.
|
CX |
getPayeeBankAccountID()
Retrieve Payee Bank Account ID (CX)
Id of Payee's Bank account.
|
XON |
getPayeeBankIdentification()
Retrieve Payee Bank Identification (XON)
This field is about Identification of Payee's financial contact, e.g., name of the bank .
|
ST |
getPayeeTransitNumber()
Retrieve Payee Transit Number (ST)
This field is about Personal ID of the payee used in financial transaction.
|
CWE |
getPaymentMethod()
retrieve Payment Method (CWE)
This field is about Code identifying the method for the movement of payment.
|
XON |
getPaymentOrganization()
Retrieve Payment Organization (XON)
This field is about Organization identifier that made the Payment/Remittance Advice; could be a Payer, Insurance Company, TPA, Drug Company.
|
EI |
getPaymentOrRemittanceAdviceNumber()
Retrieve Payment/Remittance Advice Number (EI)
This field is Unique Payment/Remittance Advice number for the sending Network Application ID.
|
CP |
getPaymentOrRemittanceAmount()
Retrieve Payment/Remittance Amount (CP)
This field is about Sum total of all Product/Service Paid Amount on PSL for this Payment/Remittance Advice, net of any Adjustments to Payee.
|
DTM |
getPaymentOrRemittanceDateOrTime()
Retrieve Payment/Remittance Date/Time (DTM)
This field is about Date Payment/Remittance Advice was paid, which might not be the same as Date/Time of Message on MSH.
|
DTM |
getPaymentOrRemittanceEffectiveDateOrTime()
Retrieve Payment/Remittance Effective Date/Time (DTM)
This field is about Date/Time for this Payment/Remittance Advice.
|
DTM |
getPaymentOrRemittanceExpirationDateOrTime()
Retrieve Payment/Remittance Expiration Date/Time (DTM)
This field is about Date/Time for this Payment/Remittance Advice.
|
void |
setCheckNumber(EI objCheckNumber)
Set Retrieve Check Number (EI)
This field is Unique check number from the Payer's application system.
|
void |
setCheckNumber(java.lang.String strEntityIdentifier,
java.lang.String strNamespaceID,
java.lang.String strUniversalID,
java.lang.String strUniversalIDType)
Set Retrieve Check Number (EI)
This field is Unique check number from the Payer's application system.
|
void |
setESR_Code_Line(ST objESR_Code_Line)
Retrieve ESR-Code-Line (ST)
This field is about Invoice Reference used with electronic banking methods.
|
void |
setESR_Code_Line(java.lang.String strESR_Code_Line)
Retrieve ESR-Code-Line (ST)
This field is about Invoice Reference used with electronic banking methods.
|
void |
setPayeeBankAccountID(CX objPayeeBankAccountID)
Set Payee Bank Account ID (CX)
Id of Payee's Bank account.
|
void |
setPayeeBankAccountID(java.lang.String strIDNumber,
java.lang.String strCheckDigit,
java.lang.String strCheckDigitScheme,
HD objAssigningAuthority,
java.lang.String strIdentifierTypeCode,
HD objAssigningFacility,
java.lang.String strEffectiveDate,
java.lang.String strExpirationDate,
CWE objAssigningJurisdiction,
CWE objAssigningAgencyOrDepartment,
java.lang.String strSecurityCheck,
java.lang.String strSecurityCheckScheme)
Set Payee Bank Account ID (CX)
Id of Payee's Bank account.
|
void |
setPayeeBankIdentification(java.lang.String strOrganizationName,
CWE objOrganizationNameTypeCode,
HD objAssigningAuthority,
java.lang.String strIdentifierTypeCode,
HD objAssigningFacility,
java.lang.String strNameRepresentationCode,
java.lang.String strOrganizationIdentifier)
Set Payee Bank Identification (XON)
This field is about Identification of Payee's financial contact, e.g., name of the bank .
|
void |
setPayeeBankIdentification(XON objPayeeBankIdentification)
Set Payee Bank Identification (XON)
This field is about Identification of Payee's financial contact, e.g., name of the bank .
|
void |
setPayeeTransitNumber(ST objPayeeTransitNumber)
Retrieve Payee Transit Number (ST)
This field is about Personal ID of the payee used in financial transaction.
|
void |
setPayeeTransitNumber(java.lang.String strPayeeTransitNumber)
Retrieve Payee Transit Number (ST)
This field is about Personal ID of the payee used in financial transaction.
|
void |
setPaymentMethod(CWE objPaymentMethod)
Set Payment Method (CWE)
This field is about Code identifying the method for the movement of payment.
|
void |
setPaymentMethod(java.lang.String strIdentifier,
java.lang.String strText,
java.lang.String strNameOfCodingSystem,
java.lang.String strAlternateIdentifier,
java.lang.String strAlternateText,
java.lang.String strNameOfAlternateCodingSystem,
java.lang.String strCodingSystemVersionID,
java.lang.String strAlternateCodingSystemVersionId,
java.lang.String strOriginalText,
java.lang.String strSecondAlternateIdentifier,
java.lang.String strSecondAlternateText,
java.lang.String strNameofSecondAlternateCodingSystem,
java.lang.String strSecondAlternateCodingSystemVersionID,
java.lang.String strCodingSystemOID,
java.lang.String strValueSetOID,
java.lang.String strValueSetVersionID,
java.lang.String strAlternateCodingSystemOID,
java.lang.String strAlternateValueSetOID,
java.lang.String strAlternateValueSetVersionID,
java.lang.String strSecondAlternateCodingSystemOID,
java.lang.String strSecondAlternateValueSetOID,
java.lang.String strSecondAlternateValueSetVersionID)
Set Payment Method (CWE)
This field is about Code identifying the method for the movement of payment.
|
void |
setPaymentOrganization(java.lang.String strOrganizationName,
CWE objOrganizationNameTypeCode,
HD objAssigningAuthority,
java.lang.String strIdentifierTypeCode,
HD objAssigningFacility,
java.lang.String strNameRepresentationCode,
java.lang.String strOrganizationIdentifier)
Set Payment Organization (XON)
This field is about Organization identifier that made the Payment/Remittance Advice; could be a Payer, Insurance Company, TPA, Drug Company.
|
void |
setPaymentOrganization(XON objPaymentOrganization)
Set Payment Organization (XON)
This field is about Organization identifier that made the Payment/Remittance Advice; could be a Payer, Insurance Company, TPA, Drug Company.
|
void |
setPaymentOrRemittanceAdviceNumber(EI objPaymentOrRemittanceAdviceNumber)
Set Retrieve Payment/Remittance Advice Number (EI)
This field is Unique Payment/Remittance Advice number for the sending Network Application ID.
|
void |
setPaymentOrRemittanceAdviceNumber(java.lang.String strEntityIdentifier,
java.lang.String strNamespaceID,
java.lang.String strUniversalID,
java.lang.String strUniversalIDType)
Set Retrieve Payment/Remittance Advice Number (EI)
This field is Unique Payment/Remittance Advice number for the sending Network Application ID.
|
void |
setPaymentOrRemittanceAmount(CP objPaymentOrRemittanceAmount)
Set Payment/Remittance Amount (CP)
This field is about Sum total of all Product/Service Paid Amount on PSL for this Payment/Remittance Advice, net of any Adjustments to Payee.
|
void |
setPaymentOrRemittanceAmount(MO objPrice,
java.lang.String strPriceType,
java.lang.String strFormValue,
java.lang.String strToValue,
CWE objRangeUnits,
java.lang.String strRangeType)
Set Payment/Remittance Amount (CP)
This field is about Sum total of all Product/Service Paid Amount on PSL for this Payment/Remittance Advice, net of any Adjustments to Payee.
|
void |
setPaymentOrRemittanceDateOrTime(DTM objPaymentOrRemittanceDateOrTime)
Set Payment/Remittance Expiration Date/Time (DTM)
This field is about Date Payment/Remittance Advice was paid, which might not be the same as Date/Time of Message on MSH.
|
void |
setPaymentOrRemittanceDateOrTime(java.lang.String strPaymentOrRemittanceDateOrTime)
Set Payment/Remittance Date/Time (DTM)
This field is about Date Payment/Remittance Advice was paid, which might not be the same as Date/Time of Message on MSH.
|
void |
setPaymentOrRemittanceEffectiveDateOrTime(DTM objPaymentOrRemittanceEffectiveDateOrTime)
Set Payment/Remittance Effective Date/Time (DTM)
This field is about Date/Time for this Payment/Remittance Advice.
|
void |
setPaymentOrRemittanceEffectiveDateOrTime(java.lang.String strPaymentOrRemittanceEffectiveDateOrTime)
Set Payment/Remittance Effective Date/Time (DTM)
This field is about Date/Time for this Payment/Remittance Advice.
|
void |
setPaymentOrRemittanceExpirationDateOrTime(DTM objPaymentOrRemittanceExpirationDateOrTime)
Set Payment/Remittance Expiration Date/Time (DTM)
This field is about Date/Time for this Payment/Remittance Advice.
|
void |
setPaymentOrRemittanceExpirationDateOrTime(java.lang.String strPaymentOrRemittanceExpirationDateOrTime)
Set Payment/Remittance Expiration Date/Time (DTM)
This field is about Date/Time for this Payment/Remittance Advice.
|
boolean |
validate()
Validates HL7 Message objects .
|
addUnRecognizedField, dumpSegment, getFields, getName, getUnrecognizedFields, moveToNextSegment, parse, removeDataElement, removeDataElement, serialize, setName, setUnRecognizedField, updateDataElement, updateDataElement, writeToXMLpublic EI getPaymentOrRemittanceAdviceNumber()
public void setPaymentOrRemittanceAdviceNumber(java.lang.String strEntityIdentifier,
java.lang.String strNamespaceID,
java.lang.String strUniversalID,
java.lang.String strUniversalIDType)
strEntityIdentifier - - string of character use to identify the entity.strNamespaceID - - Use to identify the name space id..strUniversalID - - Use to identify the name space identity.strUniversalIDType - - String of characters describe Universal Id Type.public void setPaymentOrRemittanceAdviceNumber(EI objPaymentOrRemittanceAdviceNumber)
objPaymentOrRemittanceAdviceNumber - - object of Payment/Remittance Advice Number.public DTM getPaymentOrRemittanceEffectiveDateOrTime()
public void setPaymentOrRemittanceEffectiveDateOrTime(java.lang.String strPaymentOrRemittanceEffectiveDateOrTime)
strPaymentOrRemittanceEffectiveDateOrTime - - string of Payment/Remittance Effective Date/Time.public void setPaymentOrRemittanceEffectiveDateOrTime(DTM objPaymentOrRemittanceEffectiveDateOrTime)
objPaymentOrRemittanceEffectiveDateOrTime - - object of Payment/Remittance Effective Date/Time.public DTM getPaymentOrRemittanceExpirationDateOrTime()
public void setPaymentOrRemittanceExpirationDateOrTime(java.lang.String strPaymentOrRemittanceExpirationDateOrTime)
strPaymentOrRemittanceExpirationDateOrTime - - string of Payment/Remittance Expiration Date/Time.public void setPaymentOrRemittanceExpirationDateOrTime(DTM objPaymentOrRemittanceExpirationDateOrTime)
objPaymentOrRemittanceExpirationDateOrTime - - object of Payment/Remittance Expiration Date/Time.public CWE getPaymentMethod()
public void setPaymentMethod(java.lang.String strIdentifier,
java.lang.String strText,
java.lang.String strNameOfCodingSystem,
java.lang.String strAlternateIdentifier,
java.lang.String strAlternateText,
java.lang.String strNameOfAlternateCodingSystem,
java.lang.String strCodingSystemVersionID,
java.lang.String strAlternateCodingSystemVersionId,
java.lang.String strOriginalText,
java.lang.String strSecondAlternateIdentifier,
java.lang.String strSecondAlternateText,
java.lang.String strNameofSecondAlternateCodingSystem,
java.lang.String strSecondAlternateCodingSystemVersionID,
java.lang.String strCodingSystemOID,
java.lang.String strValueSetOID,
java.lang.String strValueSetVersionID,
java.lang.String strAlternateCodingSystemOID,
java.lang.String strAlternateValueSetOID,
java.lang.String strAlternateValueSetVersionID,
java.lang.String strSecondAlternateCodingSystemOID,
java.lang.String strSecondAlternateValueSetOID,
java.lang.String strSecondAlternateValueSetVersionID)
strIdentifier - Specifies of characters (the code) that uniquely identifies the item being referenced.strText - Specifies The descriptive or textual name of the identifier, e.g., myocardial infection.strNameOfCodingSystem - Identifies the coding scheme being used in the identifier component.strAlternateIdentifier - Specifies an alternate sequence of characters (the code) that uniquely identifies the item being referenced.strAlternateText - Specifies the descriptive or textual name of the alternate identifier. See usage note in section introduction.strNameOfAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.strCodingSystemVersionID - A sequence of characters that uniquely identifies a second alternate code.strAlternateCodingSystemVersionId - This component carries the version for the coding system identified by components 4-6.strOriginalText - The text as seen and/or selected by the user who entered the data.strSecondAlternateIdentifier - A sequence of characters that uniquely identifies a second alternate code.strSecondAlternateText - The descriptive or textual name of the alternate identifier.strNameofSecondAlternateCodingSystem - Identifies the coding scheme being used in the alternate identifier component.strSecondAlternateCodingSystemVersionID - This component carries the version for the coding system identified by components 10-12.strCodingSystemOID - This component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.3.strValueSetOID - This component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.1 is obtained.strValueSetVersionID - This component carries the version for the value set identified by CWE.15. The version is a date. The date is the date/time that the value set being used was published.strAlternateCodingSystemOID - This component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.6.strAlternateValueSetOID - This component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.4 is obtained.strAlternateValueSetVersionID - This component carries the version for the value set identified by CWE.18. The version is a date.strSecondAlternateCodingSystemOID - This component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.12.strSecondAlternateValueSetOID - This component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.10 is obtained.strSecondAlternateValueSetVersionID - This component carries the version for the value set identified by CWE.21. The version is a date.public void setPaymentMethod(CWE objPaymentMethod)
objPaymentMethod - - object of Payment Method.public DTM getPaymentOrRemittanceDateOrTime()
public void setPaymentOrRemittanceDateOrTime(java.lang.String strPaymentOrRemittanceDateOrTime)
strPaymentOrRemittanceExpirationDateOrTime - - string of Payment/Remittance Date/Time.public void setPaymentOrRemittanceDateOrTime(DTM objPaymentOrRemittanceDateOrTime)
objPaymentOrRemittanceExpirationDateOrTime - - object of Payment/Remittance Expiration Date/Time.public CP getPaymentOrRemittanceAmount()
public void setPaymentOrRemittanceAmount(MO objPrice, java.lang.String strPriceType, java.lang.String strFormValue, java.lang.String strToValue, CWE objRangeUnits, java.lang.String strRangeType)
objPrice - - Gives information about the Price.strPriceType - - Gives information about Type of Price.strFormValue - - Gives information about Form Value.strToValue - - Tell about the To value.objRangeUnits - - Specifies about the range of the units.strRangeType - - Specifies about the Type of range.public void setPaymentOrRemittanceAmount(CP objPaymentOrRemittanceAmount)
objPaymentOrRemittanceAmount - - object of Payment/Remittance Amount.public EI getCheckNumber()
public void setCheckNumber(java.lang.String strEntityIdentifier,
java.lang.String strNamespaceID,
java.lang.String strUniversalID,
java.lang.String strUniversalIDType)
strEntityIdentifier - - string of character use to identify the entity.strNamespaceID - - Use to identify the name space id..strUniversalID - - Use to identify the name space identity.strUniversalIDType - - String of characters describe Universal Id Type.public void setCheckNumber(EI objCheckNumber)
objCheckNumber - - object of Check Number.public XON getPayeeBankIdentification()
public void setPayeeBankIdentification(java.lang.String strOrganizationName,
CWE objOrganizationNameTypeCode,
HD objAssigningAuthority,
java.lang.String strIdentifierTypeCode,
HD objAssigningFacility,
java.lang.String strNameRepresentationCode,
java.lang.String strOrganizationIdentifier)
strOrganizationName - Specifies name of the specified organization.strOrganizationNameTypeCode - Specifies a code that represents the type of name i.e., legal name, display name.
Suggested Values A,L,D,SL.[Refer to table No.0204]objAssigningAuthority - Specifies The assigning authority is a unique identifier of the system
(or organization or agency or department) that creates the data.strIdentifierTypeCode - Specifies a code corresponding to the type of identifier.objAssigningFacility - Specifies The place or location identifier where the identifier was first assigned to the person.strNameRepresentationCode - Specifies representations of the same name/address Suggested values are I,A,P [Refer table 0465]strOrganizationIdentifier - This component contains the sequence of characters (the code) that uniquely
identifies the item being referenced by XON.1 Organization Name.
This component replaces XON.3 ID Number as of v 2.8.2.public void setPayeeBankIdentification(XON objPayeeBankIdentification)
objVATRatesAppliedList - - object of Payee Bank Identification.public ST getPayeeTransitNumber()
public void setPayeeTransitNumber(java.lang.String strPayeeTransitNumber)
strPayeeTransitNumber - - object of Payee Transit Number.public void setPayeeTransitNumber(ST objPayeeTransitNumber)
objPayeeTransitNumber - - object of Payee Transit Number.public CX getPayeeBankAccountID()
public void setPayeeBankAccountID(java.lang.String strIDNumber,
java.lang.String strCheckDigit,
java.lang.String strCheckDigitScheme,
HD objAssigningAuthority,
java.lang.String strIdentifierTypeCode,
HD objAssigningFacility,
java.lang.String strEffectiveDate,
java.lang.String strExpirationDate,
CWE objAssigningJurisdiction,
CWE objAssigningAgencyOrDepartment,
java.lang.String strSecurityCheck,
java.lang.String strSecurityCheckScheme)
strIDNumber - Specifies the value of the identifier itself.strCheckDigit - It is part of the identifying number used in the sending application.strCheckDigitScheme - Contains the code identifying the check digit scheme employed.
Suggested Values NP,ISO,M10,M11.[Refer table No.0061].objAssigningAuthority - The assigning authority is a unique name of the system (or organization or agency
or department) that creates the data. .strIdentifierTypeCode - Specifies a code corresponding to the type of identifier.In some cases, this code may be
used as a qualifier to the "Assigning authority" component.[Refer table No 0203]objAssigningFacility - Specifies the place or location identifier where the identifier was first assigned
to the patient.strEffectiveDate - Specifies the first date, if known, on which the address is valid and active.strExpirationDate - Specifies the last date, if known, on which the address is valid and active.objAssigningJurisdiction - Specifies the geo-political body that assigned the identifier.objAssigningAgencyOrDepartment - Specifies agency or department that assigned the identifier.strSecurityCheck - is used to communicate the version code.objSecurityCheckSCheme - is used to transmit information intended to validate veracity of the supplied identifierpublic void setPayeeBankAccountID(CX objPayeeBankAccountID)
objPayeeBankAccountID - - object of Payee Bank Account ID.public XON getPaymentOrganization()
public void setPaymentOrganization(java.lang.String strOrganizationName,
CWE objOrganizationNameTypeCode,
HD objAssigningAuthority,
java.lang.String strIdentifierTypeCode,
HD objAssigningFacility,
java.lang.String strNameRepresentationCode,
java.lang.String strOrganizationIdentifier)
strOrganizationName - Specifies name of the specified organization.strOrganizationNameTypeCode - Specifies a code that represents the type of name i.e., legal name, display name.
Suggested Values A,L,D,SL.[Refer to table No.0204]objAssigningAuthority - Specifies The assigning authority is a unique identifier of the system
(or organization or agency or department) that creates the data.strIdentifierTypeCode - Specifies a code corresponding to the type of identifier.objAssigningFacility - Specifies The place or location identifier where the identifier was first assigned to the person.strNameRepresentationCode - Specifies representations of the same name/address Suggested values are I,A,P [Refer table 0465]strOrganizationIdentifier - This component contains the sequence of characters (the code) that uniquely
identifies the item being referenced by XON.1 Organization Name.
This component replaces XON.3 ID Number as of v 2.8.2.public void setPaymentOrganization(XON objPaymentOrganization)
objPaymentOrganization - - object of Payment Organization.public ST getESR_Code_Line()
public void setESR_Code_Line(java.lang.String strESR_Code_Line)
strESR_Code_Line - - object of ESR-Code-Line.public void setESR_Code_Line(ST objESR_Code_Line)
objESR_Code_Line - - object of ESR-Code-Line.public boolean validate()
throws InvalidSegmentException
validate in interface ISegmentvalidate in class SegmentInvalidSegmentException - Throws when Segment Validation fails.