public class CF extends CompositeDataType
This data type transmits codes and the formatted text associated with the code. This data type can be used to transmit for the first time the formatted text for the canned text portion of a report, for example, a standard radiological description for a normal chest X ray
Represents an HL7 CF data type. This data type has the following attributes:
1. identifier (ST)Optional
2. formatted text (FT)Optional
3. name of coding system (ID)Conditional
4. alternate identifier (ST)Optional
5. alternate formatted text (FT)Optional
6. name of alternate coding system (ID)Conditional
7. Coding System Version ID (ST)Conditional
8. Alternate Coding System Version ID (ST)Optional
9. Original Text (ST)Optional
Optional
10. Second Alternate Identifier ID (ST)Optional
11. Second Alternate Formatted Text (FT)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 |
|---|
CF()
Default Constructor for CF
|
CF(int iComponentType,
IDataTypeMap objIDataTypeMap)
Constructor for CF class which takes two arguments and
sets the value in the respective member variable.
|
CF(int iComponentType,
int iMinLength,
int iMaxLength,
java.lang.String strCLength,
IDataTypeMap objIDataTypeMap)
Constructor for CF class which takes five arguments and
sets the value in the respective member variable.
|
CF(int iComponentType,
int iMinLength,
int iMaxLength,
java.lang.String strCLength,
int ITableNo,
IDataTypeMap objIDataTypeMap)
Constructor for CF class which takes six arguments and
sets the value in the respective member variable.
|
CF(int iMinLength,
int iMaxLength,
java.lang.String strCLength,
int iComponentType)
Constructor for CF class which takes four arguments and
sets the value in the respective member variable.
|
CF(int iMinLength,
int iMaxLength,
java.lang.String strCLength,
int iTableNo,
int iComponentType)
Constructor for CF 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.
|
FT |
getAlternateFormattedText()
Returns Alternate Formatted Text.
|
ST |
getAlternateIdentifier()
Returns Alternate Identifier.
|
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.
|
FT |
getFormattedText()
Returns Formatted Text.
|
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.
|
FT |
getSecondAlternateFormattedText()
Returns Second Alternate Formatted Text.
|
ST |
getSecondAlternateIdentifier()
Returns Second Alternate Identifier .
|
ST |
getSecondAlternateValueSetOID()
Returns Second Alternate Value Set OID.
|
DTM |
getSecondAlternateValueSetVersionID()
Returns Second Alternate Value Set Version ID.
|
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 SystemVersion ID.
|
void |
setAlternateCodingSystemVersionID(java.lang.String strAlternateCodingSystemVersionID)
Sets the Alternate Coding System Version ID.
|
void |
setAlternateFormattedText(FT objFT)
Sets the Alternate Formatted Text.
|
void |
setAlternateFormattedText(java.lang.String strAlternateFormattedText)
Sets the Alternate Formatted Text.
|
void |
setAlternateIdentifier(ST objST)
Sets the Alternate Identifier.
|
void |
setAlternateIdentifier(java.lang.String strAlternateIdentifier)
Sets the Alternate Identifier.
|
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 Alternate Coding System Version ID.
|
void |
setCodingSystemVersionID(java.lang.String strCodingSystemVersionID)
Sets the Coding System Version ID.
|
void |
setFormattedText(FT objFT)
Sets the Formatted Text.
|
void |
setFormattedText(java.lang.String strFormattedText)
Sets the Formatted Text.
|
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 |
setSecondAlternateFormattedText(FT objFT)
Sets the Second Alternate Formatted Text.
|
void |
setSecondAlternateFormattedText(java.lang.String strSecondAlternateFormattedText)
Sets the Second Alternate Formatted Text.
|
void |
setSecondAlternateIdentifier(ST objST)
Sets the Second Alternate Identifier.
|
void |
setSecondAlternateIdentifier(java.lang.String strSecondAlternateIdentifier)
Sets the Second Alternate Identifier.
|
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 |
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 .
|
copy, dumpDataType, getAttributes, getDataTypeName, getLength, getValue, isPrimitive, read, setValue, validate, write, writeToXMLpublic CF()
public CF(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 CF(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 CF(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 CF(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 CF(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 CF-2.public void setIdentifier(ST objST)
objST - Specifies Sequence of characters (the code) that uniquely identifies the item being
referenced by the CF-2.public void setFormattedText(java.lang.String strFormattedText)
strFormattedText - Specifies Name or description of the item in question with the addition of embedded
formatting instructions.public void setFormattedText(FT objFT)
objFT - Specifies Name or description of the item in question with the addition of embedded
formatting instructions.public void setNameOfCodingSystem(java.lang.String strNameOfCodingSystem)
strNameOfCodingSystem - Specifies the name of the coding system employed.public void setNameOfCodingSystem(ID objID)
objID - Specifies the name of the coding system employed.public void setAlternateIdentifier(java.lang.String strAlternateIdentifier)
strAlternateIdentifier - Specifies a sequence of characters that uniquely identifies an alternate code.public void setAlternateIdentifier(ST objST)
objST - Specifies a sequence of characters that uniquely identifies an alternate code.public void setAlternateFormattedText(java.lang.String strAlternateFormattedText)
strAlternateFormattedText - Specifies name or description of the alternate identifier in question with the
addition of embedded formatting instructions.public void setAlternateFormattedText(FT objFT)
objFT - Specifies name or description of the alternate identifier in question with the
addition of embedded formatting instructions.public void setNameOfAlternateCodingSystem(java.lang.String strNameOfAlternateCodingSystem)
strNameOfAlternateCodingSystem - Specifies the name of the coding system employed for the alternate identifier.public void setNameOfAlternateCodingSystem(ID objID)
objID - Specifies the name of the coding system employed for the alternate identifier.public void setCodingSystemVersionID(java.lang.String strCodingSystemVersionID)
strCodingSystemVersionID - carries the version for the coding system identified by components 1-3.public void setCodingSystemVersionID(ST objST)
objST - carries the version for the coding system identified by components 1-3.public void setAlternateCodingSystemVersionID(java.lang.String strAlternateCodingSystemVersionID)
strAlternate - Coding System Version ID carries the version for the coding system identified by components 4-6.public void setAlternateCodingSystemVersionID(ST objST)
objST - carries version for the coding system identified by components 4-6.public void setOriginalText(java.lang.String strOriginalText)
strOriginalText - specifies the text as seen and/or selected by the user who entered the data.public void setOriginalText(ST objST)
objST - specifies the text as seen and/or selected by the user who entered the data.public void setSecondAlternateIdentifier(java.lang.String strSecondAlternateIdentifier)
strSecondAlternateIdentifier - specifies the sequence of characters that uniquely identifies an alternate code.public void setSecondAlternateIdentifier(ST objST)
objST - the sequence of characters that uniquely identifies an alternate code.public void setSecondAlternateFormattedText(java.lang.String strSecondAlternateFormattedText)
strSecondAlternateFormattedText - Specifies the descriptive or textual name of the Second Alternate Identifier.public void setSecondAlternateFormattedText(FT objFT)
objFT - Specifies the descriptive or textual name of the Second Alternate Identifier.public void setNameofSecondAlternateCodingSystem(java.lang.String strNameofSecondAlternateCodingSystem)
strNameofSecondAlternateCodingSystem - Identifies the coding scheme being used in the Second Alternate Identifier component.public void setNameofSecondAlternateCodingSystem(ID objID)
objID - Identifies the coding scheme being used in the Second Alternate Identifier component.public void setSecondAlternateCodingSystemVersionID(java.lang.String strSecondAlternateCodingSystemVersionID)
strSecondAlternateFormattedText - 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)
strSCoding - System OID 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.public void setValueSetVersionID(DTM objDTM)
objDTM - carries the version for the value set.public void setAlternateCodingSystemOID(java.lang.String strAlternateCodingSystemOID)
strAlternateCodingSystemOID - contains the ISO Object Identifier (OID) for the coding system.public void setAlternateCodingSystemOID(ST objST)
objST - contains the ISO Object Identifier (OID) for the coding system.public void setAlternateValueSetOID(java.lang.String strAlternateValueSetOID)
strAlternateValueSetOID - contains the ISO Object Identifier (OID) to allow identification of the value set.public void setAlternateValueSetOID(ST objST)
objST - contains the ISO Object Identifier (OID) to allow identification of the value set.public void setAlternateValueSetVersionID(java.lang.String strAlternateValueSetVersionID)
strAlternateValueSetVersionID - carries the version for the value set.public void setAlternateValueSetVersionID(DTM objDTM)
objDTM - carries the version for the value set.public void setSecondAlternateCodingSystemOID(java.lang.String strSecondAlternateCodingSystemOID)
strSecondAlternateCodingSystemOID - contains the ISO Object Identifier (OID) for the coding system.public void setSecondAlternateCodingSystemOID(ST objST)
objST - contains the ISO Object Identifier (OID) for the coding system.public void setSecondAlternateValueSetOID(java.lang.String strSecondAlternateValueSetOID)
strSecondAlternateValueSetOID - contains the ISO Object Identifier (OID) to allow identification of the value set.public void setSecondAlternateValueSetOID(ST objST)
objST - contains the ISO Object Identifier (OID) to allow identification of the value set.public void setSecondAlternateValueSetVersionID(java.lang.String strSecondAlternateValueSetVersionID)
strSecondAlternateValueSetVersionID - carries the version for the value set.public void setSecondAlternateValueSetVersionID(DTM objDTM)
objDTM - carries the version for the value set.public ST getIdentifier()
public FT getFormattedText()
public ID getNameOfCodingSystem()
public ST getAlternateIdentifier()
public FT getAlternateFormattedText()
public ID getNameOfAlternateCodingSystem()
public ST getCodingSystemVersionID()
public ST getAlternateCodingSystemVersionID()
public ST getOriginalText()
public ST getSecondAlternateIdentifier()
public FT getSecondAlternateFormattedText()
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 equals(java.lang.Object objObject)
equals in class java.lang.ObjectobjObject - object of Object class.