public class CNE extends CompositeDataType
This data type specifies a coded element and its associated detail. The CNE data type is used when a required or mandatory coded field is needed
Represents an HL7 CNE data type. This data type has the following attributes:
1. identifier (ST)Required
2. text (ST)Optional
3. name of coding system (ID)Optional
4. alternate identifier (ST)Optional
5. alternate text (ST)Optional
6. name of alternate coding system (ST)Optional
7. coding system version ID (ST)Conditional
8. alternate coding system version ID (ST)Optional
9. original text (ST)Optional
10. Second Alternate Identifier (ST)Optional
11. Second Alternate Text (ST)Optional
12. Name of Second Alternate Coding System (ID)Optional
13. Second Alternate Coding System Version ID (ST)Conditional
14. Coding System OID (ST)Conditional
15. Value Set OID (ST)Optional
16. Value Set Version ID (DTM)Conditional
17. Alternate Coding System OID (ST)Conditional
18. Alternate Value Set OID (ST)Optional
19. Alternate Value Set Version ID (DTM)Conditional
20. Second Alternate Coding System OID (ST)COnditional
21. Second Alternate Value Set OID (ST)Optional
22. Second Alternate Value Set Version ID (DTM)Conditional
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 |
|---|
CNE()
Default Constructor for CNE
|
CNE(int iComponentType,
IDataTypeMap objIDataTypeMap)
Constructor for CNE class which takes two arguments and
sets the value in the respective member variable.
|
CNE(int iComponentType,
int iMinLength,
int iMaxLength,
java.lang.String strCLength,
IDataTypeMap objIDataTypeMap)
Constructor for CNE class which takes five arguments and
sets the value in the respective member variable.
|
CNE(int iComponentType,
int iMinLength,
int iMaxLength,
java.lang.String strCLength,
int ITableNo,
IDataTypeMap objIDataTypeMap)
Constructor for CNE class which takes six arguments and
sets the value in the respective member variable.
|
CNE(int iMinLength,
int iMaxLength,
java.lang.String strCLength,
int iComponentType)
Constructor for CNE class which takes four arguments and
sets the value in the respective member variable.
|
CNE(int iMinLength,
int iMaxLength,
java.lang.String strCLength,
int iTableNo,
int iComponentType)
Constructor for CNE 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.
|
ST |
getAlternateCodingSystemOID()
Returns Alternate Coding System OID
|
ST |
getAlternateCodingSystemVersionID()
Returns Alternate Coding System Version ID
|
ST |
getAlternateIdentifier()
Returns Alternate Identifier
|
ST |
getAlternateText()
Returns Alternate Text
|
ST |
getAlternateValueSetOID()
Returns Alternate Value Set OID
|
DTM |
getAlternateValueSetVersionID()
Returns Alternate Value Set Version ID
|
ST |
getCodingSystemOID()
Returns Coding System OID
|
ST |
getCodingSystemVersionID()
Returns Coding System Version ID
|
ST |
getIdentifier()
Returns Identifier
|
ID |
getNameOfAlternateCodingSystem()
Returns Name of Alternate Coding System
|
ID |
getNameOfCodingSystem()
Returns Name Of Coding System
|
ID |
getNameofSecondAlternateCodingSystem()
Returns Name of Second Alternate Coding System
|
ST |
getOriginalText()
Returns Original Text
|
ST |
getSecondAlternateCodingSystemOID()
Returns Second Alternate Coding System OID
|
ST |
getSecondAlternateCodingSystemVersionID()
Returns Second Alternate Coding System Version ID
|
ST |
getSecondAlternateIdentifier()
Returns Second Alternate Identifier
|
ST |
getSecondAlternateText()
Returns Second Alternate Text.
|
ST |
getSecondAlternateValueSetOID()
Returns Second Alternate Value Set OID
|
DTM |
getSecondAlternateValueSetVersionID()
Returns Second Alternate Value Set Version ID
|
ST |
getText()
Returns Text
|
ST |
getValueSetOID()
Returns Value Set OID
|
DTM |
getValueSetVersionID()
Returns Value Set Version ID
|
void |
setAlternateCodingSystemOID(ST objST)
Sets the Alternate Coding System OID.
|
void |
setAlternateCodingSystemOID(java.lang.String strAlternateCodingSystemOID)
Sets the Alternate Coding System OID.
|
void |
setAlternateCodingSystemVersionID(ST objST)
Sets the Alternate Coding System Version ID.
|
void |
setAlternateCodingSystemVersionID(java.lang.String strAlternateCodingSystemVersionID)
Sets the Alternate Coding System Version ID.
|
void |
setAlternateIdentifier(ST objST)
Sets the Alternate Identifier.
|
void |
setAlternateIdentifier(java.lang.String strAlternateIdentifier)
Sets the Alternate Identifier.
|
void |
setAlternateText(ST objST)
Sets the Alternate Text.
|
void |
setAlternateText(java.lang.String strAlternateText)
Sets the Alternate Text.
|
void |
setAlternateValueSetOID(ST objST)
Sets the Alternate Value Set OID.
|
void |
setAlternateValueSetOID(java.lang.String strAlternateValueSetOID)
Sets the Alternate Value Set OID.
|
void |
setAlternateValueSetVersionID(DTM objDTM)
Sets the Alternate Value Set Version ID.
|
void |
setAlternateValueSetVersionID(java.lang.String strAlternateValueSetVersionID)
Sets the Alternate Value Set Version ID.
|
void |
setCodingSystemOID(ST objST)
Sets the Coding System OID.
|
void |
setCodingSystemOID(java.lang.String strCodingSystemOID)
Sets the Coding System OID.
|
void |
setCodingSystemVersionID(ST objST)
Sets the Coding System Version ID.
|
void |
setCodingSystemVersionID(java.lang.String strCodingSystemVersionID)
Sets the Coding System Version ID.
|
void |
setIdentifier(ST objST)
Sets the Identifier.
|
void |
setIdentifier(java.lang.String strIdentifier)
Sets the Identifier.
|
void |
setNameOfAlternateCodingSystem(ID objID)
Sets the Name Of Alternate Coding System.
|
void |
setNameOfAlternateCodingSystem(java.lang.String strNameOfAlternateCodingSystem)
Sets the Name Of Alternate Coding System.
|
void |
setNameOfCodingSystem(ID objID)
Sets the Name Of Coding System.
|
void |
setNameOfCodingSystem(java.lang.String strNameOfCodingSystem)
Sets the Name Of Coding System.
|
void |
setNameofSecondAlternateCodingSystem(ID objID)
Sets the Name of Second Alternate Coding System.
|
void |
setNameofSecondAlternateCodingSystem(java.lang.String strNameofSecondAlternateCodingSystem)
Sets the Name of Second Alternate Coding System.
|
void |
setOriginalText(ST objST)
Sets the Original Text.
|
void |
setOriginalText(java.lang.String strOriginalText)
Sets the Original Text.
|
void |
setSecondAlternateCodingSystemOID(ST objST)
Sets the Second Alternate Coding System OID.
|
void |
setSecondAlternateCodingSystemOID(java.lang.String strSecondAlternateCodingSystemOID)
Sets the Second Alternate Coding System OID.
|
void |
setSecondAlternateCodingSystemVersionID(ST objST)
Sets the Second Alternate Coding System Version ID.
|
void |
setSecondAlternateCodingSystemVersionID(java.lang.String strSecondAlternateCodingSystemVersionID)
Sets the Second Alternate Coding System Version ID.
|
void |
setSecondAlternateIdentifier(ST objST)
Sets the Second Alternate Identifier.
|
void |
setSecondAlternateIdentifier(java.lang.String strSecondAlternateIdentifier)
Sets the Second Alternate Identifier.
|
void |
setSecondAlternateText(ST objST)
Sets the Second Alternate Text.
|
void |
setSecondAlternateText(java.lang.String strSecondAlternateText)
Sets the Second Alternate Text.
|
void |
setSecondAlternateValueSetOID(ST objST)
Sets the Second Alternate Value Set OID.
|
void |
setSecondAlternateValueSetOID(java.lang.String strSecondAlternateValueSetOID)
Sets the Second Alternate Value Set OID.
|
void |
setSecondAlternateValueSetVersionID(DTM objDTM)
Sets the Second Alternate Value Set Version ID.
|
void |
setSecondAlternateValueSetVersionID(java.lang.String strSecondAlternateValueSetVersionID)
Sets the Second Alternate Value Set Version ID.
|
void |
setText(ST objST)
Sets the Text
|
void |
setText(java.lang.String strText)
Sets the Text
|
void |
setValueSetOID(ST objST)
Sets the Value Set OID.
|
void |
setValueSetOID(java.lang.String strValueSetOID)
Sets the Value Set OID.
|
void |
setValueSetVersionID(DTM objDTM)
Sets the Value Set Version ID.
|
void |
setValueSetVersionID(java.lang.String strValueSetVersionID)
Sets the Value Set Version ID.
|
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 CNE()
public CNE(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 CNE(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 CNE(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 CNE(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 CNE(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 setIdentifier(java.lang.String strIdentifier)
strIdentifier - Specifies sequence of characters (the code) that uniquely identifies the item being referenced by the CNE.public void setIdentifier(ST objST)
objST - Specifies sequence of characters (the code) that uniquely identifies the item being referenced by the CNE.public void setText(java.lang.String strText)
strText - Specifies descriptive or textual name of the identifier, e.g., myocardial infarctionpublic void setText(ST objST)
objST - Specifies descriptive or textual name of the identifier, e.g., myocardial infarctionpublic void setNameOfCodingSystem(java.lang.String strNameOfCodingSystem)
strNameOfCodingSystem - Specifies the coding scheme being used in the identifier component.public void setNameOfCodingSystem(ID objID)
objID - Specifies the coding scheme being used in the identifier component.public void setAlternateIdentifier(java.lang.String strAlternateIdentifier)
strAlternateIdentifier - Specifies the local or user seen code as described.public void setAlternateIdentifier(ST objST)
objST - Specifies the local or user seen code as described.public void setAlternateText(java.lang.String strAlternateText)
strAlternateText - Specifies descriptive or textual name of the alternate identifier.public void setAlternateText(ST objST)
objST - Specifies descriptive or textual name of the alternate identifier.public void setNameOfAlternateCodingSystem(java.lang.String strNameOfAlternateCodingSystem)
strNameOfAlternateCodingSystem - Name Of Alternate Coding System.public void setNameOfAlternateCodingSystem(ID objID)
objID - represents Name Of Alternate Coding System.public void setCodingSystemVersionID(java.lang.String strCodingSystemVersionID)
strCodingSystemVersionID - Specifies the version ID for the coding system.public void setCodingSystemVersionID(ST objST)
objST - Specifies the version ID for the coding system.public void setAlternateCodingSystemVersionID(java.lang.String strAlternateCodingSystemVersionID)
strAlternateCodingSystemVersionID - Specifies the version ID for the coding system.public void setAlternateCodingSystemVersionID(ST objST)
objST - Specifies the version ID for the coding system.public void setOriginalText(java.lang.String strOriginalText)
strOriginalText - Specifies the original text that was available to an automated process or a human
before a specific code was assigned.public void setOriginalText(ST objST)
objST - Specifies the original text that was available to an automated process or a human
before a specific code was assigned.public void setSecondAlternateIdentifier(java.lang.String strSecondAlternateIdentifier)
strSecondAlternateIdentifier - Specifies A sequence of characters that uniquely identifies a second alternate code.public void setSecondAlternateIdentifier(ST objST)
objST - Specifies A sequence of characters that uniquely identifies a second alternate code.public void setSecondAlternateText(java.lang.String strSecondAlternateText)
strSecond - Alternate Text Specifies A sequence of characters that uniquely identifies a second alternate code.public void setSecondAlternateText(ST objST)
objST - Specifies A sequence of characters that uniquely identifies a second alternate code.public void setNameofSecondAlternateCodingSystem(java.lang.String strNameofSecondAlternateCodingSystem)
strSecond - descriptive or textual name of the Second Alternate Identifier.public void setNameofSecondAlternateCodingSystem(ID objID)
objID - Specifies descriptive or textual name of the Second Alternate Identifier.public void setSecondAlternateCodingSystemVersionID(java.lang.String strSecondAlternateCodingSystemVersionID)
strSecond - carries the version for the coding system identified by components 10-12.public void setSecondAlternateCodingSystemVersionID(ST objST)
objST - carries the version for the coding system identified by components 10-12.public void setCodingSystemOID(java.lang.String strCodingSystemOID)
strCodingSystemOID - contains the ISO Object Identifier (OID) for the coding system.public void setCodingSystemOID(ST objST)
objST - contains the ISO Object Identifier (OID) for the coding system.public void setValueSetOID(java.lang.String strValueSetOID)
strValueSetOID - contains the ISO Object Identifier (OID) to allow identification of the value set.public void setValueSetOID(ST objST)
objST - contains the ISO Object Identifier (OID) to allow identification of the value set.public void setValueSetVersionID(java.lang.String strValueSetVersionID)
strValueSetVersionID - carries the version for the value set identified by Value Set OID.public void setValueSetVersionID(DTM objDTM)
objDTM - carries the version for the value set identified by Value Set OID.public void setAlternateCodingSystemOID(java.lang.String strAlternateCodingSystemOID)
strAlternateCodingSystemOID - contains the ISO Object Identifier (OID) for the coding system or value set named in CNE.6 (Name of the Alternate Coding System).public void setAlternateCodingSystemOID(ST objST)
objST - contains the ISO Object Identifier (OID) for the coding system or value set named in CNE.6 (Name of the Alternate Coding System).public void setAlternateValueSetOID(java.lang.String strAlternateValueSetOID)
strAlternateValueSetOID - contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CNE.4 (Alternate Identifier) is obtained.public void setAlternateValueSetOID(ST objST)
objST - contains contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CNE.4 (Alternate Identifier) is obtained.public void setAlternateValueSetVersionID(java.lang.String strAlternateValueSetVersionID)
strAlternateValueSetVersionID - carries the version for the value set identified by CNE.18 (Alternate Value Set OID).public void setAlternateValueSetVersionID(DTM objDTM)
objDTM - carries the version for the value set identified by CNE.18 (Alternate Value Set OID).public void setSecondAlternateCodingSystemOID(java.lang.String strSecondAlternateCodingSystemOID)
strSecondAlternateCodingSystemOID - contains the ISO Object Identifier (OID) from which the value in CNE.12 (Name of the Alternate COdimng System) is obtained.public void setSecondAlternateCodingSystemOID(ST objST)
objST - contains the ISO Object Identifier (OID) from which the value in CNE.12 (Name of the Alternate COdimng System) is obtained.public void setSecondAlternateValueSetOID(java.lang.String strSecondAlternateValueSetOID)
strSecondAlternateValueSetOID - contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CNE.10 (Second Alternate Identifier)is obtained.public void setSecondAlternateValueSetOID(ST objST)
objST - contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CNE.10 (Second Alternate Identifier) is obtained.public void setSecondAlternateValueSetVersionID(java.lang.String strSecondAlternateValueSetVersionID)
strSecondAlternateValueSetVersionID - carries the version for the value set identified by CNE.21 (Second Alternate Value Set OID).public void setSecondAlternateValueSetVersionID(DTM objDTM)
objDTM - carries the version for the value set identified by CNE.21 (Second Alternate Value Set OID).public ST getIdentifier()
public ST getText()
public ID getNameOfCodingSystem()
public ST getAlternateIdentifier()
public ST getAlternateText()
public ID getNameOfAlternateCodingSystem()
public ST getCodingSystemVersionID()
public ST getAlternateCodingSystemVersionID()
public ST getOriginalText()
public ST getSecondAlternateIdentifier()
public ST getSecondAlternateText()
public ID getNameofSecondAlternateCodingSystem()
public ST getSecondAlternateCodingSystemVersionID()
public ST getCodingSystemOID()
public ST getValueSetOID()
public DTM getValueSetVersionID()
public ST getAlternateCodingSystemOID()
public ST getAlternateValueSetOID()
public DTM getAlternateValueSetVersionID()
public ST getSecondAlternateCodingSystemOID()
public ST getSecondAlternateValueSetOID()
public DTM getSecondAlternateValueSetVersionID()
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.