Package org.projecthusky.common.enums

Enum Class AdministrativeGender

java.lang.Object

java.lang.Enum<AdministrativeGender>

org.projecthusky.common.enums.AdministrativeGender

All Implemented Interfaces:

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

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

Enumeration of AdministrativeGender values

EN:

History description 2014-03-26: Lock all vaue sets untouched since 2014-03-26 to trackingId 2014T1_2014_03_26

description:

The gender of a person used for adminstrative purposes (as opposed to clinical gender)

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

Identifier: 2.16.840.1.113883.1.11.1
Effective date: 2014-03-26 00:00
Version: DEFN=UV=VO=1360-20160323
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
FEMALE	EN: Female.
MALE	EN: Male.
UNDIFFERENTIATED	EN: Undifferentiated.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CODE_SYSTEM_ID	Identifier of the code system (all values share the same).
static final String	FEMALE_CODE	EN: Code for Female.
static final String	MALE_CODE	EN: Code for Male.
static final String	UNDIFFERENTIATED_CODE	EN: Code for Undifferentiated.
static final String	VALUE_SET_ID	Identifier of the value set.
static final String	VALUE_SET_NAME	Name of the value set.

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 AdministrativeGender	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 AdministrativeGender	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AdministrativeGender[]	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

FEMALE

public static final AdministrativeGender FEMALE

EN: Female.

MALE

public static final AdministrativeGender MALE

EN: Male.

UNDIFFERENTIATED

public static final AdministrativeGender UNDIFFERENTIATED

EN: Undifferentiated.

Field Details

FEMALE_CODE

public static final String FEMALE_CODE

EN: Code for Female.

See Also:

• Constant Field Values

MALE_CODE

public static final String MALE_CODE

EN: Code for Male.

See Also:

• Constant Field Values

UNDIFFERENTIATED_CODE

public static final String UNDIFFERENTIATED_CODE

EN: Code for Undifferentiated.

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 AdministrativeGender[] 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 AdministrativeGender 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 AdministrativeGender 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.