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:
  • Field Details

    • use

      Identifies the purpose for this name.
    • 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.
    • given

      protected List<StringType> given
      Given name.
    • 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 Details

  • Method Details

    • getUseElement

      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
    • hasUseElement

      public boolean hasUseElement()
    • hasUse

      public boolean hasUse()
    • setUseElement

      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
    • getUse

      Returns:
      Identifies the purpose for this name.
    • setUse

      Parameters:
      value - Identifies the purpose for this name.
    • 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
    • hasTextElement

      public boolean hasTextElement()
    • hasText

      public boolean hasText()
    • setTextElement

      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

      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
    • hasFamilyElement

      public boolean hasFamilyElement()
    • hasFamily

      public boolean hasFamily()
    • setFamilyElement

      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.
    • getGiven

      Returns:
      given (Given name.)
    • setGiven

      public HumanName setGiven(List<StringType> theGiven)
      Returns:
      Returns a reference to this for easy method chaining
    • hasGiven

      public boolean hasGiven()
    • addGivenElement

      Returns:
      given (Given name.)
    • addGiven

      public HumanName addGiven(String value)
      Parameters:
      value - given (Given name.)
    • hasGiven

      public boolean hasGiven(String value)
      Parameters:
      value - given (Given name.)
    • getPrefix

      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.)
    • setPrefix

      public HumanName setPrefix(List<StringType> thePrefix)
      Returns:
      Returns a reference to this for easy method chaining
    • hasPrefix

      public boolean hasPrefix()
    • 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

      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.)
    • setSuffix

      public HumanName setSuffix(List<StringType> theSuffix)
      Returns:
      Returns a reference to this for easy method chaining
    • hasSuffix

      public boolean hasSuffix()
    • 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.)
    • hasPeriod

      public boolean hasPeriod()
    • setPeriod

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

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

      Returns all repetitions of prefix name as a space separated string
      See Also:
      • DatatypeUtil.joinStringsSpaceSeparated(List)
    • getSuffixAsSingleString

      Returns all repetitions of suffix as a space separated string
      See Also:
      • DatatypeUtil.joinStringsSpaceSeparated(List)
    • 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.

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class Element
    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • 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
    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty 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
    • copy

      public HumanName copy()
      Overrides:
      copy in class Type
    • typedCopy

      protected HumanName typedCopy()
      Specified by:
      typedCopy in class Type
    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class Element
    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class Element
    • isEmpty

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