Package org.projecthusky.fhir.emed.ch.epr.enums

Enum Class SubstanceAdministrationSubstitutionCode

java.lang.Object
java.lang.Enum<SubstanceAdministrationSubstitutionCode>
org.projecthusky.fhir.emed.ch.epr.enums.SubstanceAdministrationSubstitutionCode
All Implemented Interfaces:
Serializable, Comparable<SubstanceAdministrationSubstitutionCode>, Constable, CodedMetadataEnumInterface, TranslatedEnumInterface, ValueSetEnumInterface, FhirValueSetEnumInterface
public enum SubstanceAdministrationSubstitutionCode extends Enum<SubstanceAdministrationSubstitutionCode> implements ValueSetEnumInterface, FhirValueSetEnumInterface
husky
Author:
Quentin Ligier

  • Enum Constant Details

  • Field Details

    • EQUIVALENT_CODE

      public static final String EQUIVALENT_CODE
      EN: Code for equivalent.
      DE: Code für Äquivalent.
      FR: Code de équivalent.
      IT: Code per equivalente.
      See Also:

    • NONE_CODE

      public static final String NONE_CODE
      EN: Code for none.
      DE: Code für nicht autorisiert.
      FR: Code de non autorisé.
      IT: Code per non autorizzato.
      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 SubstanceAdministrationSubstitutionCode[] 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 SubstanceAdministrationSubstitutionCode 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 SubstanceAdministrationSubstitutionCode 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.

    • fromCoding

      public static @Nullable SubstanceAdministrationSubstitutionCode fromCoding(org.hl7.fhir.r4.model.Coding coding)

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

    • getFhirSystem

      public @NonNull String getFhirSystem()
      Description copied from interface: FhirValueSetEnumInterface
      Returns the code system, as used in FHIR.
      Specified by:
      getFhirSystem in interface FhirValueSetEnumInterface

    • getCoding

      public org.hl7.fhir.r4.model.Coding getCoding()
      Description copied from interface: FhirValueSetEnumInterface
      Returns the enum value as a FHIR Coding.
      Specified by:
      getCoding in interface FhirValueSetEnumInterface

    • getCodeableConcept

      public org.hl7.fhir.r4.model.CodeableConcept getCodeableConcept()
      Description copied from interface: FhirValueSetEnumInterface
      Returns the enum value as a FHIR CodeableConcept.
      Specified by:
      getCodeableConcept in interface FhirValueSetEnumInterface

    • getCoding

      public @NonNull org.hl7.fhir.r4.model.Coding getCoding(LanguageCode languageCode)
      Returns the enum value as a FHIR Coding, translated in the requested language.
      Specified by:
      getCoding in interface FhirValueSetEnumInterface

    • getCodeableConcept

      public @NonNull org.hl7.fhir.r4.model.CodeableConcept getCodeableConcept(LanguageCode languageCode)
      Returns the enum value as a FHIR CodeableConcept, translated in the requested language.
      Specified by:
      getCodeableConcept in interface FhirValueSetEnumInterface

    • isEqualTo

      public boolean isEqualTo(org.hl7.fhir.r4.model.Coding coding)
      Description copied from interface: FhirValueSetEnumInterface
      Compares the enum value to the given FHIR Coding.
      Specified by:
      isEqualTo in interface FhirValueSetEnumInterface
      Parameters:
      coding - The FHIR Coding to be compared.
      Returns:
      true if they have the same system and value, false otherwise.