public class XPN extends AbstractComposite
Represents an HL7 XPN (Extended Person Name) data type. This type consists of the following components:
log
Constructor and Description |
---|
XPN(Message message)
Creates a new XPN type
|
Modifier and Type | Method and Description |
---|---|
ST |
getCalledBy()
Returns Called By (component 15).
|
Type |
getComponent(int number)
Returns an individual data component.
|
Type[] |
getComponents()
Returns an array containing the data elements.
|
NULLDT |
getDegreeEgMD()
Returns Degree (e.g., MD) (component 6).
|
DTM |
getEffectiveDate()
Returns Effective Date (component 12).
|
DTM |
getExpirationDate()
Returns Expiration Date (component 13).
|
FN |
getFamilyName()
Returns Family Name (component 1).
|
ST |
getGivenName()
Returns Given Name (component 2).
|
ID |
getNameAssemblyOrder()
Returns Name Assembly Order (component 11).
|
CWE |
getNameContext()
Returns Name Context (component 9).
|
ID |
getNameRepresentationCode()
Returns Name Representation Code (component 8).
|
ID |
getNameTypeCode()
Returns Name Type Code (component 7).
|
NULLDT |
getNameValidityRange()
Returns Name Validity Range (component 10).
|
ST |
getPrefixEgDR()
Returns Prefix (e.g., DR) (component 5).
|
ST |
getProfessionalSuffix()
Returns Professional Suffix (component 14).
|
ST |
getSecondAndFurtherGivenNamesOrInitialsThereof()
Returns Second and Further Given Names or Initials Thereof (component 3).
|
ST |
getSuffixEgJRorIII()
Returns Suffix (e.g., JR or III) (component 4).
|
FN |
getXpn1_FamilyName()
Returns Family Name (component 1).
|
NULLDT |
getXpn10_NameValidityRange()
Returns Name Validity Range (component 10).
|
ID |
getXpn11_NameAssemblyOrder()
Returns Name Assembly Order (component 11).
|
DTM |
getXpn12_EffectiveDate()
Returns Effective Date (component 12).
|
DTM |
getXpn13_ExpirationDate()
Returns Expiration Date (component 13).
|
ST |
getXpn14_ProfessionalSuffix()
Returns Professional Suffix (component 14).
|
ST |
getXpn15_CalledBy()
Returns Called By (component 15).
|
ST |
getXpn2_GivenName()
Returns Given Name (component 2).
|
ST |
getXpn3_SecondAndFurtherGivenNamesOrInitialsThereof()
Returns Second and Further Given Names or Initials Thereof (component 3).
|
ST |
getXpn4_SuffixEgJRorIII()
Returns Suffix (e.g., JR or III) (component 4).
|
ST |
getXpn5_PrefixEgDR()
Returns Prefix (e.g., DR) (component 5).
|
NULLDT |
getXpn6_DegreeEgMD()
Returns Degree (e.g., MD) (component 6).
|
ID |
getXpn7_NameTypeCode()
Returns Name Type Code (component 7).
|
ID |
getXpn8_NameRepresentationCode()
Returns Name Representation Code (component 8).
|
CWE |
getXpn9_NameContext()
Returns Name Context (component 9).
|
accept, clear, getTyped, isEmpty, provideLocation
encode, getExtraComponents, getMessage, getName, parse, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
encode, getExtraComponents, getMessage, getName, parse
public Type[] getComponents()
public Type getComponent(int number) throws DataTypeException
number
- The component number (0-indexed)DataTypeException
- if the given element number is out of range.public FN getFamilyName()
public FN getXpn1_FamilyName()
public ST getGivenName()
public ST getXpn2_GivenName()
public ST getSecondAndFurtherGivenNamesOrInitialsThereof()
public ST getXpn3_SecondAndFurtherGivenNamesOrInitialsThereof()
public ST getSuffixEgJRorIII()
public ST getXpn4_SuffixEgJRorIII()
public ST getPrefixEgDR()
public ST getXpn5_PrefixEgDR()
public NULLDT getDegreeEgMD()
public NULLDT getXpn6_DegreeEgMD()
public ID getNameTypeCode()
public ID getXpn7_NameTypeCode()
public ID getNameRepresentationCode()
public ID getXpn8_NameRepresentationCode()
public CWE getNameContext()
public CWE getXpn9_NameContext()
public NULLDT getNameValidityRange()
public NULLDT getXpn10_NameValidityRange()
public ID getNameAssemblyOrder()
public ID getXpn11_NameAssemblyOrder()
public DTM getEffectiveDate()
public DTM getXpn12_EffectiveDate()
public DTM getExpirationDate()
public DTM getXpn13_ExpirationDate()
public ST getProfessionalSuffix()
public ST getXpn14_ProfessionalSuffix()
public ST getCalledBy()
public ST getXpn15_CalledBy()
Copyright © 2001–2017 University Health Network. All rights reserved.