Package ca.uhn.fhir.model.base.composite

Class BaseHumanNameDt

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.api.BaseIdentifiableElement
ca.uhn.fhir.model.base.composite.BaseHumanNameDt
All Implemented Interfaces:
IElement, IIdentifiableElement, ISupportsUndeclaredExtensions, Serializable, IBase
public abstract class BaseHumanNameDt extends BaseIdentifiableElement
See Also:
Serialized Form

  • Constructor Details

  • Method Details

    • getFamily

      public abstract List<StringDt> getFamily()
      Gets the value(s) for family (Family name (often called 'Surname')). creating it if it does not exist. Will not return null.

      Definition: 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.

    • getFamilyAsSingleString

      public String getFamilyAsSingleString()
      Returns all repetitions of family name as a space separated string
      See Also:
      DatatypeUtil.joinStringsSpaceSeparated(List)

    • getGiven

      public abstract List<StringDt> getGiven()
      Gets the value(s) for given (Given names (not always 'first'). Includes middle names). creating it if it does not exist. Will not return null.

      Definition: Given name

    • getGivenAsSingleString

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

    • getPrefix

      public abstract List<StringDt> getPrefix()
      Gets the value(s) for prefix (Parts that come before the name). creating it if it does not exist. Will not return null.

      Definition: 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

    • getPrefixAsSingleString

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

    • getSuffix

      public abstract List<StringDt> getSuffix()
      Gets the value(s) for suffix (Parts that come after the name). creating it if it does not exist. Will not return null.

      Definition: 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

    • getSuffixAsSingleString

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

    • getTextElement

      public abstract StringDt getTextElement()
      Gets the value(s) for text (Text representation of the full name). creating it if it does not exist. Will not return null.

      Definition: A full text representation of the name

    • setText

      public abstract BaseHumanNameDt setText​(StringDt theValue)
      Sets the value(s) for text (Text representation of the full name)

      Definition: A full text representation of the name

    • toString

      public String toString()
      Overrides:
      toString in class Object

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