Package org.projecthusky.common.enums

Enum Class GeneralAddressUse

java.lang.Object
java.lang.Enum<GeneralAddressUse>
org.projecthusky.common.enums.GeneralAddressUse
All Implemented Interfaces:
Serializable, Comparable<GeneralAddressUse>, Constable, CodedMetadataEnumInterface, TranslatedEnumInterface, ValueSetEnumInterface
public enum GeneralAddressUse extends Enum<GeneralAddressUse> implements ValueSetEnumInterface
Address uses that can apply to both postal and telecommunication addresses.

  • Enum Constant Details

    • BAD

      public static final GeneralAddressUse BAD
      A flag indicating that the address is bad, in fact, useless.

    • BUSINESS

      public static final GeneralAddressUse BUSINESS
      An office address. First choice for business related contacts during business hours.

    • BUSINESS_DIRECT

      public static final GeneralAddressUse BUSINESS_DIRECT
      Indicates a work place address or telecommunication address that reaches the individual or organization directly without intermediaries. For phones, often referred to as a 'private line'.

    • CONFIDENTIAL

      public static final GeneralAddressUse CONFIDENTIAL
      Indicates that the address is considered sensitive and should only be shared or published in accordance with organizational controls governing patient demographic information with increased sensitivity. Uses of Addresses. Lloyd to supply more complete description.

    • OLD

      public static final GeneralAddressUse OLD
      This address is no longer in use. Usage Note: Address may also carry valid time ranges. This code is used to cover the situations where it is known that the address is no longer valid, but no particular time range for its use is known.

    • PRIVATE

      public static final GeneralAddressUse PRIVATE
      A communication address at a home, attempted contacts for business purposes might intrude privacy and chances are one will contact family or other household members instead of the person one wishes to call. Typically used with urgent cases, or if no other contacts are available.

    • PRIVATE_PRIMARY

      public static final GeneralAddressUse PRIVATE_PRIMARY
      The primary home, to reach a person after business hours.

    • PRIVATE_VACATION

      public static final GeneralAddressUse PRIVATE_VACATION
      A vacation home, to reach a person while on vacation.

    • PUBLIC

      public static final GeneralAddressUse PUBLIC
      Indicates a work place address or telecommunication address that is a 'standard' address which may reach a reception service, mail-room, or other intermediary prior to the target entity.

    • TEMPORARY

      public static final GeneralAddressUse TEMPORARY
      A temporary address, may be good for visit or mailing. Note that an address history can provide more detailed information.

  • Field Details

  • Method Details

    • values

      public static GeneralAddressUse[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static GeneralAddressUse valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getEnum

      public static GeneralAddressUse getEnum(String code)
      Gets the Enum with a given code
      Liefert den Enum anhand eines gegebenen codes
      .
      Parameters:
      code -
      code
      Returns:
      the enum

    • isEnumOfValueSet

      public static boolean isEnumOfValueSet(String enumName)
      Checks if a given enum is part of this value set.
      Prüft, ob der gegebene enum Teil dieses Value Sets ist.
      Parameters:
      enumName -
      enumName
      Returns:
      true, if enum is in this value set

    • isInValueSet

      public static boolean isInValueSet(String codeValue)
      Checks if a given code value is in this value set.
      Prüft, ob der gegebene code in diesem Value Set vorhanden ist.
      Parameters:
      codeValue -
      code
      Returns:
      true, if one enum of this valueset contains the given code

    • getCodeSystemName

      public String getCodeSystemName()
      Gets the code system name.
      Liefert code system name.
      Specified by:
      getCodeSystemName in interface ValueSetEnumInterface
      Returns:
      the code system name

    • getCodeSystemId

      public String getCodeSystemId()
      Gets the code system id.
      Liefert die code system id.
      Specified by:
      getCodeSystemId in interface ValueSetEnumInterface
      Returns:
      the code system id

    • getCodeValue

      public String getCodeValue()
      Gets the actual Code as string
      Liefert den eigentlichen Code als String
      .
      Specified by:
      getCodeValue in interface ValueSetEnumInterface
      Returns:
      the code

    • getDisplayName

      public String getDisplayName()
      Gets the display name.
      Liefert display name.
      Specified by:
      getDisplayName in interface TranslatedEnumInterface
      Returns:
      the display name

    • getDisplayName

      public @NonNull String getDisplayName(@Nullable LanguageCode languageCode)
      Description copied from interface: TranslatedEnumInterface
      Gets the display name defined by the language param.
      Specified by:
      getDisplayName in interface TranslatedEnumInterface
      Parameters:
      languageCode - The language code to get the display name for, null to get the default display name.
      Returns:
      the display name in the desired language.

    • getValueSetId

      public @NonNull String getValueSetId()
      Description copied from interface: ValueSetEnumInterface
      Gets the value set identifier.
      Specified by:
      getValueSetId in interface ValueSetEnumInterface
      Returns:
      the value set identifier.

    • getValueSetName

      public @NonNull String getValueSetName()
      Description copied from interface: ValueSetEnumInterface
      Gets the value set name.
      Specified by:
      getValueSetName in interface ValueSetEnumInterface
      Returns:
      the value set name.