Package com.ibm.fhir.model.type.code

Enum NameUse.ValueSet

    • Enum Constant Detail

      • USUAL

        public static final NameUse.ValueSet USUAL
        Usual

        Known as/conventional/the one you normally use.

      • OFFICIAL

        public static final NameUse.ValueSet OFFICIAL
        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 NameUse.ValueSet TEMP
        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 NameUse.ValueSet NICKNAME
        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 NameUse.ValueSet ANONYMOUS
        Anonymous

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

      • OLD

        public static final NameUse.ValueSet OLD
        Old

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

      • MAIDEN

        public static final NameUse.ValueSet MAIDEN
        Name changed for Marriage

        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.

    • Method Detail

      • values

        public static NameUse.ValueSet[] 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 (NameUse.ValueSet c : NameUse.ValueSet.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static NameUse.ValueSet 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

      • value

        public String value()
        Returns:
        The java.lang.String value of the code represented by this enum

      • from

        public static NameUse.ValueSet from​(String value)
        Factory method for creating NameUse.ValueSet values from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value