public class PPN extends CompositeDataType
This data type type is the equivalent of an XCN data type joined with a TS data type.
Represents an HL7 PPN data type. This data type has the following attributes:
1. Person Identifier (ST)Optional
2. Family Name (FN)Optional
3. Given Name (ST)Optional
4. Second and Further Given Names or Initials Thereof (ST)Optional
5. Suffix (e.g., JR or III) (ST)Optional
6. Prefix (e.g., DR) (ST)Optional
8. Source Table (CWE)Backward
9. Assigning Authority (HD)Conditional
10. Name Type Code (ID)Optional
11. Identifier Check Digit (ST)Optional
12. Check Digit Scheme (ID)Conditional
13. Identifier Type Code (ID)Optional
14. Assigning Facility (HD)Optional
15. Date/Time Action Performed (DTM)Optional
16. Name Representation Code (ID)Optional
17. Name Context (CWE)Optional
19. Name Assembly Order (ID)Optional
20. Effective Date (DTM)Optional
21. Expiration Date (DTM)Optional
22. Professional Suffix (ST)Optional
23. Assigning Jurisdiction (CWE)Optional
24. Assigning Agency or Department (CWE)Optional
25. Security Check (ST)Optional
26. Security Check Scheme (ID)Optional
This class provides accessors & mutators for the elements mentioned above. This class override the equal method, to check whether some other object is "equal to" this one.
User can also create Data Type through DataElementFactory
| Constructor and Description |
|---|
PPN()
Default Constructor for PPN
|
PPN(int iComponentType,
IDataTypeMap objIDataTypeMap)
Constructor for PPN class which takes two arguments and
sets the value in the respective member variable.
|
PPN(int iComponentType,
int iMinLength,
int iMaxLength,
java.lang.String strCLength,
IDataTypeMap objIDataTypeMap)
Constructor for PPN class which takes five arguments and
sets the value in the respective member variable.
|
PPN(int iComponentType,
int iMinLength,
int iMaxLength,
java.lang.String strCLength,
int ITableNo,
IDataTypeMap objIDataTypeMap)
Constructor for PPN class which takes six arguments and
sets the value in the respective member variable.
|
PPN(int iMinLength,
int iMaxLength,
java.lang.String strCLength,
int iComponentType)
Constructor for CQ class which takes four arguments and
sets the value in the respective member variable.
|
PPN(int iMinLength,
int iMaxLength,
java.lang.String strCLength,
int iTableNo,
int iComponentType)
Constructor for PPN class which takes five arguments and
sets the value in the respective member variable.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object objObject)
This method checks the equality of Object.
|
CWE |
getAssigningAgencyorDepartment()
Returns Assigning Agency or Department
|
HD |
getAssigningAuthority()
Returns Assigning Authority
|
HD |
getAssigningFacility()
Returns Assigning Facility
|
CWE |
getAssigningJurisdiction()
Returns Assigning Jurisdiction
|
ID |
getCheckDigitScheme()
Returns Check Digit Scheme
|
DTM |
getDateTimeActionPerformed()
Returns Date/Time Action Performed
|
DTM |
getEffectiveDate()
Returns Effective Date
|
DTM |
getExpirationDate()
Returns Expiration Date
|
FN |
getFamilyName()
Returns Family Name
|
ST |
getGivenName()
Returns Given Name
|
ST |
getIdentifierCheckDigit()
Returns Identifier Check Digit
|
ID |
getIdentifierTypeCode()
Returns Identifier Type Code
|
ID |
getNameAssemblyOrder()
Returns Name Assembly Order
|
CWE |
getNameContext()
Returns Name Context
|
ID |
getNameRepresentationCode()
Returns Name Representation Code
|
ID |
getNameTypeCode()
Returns Name Type Code
|
ST |
getPersonIdentifier()
Returns ID Number
|
ST |
getPrefix()
Returns Prefix (e.g., DR)
|
ST |
getProfessionalSuffix()
Returns Professional Suffix
|
ST |
getSecondNameInitials()
Returns Second and Further Given Names or Initials Thereof
|
ST |
getSecurityCheck()
Returns Security Check
|
ID |
getSecurityCheckScheme()
Returns Security Check Scheme
|
CWE |
getSourceTable()
Returns Source Table
|
ST |
getSuffix()
Returns Suffix (e.g., JR or III)
|
void |
setAssigningAgencyOrDepartment(CWE objAssigningAgencyOrDepartment)
Sets the AssigningAgencyOrDepartment.
|
void |
setAssigningAuthority(HD objAssigningAuthority)
Sets the AssigningAuthority.
|
void |
setAssigningFacility(HD objAssigningFacility)
Sets the AssigningFacility.
|
void |
setAssigningJurisdiction(CWE objAssigningJurisdiction)
Sets the AssigningJurisdiction.
|
void |
setCheckDigitScheme(ID objID)
Sets the CheckDigitScheme.
|
void |
setCheckDigitScheme(java.lang.String strCheckDigitScheme)
Sets the CheckDigitScheme.
|
void |
setDateTimeActionPerformed(DTM objDTM)
Sets the DateTimeActionPerformed.
|
void |
setDateTimeActionPerformed(java.lang.String strDateTimeActionPerformed)
Sets the DateTimeActionPerformed.
|
void |
setEffectiveDate(DTM objEffectiveDate)
Sets the EffectiveDate.
|
void |
setEffectiveDate(java.lang.String strEffectiveDate)
Sets the Effective Date.
|
void |
setExpirationDate(DTM objExpirationDate)
Sets the ExpirationDate.
|
void |
setExpirationDate(java.lang.String strExpirationDate)
Sets the Expiration Date.
|
void |
setFamilyName(FN objFamilyName)
Sets the FamilyName.
|
void |
setGivenName(ST objST)
Sets the GivenName.
|
void |
setGivenName(java.lang.String strGivenName)
Sets the GivenName.
|
void |
setIdentifierCheckDigit(ST objST)
Sets the IdentifierCheckDigit.
|
void |
setIdentifierCheckDigit(java.lang.String strIdentifierCheckDigit)
Sets the IdentifierCheckDigit.
|
void |
setIdentifierTypeCode(ID objID)
Sets the IdentifierTypeCode.
|
void |
setIdentifierTypeCode(java.lang.String strIdentifierTypeCode)
Sets the IdentifierTypeCode.
|
void |
setNameAssemblyOrder(ID objID)
Sets the NameAssemblyOrder.
|
void |
setNameAssemblyOrder(java.lang.String strNameAssemblyOrder)
Sets the NameAssemblyOrder.
|
void |
setNameContext(CWE objNameContext)
Sets the NameContext.
|
void |
setNameRepresentationCode(ID objID)
Sets the NameRepresentationCode.
|
void |
setNameRepresentationCode(java.lang.String strNameRepresentationCode)
Sets the NameRepresentationCode.
|
void |
setNameTypeCode(ID objID)
Sets the NameTypeCode.
|
void |
setNameTypeCode(java.lang.String strNameTypeCode)
Sets the NameTypeCode.
|
void |
setPersonIdentifier(ST objST)
Sets the Person Identifier.
|
void |
setPersonIdentifier(java.lang.String strPersonIdentifier)
Sets the Person Identifier.
|
void |
setPrefix(ST objST)
Sets the Prefix.
|
void |
setPrefix(java.lang.String strPrefix)
Sets the Prefix.
|
void |
setProfessionalSuffix(ST objST)
Sets the ProfessionalSuffix.
|
void |
setProfessionalSuffix(java.lang.String strProfessionalSuffix)
Sets the ProfessionalSuffix.
|
void |
setSecondAndFurtherGivenNamesOrInitialsThereof(ST objST)
Sets the SecondAndFurtherGivenNamesOrInitialsThereof.
|
void |
setSecondAndFurtherGivenNamesOrInitialsThereof(java.lang.String strSecondNamesOrInitials)
Sets the SecondAndFurtherGivenNamesOrInitialsThereof.
|
void |
setSecurityCheck(ST objST)
Sets the Security Check.
|
void |
setSecurityCheck(java.lang.String strSecurityCheck)
Sets the Security Check.
|
void |
setSecurityCheckScheme(ID objID)
Sets the Security Check Scheme.
|
void |
setSecurityCheckScheme(java.lang.String strSecurityCheckScheme)
Sets the Security Check Scheme.
|
void |
setSourceTable(CWE objCWE)
Sets the SourceTable.
|
void |
setSourceTable(java.lang.String strSourceTable)
Sets the SourceTable.
|
void |
setSuffix(ST objST)
Sets the Suffix.
|
void |
setSuffix(java.lang.String strSuffix)
Sets the Suffix.
|
boolean |
validate()
The Method validates the Input value,and if validated properly then returns true.
|
copy, dumpDataType, getAttributes, getDataTypeName, getLength, getValue, isPrimitive, read, setValue, write, writeToXMLpublic PPN()
public PPN(int iMinLength,
int iMaxLength,
java.lang.String strCLength,
int iComponentType)
throws InvalidComponentTypeException
iMaxLength - - The Maximum length the DataType can have.iComponentType - - The Type of the component i.e Component or a subcomponent.InvalidComponentTypeException - - if Component Type is not specified or valid.public PPN(int iMinLength,
int iMaxLength,
java.lang.String strCLength,
int iTableNo,
int iComponentType)
throws InvalidComponentTypeException
iMinLength - The Minimum length the DataType can have.iMaxLength - The Maximum length the DataType can have.iCLength - The Conformance length the DataType can have.iTableNo - The Table number to which the value for the component is specified.iComponentType - The Type of the component i.e Component or a subcomponent.InvalidComponentTypeException - - if Component Type is not specified or valid.public PPN(int iComponentType, IDataTypeMap objIDataTypeMap)
objIDataTypeMap - object of Data Type Map.iComponentType - The Type of the component i.e Component or a subcomponent.InvalidComponentTypeException - - if Component Type is not specified or valid.public PPN(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, IDataTypeMap objIDataTypeMap)
objIDataTypeMap - object of Data Type Map.iComponentType - The Type of the component i.e Component or a subcomponent.iMinLength - The Minimum length the DataType can have.iMaxLength - The Maximum length the DataType can have.iCLength - The Conformance length the DataType can have.InvalidComponentTypeException - - if Component Type is not specified or valid.public PPN(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, int ITableNo, IDataTypeMap objIDataTypeMap)
objIDataTypeMap - object of Data Type Map.iComponentType - The Type of the component i.e Component or a subcomponent.iMinLength - The Minimum length the DataType can have.iMaxLength - The Maximum length the DataType can have.iCLength - The Conformance length the DataType can have.iTableNo - The Table number to which the value for the component is specified.InvalidComponentTypeException - - if Component Type is not specified or valid.public void setPersonIdentifier(java.lang.String strPersonIdentifier)
strPersonIdentifier - carries the Person Identifier itself.public void setPersonIdentifier(ST objST)
objST - carries the Person Identifier itself.public void setFamilyName(FN objFamilyName)
objFamilyName - Specifies the surname of a person.public void setGivenName(java.lang.String strGivenName)
strGivenName - First name.public void setGivenName(ST objST)
objST - First name.public void setSecondAndFurtherGivenNamesOrInitialsThereof(java.lang.String strSecondNamesOrInitials)
strSecondNamesOrInitials - Multiple middle names may be included by separating them with spaces.public void setSecondAndFurtherGivenNamesOrInitialsThereof(ST objST)
objST - Multiple middle names may be included by separating them with spaces.public void setSuffix(java.lang.String strSuffix)
strSuffix - Used to specify a name suffix (e.g., Jr. or III).public void setSuffix(ST objST)
objST - Used to specify a name suffix (e.g., Jr. or III).public void setPrefix(java.lang.String strPrefix)
strPrefix - Used to specify a name prefix (e.g., Dr.).public void setPrefix(ST objST)
objST - Used to specify a name prefix (e.g., Dr.).public void setSourceTable(java.lang.String strSourceTable)
strSourceTable - source is used as the HL7 identifier for the user-defined table of values for this component.public void setSourceTable(CWE objCWE)
objCWE - source is used as the HL7 identifier for the user-defined table of values for this component.public void setAssigningAuthority(HD objAssigningAuthority)
objAssigningAuthority - The assigning authority is a unique identifier of the systempublic void setNameTypeCode(java.lang.String strNameTypeCode)
strNameTypeCode - A code that represents the type of name.public void setNameTypeCode(ID objID)
objString - A code that represents the type of name.public void setIdentifierCheckDigit(java.lang.String strIdentifierCheckDigit)
strIdentifierCheckDigit - The check digit in this data type is not an add-on produced by the message processor.public void setIdentifierCheckDigit(ST objST)
objST - The check digit in this data type is not an add-on produced by the message processor.public void setCheckDigitScheme(java.lang.String strCheckDigitScheme)
strCheckDigitScheme - Contains the code identifying the check digit scheme employed.public void setCheckDigitScheme(ID objID)
objID - Contains the code identifying the check digit scheme employed.public void setIdentifierTypeCode(java.lang.String strIdentifierTypeCode)
strIdentifierTypeCode - A code corresponding to the type of identifier.public void setIdentifierTypeCode(ID objID)
objID - A code corresponding to the type of identifier.public void setAssigningFacility(HD objAssigningFacility)
objAssigningFacility - The place or location identifier where the identifier was first assigned to the patient.public void setDateTimeActionPerformed(java.lang.String strDateTimeActionPerformed)
strDateTimeActionPerformed - describes when the activity was performed.public void setDateTimeActionPerformed(DTM objDTM)
objDTM - describes when the activity was performed.public void setNameRepresentationCode(java.lang.String strNameRepresentationCode)
strNameRepresentationCode - Different name/address types and representations of the same name/address should be described by repeating of this fieldpublic void setNameRepresentationCode(ID objID)
objID - Different name/address types and representations of the same name/address should be described by repeating of this fieldpublic void setNameContext(CWE objNameContext)
objNameContext - This component is used to designate the context in which a name is used.public void setNameAssemblyOrder(java.lang.String strNameAssemblyOrder)
strNameAssemblyOrder - A code that represents the preferred display order of the components of this person name.public void setNameAssemblyOrder(ID objID)
objID - A code that represents the preferred display order of the components of this person name.public void setEffectiveDate(java.lang.String strEffectiveDate)
strEffectiveDate - specifies The first date, if known, on which the address is valid and active.public void setEffectiveDate(DTM objEffectiveDate)
objEffectiveDate - The first date, if known, on which the address is valid and active.public void setExpirationDate(java.lang.String strExpirationDate)
strExpirationDate - specifies The last date, if known, on which the address is valid and active.public void setExpirationDate(DTM objExpirationDate)
objExpirationDate - The last date, if known, on which the address is valid and active.public void setProfessionalSuffix(java.lang.String strProfessionalSuffix)
strProfessionalSuffix - Used to specify an abbreviation, or a string of abbreviations,
denoting qualifications that support the person's professionpublic void setProfessionalSuffix(ST objST)
objST - Used to specify an abbreviation, or a string of abbreviations,
denoting qualifications that support the person's professionpublic void setAssigningJurisdiction(CWE objAssigningJurisdiction)
objAssigningJurisdiction - The geo-political body that assigned the identifier in component 1.public void setAssigningAgencyOrDepartment(CWE objAssigningAgencyOrDepartment)
objAssigningAgencyOrDepartment - The agency or department that assigned the identifier in component 1.public void setSecurityCheck(java.lang.String strSecurityCheck)
strSecurityCheck - is used to communicate a version code.public void setSecurityCheck(ST objST)
objST - carries the version code.public void setSecurityCheckScheme(java.lang.String strSecurityCheckScheme)
strSecurityCheckScheme - is used to communicate a version code.public void setSecurityCheckScheme(ID objID)
objID - carries a version code.public ST getPersonIdentifier()
public FN getFamilyName()
public ST getGivenName()
public ST getSecondNameInitials()
public ST getSuffix()
public ST getPrefix()
public CWE getSourceTable()
public HD getAssigningAuthority()
public ID getNameTypeCode()
public ST getIdentifierCheckDigit()
public ID getCheckDigitScheme()
public ID getIdentifierTypeCode()
public HD getAssigningFacility()
public DTM getDateTimeActionPerformed()
public ID getNameRepresentationCode()
public CWE getNameContext()
public ID getNameAssemblyOrder()
public DTM getEffectiveDate()
public DTM getExpirationDate()
public ST getProfessionalSuffix()
public CWE getAssigningJurisdiction()
public CWE getAssigningAgencyorDepartment()
public ST getSecurityCheck()
public ID getSecurityCheckScheme()
public boolean validate()
throws InvalidDataTypeException
validate in interface IDataTypevalidate in class CompositeDataTypeInvalidDataTypeException - - if Invalid values is entered or Mandatory field is missing.public boolean equals(java.lang.Object objObject)
equals in class java.lang.ObjectobjObject - object of Object class.