Package com.ibm.fhir.model.type

Class HumanName

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class HumanName
extends Element
    A human's name with the ability to identify parts and usage.

    • Method Detail

      • getUse

        public NameUse getUse()
        Identifies the purpose for this name.
        Returns:
        An immutable object of type NameUse that may be null.

      • getText

        public String getText()
        Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
        Returns:
        An immutable object of type String that may be null.

      • getFamily

        public String getFamily()
        The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
        Returns:
        An immutable object of type String that may be null.

      • getGiven

        public List<String> getGiven()
        Given name.
        Returns:
        An unmodifiable list containing immutable objects of type String that may be empty.

      • getPrefix

        public List<String> getPrefix()
        Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
        Returns:
        An unmodifiable list containing immutable objects of type String that may be empty.

      • getSuffix

        public List<String> getSuffix()
        Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
        Returns:
        An unmodifiable list containing immutable objects of type String that may be empty.

      • getPeriod

        public Period getPeriod()
        Indicates the period of time when this name was valid for the named person.
        Returns:
        An immutable object of type Period that may be null.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object