Package org.hl7.fhir

Class HumanName

java.lang.Object
org.hl7.fhir.Element
org.hl7.fhir.HumanName
All Implemented Interfaces:
org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2
public class HumanName extends Element implements org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions

Java class for HumanName complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="HumanName">
   <complexContent>
     <extension base="{http://hl7.org/fhir}Element">
       <sequence>
         <element name="use" type="{http://hl7.org/fhir}NameUse" minOccurs="0"/>
         <element name="text" type="{http://hl7.org/fhir}string" minOccurs="0"/>
         <element name="family" type="{http://hl7.org/fhir}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="given" type="{http://hl7.org/fhir}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="prefix" type="{http://hl7.org/fhir}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="suffix" type="{http://hl7.org/fhir}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="period" type="{http://hl7.org/fhir}Period" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>

  • Field Details

  • Constructor Details

    • HumanName

      public HumanName()

  • Method Details

    • getUse

      public NameUse getUse()
      Gets the value of the use property.
      Returns:
      possible object is NameUse

    • setUse

      public void setUse(NameUse value)
      Sets the value of the use property.
      Parameters:
      value - allowed object is NameUse

    • getText

      public String getText()
      Gets the value of the text property.
      Returns:
      possible object is String

    • setText

      public void setText(String value)
      Sets the value of the text property.
      Parameters:
      value - allowed object is String

    • getFamily

      public List<String> getFamily()
      Gets the value of the family property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the family property.

      For example, to add a new item, do as follows: 

          getFamily().add(newItem);

      Objects of the following type(s) are allowed in the list String

    • getGiven

      public List<String> getGiven()
      Gets the value of the given property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the given property.

      For example, to add a new item, do as follows: 

          getGiven().add(newItem);

      Objects of the following type(s) are allowed in the list String

    • getPrefix

      public List<String> getPrefix()
      Gets the value of the prefix property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the prefix property.

      For example, to add a new item, do as follows: 

          getPrefix().add(newItem);

      Objects of the following type(s) are allowed in the list String

    • getSuffix

      public List<String> getSuffix()
      Gets the value of the suffix property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the suffix property.

      For example, to add a new item, do as follows: 

          getSuffix().add(newItem);

      Objects of the following type(s) are allowed in the list String

    • getPeriod

      public Period getPeriod()
      Gets the value of the period property.
      Returns:
      possible object is Period

    • setPeriod

      public void setPeriod(Period value)
      Sets the value of the period property.
      Parameters:
      value - allowed object is Period

    • withUse

      public HumanName withUse(NameUse value)

    • withText

      public HumanName withText(String value)

    • withFamily

      public HumanName withFamily(String... values)

    • withFamily

      public HumanName withFamily(Collection<String> values)

    • withGiven

      public HumanName withGiven(String... values)

    • withGiven

      public HumanName withGiven(Collection<String> values)

    • withPrefix

      public HumanName withPrefix(String... values)

    • withPrefix

      public HumanName withPrefix(Collection<String> values)

    • withSuffix

      public HumanName withSuffix(String... values)

    • withSuffix

      public HumanName withSuffix(Collection<String> values)

    • withPeriod

      public HumanName withPeriod(Period value)

    • withExtension

      public HumanName withExtension(Extension... values)
      Overrides:
      withExtension in class Element

    • withExtension

      public HumanName withExtension(Collection<Extension> values)
      Overrides:
      withExtension in class Element

    • withId

      public HumanName withId(String value)
      Overrides:
      withId in class Element

    • equals

      public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)
      Specified by:
      equals in interface org.jvnet.jaxb2_commons.lang.Equals2
      Overrides:
      equals in class Element

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Element

    • hashCode

      public int hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)
      Specified by:
      hashCode in interface org.jvnet.jaxb2_commons.lang.HashCode2
      Overrides:
      hashCode in class Element

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Element

    • toString

      public String toString()
      Overrides:
      toString in class Element

    • append

      public StringBuilder append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
      Specified by:
      append in interface org.jvnet.jaxb2_commons.lang.ToString2
      Overrides:
      append in class Element

    • appendFields

      public StringBuilder appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
      Specified by:
      appendFields in interface org.jvnet.jaxb2_commons.lang.ToString2
      Overrides:
      appendFields in class Element

    • setFamily

      public void setFamily(List<String> value)

    • setGiven

      public void setGiven(List<String> value)

    • setPrefix

      public void setPrefix(List<String> value)

    • setSuffix

      public void setSuffix(List<String> value)