Package org.projecthusky.common.ch.enums.r202104

Enum Class AuthorRole

java.lang.Object
java.lang.Enum<AuthorRole>
org.projecthusky.common.ch.enums.r202104.AuthorRole
All Implemented Interfaces:
Serializable, Comparable<AuthorRole>, Constable, CodedMetadataEnumInterface, TranslatedEnumInterface, ValueSetEnumInterface
@Generated(value="org.projecthusky.codegenerator.ch.valuesets.UpdateValueSets", date="2022-09-29") public enum AuthorRole extends Enum<AuthorRole> implements ValueSetEnumInterface
Enumeration of DocumentEntry.author.authorRole values

EN: Role of the author. This code defines the role of the author of the document. This is a sub-attribute of epd_xds_author.
DE: Rolle des Autors. Dieser Code definiert die Rolle des Authors vom Dokument. Dies ist ein Sub-Attribut von epd_xds_author.
FR: Rôle de l'auteur. Ce code définit le rôle de l'auteur du document. Il s'agit d'un sous-attribut de epd_xds_author.
IT: Ruolo dell'autore. Questo codice definisce il ruolo dell'autore del documento. È un sottoattributo di epd_xds_author.

Identifier: 2.16.756.5.30.1.127.3.10.1.1.3
Effective date: 2021-04-01 08:55
Version: 202104.0-stable
Status: FINAL

  • Enum Constant Details

    • ASSISTANT

      public static final AuthorRole ASSISTANT
      EN: Assistant.
      DE: Hilfsperson.
      FR: Auxiliaire.
      IT: Persona ausiliara.

    • HEALTHCARE_PROFESSIONAL

      public static final AuthorRole HEALTHCARE_PROFESSIONAL
      EN: Healthcare professional.
      DE: Gesundheitsfachperson.
      FR: Professionnel de la santé.
      IT: Professionista della salute.

    • PATIENT

      public static final AuthorRole PATIENT
      EN: Patient.
      DE: Patient.
      FR: Patient.
      IT: Paziente.

    • REPRESENTATIVE

      public static final AuthorRole REPRESENTATIVE
      EN: Representative.
      DE: Stellvertretung.
      FR: Représentant.
      IT: Rappresentante.

    • TECHNICAL_USER

      public static final AuthorRole TECHNICAL_USER
      EN: Technical user.
      DE: Technischer Benutzer.
      FR: Utilisateur technique.
      IT: Utente tecnico.

  • Field Details

    • ASSISTANT_CODE

      public static final String ASSISTANT_CODE
      EN: Code for Assistant.
      DE: Code für Hilfsperson.
      FR: Code de Auxiliaire.
      IT: Code per Persona ausiliara.
      See Also:

    • HEALTHCARE_PROFESSIONAL_CODE

      public static final String HEALTHCARE_PROFESSIONAL_CODE
      EN: Code for Healthcare professional.
      DE: Code für Gesundheitsfachperson.
      FR: Code de Professionnel de la santé.
      IT: Code per Professionista della salute.
      See Also:

    • PATIENT_CODE

      public static final String PATIENT_CODE
      EN: Code for Patient.
      DE: Code für Patient.
      FR: Code de Patient.
      IT: Code per Paziente.
      See Also:

    • REPRESENTATIVE_CODE

      public static final String REPRESENTATIVE_CODE
      EN: Code for Representative.
      DE: Code für Stellvertretung.
      FR: Code de Représentant.
      IT: Code per Rappresentante.
      See Also:

    • TECHNICAL_USER_CODE

      public static final String TECHNICAL_USER_CODE
      EN: Code for Technical user.
      DE: Code für Technischer Benutzer.
      FR: Code de Utilisateur technique.
      IT: Code per Utente tecnico.
      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 AuthorRole[] 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 AuthorRole 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 AuthorRole 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.