Package org.projecthusky.common.enums

Enum Class TelecomAddressUse

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

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ANSWERING_SERVICE
    An automated answering machine used for less urgent cases and if the main purpose of contact is to leave a message or access an automated announcement.
    BAD
    A flag indicating that the address is bad, in fact, useless.
    BUSINESS
    An office address.
    BUSINESS_DIRECT
    Indicates a work place address or telecommunication address that reaches the individual or organization directly without intermediaries.
    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.
    EMERGENCY_CONTACT
    A contact specifically designated to be used for emergencies.
    MOBILE
    A telecommunication device that moves and stays with its owner.
    OLD
    This address is no longer in use.
    PAGER
    A paging device suitable to solicit a callback or to leave a very short message.
    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.
    PRIVATE_PRIMARY
    The primary home, to reach a person after business hours.
    PRIVATE_VACATION
    A vacation home, to reach a person while on vacation.
    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
    A temporary address, may be good for visit or mailing.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CODE_SYSTEM_NAME
    The Constant CODE_SYSTEM_NAME.
    static final String
    CODE_SYSTEM_OID
    The Constant CODE_SYSTEM.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull String
    getCodeSystemId()
    Gets the code system identifier.
    @NonNull String
    getCodeSystemName()
    Gets the code system name.
    String
    getCodeValue()
    Gets the actual Code as string Liefert den eigentlichen Code als String.
    String
    getDisplayName()
    Gets the display name. Liefert display name.
    @NonNull String
    getDisplayName(@Nullable LanguageCode languageCode)
    Gets the display name defined by the language param.
    static TelecomAddressUse
    getEnum(String code)
    Gets the Enum with a given code Liefert den Enum anhand eines gegebenen codes.
    @NonNull String
    getValueSetId()
    Gets the value set identifier.
    @NonNull String
    getValueSetName()
    Gets the value set name.
    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.
    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.
    static TelecomAddressUse
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static TelecomAddressUse[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.projecthusky.common.enums.ValueSetEnumInterface

    getCD, getCD, getCE, getCE, getCode, getCode, getCodedString, getIpfCode, isContainedIn, isEqualTo, name

  • Enum Constant Details

    • ANSWERING_SERVICE

      public static final TelecomAddressUse ANSWERING_SERVICE
      An automated answering machine used for less urgent cases and if the main purpose of contact is to leave a message or access an automated announcement.

    • BAD

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

    • BUSINESS

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

    • BUSINESS_DIRECT

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

    • EMERGENCY_CONTACT

      public static final TelecomAddressUse EMERGENCY_CONTACT
      A contact specifically designated to be used for emergencies. This is the first choice in emergencies, independent of any other use codes.

    • MOBILE

      public static final TelecomAddressUse MOBILE
      A telecommunication device that moves and stays with its owner. May have characteristics of all other use codes, suitable for urgent matters, not the first choice for routine business.

    • OLD

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

    • PAGER

      public static final TelecomAddressUse PAGER
      A paging device suitable to solicit a callback or to leave a very short message.

    • PRIVATE

      public static final TelecomAddressUse 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 TelecomAddressUse PRIVATE_PRIMARY
      The primary home, to reach a person after business hours.

    • PRIVATE_VACATION

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

    • PUBLIC

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

    • 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

    • getCodeSystemId

      public @NonNull String getCodeSystemId()
      Description copied from interface: ValueSetEnumInterface
      Gets the code system identifier.
      Specified by:
      getCodeSystemId in interface ValueSetEnumInterface
      Returns:
      the code system identifier.

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

    • getCodeSystemName

      public @NonNull String getCodeSystemName()
      Description copied from interface: ValueSetEnumInterface
      Gets the code system name.
      Specified by:
      getCodeSystemName in interface ValueSetEnumInterface
      Returns:
      the code system name.