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 Link icon

    • use Link icon

      Identifies the purpose for this name.
    • text Link icon

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

      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 Link icon

      protected List<StringType> given
      Given name.
    • prefix Link icon

      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 Link icon

      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 Link icon

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

  • Method Details Link icon

    • getUseElement Link icon

      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 Link icon

      public boolean hasUseElement()
    • hasUse Link icon

      public boolean hasUse()
    • setUseElement Link icon

      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 Link icon

      Returns:
      Identifies the purpose for this name.
    • setUse Link icon

      Parameters:
      value - Identifies the purpose for this name.
    • getTextElement Link icon

      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 Link icon

      public boolean hasTextElement()
    • hasText Link icon

      public boolean hasText()
    • setTextElement Link icon

      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 Link icon

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

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

      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 Link icon

      public boolean hasFamilyElement()
    • hasFamily Link icon

      public boolean hasFamily()
    • setFamilyElement Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      Returns:
      given (Given name.)
    • setGiven Link icon

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

      public boolean hasGiven()
    • addGivenElement Link icon

      Returns:
      given (Given name.)
    • addGiven Link icon

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

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

      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 Link icon

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

      public boolean hasPrefix()
    • addPrefixElement Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

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

      public boolean hasSuffix()
    • addSuffixElement Link icon

      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 Link icon

      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 Link icon

      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 Link icon

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

      public boolean hasPeriod()
    • setPeriod Link icon

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

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

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

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

      Returns the text element value if it is not null.

      If the text element value is null, returns all the components of the name (prefix, given, family, suffix) as a single string with a single spaced string separating each part.

      Returns:
      the human name as a single string
    • listChildren Link icon

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

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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 Link icon

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

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

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

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

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

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

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