Package org.hl7.fhir.dstu2.model

Class HumanName

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.Element

org.hl7.fhir.dstu2.model.Type

org.hl7.fhir.dstu2.model.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:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HumanName.NameUse
static class	HumanName.NameUseEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected List<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. and that appears at the start of the name.
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.
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.dstu2.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
HumanName()

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
HumanName	addFamily(String value)
StringType	addFamilyElement()
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()
List<StringType>	getFamily()
List<StringType>	getGiven()
Period	getPeriod()
List<StringType>	getPrefix()
List<StringType>	getSuffix()
String	getText()
StringType	getTextElement()
HumanName.NameUse	getUse()
Enumeration<HumanName.NameUse>	getUseElement()
boolean	hasFamily()
boolean	hasFamily(String value)
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)
HumanName	setPeriod(Period value)
void	setProperty(String name, Base value)
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.dstu2.model.Element

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

Field Details

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 List<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 Details

HumanName

public HumanName()

Method Details

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.

getFamily

public List<StringType> getFamily()

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

hasFamily

public boolean hasFamily()

addFamilyElement

public StringType addFamilyElement()

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

addFamily

public HumanName addFamily(String 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.)

hasFamily

public boolean hasFamily(String 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.)

getGiven

public List<StringType> getGiven()

Returns:

given (Given name.)

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

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

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

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class Element

setProperty

public void setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

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 org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class Element