Package org.hl7.fhir.r4.model
Enum HumanName.NameUse
- All Implemented Interfaces:
Serializable
,Comparable<HumanName.NameUse>
- Enclosing class:
HumanName
-
Enum Constant Summary
Enum ConstantDescriptionAnonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons).A name used prior to changing name because of marriage.A name that is used to address the person in an informal manner, but is not part of their formal or usual name.added to help the parsers with the generic typesThe formal name as registered in an official (government) registry, but which name might not be commonly used.This name is no longer in use (or was never correct, but retained for records).A temporary name.Known as/conventional/the one you normally use. -
Method Summary
Modifier and TypeMethodDescriptionstatic HumanName.NameUse
toCode()
static HumanName.NameUse
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.
-
Enum Constant Details
-
USUAL
Known as/conventional/the one you normally use. -
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
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
A name that is used to address the person in an informal manner, but is not part of their formal or usual name. -
ANONYMOUS
Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons). -
OLD
This name is no longer in use (or was never correct, but retained for records). -
MAIDEN
A name used prior to changing name because of marriage. This name use is for use by applications that collect and store names that were used prior to a marriage. Marriage naming customs vary greatly around the world, and are constantly changing. This term is not gender specific. The use of this term does not imply any particular history for a person's name. -
NULL
added to help the parsers with the generic types
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException
- 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
-
getSystem
-
getDefinition
-
getDisplay
-