ca.uhn.fhir.model.dstu.composite

Class HumanNameDt

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.base.composite.BaseHumanNameDt

ca.uhn.fhir.model.dstu.composite.HumanNameDt

All Implemented Interfaces:

ICompositeDatatype, ICompositeElement, IDatatype, IElement, IIdentifiableElement, ISupportsUndeclaredExtensions

public class HumanNameDt
extends BaseHumanNameDt
implements ICompositeDatatype

HAPI/FHIR HumanNameDt Datatype (Name of a human - parts and usage)

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

Constructor Summary

Constructors

Constructor and Description
HumanNameDt() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
StringDt	addFamily() Adds and returns a new value for family (Family name (often called 'Surname'))
HumanNameDt	addFamily(String theString) Adds a new value for family (Family name (often called 'Surname'))
StringDt	addGiven() Adds and returns a new value for given (Given names (not always 'first').
HumanNameDt	addGiven(String theString) Adds a new value for given (Given names (not always 'first').
StringDt	addPrefix() Adds and returns a new value for prefix (Parts that come before the name)
HumanNameDt	addPrefix(String theString) Adds a new value for prefix (Parts that come before the name)
StringDt	addSuffix() Adds and returns a new value for suffix (Parts that come after the name)
HumanNameDt	addSuffix(String theString) Adds a new value for suffix (Parts that come after the name)
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
List<StringDt>	getFamily() Gets the value(s) for family (Family name (often called 'Surname')).
StringDt	getFamilyFirstRep() Gets the first repetition for family (Family name (often called 'Surname')), creating it if it does not already exist.
List<StringDt>	getGiven() Gets the value(s) for given (Given names (not always 'first').
StringDt	getGivenFirstRep() Gets the first repetition for given (Given names (not always 'first').
PeriodDt	getPeriod() Gets the value(s) for period (Time period when name was/is in use).
List<StringDt>	getPrefix() Gets the value(s) for prefix (Parts that come before the name).
StringDt	getPrefixFirstRep() Gets the first repetition for prefix (Parts that come before the name), creating it if it does not already exist.
List<StringDt>	getSuffix() Gets the value(s) for suffix (Parts that come after the name).
StringDt	getSuffixFirstRep() Gets the first repetition for suffix (Parts that come after the name), creating it if it does not already exist.
StringDt	getText() Gets the value(s) for text (Text representation of the full name).
BoundCodeDt<NameUseEnum>	getUse() Gets the value(s) for use (usual | official | temp | nickname | anonymous | old | maiden).
boolean	isEmpty()
HumanNameDt	setFamily(List<StringDt> theValue) Sets the value(s) for family (Family name (often called 'Surname'))
HumanNameDt	setGiven(List<StringDt> theValue) Sets the value(s) for given (Given names (not always 'first').
HumanNameDt	setPeriod(PeriodDt theValue) Sets the value(s) for period (Time period when name was/is in use)
HumanNameDt	setPrefix(List<StringDt> theValue) Sets the value(s) for prefix (Parts that come before the name)
HumanNameDt	setSuffix(List<StringDt> theValue) Sets the value(s) for suffix (Parts that come after the name)
HumanNameDt	setText(String theString) Sets the value for text (Text representation of the full name)
HumanNameDt	setText(StringDt theValue) Sets the value(s) for text (Text representation of the full name)
HumanNameDt	setUse(BoundCodeDt<NameUseEnum> theValue) Sets the value(s) for use (usual | official | temp | nickname | anonymous | old | maiden)
HumanNameDt	setUse(NameUseEnum theValue) Sets the value(s) for use (usual | official | temp | nickname | anonymous | old | maiden)

Methods inherited from class ca.uhn.fhir.model.base.composite.BaseHumanNameDt

getFamilyAsSingleString, getGivenAsSingleString, 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, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HumanNameDt

public HumanNameDt()

Constructor

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getUse

public BoundCodeDt<NameUseEnum> getUse()

Gets the value(s) for use (usual | official | temp | nickname | anonymous | old | maiden). creating it if it does not exist. Will not return null.

Definition: Identifies the purpose for this name

setUse

public HumanNameDt setUse(BoundCodeDt<NameUseEnum> theValue)

Sets the value(s) for use (usual | official | temp | nickname | anonymous | old | maiden)

Definition: Identifies the purpose for this name

setUse

public HumanNameDt setUse(NameUseEnum theValue)

Sets the value(s) for use (usual | official | temp | nickname | anonymous | old | maiden)

Definition: Identifies the purpose for this name

getText

public StringDt getText()

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 HumanNameDt setText(StringDt theValue)

Sets the value(s) for text (Text representation of the full name)

Definition: A full text representation of the name

setText

public HumanNameDt setText(String theString)

Sets the value for text (Text representation of the full name)

Definition: A full text representation of the name

getFamily

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

Specified by:

getFamily in class BaseHumanNameDt

setFamily

public HumanNameDt setFamily(List<StringDt> theValue)

Sets the value(s) for family (Family name (often called 'Surname'))

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 StringDt addFamily()

Adds and returns a new value for family (Family name (often called 'Surname'))

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.

getFamilyFirstRep

public StringDt getFamilyFirstRep()

Gets the first repetition for family (Family name (often called 'Surname')), 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 (Family name (often called 'Surname'))

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

Specified by:

getGiven in class BaseHumanNameDt

setGiven

public HumanNameDt setGiven(List<StringDt> theValue)

Sets the value(s) for given (Given names (not always 'first'). Includes middle names)

Definition: Given name

addGiven

public StringDt addGiven()

Adds and returns a new value for given (Given names (not always 'first'). Includes middle names)

Definition: Given name

getGivenFirstRep

public StringDt getGivenFirstRep()

Gets the first repetition for given (Given names (not always 'first'). Includes middle names), creating it if it does not already exist.

Definition: Given name

addGiven

public HumanNameDt addGiven(String theString)

Adds a new value for given (Given names (not always 'first'). Includes middle names)

Definition: Given name

Returns:

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

getPrefix

public 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

Specified by:

getPrefix in class BaseHumanNameDt

setPrefix

public HumanNameDt setPrefix(List<StringDt> theValue)

Sets the value(s) for prefix (Parts that come before the name)

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 StringDt addPrefix()

Adds and returns a new value for prefix (Parts that come before the name)

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

getPrefixFirstRep

public StringDt getPrefixFirstRep()

Gets the first repetition for prefix (Parts that come before the name), 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 (Parts that come before the name)

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

Specified by:

getSuffix in class BaseHumanNameDt

setSuffix

public HumanNameDt setSuffix(List<StringDt> theValue)

Sets the value(s) for suffix (Parts that come after the name)

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 StringDt addSuffix()

Adds and returns a new value for suffix (Parts that come after the name)

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

getSuffixFirstRep

public StringDt getSuffixFirstRep()

Gets the first repetition for suffix (Parts that come after the name), 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 (Parts that come after the name)

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 (Time period when name was/is in use). 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 (Time period when name was/is in use)

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