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
    ANONYMOUS
    Display: Anonymous
    Code Value: anonymous Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons)
    MAIDEN
    Display: Maiden
    Code Value: maiden A name used prior to marriage.
    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
    OFFICIAL
    Display: Official
    Code Value: official The formal name as registered in an official (government) registry, but which name might not be commonly used.
    OLD
    Display: Old
    Code Value: old This name is no longer in use (or was never correct, but retained for records)
    TEMP
    Display: Temp
    Code Value: temp A temporary name.
    USUAL
    Display: Usual
    Code Value: usual Known as/conventional/the one you normally use

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final ca.uhn.fhir.model.api.IValueSetEnumBinder<NameUseEnum>
    VALUESET_BINDER
    Converts codes to their respective enumerated values
    static final String
    VALUESET_IDENTIFIER
    Identifier for this Value Set:
    static final String
    VALUESET_NAME
    Name for this Value Set: NameUse

  • Method Summary

    Modifier and Type
    Method
    Description
    static NameUseEnum
    forCode(String theCode)
    Returns the enumerated value associated with this code
    String
    getCode()
    Returns the code associated with this enumerated value
    String
    getSystem()
    Returns the code system associated with this enumerated value
    static NameUseEnum
    valueOf(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.

    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 Details

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

  • Method Details

    • values

      public static NameUseEnum[] 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

      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 name
      NullPointerException - if the argument is null

    • getCode

      public String getCode()
      Returns the code associated with this enumerated value

    • getSystem

      public String getSystem()
      Returns the code system associated with this enumerated value

    • forCode

      public static NameUseEnum forCode(String theCode)
      Returns the enumerated value associated with this code