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

Class NameUse

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class NameUse
extends Code

    • Field Detail

      • USUAL

        public static final NameUse USUAL
        Usual

        Known as/conventional/the one you normally use.

      • OFFICIAL

        public static final NameUse 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 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 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 ANONYMOUS
        Anonymous

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

      • OLD

        public static final NameUse OLD
        Old

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

      • MAIDEN

        public static final NameUse 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

      • of

        public static NameUse of​(NameUse.ValueSet value)
        Factory method for creating NameUse objects from a passed enum value.

      • of

        public static NameUse of​(String value)
        Factory method for creating NameUse objects 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

      • string

        public static String string​(String value)
        Inherited factory method for creating NameUse objects 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

      • code

        public static Code code​(String value)
        Inherited factory method for creating NameUse objects 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

      • equals

        public boolean equals​(Object obj)
        Overrides:
        equals in class Code

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Code

      • toBuilder

        public NameUse.Builder toBuilder()
        Description copied from class: Element
        Create a new Builder from the contents of this Element
        Overrides:
        toBuilder in class Code