Package org.projecthusky.common.enums

Enum Class PostalAddressUse

java.lang.Object

java.lang.Enum<PostalAddressUse>

org.projecthusky.common.enums.PostalAddressUse

All Implemented Interfaces:

Serializable, Comparable<PostalAddressUse>, Constable, CodedMetadataEnumInterface, TranslatedEnumInterface, ValueSetEnumInterface

@Generated(value="org.projecthusky.codegenerator.ch.valuesets.UpdateValueSets",
           date="2022-04-19")
public enum PostalAddressUse
extends Enum<PostalAddressUse>
implements ValueSetEnumInterface

Enumeration of PostalAddressUse values

EN: No designation found.
DE: No designation found.
FR: No designation found.
IT: No designation found.

Identifier: 2.16.840.1.113883.1.11.10637
Effective date: 2013-01-31 00:00
Version: null
Status: FINAL

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
BAD_ADDRESS	EN: bad address.
CONFIDENTIAL	EN: confidential.
DIRECT	EN: direct.
HOME_ADDRESS	EN: home address.
PHYSICAL_VISIT_ADDRESS	EN: physical visit address.
POSTAL_ADDRESS	EN: postal address.
PRIMARY_HOME	EN: primary home.
PUBLIC	EN: public.
TEMPORARY	EN: temporary.
VACATION_HOME	EN: vacation home.
WORK_PLACE	EN: work place.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BAD_ADDRESS_CODE	EN: Code for bad address.
static final String	CODE_SYSTEM_ID	Identifier of the code system (all values share the same).
static final String	CONFIDENTIAL_CODE	EN: Code for confidential.
static final String	DIRECT_CODE	EN: Code for direct.
static final String	HOME_ADDRESS_CODE	EN: Code for home address.
static final String	PHYSICAL_VISIT_ADDRESS_CODE	EN: Code for physical visit address.
static final String	POSTAL_ADDRESS_CODE	EN: Code for postal address.
static final String	PRIMARY_HOME_CODE	EN: Code for primary home.
static final String	PUBLIC_CODE	EN: Code for public.
static final String	TEMPORARY_CODE	EN: Code for temporary.
static final String	VACATION_HOME_CODE	EN: Code for vacation home.
static final String	VALUE_SET_ID	Identifier of the value set.
static final String	VALUE_SET_NAME	Name of the value set.
static final String	WORK_PLACE_CODE	EN: Code for work place.

Method Summary

Modifier and Type	Method	Description
@NonNull String	getCodeSystemId()	Gets the code system identifier.
@NonNull String	getCodeSystemName()	Gets the code system name.
@NonNull String	getCodeValue()	Gets the code value as a string.
@NonNull String	getDisplayName(@Nullable LanguageCode languageCode)	Gets the display name defined by the language param.
static @Nullable PostalAddressUse	getEnum(@Nullable String code)	Gets the Enum with a given code.
@NonNull String	getValueSetId()	Gets the value set identifier.
@NonNull String	getValueSetName()	Gets the value set name.
static boolean	isEnumOfValueSet(@Nullable String enumName)	Checks if a given enum is part of this value set.
static boolean	isInValueSet(@Nullable String codeValue)	Checks if a given code value is in this value set.
static PostalAddressUse	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PostalAddressUse[]	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.TranslatedEnumInterface

getDisplayName

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

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

Enum Constant Details

BAD_ADDRESS

public static final PostalAddressUse BAD_ADDRESS

EN: bad address.

CONFIDENTIAL

public static final PostalAddressUse CONFIDENTIAL

EN: confidential.

DIRECT

public static final PostalAddressUse DIRECT

EN: direct.

HOME_ADDRESS

public static final PostalAddressUse HOME_ADDRESS

EN: home address.

PHYSICAL_VISIT_ADDRESS

public static final PostalAddressUse PHYSICAL_VISIT_ADDRESS

EN: physical visit address.

POSTAL_ADDRESS

public static final PostalAddressUse POSTAL_ADDRESS

EN: postal address.

PRIMARY_HOME

public static final PostalAddressUse PRIMARY_HOME

EN: primary home.

PUBLIC

public static final PostalAddressUse PUBLIC

EN: public.

TEMPORARY

public static final PostalAddressUse TEMPORARY

EN: temporary.

VACATION_HOME

public static final PostalAddressUse VACATION_HOME

EN: vacation home.

WORK_PLACE

public static final PostalAddressUse WORK_PLACE

EN: work place.

Field Details

BAD_ADDRESS_CODE

public static final String BAD_ADDRESS_CODE

EN: Code for bad address.

See Also:

• Constant Field Values

CONFIDENTIAL_CODE

public static final String CONFIDENTIAL_CODE

EN: Code for confidential.

See Also:

• Constant Field Values

DIRECT_CODE

public static final String DIRECT_CODE

EN: Code for direct.

See Also:

• Constant Field Values

HOME_ADDRESS_CODE

public static final String HOME_ADDRESS_CODE

EN: Code for home address.

See Also:

• Constant Field Values

PHYSICAL_VISIT_ADDRESS_CODE

public static final String PHYSICAL_VISIT_ADDRESS_CODE

EN: Code for physical visit address.

See Also:

• Constant Field Values

POSTAL_ADDRESS_CODE

public static final String POSTAL_ADDRESS_CODE

EN: Code for postal address.

See Also:

• Constant Field Values

PRIMARY_HOME_CODE

public static final String PRIMARY_HOME_CODE

EN: Code for primary home.

See Also:

• Constant Field Values

PUBLIC_CODE

public static final String PUBLIC_CODE

EN: Code for public.

See Also:

• Constant Field Values

TEMPORARY_CODE

public static final String TEMPORARY_CODE

EN: Code for temporary.

See Also:

• Constant Field Values

VACATION_HOME_CODE

public static final String VACATION_HOME_CODE

EN: Code for vacation home.

See Also:

• Constant Field Values

WORK_PLACE_CODE

public static final String WORK_PLACE_CODE

EN: Code for work place.

See Also:

• Constant Field Values

VALUE_SET_ID

public static final String VALUE_SET_ID

Identifier of the value set.

See Also:

• Constant Field Values

VALUE_SET_NAME

public static final String VALUE_SET_NAME

Name of the value set.

See Also:

• Constant Field Values

CODE_SYSTEM_ID

public static final String CODE_SYSTEM_ID

Identifier of the code system (all values share the same).

See Also:

• Constant Field Values

Method Details

values

public static PostalAddressUse[] 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 PostalAddressUse 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 @Nullable PostalAddressUse getEnum(@Nullable String code)

Gets the Enum with a given code.

Parameters:

code - The code value.

Returns:

the enum value found or null.

isEnumOfValueSet

public static boolean isEnumOfValueSet(@Nullable String enumName)

Checks if a given enum is part of this value set.

Parameters:

enumName - The name of the enum.

Returns:

true if the name is found in this value set, false otherwise.

isInValueSet

public static boolean isInValueSet(@Nullable String codeValue)

Checks if a given code value is in this value set.

Parameters:

codeValue - The code value.

Returns:

true if the value is found in this value set, false otherwise.

getCodeSystemId

public @NonNull String getCodeSystemId()

Gets the code system identifier.

Specified by:

getCodeSystemId in interface ValueSetEnumInterface

Returns:

the code system identifier.

getCodeSystemName

public @NonNull String getCodeSystemName()

Gets the code system name.

Specified by:

getCodeSystemName in interface ValueSetEnumInterface

Returns:

the code system name.

getCodeValue

public @NonNull String getCodeValue()

Gets the code value as a string.

Specified by:

getCodeValue in interface ValueSetEnumInterface

Returns:

the code value.

getDisplayName

public @NonNull String getDisplayName(@Nullable LanguageCode languageCode)

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()

Gets the value set identifier.

Specified by:

getValueSetId in interface ValueSetEnumInterface

Returns:

the value set identifier.

getValueSetName

public @NonNull String getValueSetName()

Gets the value set name.

Specified by:

getValueSetName in interface ValueSetEnumInterface

Returns:

the value set name.