Class HumanName

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType

    public class HumanName
    extends Type
    implements org.hl7.fhir.instance.model.api.ICompositeType
    A human's name with the ability to identify parts and usage.
    See Also:
    Serialized Form
    • Field Detail

      • text

        protected StringType text
        A full text representation of the name.
      • family

        protected StringType family
        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.
      • prefix

        protected List<StringType> prefix
        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.
      • suffix

        protected List<StringType> suffix
        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.
      • period

        protected Period period
        Indicates the period of time when this name was valid for the named person.
    • Constructor Detail

    • Method Detail

      • getUseElement

        public Enumeration<HumanName.NameUsegetUseElement()
        Returns:
        use (Identifies the purpose for this name.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value
      • hasUse

        public boolean hasUse()
      • setUseElement

        public HumanName setUseElement​(Enumeration<HumanName.NameUse> value)
        Parameters:
        value - use (Identifies the purpose for this name.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value
      • getTextElement

        public StringType getTextElement()
        Returns:
        text (A full text representation of the name.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value
      • hasText

        public boolean hasText()
      • setTextElement

        public HumanName setTextElement​(StringType value)
        Parameters:
        value - text (A full text representation of the name.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value
      • getText

        public String getText()
        Returns:
        A full text representation of the name.
      • setText

        public HumanName setText​(String value)
        Parameters:
        value - A full text representation of the name.
      • getFamilyElement

        public StringType getFamilyElement()
        Returns:
        family (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.). This is the underlying object with id, value and extensions. The accessor "getFamily" gives direct access to the value
      • setFamilyElement

        public HumanName setFamilyElement​(StringType value)
        Parameters:
        value - family (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.). This is the underlying object with id, value and extensions. The accessor "getFamily" gives direct access to the value
      • getFamily

        public String getFamily()
        Returns:
        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.
      • setFamily

        public HumanName setFamily​(String value)
        Parameters:
        value - 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.
      • getPrefix

        public List<StringTypegetPrefix()
        Returns:
        prefix (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.)
      • addPrefixElement

        public StringType addPrefixElement()
        Returns:
        prefix (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.)
      • addPrefix

        public HumanName addPrefix​(String value)
        Parameters:
        value - prefix (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.)
      • hasPrefix

        public boolean hasPrefix​(String value)
        Parameters:
        value - prefix (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.)
      • getSuffix

        public List<StringTypegetSuffix()
        Returns:
        suffix (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.)
      • addSuffixElement

        public StringType addSuffixElement()
        Returns:
        suffix (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.)
      • addSuffix

        public HumanName addSuffix​(String value)
        Parameters:
        value - suffix (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.)
      • hasSuffix

        public boolean hasSuffix​(String value)
        Parameters:
        value - suffix (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.)
      • getPeriod

        public Period getPeriod()
        Returns:
        period (Indicates the period of time when this name was valid for the named person.)
      • setPeriod

        public HumanName setPeriod​(Period value)
        Parameters:
        value - period (Indicates the period of time when this name was valid for the named person.)
      • getGivenAsSingleString

        public String getGivenAsSingleString()
        /** Returns all repetitions of given name as a space separated string
        See Also:
        DatatypeUtil.joinStringsSpaceSeparated(List)
      • getSuffixAsSingleString

        public String getSuffixAsSingleString()
        Returns all repetitions of suffix as a space separated string
        See Also:
        DatatypeUtil.joinStringsSpaceSeparated(List)
      • getNameAsSingleString

        public String getNameAsSingleString()
        Returns all of the components of the name (prefix, given, family, suffix) as a single string with a single spaced string separating each part.

        If none of the parts are populated, returns the text element value instead.

      • getProperty

        public Base[] getProperty​(int hash,
                                  String name,
                                  boolean checkValid)
                           throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class Element
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • addChild

        public Base addChild​(String name)
                      throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        addChild in class Element
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • fhirType

        public String fhirType()
        Specified by:
        fhirType in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        fhirType in class Element
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class Element