org.eclipse.ohf.ihe.common.hl7v2
Interface XCN

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

XCNImpl

public interface XCN
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'XCN'. This data structure is being used to represent a person name and identifier and is based on the HL7 v2.5 data type XCN.

The following features are supported:

• Id Number
• Family Name
• Given Name
• Other Name
• Suffix
• Prefix
• Assigning Authority Name
• Assigning Authority Universal Id
• Assigning Authority Universal Id Type

See Also:

Hl7v2Package.getXCN()

Method Summary

java.lang.String	getAssigningAuthorityName() Returns the value of the 'Assigning Authority Name' attribute.
java.lang.String	getAssigningAuthorityUniversalId() Returns the value of the 'Assigning Authority Universal Id' attribute.
java.lang.String	getAssigningAuthorityUniversalIdType() Returns the value of the 'Assigning Authority Universal Id Type' attribute.
java.lang.String	getFamilyName() Returns the value of the 'Family Name' attribute.
java.lang.String	getGivenName() Returns the value of the 'Given Name' attribute.
java.lang.String	getIdNumber() Returns the value of the 'Id Number' attribute.
java.lang.String	getOtherName() Returns the value of the 'Other Name' attribute.
java.lang.String	getPrefix() Returns the value of the 'Prefix' attribute.
java.lang.String	getSuffix() Returns the value of the 'Suffix' attribute.
void	setAssigningAuthorityName(java.lang.String value) Sets the value of the 'Assigning Authority Name' attribute.
void	setAssigningAuthorityUniversalId(java.lang.String value) Sets the value of the 'Assigning Authority Universal Id' attribute.
void	setAssigningAuthorityUniversalIdType(java.lang.String value) Sets the value of the 'Assigning Authority Universal Id Type' attribute.
void	setFamilyName(java.lang.String value) Sets the value of the 'Family Name' attribute.
void	setGivenName(java.lang.String value) Sets the value of the 'Given Name' attribute.
void	setIdNumber(java.lang.String value) Sets the value of the 'Id Number' attribute.
void	setOtherName(java.lang.String value) Sets the value of the 'Other Name' attribute.
void	setPrefix(java.lang.String value) Sets the value of the 'Prefix' attribute.
void	setSuffix(java.lang.String value) Sets the value of the 'Suffix' attribute.

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getIdNumber

java.lang.String getIdNumber()

Returns the value of the 'Id Number' attribute.

If the meaning of the 'Id Number' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Id Number' attribute.

See Also:

setIdNumber(String), Hl7v2Package.getXCN_IdNumber()

setIdNumber

void setIdNumber(java.lang.String value)

Sets the value of the 'Id Number' attribute.

Parameters:

value - the new value of the 'Id Number' attribute.

See Also:

getIdNumber()

getFamilyName

java.lang.String getFamilyName()

Returns the value of the 'Family Name' attribute.

If the meaning of the 'Family Name' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Family Name' attribute.

See Also:

setFamilyName(String), Hl7v2Package.getXCN_FamilyName()

setFamilyName

void setFamilyName(java.lang.String value)

Sets the value of the 'Family Name' attribute.

Parameters:

value - the new value of the 'Family Name' attribute.

See Also:

getFamilyName()

getGivenName

java.lang.String getGivenName()

Returns the value of the 'Given Name' attribute.

If the meaning of the 'Given Name' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Given Name' attribute.

See Also:

setGivenName(String), Hl7v2Package.getXCN_GivenName()

setGivenName

void setGivenName(java.lang.String value)

Sets the value of the 'Given Name' attribute.

Parameters:

value - the new value of the 'Given Name' attribute.

See Also:

getGivenName()

getOtherName

java.lang.String getOtherName()

Returns the value of the 'Other Name' attribute.

If the meaning of the 'Other Name' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Other Name' attribute.

See Also:

setOtherName(String), Hl7v2Package.getXCN_OtherName()

setOtherName

void setOtherName(java.lang.String value)

Sets the value of the 'Other Name' attribute.

Parameters:

value - the new value of the 'Other Name' attribute.

See Also:

getOtherName()

getSuffix

java.lang.String getSuffix()

Returns the value of the 'Suffix' attribute.

If the meaning of the 'Suffix' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Suffix' attribute.

See Also:

setSuffix(String), Hl7v2Package.getXCN_Suffix()

setSuffix

void setSuffix(java.lang.String value)

Sets the value of the 'Suffix' attribute.

Parameters:

value - the new value of the 'Suffix' attribute.

See Also:

getSuffix()

getPrefix

java.lang.String getPrefix()

Returns the value of the 'Prefix' attribute.

If the meaning of the 'Prefix' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Prefix' attribute.

See Also:

setPrefix(String), Hl7v2Package.getXCN_Prefix()

setPrefix

void setPrefix(java.lang.String value)

Sets the value of the 'Prefix' attribute.

Parameters:

value - the new value of the 'Prefix' attribute.

See Also:

getPrefix()

getAssigningAuthorityName

java.lang.String getAssigningAuthorityName()

Returns the value of the 'Assigning Authority Name' attribute.

If the meaning of the 'Assigning Authority Name' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Assigning Authority Name' attribute.

See Also:

setAssigningAuthorityName(String), Hl7v2Package.getXCN_AssigningAuthorityName()

setAssigningAuthorityName

void setAssigningAuthorityName(java.lang.String value)

Sets the value of the 'Assigning Authority Name' attribute.

Parameters:

value - the new value of the 'Assigning Authority Name' attribute.

See Also:

getAssigningAuthorityName()

getAssigningAuthorityUniversalId

java.lang.String getAssigningAuthorityUniversalId()

Returns the value of the 'Assigning Authority Universal Id' attribute.

If the meaning of the 'Assigning Authority Universal Id' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Assigning Authority Universal Id' attribute.

See Also:

setAssigningAuthorityUniversalId(String), Hl7v2Package.getXCN_AssigningAuthorityUniversalId()

setAssigningAuthorityUniversalId

void setAssigningAuthorityUniversalId(java.lang.String value)

Sets the value of the 'Assigning Authority Universal Id' attribute.

Parameters:

value - the new value of the 'Assigning Authority Universal Id' attribute.

See Also:

getAssigningAuthorityUniversalId()

getAssigningAuthorityUniversalIdType

java.lang.String getAssigningAuthorityUniversalIdType()

Returns the value of the 'Assigning Authority Universal Id Type' attribute.

If the meaning of the 'Assigning Authority Universal Id Type' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Assigning Authority Universal Id Type' attribute.

See Also:

setAssigningAuthorityUniversalIdType(String), Hl7v2Package.getXCN_AssigningAuthorityUniversalIdType()

setAssigningAuthorityUniversalIdType

void setAssigningAuthorityUniversalIdType(java.lang.String value)

Sets the value of the 'Assigning Authority Universal Id Type' attribute.

Parameters:

value - the new value of the 'Assigning Authority Universal Id Type' attribute.

See Also:

getAssigningAuthorityUniversalIdType()