HumanName (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.dstu3.model.Base
- - org.hl7.fhir.dstu3.model.Element
  - - org.hl7.fhir.dstu3.model.Type
    - - org.hl7.fhir.dstu3.model.HumanName

All Implemented Interfaces:

IElement, Serializable, IBase, IBaseDatatype, IBaseElement, IBaseHasExtensions, ICompositeType
```
public class HumanName
extends Type
implements ICompositeType
```
A human's name with the ability to identify parts and usage.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HumanName.NameUse

static class HumanName.NameUseEnumFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`HumanName.NameUse`
`static class`	`HumanName.NameUseEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected StringType`	`family` The part of a name that links to the genealogy.
`protected List<StringType>`	`given` Given name.
`protected Period`	`period` Indicates the period of time when this name was valid for the named person.
`protected List<StringType>`	`prefix` Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc.
`protected List<StringType>`	`suffix` Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc.
`protected StringType`	`text` A full text representation of the name.
`protected Enumeration<HumanName.NameUse>`	`use` Identifies the purpose for this name.

Fields inherited from class org.hl7.fhir.dstu3.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description

HumanName()
Constructor

Constructors
Constructor and Description
`HumanName()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`HumanName`	`addGiven(String value)`
`StringType`	`addGivenElement()`
`HumanName`	`addPrefix(String value)`
`StringType`	`addPrefixElement()`
`HumanName`	`addSuffix(String value)`
`StringType`	`addSuffixElement()`
`HumanName`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`String`	`getFamily()`
`StringType`	`getFamilyElement()`
`List<StringType>`	`getGiven()`
`String`	`getGivenAsSingleString()` /** Returns all repetitions of `given name` as a space separated string
`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.
`Period`	`getPeriod()`
`List<StringType>`	`getPrefix()`
`String`	`getPrefixAsSingleString()` Returns all repetitions of `prefix name` as a space separated string
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<StringType>`	`getSuffix()`
`String`	`getSuffixAsSingleString()` Returns all repetitions of `suffix` as a space separated string
`String`	`getText()`
`StringType`	`getTextElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`HumanName.NameUse`	`getUse()`
`Enumeration<HumanName.NameUse>`	`getUseElement()`
`boolean`	`hasFamily()`
`boolean`	`hasFamilyElement()`
`boolean`	`hasGiven()`
`boolean`	`hasGiven(String value)`
`boolean`	`hasPeriod()`
`boolean`	`hasPrefix()`
`boolean`	`hasPrefix(String value)`
`boolean`	`hasSuffix()`
`boolean`	`hasSuffix(String value)`
`boolean`	`hasText()`
`boolean`	`hasTextElement()`
`boolean`	`hasUse()`
`boolean`	`hasUseElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`HumanName`	`setFamily(String value)`
`HumanName`	`setFamilyElement(StringType value)`
`HumanName`	`setGiven(List<StringType> theGiven)`
`HumanName`	`setPeriod(Period value)`
`HumanName`	`setPrefix(List<StringType> thePrefix)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`HumanName`	`setSuffix(List<StringType> theSuffix)`
`HumanName`	`setText(String value)`
`HumanName`	`setTextElement(StringType value)`
`HumanName`	`setUse(HumanName.NameUse value)`
`HumanName`	`setUseElement(Enumeration<HumanName.NameUse> value)`
`protected HumanName`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu3.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - use
```
protected Enumeration<HumanName.NameUse> 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 Detail
  - HumanName
```
public HumanName()
```
    Constructor
- Method Detail
  - getUseElement
```
public Enumeration<HumanName.NameUse> 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
```
public HumanName setUseElement(Enumeration<HumanName.NameUse> value)
```
    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
```
public HumanName.NameUse getUse()
```
    Returns:
    
    Identifies the purpose for this name.
  - setUse
```
public HumanName setUse(HumanName.NameUse value)
```
    Parameters:
    
    value - Identifies the purpose for this name.
  - getTextElement
```
public StringType 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
```
public HumanName setTextElement(StringType value)
```
    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
```
public StringType 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
```
public HumanName setFamilyElement(StringType value)
```
    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
```
public List<StringType> 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
```
public StringType 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
```
public List<StringType> 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
```
public StringType 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
```
public List<StringType> 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
```
public StringType 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
```
public String getGivenAsSingleString()
```
    /** Returns all repetitions of given name as a space separated string
    
    See Also:
    
    DatatypeUtil#joinStringsSpaceSeparated(List)
  - getPrefixAsSingleString
```
public String getPrefixAsSingleString()
```
    Returns all repetitions of prefix name as a space separated string
    
    See Also:
    
    DatatypeUtil#joinStringsSpaceSeparated(List)
  - getSuffixAsSingleString
```
public String getSuffixAsSingleString()
```
    Returns all repetitions of suffix as a space separated string
    
    See Also:
    
    DatatypeUtil#joinStringsSpaceSeparated(List)
  - 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.
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class Element
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException
```
    Overrides:
    
    getProperty in class Element
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class Element
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class Element
    
    Throws:
    
    FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws FHIRException
```
    Overrides:
    
    makeProperty in class Element
    
    Throws:
    
    FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException
```
    Overrides:
    
    getTypesForProperty in class Element
    
    Throws:
    
    FHIRException
  - addChild
```
public Base addChild(String name)
              throws FHIRException
```
    Overrides:
    
    addChild in class Element
    
    Throws:
    
    FHIRException
  - fhirType
```
public String fhirType()
```
    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 IBase
    
    Overrides:
    
    isEmpty in class Element

Class HumanName

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu3.model.Element

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu3.model.Element

Methods inherited from class org.hl7.fhir.dstu3.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Field Detail

use

text

family

given

prefix

suffix

period

Constructor Detail

HumanName

Method Detail

getUseElement

hasUseElement

hasUse

setUseElement

getUse

setUse

getTextElement

hasTextElement

hasText

setTextElement

getText

setText

getFamilyElement

hasFamilyElement

hasFamily

setFamilyElement

getFamily

setFamily

getGiven

setGiven

hasGiven

addGivenElement

addGiven

hasGiven

getPrefix

setPrefix

hasPrefix

addPrefixElement

addPrefix

hasPrefix

getSuffix

setSuffix

hasSuffix

addSuffixElement

addSuffix

hasSuffix

getPeriod

hasPeriod

setPeriod

getGivenAsSingleString

getPrefixAsSingleString

getSuffixAsSingleString

getNameAsSingleString

listChildren

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

fhirType

copy

typedCopy

equalsDeep

equalsShallow

isEmpty