com.merge.HL7.v231.fields
Class HL7FieldCX

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v231.fields.HL7FieldCX

public class HL7FieldCX
extends HL7Field

This data type is used for specifying an identifier with its associated administrative detail.

Nested Class Summary

Nested classes/interfaces inherited from class com.merge.HL7.HL7Field

HL7Field.FieldFormatter

Field Summary

Fields inherited from class com.merge.HL7.HL7Field

EMPTY_VALUE, NULL_VALUE

Constructor Summary

HL7FieldCX()
Creates an empty HL7 CX type field object.

Method Summary

HL7FieldHD	getAssigningAuthority() Gets the Assigning Authority component of this field.
java.lang.String	getAssigningAuthorityValue() Gets the Assigning Authority component of this field.
HL7FieldHD	getAssigningFacility() Gets the Assigning Facility component of this field.
java.lang.String	getAssigningFacilityValue() Gets the Assigning Facility component of this field.
java.lang.String	getCheckDigit() Gets the Check Digit component of this field.
java.lang.String	getCheckDigitScheme() Gets the Check Digit Scheme component of this field.
java.lang.String	getComponentDescription(int index) Gets the description of a component in this field.
int	getComponentLength(int index) Gets the maximum number of characters for a component in this field.
java.lang.String	getComponentType(int index) Gets the HL7 data type of a component in this field.
java.lang.String	getIdentifierTypeCode() Gets the Identifier Type Code component of this field.
java.lang.String	getIDNumber() Gets the ID Number component of this field.
int	getMaxSize() Gets the number of components defined for this field.
java.lang.String	getTableNo(int index) Gets the table identifier of a component in this field.
boolean	isAssigningAuthorityEmpty() Tells whether the Assigning Authority component has been specified.
boolean	isAssigningAuthorityNull() Tells whether the Assigning Authority component has a has Null value as defined by HL7.
boolean	isAssigningFacilityEmpty() Tells whether the Assigning Facility component has been specified.
boolean	isAssigningFacilityNull() Tells whether the Assigning Facility component has a has Null value as defined by HL7.
boolean	isCheckDigitEmpty() Tells whether the Check Digit component has been specified.
boolean	isCheckDigitNull() Tells whether the Check Digit component has a has Null value as defined by HL7.
boolean	isCheckDigitSchemeEmpty() Tells whether the Check Digit Scheme component has been specified.
boolean	isCheckDigitSchemeNull() Tells whether the Check Digit Scheme component has a has Null value as defined by HL7.
boolean	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isIdentifierTypeCodeEmpty() Tells whether the Identifier Type Code component has been specified.
boolean	isIdentifierTypeCodeNull() Tells whether the Identifier Type Code component has a has Null value as defined by HL7.
boolean	isIDNumberEmpty() Tells whether the ID Number component has been specified.
boolean	isIDNumberNull() Tells whether the ID Number component has a has Null value as defined by HL7.
void	setAssigningAuthority(HL7FieldHD val) Sets the Assigning Authority component of this field.
void	setAssigningAuthorityValue(java.lang.String val) Sets the Assigning Authority from a string.
void	setAssigningFacility(HL7FieldHD val) Sets the Assigning Facility component of this field.
void	setAssigningFacilityValue(java.lang.String val) Sets the Assigning Facility from a string.
void	setCheckDigit(java.lang.String val) Sets the Check Digit from a string.
void	setCheckDigitScheme(java.lang.String val) Sets the Check Digit Scheme from a string.
void	setIdentifierTypeCode(java.lang.String val) Sets the Identifier Type Code from a string.
void	setIDNumber(java.lang.String val) Sets the ID Number from a string.

Methods inherited from class com.merge.HL7.HL7Field

clone, createField, createField, getBoolValue, getComponent, getContent, getContent, getContent, getDataType, getDateValue, getDoubleValue, getFieldFormatter, getFieldName, getHL7Version, getIntValue, getMinSize, getValue, getValue, isBasicType, isEmpty, isNull, setComponent, setContent, setContent, setFieldClass, setFormatter, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, size, toAnnotatedString, toAnnotatedString, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HL7FieldCX

public HL7FieldCX()

Creates an empty HL7 CX type field object.

Method Detail

getMaxSize

public int getMaxSize()

Gets the number of components defined for this field.

Overrides:

getMaxSize in class HL7Field

Returns:

The maximum number of components.

getComponentType

public java.lang.String getComponentType(int index)

Gets the HL7 data type of a component in this field.

Overrides:

getComponentType in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the component's data type.

getComponentDescription

public java.lang.String getComponentDescription(int index)

Gets the description of a component in this field.

Overrides:

getComponentDescription in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the component's description.

getComponentLength

public int getComponentLength(int index)

Gets the maximum number of characters for a component in this field.

Overrides:

getComponentLength in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

The maximum length of the component as defined by HL7.

isComponentMandatory

public boolean isComponentMandatory(int index)

Tells whether a component is mandatory.

Overrides:

isComponentMandatory in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

true if the specified component is mandatory.

getTableNo

public java.lang.String getTableNo(int index)

Gets the table identifier of a component in this field.

Overrides:

getTableNo in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the table number as defined by HL7 or an empty string if a table number is not defined.

getIDNumber

public java.lang.String getIDNumber()

Gets the ID Number component of this field.

Returns:

the ID Number value

setIDNumber

public void setIDNumber(java.lang.String val)

Sets the ID Number from a string.

Parameters:

val - The value to set for ID Number

isIDNumberEmpty

public boolean isIDNumberEmpty()

Tells whether the ID Number component has been specified.

Returns:

true if the component is empty.

isIDNumberNull

public boolean isIDNumberNull()

Tells whether the ID Number component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getCheckDigit

public java.lang.String getCheckDigit()

Gets the Check Digit component of this field.

Returns:

the Check Digit value

setCheckDigit

public void setCheckDigit(java.lang.String val)

Sets the Check Digit from a string.

Parameters:

val - The value to set for Check Digit

isCheckDigitEmpty

public boolean isCheckDigitEmpty()

Tells whether the Check Digit component has been specified.

Returns:

true if the component is empty.

isCheckDigitNull

public boolean isCheckDigitNull()

Tells whether the Check Digit component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getCheckDigitScheme

public java.lang.String getCheckDigitScheme()

Gets the Check Digit Scheme component of this field.

Returns:

the Check Digit Scheme value

setCheckDigitScheme

public void setCheckDigitScheme(java.lang.String val)

Sets the Check Digit Scheme from a string.

Parameters:

val - The value to set for Check Digit Scheme

isCheckDigitSchemeEmpty

public boolean isCheckDigitSchemeEmpty()

Tells whether the Check Digit Scheme component has been specified.

Returns:

true if the component is empty.

isCheckDigitSchemeNull

public boolean isCheckDigitSchemeNull()

Tells whether the Check Digit Scheme component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getAssigningAuthorityValue

public java.lang.String getAssigningAuthorityValue()

Gets the Assigning Authority component of this field.

Returns:

the Assigning Authority value

setAssigningAuthorityValue

public void setAssigningAuthorityValue(java.lang.String val)

Sets the Assigning Authority from a string.

Parameters:

val - The value to set for Assigning Authority

getAssigningAuthority

public HL7FieldHD getAssigningAuthority()

Gets the Assigning Authority component of this field.

Returns:

An HL7FieldHD object representing Assigning Authority

setAssigningAuthority

public void setAssigningAuthority(HL7FieldHD val)

Sets the Assigning Authority component of this field.

Parameters:

val - An HL7FieldHD object containing the value to be set.

isAssigningAuthorityEmpty

public boolean isAssigningAuthorityEmpty()

Tells whether the Assigning Authority component has been specified.

Returns:

true if the component is empty.

isAssigningAuthorityNull

public boolean isAssigningAuthorityNull()

Tells whether the Assigning Authority component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getIdentifierTypeCode

public java.lang.String getIdentifierTypeCode()

Gets the Identifier Type Code component of this field.

Returns:

the Identifier Type Code value

setIdentifierTypeCode

public void setIdentifierTypeCode(java.lang.String val)

Sets the Identifier Type Code from a string.

Parameters:

val - The value to set for Identifier Type Code

isIdentifierTypeCodeEmpty

public boolean isIdentifierTypeCodeEmpty()

Tells whether the Identifier Type Code component has been specified.

Returns:

true if the component is empty.

isIdentifierTypeCodeNull

public boolean isIdentifierTypeCodeNull()

Tells whether the Identifier Type Code component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getAssigningFacilityValue

public java.lang.String getAssigningFacilityValue()

Gets the Assigning Facility component of this field.

Returns:

the Assigning Facility value

setAssigningFacilityValue

public void setAssigningFacilityValue(java.lang.String val)

Sets the Assigning Facility from a string.

Parameters:

val - The value to set for Assigning Facility

getAssigningFacility

public HL7FieldHD getAssigningFacility()

Gets the Assigning Facility component of this field.

Returns:

An HL7FieldHD object representing Assigning Facility

setAssigningFacility

public void setAssigningFacility(HL7FieldHD val)

Sets the Assigning Facility component of this field.

Parameters:

val - An HL7FieldHD object containing the value to be set.

isAssigningFacilityEmpty

public boolean isAssigningFacilityEmpty()

Tells whether the Assigning Facility component has been specified.

Returns:

true if the component is empty.

isAssigningFacilityNull

public boolean isAssigningFacilityNull()

Tells whether the Assigning Facility component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.