public class XCN extends CompositeDataType
This data type is used extensively appearing in the PV1, ORC, RXO, RXE, OBR and SCH segments, as well as others, where there is a need to specify the ID number and name of a person. Example without assigning authority and assigning facility: |1234567^Smith^John^J^III^DR^PHD^ADT01^^L^4^M11^MR|
Represents an HL7 XCN data type. This data type has the following attributes:
1. Person Identifier (ST)Conditional
2. Family Name (FN)Conditional
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)Conditional
11. Identifier Check Digit (ST)Optional
12. Check Digit Scheme (ID)Conditional
13. Identifier Type Code (ID)Conditional
14. Assigning Facility (HD)Optional
15. Name Representation Code (ID)Optional
16. Name Context (CWE)Optional
18. Name Assembly Order (ID)Optional
19. Effective Date (DTM)Optional
20. Expiration Date (DTM)Optional
21. Professional Suffix (ST)Optional
22. Assigning Jurisdiction (CWE)Conditional
23. Assigning Agency or Department (CWE)Conditional
24. Security Check (ST)Optional
25. 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 |
|---|
XCN()
Default Constructor for XCN
|
XCN(int iComponentType,
IDataTypeMap objIDataTypeMap)
Constructor for XCN class which takes two arguments and
sets the value in the respective member variable.
|
XCN(int iComponentType,
int iMinLength,
int iMaxLength,
java.lang.String strCLength,
IDataTypeMap objIDataTypeMap)
Constructor for XCN class which takes five arguments and
sets the value in the respective member variable.
|
XCN(int iComponentType,
int iMinLength,
int iMaxLength,
java.lang.String strCLength,
int ITableNo,
IDataTypeMap objIDataTypeMap)
Constructor for XCN class which takes six arguments and
sets the value in the respective member variable.
|
XCN(int iMinLength,
int iMaxLength,
java.lang.String strCLength,
int iComponentType)
Constructor for XCN class which takes four arguments and
sets the value in the respective member variable.
|
XCN(int iMinLength,
int iMaxLength,
java.lang.String strCLength,
int iTableNo,
int iComponentType)
Constructor for XCN 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 |
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
|
ST |
getIDNumber()
Returns ID Number
|
ID |
getNameAssemblyOrder()
Returns Name Assembly Order
|
CWE |
getNameContext()
Returns Name Context
|
ID |
getNameRepresentationCode()
Returns Name Representation Code
|
ID |
getNameTypeCode()
Returns Name Type Code
|
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 Assigning Agency Or Department.
|
void |
setAssigningAuthority(HD objAssigningAuthority)
Sets the Assigning Authority.
|
void |
setAssigningFacility(HD objAssigningFacility)
Sets the Assigning Facility.
|
void |
setAssigningJurisdiction(CWE objAssigningJurisdiction)
Sets the Assigning Jurisdiction.
|
void |
setCheckDigitScheme(ID objID)
Sets the Check Digit Scheme.
|
void |
setCheckDigitScheme(java.lang.String strCheckDigitScheme)
Sets the Check Digit Scheme.
|
void |
setEffectiveDate(DTM objEffectiveDate)
Sets the Effective Date.
|
void |
setEffectiveDate(java.lang.String strEffectiveDate)
Sets the Effective Date.
|
void |
setExpirationDate(DTM objExpirationDate)
Sets the Expiration Date.
|
void |
setExpirationDate(java.lang.String strExpirationDate)
Sets the Expiration Date.
|
void |
setFamilyName(FN objFamilyName)
Sets the Family Name.
|
void |
setGivenName(ST objST)
Sets the Given Name.
|
void |
setGivenName(java.lang.String strGivenName)
Sets the Given Name.
|
void |
setIdentifierCheckDigit(ST objST)
Sets the Identifier CheckDigit.
|
void |
setIdentifierCheckDigit(java.lang.String strIdentifierCheckDigit)
Sets the Identifier Check Digit.
|
void |
setIdentifierTypeCode(ID objID)
Sets the Identifier Type Code.
|
void |
setIdentifierTypeCode(java.lang.String strIdentifierTypeCode)
Sets the Identifier Type Code.
|
void |
setIdNumber(ST objST)
Sets the Id Number.
|
void |
setIdNumber(java.lang.String strIdNumber)
Sets the Id Number.
|
void |
setNameAssemblyOrder(ID objID)
Sets the Name Assembly Order.
|
void |
setNameAssemblyOrder(java.lang.String strNameAssemblyOrder)
Sets the Name Assembly Order.
|
void |
setNameContext(CWE objCWE)
Sets the Name Context.
|
void |
setNameRepresentationCode(ID objID)
Sets the Name Representation Code.
|
void |
setNameRepresentationCode(java.lang.String strNameRepresentationCode)
Sets the Name Representation Code.
|
void |
setNameTypeCode(ID objID)
Sets the Name Type Code.
|
void |
setNameTypeCode(java.lang.String strNameTypeCode)
Sets the Name Type Code.
|
void |
setPrefix(ST objST)
Sets the Prefix.
|
void |
setPrefix(java.lang.String strPrefix)
Sets the Prefix.
|
void |
setProfessionalSuffix(ST objST)
Sets the Professional Suffix.
|
void |
setProfessionalSuffix(java.lang.String strProfessionalSuffix)
Sets the Professional Suffix.
|
void |
setSecondNameOrInitials(ST objST)
Sets the Second Name Or Initials.
|
void |
setSecondNameOrInitials(java.lang.String strSecondNameOrInitials)
Sets the Second Name Or Initials.
|
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 Source Table.
|
void |
setSourceTable(java.lang.String strSourceTable)
Sets the Source Table.
|
void |
setSuffix(ST objST)
Sets the Suffix.
|
void |
setSuffix(java.lang.String strSuffix)
Sets the Suffix.
|
copy, dumpDataType, getAttributes, getDataTypeName, getLength, getValue, isPrimitive, read, setValue, validate, write, writeToXMLpublic XCN()
public XCN(int iMinLength,
int iMaxLength,
java.lang.String strCLength,
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.iComponentType - The Type of the component i.e Component or a subcomponent.InvalidComponentTypeException - - if Component Type is not specified or valid.public XCN(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 XCN(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 XCN(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 XCN(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 setIdNumber(java.lang.String strIdNumber)
strIdNumber - Refers to the coded ID according to a user-defined tablepublic void setIdNumber(ST objST)
objString - Refers to the coded ID according to a user-defined tablepublic void setFamilyName(FN objFamilyName)
objFamilyName - Specifies the surname of a person.public void setGivenName(java.lang.String strGivenName)
strGivenName - Specifies First name.public void setGivenName(ST objST)
objST - Specifies First name.public void setSecondNameOrInitials(java.lang.String strSecondNameOrInitials)
strSecondNameOrInitials - Specifies multiple middle names that may be included by
separating them with spaces.public void setSecondNameOrInitials(ST objST)
objST - Specifies multiple middle names that 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)
objString - Used to specify a name prefix (e.g., Dr.).public void setSourceTable(java.lang.String strSourceTable)
strSourceTable - used as the HL7 identifier for the user-defined table of values for this component. [Refer User-defined Table 0297 \96 CN ID.]public void setSourceTable(CWE objCWE)
objCWE - used as the HL7 identifier for the user-defined table of values for this component. [Refer User-defined Table 0297 CN ID.]public void setAssigningAuthority(HD objAssigningAuthority)
objAssigningAuthority - Specifies a unique identifier of the system (or organization or agency of department)
that creates the data. [Refer User-defined Table 0363 Assigning authority]public void setNameTypeCode(java.lang.String strNameTypeCode)
strNameTypeCode - Specifies a code that represents the type of name.public void setNameTypeCode(ID objID)
objID - Specifies a code that represents the type of name.public void setIdentifierCheckDigit(java.lang.String strIdentifierCheckDigit)
strIdentifierCheckDigit - Specifies part of the identifying number used in the sending application.public void setIdentifierCheckDigit(ST objST)
objST - Specifies part of the identifying number used in the sending application.public void setCheckDigitScheme(java.lang.String strCheckDigitScheme)
strCheckDigitScheme - Specifies the code identifying the check digit scheme employed.[Refer HL7 Table 0061 - Check digit scheme].public void setCheckDigitScheme(ID objID)
objID - Specifies the code identifying the check digit scheme employed.[Refer HL7 Table 0061 - Check digit scheme].public void setIdentifierTypeCode(java.lang.String strIdentifierTypeCode)
strIdentifierTypeCode - Specifies A code corresponding to the type of identifier.[Refer HL7 Table 0203 - Identifier type].public void setIdentifierTypeCode(ID objID)
objID - Specifies A code corresponding to the type of identifier.[Refer HL7 Table 0203 - Identifier type].public void setAssigningFacility(HD objAssigningFacility)
objAssigningFacility - Specifies the place or location identifier where the identifier was first assigned to the personpublic void setNameRepresentationCode(java.lang.String strNameRepresentationCode)
strNameRepresentationCode - provides an indication of the representation provided by the data item.public void setNameRepresentationCode(ID objID)
objID - provides an indication of the representation provided by the data item.public void setNameContext(CWE objCWE)
objCWE - Designates the context in which a name is used. [Refer User-defined Table 0448 ]public void setNameAssemblyOrder(java.lang.String strNameAssemblyOrder)
strNameAssemblyOrder - Specifies a code that represents the preferred display order of the components of this person name. Suggested values are G,F[Refer table 0444.]public void setNameAssemblyOrder(ID objID)
objID - Specifies a code that represents the preferred display order of the components of this person name. Suggested values are G,F[Refer table 0444.]public void setEffectiveDate(DTM objEffectiveDate)
objEffectiveDate - Specifies the first date, if known, on which the address is valid and active.public void setEffectiveDate(java.lang.String strEffectiveDate)
strEffectiveDate - Specifies the first date, if known, on which the address is valid and active.public void setExpirationDate(DTM objExpirationDate)
objExpirationDate - Specifies the last 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 setProfessionalSuffix(java.lang.String strProfessionalSuffix)
strProfessionalSuffix - Used to specify an abbreviation, or a string of abbreviations, denoting qualifications that support the person's profession, (e.g., licenses).public void setProfessionalSuffix(ST objST)
objString - Used to specify an abbreviation, or a string of abbreviations, denoting qualifications that support the person's profession, (e.g., licenses).public void setAssigningJurisdiction(CWE objAssigningJurisdiction)
objAssigningJurisdiction - Specifies the geo-political body that assigned the identifier.public void setAssigningAgencyOrDepartment(CWE objAssigningAgencyOrDepartment)
objAssigningAgencyOrDepartment - Specifies the agency or department that assigned the identifier.public void setSecurityCheck(java.lang.String strSecurityCheck)
strSecurityCheck - Refers to a version code that may be assigned to the value given in XCN.1 Person Identifier.public void setSecurityCheck(ST objST)
objST - Refers to a version code that may be assigned to the value given in XCN.1 Person Identifier.public void setSecurityCheckScheme(java.lang.String strSecurityCheckScheme)
strSecurityCheckScheme - is used to transmit information intended to validate the veracity of the supplied identifier or the presenter of the identifier.public void setSecurityCheckScheme(ID objID)
objID - is used to transmit information intended to validate the veracity of the supplied identifier or the presenter of the identifier.public ST getIDNumber()
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 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 equals(java.lang.Object objObject)
equals in class java.lang.ObjectobjObject - object of Object class.