Package ca.uhn.fhir.model.dstu2.valueset
Enum NameUseEnum
- java.lang.Object
-
- java.lang.Enum<NameUseEnum>
-
- ca.uhn.fhir.model.dstu2.valueset.NameUseEnum
-
- All Implemented Interfaces:
Serializable,Comparable<NameUseEnum>
public enum NameUseEnum extends Enum<NameUseEnum>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ANONYMOUSDisplay: Anonymous
Code Value: anonymous Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons)MAIDENDisplay: Maiden
Code Value: maiden A name used prior to marriage.NICKNAMEDisplay: Nickname
Code Value: nickname A name that is used to address the person in an informal manner, but is not part of their formal or usual nameOFFICIALDisplay: Official
Code Value: official The formal name as registered in an official (government) registry, but which name might not be commonly used.OLDDisplay: Old
Code Value: old This name is no longer in use (or was never correct, but retained for records)TEMPDisplay: Temp
Code Value: temp A temporary name.USUALDisplay: Usual
Code Value: usual Known as/conventional/the one you normally use
-
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.model.api.IValueSetEnumBinder<NameUseEnum>VALUESET_BINDERConverts codes to their respective enumerated valuesstatic StringVALUESET_IDENTIFIERIdentifier for this Value Set:static StringVALUESET_NAMEName for this Value Set: NameUse
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static NameUseEnumforCode(String theCode)Returns the enumerated value associated with this codeStringgetCode()Returns the code associated with this enumerated valueStringgetSystem()Returns the code system associated with this enumerated valuestatic NameUseEnumvalueOf(String name)Returns the enum constant of this type with the specified name.static NameUseEnum[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
USUAL
public static final NameUseEnum USUAL
Display: Usual
Code Value: usual Known as/conventional/the one you normally use
-
OFFICIAL
public static final NameUseEnum OFFICIAL
Display: Official
Code Value: 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 NameUseEnum TEMP
Display: Temp
Code Value: 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 NameUseEnum NICKNAME
Display: Nickname
Code Value: 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 NameUseEnum ANONYMOUS
Display: Anonymous
Code Value: anonymous Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons)
-
OLD
public static final NameUseEnum OLD
Display: Old
Code Value: old This name is no longer in use (or was never correct, but retained for records)
-
MAIDEN
public static final NameUseEnum MAIDEN
Display: Maiden
Code Value: 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.
-
-
Field Detail
-
VALUESET_IDENTIFIER
public static final String VALUESET_IDENTIFIER
Identifier for this Value Set:- See Also:
- Constant Field Values
-
VALUESET_NAME
public static final String VALUESET_NAME
Name for this Value Set: NameUse- See Also:
- Constant Field Values
-
VALUESET_BINDER
public static final ca.uhn.fhir.model.api.IValueSetEnumBinder<NameUseEnum> VALUESET_BINDER
Converts codes to their respective enumerated values
-
-
Method Detail
-
values
public static NameUseEnum[] 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 (NameUseEnum c : NameUseEnum.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static NameUseEnum 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 nameNullPointerException- if the argument is null
-
forCode
public static NameUseEnum forCode(String theCode)
Returns the enumerated value associated with this code
-
-