Package ca.uhn.hl7v2.model.v251.datatype

Class XPN

java.lang.Object
ca.uhn.hl7v2.model.AbstractType
ca.uhn.hl7v2.model.AbstractComposite
ca.uhn.hl7v2.model.v251.datatype.XPN
All Implemented Interfaces:
Composite, Type, Visitable, Serializable
public class XPN extends AbstractComposite

Represents an HL7 XPN (Extended Person Name) data type. This type consists of the following components:

  • Family Name (FN)
  • Given Name (ST)
  • Second and Further Given Names or Initials Thereof (ST)
  • Suffix (e.g., JR or III) (ST)
  • Prefix (e.g., DR) (ST)
  • Degree (e.g., MD) (IS)
  • Name Type Code (ID)
  • Name Representation Code (ID)
  • Name Context (CE)
  • Name Validity Range (DR)
  • Name Assembly Order (ID)
  • Effective Date (TS)
  • Expiration Date (TS)
  • Professional Suffix (ST)
See Also:

  • Constructor Details

    • XPN

      public XPN(Message message)
      Creates a new XPN type

  • Method Details

    • getComponents

      public Type[] getComponents()
      Returns an array containing the data elements.

    • getComponent

      public Type getComponent(int number) throws DataTypeException
      Returns an individual data component.
      Parameters:
      number - The component number (0-indexed)
      Throws:
      DataTypeException - if the given element number is out of range.

    • getFamilyName

      public FN getFamilyName()
      Returns Family Name (component 1). This is a convenience method that saves you from casting and handling an exception.

    • getXpn1_FamilyName

      public FN getXpn1_FamilyName()
      Returns Family Name (component 1). This is a convenience method that saves you from casting and handling an exception.

    • getGivenName

      public ST getGivenName()
      Returns Given Name (component 2). This is a convenience method that saves you from casting and handling an exception.

    • getXpn2_GivenName

      public ST getXpn2_GivenName()
      Returns Given Name (component 2). This is a convenience method that saves you from casting and handling an exception.

    • getSecondAndFurtherGivenNamesOrInitialsThereof

      public ST getSecondAndFurtherGivenNamesOrInitialsThereof()
      Returns Second and Further Given Names or Initials Thereof (component 3). This is a convenience method that saves you from casting and handling an exception.

    • getXpn3_SecondAndFurtherGivenNamesOrInitialsThereof

      public ST getXpn3_SecondAndFurtherGivenNamesOrInitialsThereof()
      Returns Second and Further Given Names or Initials Thereof (component 3). This is a convenience method that saves you from casting and handling an exception.

    • getSuffixEgJRorIII

      public ST getSuffixEgJRorIII()
      Returns Suffix (e.g., JR or III) (component 4). This is a convenience method that saves you from casting and handling an exception.

    • getXpn4_SuffixEgJRorIII

      public ST getXpn4_SuffixEgJRorIII()
      Returns Suffix (e.g., JR or III) (component 4). This is a convenience method that saves you from casting and handling an exception.

    • getPrefixEgDR

      public ST getPrefixEgDR()
      Returns Prefix (e.g., DR) (component 5). This is a convenience method that saves you from casting and handling an exception.

    • getXpn5_PrefixEgDR

      public ST getXpn5_PrefixEgDR()
      Returns Prefix (e.g., DR) (component 5). This is a convenience method that saves you from casting and handling an exception.

    • getDegreeEgMD

      public IS getDegreeEgMD()
      Returns Degree (e.g., MD) (component 6). This is a convenience method that saves you from casting and handling an exception.

    • getXpn6_DegreeEgMD

      public IS getXpn6_DegreeEgMD()
      Returns Degree (e.g., MD) (component 6). This is a convenience method that saves you from casting and handling an exception.

    • getNameTypeCode

      public ID getNameTypeCode()
      Returns Name Type Code (component 7). This is a convenience method that saves you from casting and handling an exception.

    • getXpn7_NameTypeCode

      public ID getXpn7_NameTypeCode()
      Returns Name Type Code (component 7). This is a convenience method that saves you from casting and handling an exception.

    • getNameRepresentationCode

      public ID getNameRepresentationCode()
      Returns Name Representation Code (component 8). This is a convenience method that saves you from casting and handling an exception.

    • getXpn8_NameRepresentationCode

      public ID getXpn8_NameRepresentationCode()
      Returns Name Representation Code (component 8). This is a convenience method that saves you from casting and handling an exception.

    • getNameContext

      public CE getNameContext()
      Returns Name Context (component 9). This is a convenience method that saves you from casting and handling an exception.

    • getXpn9_NameContext

      public CE getXpn9_NameContext()
      Returns Name Context (component 9). This is a convenience method that saves you from casting and handling an exception.

    • getNameValidityRange

      public DR getNameValidityRange()
      Returns Name Validity Range (component 10). This is a convenience method that saves you from casting and handling an exception.

    • getXpn10_NameValidityRange

      public DR getXpn10_NameValidityRange()
      Returns Name Validity Range (component 10). This is a convenience method that saves you from casting and handling an exception.

    • getNameAssemblyOrder

      public ID getNameAssemblyOrder()
      Returns Name Assembly Order (component 11). This is a convenience method that saves you from casting and handling an exception.

    • getXpn11_NameAssemblyOrder

      public ID getXpn11_NameAssemblyOrder()
      Returns Name Assembly Order (component 11). This is a convenience method that saves you from casting and handling an exception.

    • getEffectiveDate

      public TS getEffectiveDate()
      Returns Effective Date (component 12). This is a convenience method that saves you from casting and handling an exception.

    • getXpn12_EffectiveDate

      public TS getXpn12_EffectiveDate()
      Returns Effective Date (component 12). This is a convenience method that saves you from casting and handling an exception.

    • getExpirationDate

      public TS getExpirationDate()
      Returns Expiration Date (component 13). This is a convenience method that saves you from casting and handling an exception.

    • getXpn13_ExpirationDate

      public TS getXpn13_ExpirationDate()
      Returns Expiration Date (component 13). This is a convenience method that saves you from casting and handling an exception.

    • getProfessionalSuffix

      public ST getProfessionalSuffix()
      Returns Professional Suffix (component 14). This is a convenience method that saves you from casting and handling an exception.

    • getXpn14_ProfessionalSuffix

      public ST getXpn14_ProfessionalSuffix()
      Returns Professional Suffix (component 14). This is a convenience method that saves you from casting and handling an exception.