Package org.hl7.fhir.dstu2.model

Enum HumanName.NameUse

java.lang.Object

java.lang.Enum<HumanName.NameUse>

org.hl7.fhir.dstu2.model.HumanName.NameUse

All Implemented Interfaces:

Serializable, Comparable<HumanName.NameUse>

Enclosing class:

HumanName

public static enum HumanName.NameUse
extends Enum<HumanName.NameUse>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANONYMOUS	Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons)
MAIDEN	A name used prior to marriage.
NICKNAME	A name that is used to address the person in an informal manner, but is not part of their formal or usual name
NULL	added to help the parsers
OFFICIAL	The formal name as registered in an official (government) registry, but which name might not be commonly used.
OLD	This name is no longer in use (or was never correct, but retained for records)
TEMP	A temporary name.
USUAL	Known as/conventional/the one you normally use

Method Summary

Modifier and Type	Method	Description
static HumanName.NameUse	fromCode(String codeString)
String	getDefinition()
String	getDisplay()
String	getSystem()
String	toCode()
static HumanName.NameUse	valueOf(String name)	Returns the enum constant of this type with the specified name.
static HumanName.NameUse[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

USUAL

public static final HumanName.NameUse USUAL

Known as/conventional/the one you normally use

OFFICIAL

public static final HumanName.NameUse OFFICIAL

The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called "legal name".

TEMP

public static final HumanName.NameUse TEMP

A temporary name. Name.period can provide more detailed information. This may also be used for temporary names assigned at birth or in emergency situations.

NICKNAME

public static final HumanName.NameUse NICKNAME

A name that is used to address the person in an informal manner, but is not part of their formal or usual name

ANONYMOUS

public static final HumanName.NameUse ANONYMOUS

Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons)

OLD

public static final HumanName.NameUse OLD

This name is no longer in use (or was never correct, but retained for records)

MAIDEN

public static final HumanName.NameUse MAIDEN

A name used prior to marriage. Marriage naming customs vary greatly around the world. This name use is for use by applications that collect and store "maiden" names. Though the concept of maiden name is often gender specific, the use of this term is not gender specific. The use of this term does not imply any particular history for a person's name, nor should the maiden name be determined algorithmically.

NULL

public static final HumanName.NameUse NULL

added to help the parsers

Method Detail

values

public static HumanName.NameUse[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HumanName.NameUse c : HumanName.NameUse.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HumanName.NameUse valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromCode

public static HumanName.NameUse fromCode(String codeString)
                                  throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

toCode

public String toCode()

getSystem

public String getSystem()

getDefinition

public String getDefinition()

getDisplay

public String getDisplay()