Package org.projecthusky.communication.ch.enums.beta

Enum Class PurposeOfUse

java.lang.Object
java.lang.Enum<PurposeOfUse>
org.projecthusky.communication.ch.enums.beta.PurposeOfUse
All Implemented Interfaces:
Serializable, Comparable<PurposeOfUse>, Constable, CodedMetadataEnumInterface, TranslatedEnumInterface, ValueSetEnumInterface
@Generated(value="org.projecthusky.codegenerator.ch.valuesets.UpdateValueSets", date="2023-05-10") public enum PurposeOfUse extends Enum<PurposeOfUse> implements ValueSetEnumInterface
Enumeration of EprPurposeOfUse values

EN: Purpose Of Use as per Annex 5 EPRO-FDHA, Extension 1.
DE: No designation found.
FR: No designation found.
IT: No designation found.

Identifier: 2.16.756.5.30.1.127.3.10.15.2
Effective date: 2023-04-12 15:23
Version: 202306.0-beta
Status: DRAFT

  • Enum Constant Details

    • AUTOMATIC_UPLOAD

      public static final PurposeOfUse AUTOMATIC_UPLOAD
      EN: Automatic Upload.
      DE: Automatischer Upload.
      FR: Upload automatique.
      IT: Upload automatico.

    • DICOM_AUTO

      public static final PurposeOfUse DICOM_AUTO
      EN: DICOM_AUTO.
      DE: DICOM_AUTO.
      FR: DICOM_AUTO.
      IT: DICOM_AUTO.

    • EMERGENCY_ACCESS

      public static final PurposeOfUse EMERGENCY_ACCESS
      EN: Emergency Access.
      DE: Notfallzugriff.
      FR: Accès d’urgence.
      IT: Accesso di emergenza.

    • NORMAL_ACCESS

      public static final PurposeOfUse NORMAL_ACCESS
      EN: Normal Access.
      DE: Normaler Zugriff.
      FR: Accès normal.
      IT: Accesso normale.

  • Field Details

    • AUTOMATIC_UPLOAD_CODE

      public static final String AUTOMATIC_UPLOAD_CODE
      EN: Code for Automatic Upload.
      DE: Code für Automatischer Upload.
      FR: Code de Upload automatique.
      IT: Code per Upload automatico.
      See Also:

    • DICOM_AUTO_CODE

      public static final String DICOM_AUTO_CODE
      EN: Code for DICOM_AUTO.
      DE: Code für DICOM_AUTO.
      FR: Code de DICOM_AUTO.
      IT: Code per DICOM_AUTO.
      See Also:

    • EMERGENCY_ACCESS_CODE

      public static final String EMERGENCY_ACCESS_CODE
      EN: Code for Emergency Access.
      DE: Code für Notfallzugriff.
      FR: Code de Accès d’urgence.
      IT: Code per Accesso di emergenza.
      See Also:

    • NORMAL_ACCESS_CODE

      public static final String NORMAL_ACCESS_CODE
      EN: Code for Normal Access.
      DE: Code für Normaler Zugriff.
      FR: Code de Accès normal.
      IT: Code per Accesso normale.
      See Also:

    • VALUE_SET_ID

      public static final String VALUE_SET_ID
      Identifier of the value set.
      See Also:

    • VALUE_SET_NAME

      public static final String VALUE_SET_NAME
      Name of the value set.
      See Also:

    • CODE_SYSTEM_ID

      public static final String CODE_SYSTEM_ID
      Identifier of the code system (all values share the same).
      See Also:

  • Method Details

    • values

      public static PurposeOfUse[] 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 PurposeOfUse 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 PurposeOfUse 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.