public class GP1 extends Segment
This Segment contains fields that are used in grouping and reimbursement
Represents an HL7 GP1 message segment. This segment has the following fields:
GP1-1: Type of Bill Code (CWE)Required
GP1-2: Revenue Code (CWE)Optional
GP1-3: Overall Claim Disposition Code (CWE)Optional
GP1-4: OCE Edits per Visit Code (CWE)Optional
GP1-5: Outlier Cost (CP)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. The class has validate method which validates Message against HL7 v 2.8.2 standard.
User can also create Segment through SegmentFactory
| Constructor and Description |
|---|
GP1()
Constructs the GP1 segment.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addOCEEditsPerVisitCode(CWE objOCEEditsPerVisitCode)
Set the OCE Edits Per Visit Code.
|
void |
addOCEEditsPerVisitCode(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 the OCE Edits Per Visit Code.
|
void |
addRevenueCode(CWE objrevenueCode)
Set the Revenue Code.
|
void |
addRevenueCode(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 the Revenue Code.
|
ISingleCollection<CWE> |
getOCEEditsPerVisitCode()
Retrieves the OCE Edits Per Visit Code.
|
CP |
getOutlierCost()
Retrieves the Outlier Cost.
|
CWE |
getOverallClaimDispositionCode()
Retrieves the Overall Claim Disposition Code.
|
ISingleCollection<CWE> |
getRevenueCode()
Retrieves the Revenue Code.
|
CWE |
getTypeOfBillCode()
Retrieves the Type Of Bill Code.
|
void |
setOCEEditsPerVisitCode(ISingleCollection<CWE> objOCEEditsPerVisitCodeList)
Set the OCEEditsPerVisitCode list.
|
void |
setOutlierCost(CP objoutlierCost)
Set the Outlier Cost.
|
void |
setOutlierCost(MO objPrice,
java.lang.String strPriceType,
java.lang.String strFromValue,
java.lang.String strToValue,
CWE objRangeUnits,
java.lang.String strRangeType)
Set the Outlier Cost.
|
void |
setOverallClaimDispositionCode(CWE objoverallClaimDispositionCode)
Set the Overall Claim Disposition Code.
|
void |
setOverallClaimDispositionCode(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 the Overall Claim Disposition Code.
|
void |
setRevenueCode(ISingleCollection<CWE> objRevenueCodeList)
Set the RevenueCode list.
|
void |
setTypeOfBillCode(CWE objtypeOfBillCode)
Set the Type Of Bill Code.
|
void |
setTypeOfBillCode(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 the Type Of Bill Code.
|
boolean |
validate()
Validates HL7 Message objects .
|
addUnRecognizedField, dumpSegment, getFields, getName, getUnrecognizedFields, moveToNextSegment, parse, removeDataElement, removeDataElement, serialize, setName, setUnRecognizedField, updateDataElement, updateDataElement, writeToXMLpublic ISingleCollection<CWE> getOCEEditsPerVisitCode()
public CP getOutlierCost()
public CWE getOverallClaimDispositionCode()
public ISingleCollection<CWE> getRevenueCode()
public CWE getTypeOfBillCode()
public void addOCEEditsPerVisitCode(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 infarction.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 addOCEEditsPerVisitCode(CWE objOCEEditsPerVisitCode)
objOCEEditsPerVisitCode - This field contains the String Value of Edits Per Visit Codepublic void setOCEEditsPerVisitCode(ISingleCollection<CWE> objOCEEditsPerVisitCodeList)
objOCEEditsPerVisitCodeList - List of OCEEditsPerVisitCodepublic void setOutlierCost(MO objPrice, java.lang.String strPriceType, java.lang.String strFromValue, java.lang.String strToValue, CWE objRangeUnits, java.lang.String strRangeType)
objPrice - Specifies an amount of money and the denomination in which it is expressed.strPriceType - Specifies a coded value, data type ID.[Refer to HL7 Table 0205]
Suggested Values AP,DC,IC,PF,TF,TP,UP.strFromValue - Spefies the "range" alongwith strToValue.strToValue - Spefies the "range" alongwith strFromValue.objRangeUnits - Specifies This describes the units associated with the range, e.g., seconds, minutesstrRangeType - Refer to HL7 Table 0298 - CP range type for valid values.(P,F)public void setOutlierCost(CP objoutlierCost)
objoutlierCost - public void setOverallClaimDispositionCode(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 infarction.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 setOverallClaimDispositionCode(CWE objoverallClaimDispositionCode)
objoverallClaimDispositionCode - This field contains the String Value of Overall Claim Disposition Codepublic void addRevenueCode(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 infarction.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 addRevenueCode(CWE objrevenueCode)
objrevenueCode - This field contains the String Value of Revenue Codepublic void setRevenueCode(ISingleCollection<CWE> objRevenueCodeList)
objRevenueCodeList - List of RevenueCodepublic void setTypeOfBillCode(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 infarction.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 setTypeOfBillCode(CWE objtypeOfBillCode)
objtypeOfBillCode - This field contains the String Value of Type Of Bill Codepublic boolean validate()
throws InvalidSegmentException
validate in interface ISegmentvalidate in class SegmentInvalidSegmentException - If Segment Validation fails