Package org.projecthusky.communication.ch.enums.stable

Enum Class ClassCode

java.lang.Object
java.lang.Enum<ClassCode>
org.projecthusky.communication.ch.enums.stable.ClassCode
All Implemented Interfaces:
Serializable, Comparable<ClassCode>, Constable, CodedMetadataEnumInterface, TranslatedEnumInterface, ValueSetEnumInterface
@Generated(value="org.projecthusky.codegenerator.ch.valuesets.UpdateValueSets", date="2025-03-03") public enum ClassCode extends Enum<ClassCode> implements ValueSetEnumInterface
Enumeration of DocumentEntry.classCode values

EN: Document class as per EPRO-FDHA Annex 3.
DE: Dokumentenklasse gemäss EPDV-EDI Anhang 3.
FR: <div>Classification du document selon l'annexe 3 ODEP-DFI</div>.
IT: <div>Classe del documento secondo l'allegato 3 OCIP-DFI</div>.

Identifier: 2.16.756.5.30.1.127.3.10.1.3
Effective date: 2022-06-25 19:03
Version: 202306.0-stable
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
    ADMINISTRATIVE_DOCUMENT
    EN: Administrative document.
    DE: Administratives Dokument.
    FR: document administratif.
    IT: documento amministrativo.
    ADVANCE_DIRECTIVES
    EN: Advance directives.
    DE: Patientenverfügung.
    FR: directives anticipées.
    IT: direttive anticipate.
    BIRTH_REPORT
    EN: Birth report.
    DE: Schwangerschaftsbericht.
    FR: rapport de grossesse.
    IT: rapporto di gravidanza.
    CARE_PLAN
    EN: Care plan.
    DE: Behandlungsplan.
    FR: plans de soins.
    IT: piano di cura.
    CONSENT
    EN: Consent.
    DE: Einverständniserklärung.
    FR: consentement.
    IT: consenso.
    EMERGENCY_ID_CARD
    EN: Emergency ID card.
    DE: Notfallkarte.
    FR: carte d'urgence.
    IT: tessera di emergenza.
    EVENT_REPORT
    EN: Event report.
    DE: Dokument zu gesundheitsrelevantem Ereignis.
    FR: document sur l'événement sanitaire.
    IT: documento concernente un evento rilevante per la salute.
    ORDER
    EN: Order.
    DE: Untersuchungsauftrag.
    FR: demande d'examen.
    IT: richiesta di esami.
    ORGAN_DONOR_CARD
    EN: Organ donor card.
    DE: Organspendeausweis.
    FR: carte de donneur d'organes.
    IT: tessera di donatore di organi.
    OTHER_DOCUMENTATION
    EN: Other documentation.
    DE: Sonstige Dokumentation.
    FR: autre documentation.
    IT: altra documentazione.
    PATIENT_DOCUMENTATION
    EN: Patient documentation.
    DE: Patientendokumentation.
    FR: documentation du patient.
    IT: documentazione del paziente.
    PRESCRIPTION
    EN: Prescription.
    DE: Rezept.
    FR: ordonnance.
    IT: prescrizione medica.
    PROCEDURE_REPORT
    EN: Procedure report.
    DE: Interventionsbericht.
    FR: rapport d'intervention.
    IT: rapporto operatorio.
    RECORD_ACCESS
    EN: Record access.
    DE: Rückverfolgung der EPD Zugriffe.
    FR: traçabilité des accès aux DEP.
    IT: calloutronologia degli accessi alla CIP.
    REFERRAL_NOTE
    EN: Referral note.
    DE: Zuweisungsschreiben.
    FR: lettre de référence.
    IT: lettera d'invio.
    REPORT_OF_CLINICAL_ENCOUNTER
    EN: Report of clinical encounter.
    DE: Konsultationsbericht.
    FR: rapport de consultation.
    IT: rapporto di visita medica.
    SUMMARY
    EN: Summary.
    DE: Zusammenfassung.
    FR: résumé.
    IT: riepilogo.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ADMINISTRATIVE_DOCUMENT_CODE
    EN: Code for Administrative document.
    DE: Code für Administratives Dokument.
    FR: Code de document administratif.
    IT: Code per documento amministrativo.
    static final String
    ADVANCE_DIRECTIVES_CODE
    EN: Code for Advance directives.
    DE: Code für Patientenverfügung.
    FR: Code de directives anticipées.
    IT: Code per direttive anticipate.
    static final String
    BIRTH_REPORT_CODE
    EN: Code for Birth report.
    DE: Code für Schwangerschaftsbericht.
    FR: Code de rapport de grossesse.
    IT: Code per rapporto di gravidanza.
    static final String
    CARE_PLAN_CODE
    EN: Code for Care plan.
    DE: Code für Behandlungsplan.
    FR: Code de plans de soins.
    IT: Code per piano di cura.
    static final String
    CONSENT_CODE
    EN: Code for Consent.
    DE: Code für Einverständniserklärung.
    FR: Code de consentement.
    IT: Code per consenso.
    static final String
    EMERGENCY_ID_CARD_CODE
    EN: Code for Emergency ID card.
    DE: Code für Notfallkarte.
    FR: Code de carte d'urgence.
    IT: Code per tessera di emergenza.
    static final String
    EVENT_REPORT_CODE
    EN: Code for Event report.
    DE: Code für Dokument zu gesundheitsrelevantem Ereignis.
    FR: Code de document sur l'événement sanitaire.
    IT: Code per documento concernente un evento rilevante per la salute.
    static final String
    ORDER_CODE
    EN: Code for Order.
    DE: Code für Untersuchungsauftrag.
    FR: Code de demande d'examen.
    IT: Code per richiesta di esami.
    static final String
    ORGAN_DONOR_CARD_CODE
    EN: Code for Organ donor card.
    DE: Code für Organspendeausweis.
    FR: Code de carte de donneur d'organes.
    IT: Code per tessera di donatore di organi.
    static final String
    OTHER_DOCUMENTATION_CODE
    EN: Code for Other documentation.
    DE: Code für Sonstige Dokumentation.
    FR: Code de autre documentation.
    IT: Code per altra documentazione.
    static final String
    PATIENT_DOCUMENTATION_CODE
    EN: Code for Patient documentation.
    DE: Code für Patientendokumentation.
    FR: Code de documentation du patient.
    IT: Code per documentazione del paziente.
    static final String
    PRESCRIPTION_CODE
    EN: Code for Prescription.
    DE: Code für Rezept.
    FR: Code de ordonnance.
    IT: Code per prescrizione medica.
    static final String
    PROCEDURE_REPORT_CODE
    EN: Code for Procedure report.
    DE: Code für Interventionsbericht.
    FR: Code de rapport d'intervention.
    IT: Code per rapporto operatorio.
    static final String
    RECORD_ACCESS_CODE
    EN: Code for Record access.
    DE: Code für Rückverfolgung der EPD Zugriffe.
    FR: Code de traçabilité des accès aux DEP.
    IT: Code per calloutronologia degli accessi alla CIP.
    static final String
    REFERRAL_NOTE_CODE
    EN: Code for Referral note.
    DE: Code für Zuweisungsschreiben.
    FR: Code de lettre de référence.
    IT: Code per lettera d'invio.
    static final String
    REPORT_OF_CLINICAL_ENCOUNTER_CODE
    EN: Code for Report of clinical encounter.
    DE: Code für Konsultationsbericht.
    FR: Code de rapport de consultation.
    IT: Code per rapporto di visita medica.
    static final String
    SUMMARY_CODE
    EN: Code for Summary.
    DE: Code für Zusammenfassung.
    FR: Code de résumé.
    IT: Code per riepilogo.
    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 ClassCode
    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 ClassCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ClassCode[]
    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

    • ADMINISTRATIVE_DOCUMENT

      public static final ClassCode ADMINISTRATIVE_DOCUMENT
      EN: Administrative document.
      DE: Administratives Dokument.
      FR: document administratif.
      IT: documento amministrativo.

    • ADVANCE_DIRECTIVES

      public static final ClassCode ADVANCE_DIRECTIVES
      EN: Advance directives.
      DE: Patientenverfügung.
      FR: directives anticipées.
      IT: direttive anticipate.

    • BIRTH_REPORT

      public static final ClassCode BIRTH_REPORT
      EN: Birth report.
      DE: Schwangerschaftsbericht.
      FR: rapport de grossesse.
      IT: rapporto di gravidanza.

    • CARE_PLAN

      public static final ClassCode CARE_PLAN
      EN: Care plan.
      DE: Behandlungsplan.
      FR: plans de soins.
      IT: piano di cura.

    • EMERGENCY_ID_CARD

      public static final ClassCode EMERGENCY_ID_CARD
      EN: Emergency ID card.
      DE: Notfallkarte.
      FR: carte d'urgence.
      IT: tessera di emergenza.

    • EVENT_REPORT

      public static final ClassCode EVENT_REPORT
      EN: Event report.
      DE: Dokument zu gesundheitsrelevantem Ereignis.
      FR: document sur l'événement sanitaire.
      IT: documento concernente un evento rilevante per la salute.

    • ORDER

      public static final ClassCode ORDER
      EN: Order.
      DE: Untersuchungsauftrag.
      FR: demande d'examen.
      IT: richiesta di esami.

    • ORGAN_DONOR_CARD

      public static final ClassCode ORGAN_DONOR_CARD
      EN: Organ donor card.
      DE: Organspendeausweis.
      FR: carte de donneur d'organes.
      IT: tessera di donatore di organi.

    • OTHER_DOCUMENTATION

      public static final ClassCode OTHER_DOCUMENTATION
      EN: Other documentation.
      DE: Sonstige Dokumentation.
      FR: autre documentation.
      IT: altra documentazione.

    • PATIENT_DOCUMENTATION

      public static final ClassCode PATIENT_DOCUMENTATION
      EN: Patient documentation.
      DE: Patientendokumentation.
      FR: documentation du patient.
      IT: documentazione del paziente.

    • PRESCRIPTION

      public static final ClassCode PRESCRIPTION
      EN: Prescription.
      DE: Rezept.
      FR: ordonnance.
      IT: prescrizione medica.

    • PROCEDURE_REPORT

      public static final ClassCode PROCEDURE_REPORT
      EN: Procedure report.
      DE: Interventionsbericht.
      FR: rapport d'intervention.
      IT: rapporto operatorio.

    • RECORD_ACCESS

      public static final ClassCode RECORD_ACCESS
      EN: Record access.
      DE: Rückverfolgung der EPD Zugriffe.
      FR: traçabilité des accès aux DEP.
      IT: calloutronologia degli accessi alla CIP.

    • REFERRAL_NOTE

      public static final ClassCode REFERRAL_NOTE
      EN: Referral note.
      DE: Zuweisungsschreiben.
      FR: lettre de référence.
      IT: lettera d'invio.

    • REPORT_OF_CLINICAL_ENCOUNTER

      public static final ClassCode REPORT_OF_CLINICAL_ENCOUNTER
      EN: Report of clinical encounter.
      DE: Konsultationsbericht.
      FR: rapport de consultation.
      IT: rapporto di visita medica.

    • SUMMARY

      public static final ClassCode SUMMARY
      EN: Summary.
      DE: Zusammenfassung.
      FR: résumé.
      IT: riepilogo.

  • Field Details

    • ADMINISTRATIVE_DOCUMENT_CODE

      public static final String ADMINISTRATIVE_DOCUMENT_CODE
      EN: Code for Administrative document.
      DE: Code für Administratives Dokument.
      FR: Code de document administratif.
      IT: Code per documento amministrativo.
      See Also:

    • ADVANCE_DIRECTIVES_CODE

      public static final String ADVANCE_DIRECTIVES_CODE
      EN: Code for Advance directives.
      DE: Code für Patientenverfügung.
      FR: Code de directives anticipées.
      IT: Code per direttive anticipate.
      See Also:

    • BIRTH_REPORT_CODE

      public static final String BIRTH_REPORT_CODE
      EN: Code for Birth report.
      DE: Code für Schwangerschaftsbericht.
      FR: Code de rapport de grossesse.
      IT: Code per rapporto di gravidanza.
      See Also:

    • CARE_PLAN_CODE

      public static final String CARE_PLAN_CODE
      EN: Code for Care plan.
      DE: Code für Behandlungsplan.
      FR: Code de plans de soins.
      IT: Code per piano di cura.
      See Also:

    • EMERGENCY_ID_CARD_CODE

      public static final String EMERGENCY_ID_CARD_CODE
      EN: Code for Emergency ID card.
      DE: Code für Notfallkarte.
      FR: Code de carte d'urgence.
      IT: Code per tessera di emergenza.
      See Also:

    • EVENT_REPORT_CODE

      public static final String EVENT_REPORT_CODE
      EN: Code for Event report.
      DE: Code für Dokument zu gesundheitsrelevantem Ereignis.
      FR: Code de document sur l'événement sanitaire.
      IT: Code per documento concernente un evento rilevante per la salute.
      See Also:

    • ORDER_CODE

      public static final String ORDER_CODE
      EN: Code for Order.
      DE: Code für Untersuchungsauftrag.
      FR: Code de demande d'examen.
      IT: Code per richiesta di esami.
      See Also:

    • ORGAN_DONOR_CARD_CODE

      public static final String ORGAN_DONOR_CARD_CODE
      EN: Code for Organ donor card.
      DE: Code für Organspendeausweis.
      FR: Code de carte de donneur d'organes.
      IT: Code per tessera di donatore di organi.
      See Also:

    • OTHER_DOCUMENTATION_CODE

      public static final String OTHER_DOCUMENTATION_CODE
      EN: Code for Other documentation.
      DE: Code für Sonstige Dokumentation.
      FR: Code de autre documentation.
      IT: Code per altra documentazione.
      See Also:

    • PATIENT_DOCUMENTATION_CODE

      public static final String PATIENT_DOCUMENTATION_CODE
      EN: Code for Patient documentation.
      DE: Code für Patientendokumentation.
      FR: Code de documentation du patient.
      IT: Code per documentazione del paziente.
      See Also:

    • PRESCRIPTION_CODE

      public static final String PRESCRIPTION_CODE
      EN: Code for Prescription.
      DE: Code für Rezept.
      FR: Code de ordonnance.
      IT: Code per prescrizione medica.
      See Also:

    • PROCEDURE_REPORT_CODE

      public static final String PROCEDURE_REPORT_CODE
      EN: Code for Procedure report.
      DE: Code für Interventionsbericht.
      FR: Code de rapport d'intervention.
      IT: Code per rapporto operatorio.
      See Also:

    • RECORD_ACCESS_CODE

      public static final String RECORD_ACCESS_CODE
      EN: Code for Record access.
      DE: Code für Rückverfolgung der EPD Zugriffe.
      FR: Code de traçabilité des accès aux DEP.
      IT: Code per calloutronologia degli accessi alla CIP.
      See Also:

    • REFERRAL_NOTE_CODE

      public static final String REFERRAL_NOTE_CODE
      EN: Code for Referral note.
      DE: Code für Zuweisungsschreiben.
      FR: Code de lettre de référence.
      IT: Code per lettera d'invio.
      See Also:

    • REPORT_OF_CLINICAL_ENCOUNTER_CODE

      public static final String REPORT_OF_CLINICAL_ENCOUNTER_CODE
      EN: Code for Report of clinical encounter.
      DE: Code für Konsultationsbericht.
      FR: Code de rapport de consultation.
      IT: Code per rapporto di visita medica.
      See Also:

    • SUMMARY_CODE

      public static final String SUMMARY_CODE
      EN: Code for Summary.
      DE: Code für Zusammenfassung.
      FR: Code de résumé.
      IT: Code per riepilogo.
      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:

  • Method Details

    • values

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