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

Class FN

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

Represents an HL7 FN (Family Name) data type. This type consists of the following components:

  • Surname (ST)
  • Own Surname Prefix (ST)
  • Own Surname (ST)
  • Surname Prefix From Partner/Spouse (ST)
  • Surname From Partner/Spouse (ST)
See Also:

  • Constructor Details

    • FN

      public FN(Message message)
      Creates a new FN 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.

    • getSurname

      public ST getSurname()
      Returns Surname (component 1). This is a convenience method that saves you from casting and handling an exception.

    • getFn1_Surname

      public ST getFn1_Surname()
      Returns Surname (component 1). This is a convenience method that saves you from casting and handling an exception.

    • getOwnSurnamePrefix

      public ST getOwnSurnamePrefix()
      Returns Own Surname Prefix (component 2). This is a convenience method that saves you from casting and handling an exception.

    • getFn2_OwnSurnamePrefix

      public ST getFn2_OwnSurnamePrefix()
      Returns Own Surname Prefix (component 2). This is a convenience method that saves you from casting and handling an exception.

    • getOwnSurname

      public ST getOwnSurname()
      Returns Own Surname (component 3). This is a convenience method that saves you from casting and handling an exception.

    • getFn3_OwnSurname

      public ST getFn3_OwnSurname()
      Returns Own Surname (component 3). This is a convenience method that saves you from casting and handling an exception.

    • getSurnamePrefixFromPartnerSpouse

      public ST getSurnamePrefixFromPartnerSpouse()
      Returns Surname Prefix From Partner/Spouse (component 4). This is a convenience method that saves you from casting and handling an exception.

    • getFn4_SurnamePrefixFromPartnerSpouse

      public ST getFn4_SurnamePrefixFromPartnerSpouse()
      Returns Surname Prefix From Partner/Spouse (component 4). This is a convenience method that saves you from casting and handling an exception.

    • getSurnameFromPartnerSpouse

      public ST getSurnameFromPartnerSpouse()
      Returns Surname From Partner/Spouse (component 5). This is a convenience method that saves you from casting and handling an exception.

    • getFn5_SurnameFromPartnerSpouse

      public ST getFn5_SurnameFromPartnerSpouse()
      Returns Surname From Partner/Spouse (component 5). This is a convenience method that saves you from casting and handling an exception.