com.merge.HL7.v240.fields
Class HL7FieldCN

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v240.fields.HL7FieldCN

public class HL7FieldCN
extends HL7Field

Composite ID number and name

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

HL7FieldCN()
Creates an empty HL7 CN 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.
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	getDegree() Gets the Degree (e.g., MD) component of this field.
HL7FieldFN	getFamilyName() Gets the Family Name component of this field.
java.lang.String	getFamilyNameValue() Gets the Family Name component of this field.
java.lang.String	getGivenName() Gets the Given Name 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	getPrefix() Gets the Prefix (e.g., DR) component of this field.
java.lang.String	getSecondandFurtherGivenNamesorInitialsThereof() Gets the Second and Further Given Names or Initials Thereof component of this field.
java.lang.String	getSourceTable() Gets the Source Table component of this field.
java.lang.String	getSuffix() Gets the Suffix (e.g., JR or III) component of 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	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isDegreeEmpty() Tells whether the Degree (e.g., MD) component has been specified.
boolean	isDegreeNull() Tells whether the Degree (e.g., MD) component has a has Null value as defined by HL7.
boolean	isFamilyNameEmpty() Tells whether the Family Name component has been specified.
boolean	isFamilyNameNull() Tells whether the Family Name component has a has Null value as defined by HL7.
boolean	isGivenNameEmpty() Tells whether the Given Name component has been specified.
boolean	isGivenNameNull() Tells whether the Given Name 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.
boolean	isPrefixEmpty() Tells whether the Prefix (e.g., DR) component has been specified.
boolean	isPrefixNull() Tells whether the Prefix (e.g., DR) component has a has Null value as defined by HL7.
boolean	isSecondandFurtherGivenNamesorInitialsThereofEmpty() Tells whether the Second and Further Given Names or Initials Thereof component has been specified.
boolean	isSecondandFurtherGivenNamesorInitialsThereofNull() Tells whether the Second and Further Given Names or Initials Thereof component has a has Null value as defined by HL7.
boolean	isSourceTableEmpty() Tells whether the Source Table component has been specified.
boolean	isSourceTableNull() Tells whether the Source Table component has a has Null value as defined by HL7.
boolean	isSuffixEmpty() Tells whether the Suffix (e.g., JR or III) component has been specified.
boolean	isSuffixNull() Tells whether the Suffix (e.g., JR or III) 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	setDegree(java.lang.String val) Sets the Degree (e.g., MD) from a string.
void	setFamilyName(HL7FieldFN val) Sets the Family Name component of this field.
void	setFamilyNameValue(java.lang.String val) Sets the Family Name from a string.
void	setGivenName(java.lang.String val) Sets the Given Name from a string.
void	setIDNumber(java.lang.String val) Sets the ID Number from a string.
void	setPrefix(java.lang.String val) Sets the Prefix (e.g., DR) from a string.
void	setSecondandFurtherGivenNamesorInitialsThereof(java.lang.String val) Sets the Second and Further Given Names or Initials Thereof from a string.
void	setSourceTable(java.lang.String val) Sets the Source Table from a string.
void	setSuffix(java.lang.String val) Sets the Suffix (e.g., JR or III) 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

HL7FieldCN

public HL7FieldCN()

Creates an empty HL7 CN 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.

getFamilyNameValue

public java.lang.String getFamilyNameValue()

Gets the Family Name component of this field.

Returns:

the Family Name value

setFamilyNameValue

public void setFamilyNameValue(java.lang.String val)

Sets the Family Name from a string.

Parameters:

val - The value to set for Family Name

getFamilyName

public HL7FieldFN getFamilyName()

Gets the Family Name component of this field.

Returns:

An HL7FieldFN object representing Family Name

setFamilyName

public void setFamilyName(HL7FieldFN val)

Sets the Family Name component of this field.

Parameters:

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

isFamilyNameEmpty

public boolean isFamilyNameEmpty()

Tells whether the Family Name component has been specified.

Returns:

true if the component is empty.

isFamilyNameNull

public boolean isFamilyNameNull()

Tells whether the Family Name component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getGivenName

public java.lang.String getGivenName()

Gets the Given Name component of this field.

Returns:

the Given Name value

setGivenName

public void setGivenName(java.lang.String val)

Sets the Given Name from a string.

Parameters:

val - The value to set for Given Name

isGivenNameEmpty

public boolean isGivenNameEmpty()

Tells whether the Given Name component has been specified.

Returns:

true if the component is empty.

isGivenNameNull

public boolean isGivenNameNull()

Tells whether the Given Name component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getSecondandFurtherGivenNamesorInitialsThereof

public java.lang.String getSecondandFurtherGivenNamesorInitialsThereof()

Gets the Second and Further Given Names or Initials Thereof component of this field.

Returns:

the Second and Further Given Names or Initials Thereof value

setSecondandFurtherGivenNamesorInitialsThereof

public void setSecondandFurtherGivenNamesorInitialsThereof(java.lang.String val)

Sets the Second and Further Given Names or Initials Thereof from a string.

Parameters:

val - The value to set for Second and Further Given Names or Initials Thereof

isSecondandFurtherGivenNamesorInitialsThereofEmpty

public boolean isSecondandFurtherGivenNamesorInitialsThereofEmpty()

Tells whether the Second and Further Given Names or Initials Thereof component has been specified.

Returns:

true if the component is empty.

isSecondandFurtherGivenNamesorInitialsThereofNull

public boolean isSecondandFurtherGivenNamesorInitialsThereofNull()

Tells whether the Second and Further Given Names or Initials Thereof component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getSuffix

public java.lang.String getSuffix()

Gets the Suffix (e.g., JR or III) component of this field.

Returns:

the Suffix (e.g., JR or III) value

setSuffix

public void setSuffix(java.lang.String val)

Sets the Suffix (e.g., JR or III) from a string.

Parameters:

val - The value to set for Suffix (e.g., JR or III)

isSuffixEmpty

public boolean isSuffixEmpty()

Tells whether the Suffix (e.g., JR or III) component has been specified.

Returns:

true if the component is empty.

isSuffixNull

public boolean isSuffixNull()

Tells whether the Suffix (e.g., JR or III) component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getPrefix

public java.lang.String getPrefix()

Gets the Prefix (e.g., DR) component of this field.

Returns:

the Prefix (e.g., DR) value

setPrefix

public void setPrefix(java.lang.String val)

Sets the Prefix (e.g., DR) from a string.

Parameters:

val - The value to set for Prefix (e.g., DR)

isPrefixEmpty

public boolean isPrefixEmpty()

Tells whether the Prefix (e.g., DR) component has been specified.

Returns:

true if the component is empty.

isPrefixNull

public boolean isPrefixNull()

Tells whether the Prefix (e.g., DR) component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getDegree

public java.lang.String getDegree()

Gets the Degree (e.g., MD) component of this field.

Returns:

the Degree (e.g., MD) value

setDegree

public void setDegree(java.lang.String val)

Sets the Degree (e.g., MD) from a string.

Parameters:

val - The value to set for Degree (e.g., MD)

isDegreeEmpty

public boolean isDegreeEmpty()

Tells whether the Degree (e.g., MD) component has been specified.

Returns:

true if the component is empty.

isDegreeNull

public boolean isDegreeNull()

Tells whether the Degree (e.g., MD) component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getSourceTable

public java.lang.String getSourceTable()

Gets the Source Table component of this field.

Returns:

the Source Table value

setSourceTable

public void setSourceTable(java.lang.String val)

Sets the Source Table from a string.

Parameters:

val - The value to set for Source Table

isSourceTableEmpty

public boolean isSourceTableEmpty()

Tells whether the Source Table component has been specified.

Returns:

true if the component is empty.

isSourceTableNull

public boolean isSourceTableNull()

Tells whether the Source Table 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.