Enum NameUse

All Implemented Interfaces:
Serializable, Comparable<NameUse>

public enum NameUse extends Enum<NameUse>
  • Enum Constant Details

    • USUAL

      public static final NameUse USUAL
      Known as/conventional/the one you normally use.

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

      public static final NameUse NICKNAME
      A name that is used to address the person in an informal manner, but is not part of their formal or usual name.

      public static final NameUse ANONYMOUS
      Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons).
    • OLD

      public static final NameUse OLD
      This name is no longer in use (or was never correct, but retained for records).
    • MAIDEN

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

      public static final NameUse NULL
      added to help the parsers
  • Method Details

    • values

      public static NameUse[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static NameUse 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.)
      name - the name of the enum constant to be returned.
      the enum constant with the specified name
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • fromCode

      public static NameUse fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException
    • toCode

      public String toCode()
    • getSystem

      public String getSystem()
    • getDefinition

    • getDisplay

      public String getDisplay()