Class HumanNameDt

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeDatatype, ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IDatatype, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.ICompositeType

    public class HumanNameDt
    extends ca.uhn.fhir.model.base.composite.BaseHumanNameDt
    implements ca.uhn.fhir.model.api.ICompositeDatatype
    HAPI/FHIR HumanNameDt Datatype ()

    Definition: A human's name with the ability to identify parts and usage

    Requirements: Need to be able to record names, along with notes about their use

    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      HumanNameDt()
      Constructor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ca.uhn.fhir.model.primitive.StringDt addFamily()
      Adds and returns a new value for family ()
      HumanNameDt addFamily​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Adds a given new value for family ()
      HumanNameDt addFamily​(String theString)
      Adds a new value for family ()
      ca.uhn.fhir.model.primitive.StringDt addGiven()
      Adds and returns a new value for given ()
      HumanNameDt addGiven​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Adds a given new value for given ()
      HumanNameDt addGiven​(String theString)
      Adds a new value for given ()
      ca.uhn.fhir.model.primitive.StringDt addPrefix()
      Adds and returns a new value for prefix ()
      HumanNameDt addPrefix​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Adds a given new value for prefix ()
      HumanNameDt addPrefix​(String theString)
      Adds a new value for prefix ()
      ca.uhn.fhir.model.primitive.StringDt addSuffix()
      Adds and returns a new value for suffix ()
      HumanNameDt addSuffix​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Adds a given new value for suffix ()
      HumanNameDt addSuffix​(String theString)
      Adds a new value for suffix ()
      <T extends ca.uhn.fhir.model.api.IElement>
      List<T>
      getAllPopulatedChildElementsOfType​(Class<T> theType)  
      List<ca.uhn.fhir.model.primitive.StringDt> getFamily()
      Gets the value(s) for family ().
      ca.uhn.fhir.model.primitive.StringDt getFamilyFirstRep()
      Gets the first repetition for family (), creating it if it does not already exist.
      List<ca.uhn.fhir.model.primitive.StringDt> getGiven()
      Gets the value(s) for given ().
      ca.uhn.fhir.model.primitive.StringDt getGivenFirstRep()
      Gets the first repetition for given (), creating it if it does not already exist.
      PeriodDt getPeriod()
      Gets the value(s) for period ().
      List<ca.uhn.fhir.model.primitive.StringDt> getPrefix()
      Gets the value(s) for prefix ().
      ca.uhn.fhir.model.primitive.StringDt getPrefixFirstRep()
      Gets the first repetition for prefix (), creating it if it does not already exist.
      List<ca.uhn.fhir.model.primitive.StringDt> getSuffix()
      Gets the value(s) for suffix ().
      ca.uhn.fhir.model.primitive.StringDt getSuffixFirstRep()
      Gets the first repetition for suffix (), creating it if it does not already exist.
      String getText()
      Gets the value(s) for text ().
      ca.uhn.fhir.model.primitive.StringDt getTextElement()
      Gets the value(s) for text ().
      String getUse()
      Gets the value(s) for use ().
      ca.uhn.fhir.model.primitive.BoundCodeDt<NameUseEnum> getUseElement()
      Gets the value(s) for use ().
      boolean isEmpty()  
      HumanNameDt setFamily​(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
      Sets the value(s) for family ()
      HumanNameDt setGiven​(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
      Sets the value(s) for given ()
      HumanNameDt setPeriod​(PeriodDt theValue)
      Sets the value(s) for period ()
      HumanNameDt setPrefix​(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
      Sets the value(s) for prefix ()
      HumanNameDt setSuffix​(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
      Sets the value(s) for suffix ()
      HumanNameDt setText​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for text ()
      HumanNameDt setText​(String theString)
      Sets the value for text ()
      HumanNameDt setUse​(NameUseEnum theValue)
      Sets the value(s) for use ()
      HumanNameDt setUse​(ca.uhn.fhir.model.primitive.BoundCodeDt<NameUseEnum> theValue)
      Sets the value(s) for use ()
      • Methods inherited from class ca.uhn.fhir.model.base.composite.BaseHumanNameDt

        getFamilyAsSingleString, getGivenAsSingleString, getNameAsSingleString, getPrefixAsSingleString, getSuffixAsSingleString, toString
      • Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

        getElementSpecificId, getId, setElementSpecificId, setId, setId
      • Methods inherited from class ca.uhn.fhir.model.api.BaseElement

        addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, isBaseEmpty, setUserData
      • Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

        fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
    • Constructor Detail

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getUseElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<NameUseEnumgetUseElement()
        Gets the value(s) for use (). creating it if it does not exist. Will not return null.

        Definition: Identifies the purpose for this name

      • getUse

        public String getUse()
        Gets the value(s) for use (). creating it if it does not exist. This method may return null.

        Definition: Identifies the purpose for this name

      • setUse

        public HumanNameDt setUse​(ca.uhn.fhir.model.primitive.BoundCodeDt<NameUseEnum> theValue)
        Sets the value(s) for use ()

        Definition: Identifies the purpose for this name

      • setUse

        public HumanNameDt setUse​(NameUseEnum theValue)
        Sets the value(s) for use ()

        Definition: Identifies the purpose for this name

      • getTextElement

        public ca.uhn.fhir.model.primitive.StringDt getTextElement()
        Gets the value(s) for text (). creating it if it does not exist. Will not return null.

        Definition: A full text representation of the name

        Specified by:
        getTextElement in class ca.uhn.fhir.model.base.composite.BaseHumanNameDt
      • getText

        public String getText()
        Gets the value(s) for text (). creating it if it does not exist. This method may return null.

        Definition: A full text representation of the name

      • setText

        public HumanNameDt setText​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for text ()

        Definition: A full text representation of the name

        Specified by:
        setText in class ca.uhn.fhir.model.base.composite.BaseHumanNameDt
      • setText

        public HumanNameDt setText​(String theString)
        Sets the value for text ()

        Definition: A full text representation of the name

      • getFamily

        public List<ca.uhn.fhir.model.primitive.StringDt> getFamily()
        Gets the value(s) for family (). 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.

        Specified by:
        getFamily in class ca.uhn.fhir.model.base.composite.BaseHumanNameDt
      • setFamily

        public HumanNameDt setFamily​(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
        Sets the value(s) for family ()

        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.

      • addFamily

        public ca.uhn.fhir.model.primitive.StringDt addFamily()
        Adds and returns a new value for family ()

        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.

      • addFamily

        public HumanNameDt addFamily​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Adds a given new value for family ()

        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.

        Parameters:
        theValue - The family to add (must not be null)
      • getFamilyFirstRep

        public ca.uhn.fhir.model.primitive.StringDt getFamilyFirstRep()
        Gets the first repetition for family (), creating it if it does not already exist.

        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.

      • addFamily

        public HumanNameDt addFamily​(String theString)
        Adds a new value for family ()

        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.

        Returns:
        Returns a reference to this object, to allow for simple chaining.
      • getGiven

        public List<ca.uhn.fhir.model.primitive.StringDt> getGiven()
        Gets the value(s) for given (). creating it if it does not exist. Will not return null.

        Definition: Given name

        Specified by:
        getGiven in class ca.uhn.fhir.model.base.composite.BaseHumanNameDt
      • setGiven

        public HumanNameDt setGiven​(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
        Sets the value(s) for given ()

        Definition: Given name

      • addGiven

        public ca.uhn.fhir.model.primitive.StringDt addGiven()
        Adds and returns a new value for given ()

        Definition: Given name

      • addGiven

        public HumanNameDt addGiven​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Adds a given new value for given ()

        Definition: Given name

        Parameters:
        theValue - The given to add (must not be null)
      • getGivenFirstRep

        public ca.uhn.fhir.model.primitive.StringDt getGivenFirstRep()
        Gets the first repetition for given (), creating it if it does not already exist.

        Definition: Given name

      • addGiven

        public HumanNameDt addGiven​(String theString)
        Adds a new value for given ()

        Definition: Given name

        Returns:
        Returns a reference to this object, to allow for simple chaining.
      • getPrefix

        public List<ca.uhn.fhir.model.primitive.StringDt> getPrefix()
        Gets the value(s) for prefix (). 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

        Specified by:
        getPrefix in class ca.uhn.fhir.model.base.composite.BaseHumanNameDt
      • setPrefix

        public HumanNameDt setPrefix​(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
        Sets the value(s) for prefix ()

        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

      • addPrefix

        public ca.uhn.fhir.model.primitive.StringDt addPrefix()
        Adds and returns a new value for prefix ()

        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

      • addPrefix

        public HumanNameDt addPrefix​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Adds a given new value for prefix ()

        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

        Parameters:
        theValue - The prefix to add (must not be null)
      • getPrefixFirstRep

        public ca.uhn.fhir.model.primitive.StringDt getPrefixFirstRep()
        Gets the first repetition for prefix (), creating it if it does not already exist.

        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

      • addPrefix

        public HumanNameDt addPrefix​(String theString)
        Adds a new value for prefix ()

        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

        Returns:
        Returns a reference to this object, to allow for simple chaining.
      • getSuffix

        public List<ca.uhn.fhir.model.primitive.StringDt> getSuffix()
        Gets the value(s) for suffix (). 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

        Specified by:
        getSuffix in class ca.uhn.fhir.model.base.composite.BaseHumanNameDt
      • setSuffix

        public HumanNameDt setSuffix​(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
        Sets the value(s) for suffix ()

        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

      • addSuffix

        public ca.uhn.fhir.model.primitive.StringDt addSuffix()
        Adds and returns a new value for suffix ()

        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

      • addSuffix

        public HumanNameDt addSuffix​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Adds a given new value for suffix ()

        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

        Parameters:
        theValue - The suffix to add (must not be null)
      • getSuffixFirstRep

        public ca.uhn.fhir.model.primitive.StringDt getSuffixFirstRep()
        Gets the first repetition for suffix (), creating it if it does not already exist.

        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

      • addSuffix

        public HumanNameDt addSuffix​(String theString)
        Adds a new value for suffix ()

        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

        Returns:
        Returns a reference to this object, to allow for simple chaining.
      • getPeriod

        public PeriodDt getPeriod()
        Gets the value(s) for period (). creating it if it does not exist. Will not return null.

        Definition: Indicates the period of time when this name was valid for the named person.

      • setPeriod

        public HumanNameDt setPeriod​(PeriodDt theValue)
        Sets the value(s) for period ()

        Definition: Indicates the period of time when this name was valid for the named person.