Enum Class SourcePatientInfo

java.lang.Object
java.lang.Enum<SourcePatientInfo>
org.projecthusky.communication.ch.enums.stable.SourcePatientInfo
All Implemented Interfaces:
Serializable, Comparable<SourcePatientInfo>, Constable, CodedMetadataEnumInterface, TranslatedEnumInterface, ValueSetEnumInterface

@Generated(value="org.projecthusky.codegenerator.ch.valuesets.UpdateValueSets", date="2022-09-29") public enum SourcePatientInfo extends Enum<SourcePatientInfo> implements ValueSetEnumInterface
Enumeration of DocumentEntry.sourcePatientInfo.PID-8 values

EN: Patient’s gender as per Annex 3; EPRO-FDHA.
DE: Geschlecht der Patientin oder des Patienten gemäss Anhang 3 EPDV-EDI.
FR: Sexe du patient selon l'annexe 3 ODEP-DFI.
IT: Sesso del paziente secondo l'allegato 3 OCIP-DFI.

Identifier: 2.16.840.1.113883.4.642.3.1
Effective date: 2021-04-01 17:04
Version: 202104.0-stable
Status: FINAL

  • Enum Constant Details

    • FEMALE

      public static final SourcePatientInfo FEMALE
      EN: Female.
      DE: Weiblich.
      FR: Féminin.
      IT: Femminile.
    • MALE

      public static final SourcePatientInfo MALE
      EN: Male.
      DE: Männlich.
      FR: Masculin.
      IT: Maschile.
    • OTHER

      public static final SourcePatientInfo OTHER
      EN: Other.
      DE: Anderes.
      FR: Autre.
      IT: Altro.
    • UNKNOWN

      public static final SourcePatientInfo UNKNOWN
      EN: Unknown.
      DE: Unbekannt.
      FR: Inconnu.
      IT: Sconosciuto.
  • Field Details

    • FEMALE_CODE

      public static final String FEMALE_CODE
      EN: Code for Female.
      DE: Code für Weiblich.
      FR: Code de Féminin.
      IT: Code per Femminile.
      See Also:
    • MALE_CODE

      public static final String MALE_CODE
      EN: Code for Male.
      DE: Code für Männlich.
      FR: Code de Masculin.
      IT: Code per Maschile.
      See Also:
    • OTHER_CODE

      public static final String OTHER_CODE
      EN: Code for Other.
      DE: Code für Anderes.
      FR: Code de Autre.
      IT: Code per Altro.
      See Also:
    • UNKNOWN_CODE

      public static final String UNKNOWN_CODE
      EN: Code for Unknown.
      DE: Code für Unbekannt.
      FR: Code de Inconnu.
      IT: Code per Sconosciuto.
      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 SourcePatientInfo[] 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 SourcePatientInfo 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 SourcePatientInfo 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.