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

Enum Class ClassCode

java.lang.Object
java.lang.Enum<ClassCode>
org.projecthusky.communication.ch.enums.beta.ClassCode
All Implemented Interfaces:
Serializable, Comparable<ClassCode>, Constable, CodedMetadataEnumInterface, TranslatedEnumInterface, ValueSetEnumInterface
@Generated(value="org.projecthusky.codegenerator.ch.valuesets.UpdateValueSets", date="2023-05-10") 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: Classification du document selon l'annexe 3 ODEP-DFI.
IT: Classe del documento secondo l'allegato 3 OCIP-DFI.

Identifier: 2.16.756.5.30.1.127.3.10.1.3
Effective date: 2022-11-29 13:30
Version: 202212.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_DOCUMENTATION
    EN: Administrative documentation.
    DE: Administratives Dokument.
    FR: Document administratif.
    IT: Documento amministrativo.
    ADVANCE_DIRECTIVE_REPORT
    EN: Advance directive report.
    DE: Patientenverfügung.
    FR: Directives anticipées.
    IT: Direttive del paziente.
    AUDIT_TRAIL_REPORT
    EN: Audit trail report.
    DE: Rückverfolgung der EPD Zugriffe.
    FR: Traçabilité des accès aux DEP.
    IT: Cronologia degli accessi alla CIP.
    CARE_PLAN
    EN: Care Plan.
    DE: Behandlungsplan.
    FR: Plan de traitement.
    IT: Piano di trattamento.
    CLINICAL_PROCEDURE_REPORT
    EN: Clinical procedure report.
    DE: Interventionsbericht / Untersuchungsresultat.
    FR: Rapport d’intervention / résultat de l’analyse.
    IT: Rapporto operatorio / Referto di analisi.
    CONSENT_REPORT
    EN: Consent report.
    DE: Einwilligung zur Behandlung.
    FR: Consentement au traitement.
    IT: Consenso al trattamento.
    EMERGENCY_MEDICAL_IDENTIFICATION_RECORD
    EN: Emergency medical identification record.
    DE: Notfall-ID / Ausweis.
    FR: ID d’urgence / carte d’urgence.
    IT: Identificativo d'emergenza / scheda d'emergenza.
    OBSTETRICAL_RECORD
    EN: Obstetrical Record.
    DE: Schwangerschafts-/ Geburtsbericht.
    FR: Rapport de grossesse / de naissance.
    IT: Referto della gravidanza / del parto.
    ORDER
    EN: Order.
    DE: Untersuchungsauftrag.
    FR: Mandat d’analyse.
    IT: Prescrizione di analisi.
    ORGAN_DONOR_CARD
    EN: Organ donor card.
    DE: Organspendeausweis.
    FR: Carte de donneur d’organes.
    IT: Tessera di donatore di organi.
    PATIENT_RECORD_TYPE
    EN: Patient record type.
    DE: Langzeitdokumentation.
    FR: Documentation à long terme.
    IT: Documentazione a lungo termine.
    PRESCRIPTION_RECORD
    EN: Prescription record.
    DE: Verschreibung / Rezept.
    FR: Prescription / ordonnance.
    IT: Prescrizione medica.
    RECORD_ARTIFACT
    EN: Record artifact.
    DE: Nicht näher bezeichnetes Dokument.
    FR: Document non précisé.
    IT: Documento non meglio specificato.
    RECORD_OF_HEALTH_EVENT
    EN: Record of health event.
    DE: Dokument zu gesundheitsrelevantem Ereignis.
    FR: Document sur l’événement sanitaire.
    IT: Documento concernente un evento rilevante per la salute.
    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: Bericht aufgrund einer Konsultation.
    FR: Rapport suite à une consultation.
    IT: Rapporto di visita medica.
    SUMMARY_CLINICAL_DOCUMENT
    EN: Summary clinical document.
    DE: Zusammenfassender Bericht.
    FR: Rapport de synthèse.
    IT: Rapporto riassuntivo.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ADMINISTRATIVE_DOCUMENTATION_CODE
    EN: Code for Administrative documentation.
    DE: Code für Administratives Dokument.
    FR: Code de Document administratif.
    IT: Code per Documento amministrativo.
    static final String
    ADVANCE_DIRECTIVE_REPORT_CODE
    EN: Code for Advance directive report.
    DE: Code für Patientenverfügung.
    FR: Code de Directives anticipées.
    IT: Code per Direttive del paziente.
    static final String
    AUDIT_TRAIL_REPORT_CODE
    EN: Code for Audit trail report.
    DE: Code für Rückverfolgung der EPD Zugriffe.
    FR: Code de Traçabilité des accès aux DEP.
    IT: Code per Cronologia degli accessi alla CIP.
    static final String
    CARE_PLAN_CODE
    EN: Code for Care Plan.
    DE: Code für Behandlungsplan.
    FR: Code de Plan de traitement.
    IT: Code per Piano di trattamento.
    static final String
    CLINICAL_PROCEDURE_REPORT_CODE
    EN: Code for Clinical procedure report.
    DE: Code für Interventionsbericht / Untersuchungsresultat.
    FR: Code de Rapport d’intervention / résultat de l’analyse.
    IT: Code per Rapporto operatorio / Referto di analisi.
    static final String
    CONSENT_REPORT_CODE
    EN: Code for Consent report.
    DE: Code für Einwilligung zur Behandlung.
    FR: Code de Consentement au traitement.
    IT: Code per Consenso al trattamento.
    static final String
    EMERGENCY_MEDICAL_IDENTIFICATION_RECORD_CODE
    EN: Code for Emergency medical identification record.
    DE: Code für Notfall-ID / Ausweis.
    FR: Code de ID d’urgence / carte d’urgence.
    IT: Code per Identificativo d'emergenza / scheda d'emergenza.
    static final String
    OBSTETRICAL_RECORD_CODE
    EN: Code for Obstetrical Record.
    DE: Code für Schwangerschafts-/ Geburtsbericht.
    FR: Code de Rapport de grossesse / de naissance.
    IT: Code per Referto della gravidanza / del parto.
    static final String
    ORDER_CODE
    EN: Code for Order.
    DE: Code für Untersuchungsauftrag.
    FR: Code de Mandat d’analyse.
    IT: Code per Prescrizione di analisi.
    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
    PATIENT_RECORD_TYPE_CODE
    EN: Code for Patient record type.
    DE: Code für Langzeitdokumentation.
    FR: Code de Documentation à long terme.
    IT: Code per Documentazione a lungo termine.
    static final String
    PRESCRIPTION_RECORD_CODE
    EN: Code for Prescription record.
    DE: Code für Verschreibung / Rezept.
    FR: Code de Prescription / ordonnance.
    IT: Code per Prescrizione medica.
    static final String
    RECORD_ARTIFACT_CODE
    EN: Code for Record artifact.
    DE: Code für Nicht näher bezeichnetes Dokument.
    FR: Code de Document non précisé.
    IT: Code per Documento non meglio specificato.
    static final String
    RECORD_OF_HEALTH_EVENT_CODE
    EN: Code for Record of health event.
    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
    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 Bericht aufgrund einer Konsultation.
    FR: Code de Rapport suite à une consultation.
    IT: Code per Rapporto di visita medica.
    static final String
    SUMMARY_CLINICAL_DOCUMENT_CODE
    EN: Code for Summary clinical document.
    DE: Code für Zusammenfassender Bericht.
    FR: Code de Rapport de synthèse.
    IT: Code per Rapporto riassuntivo.
    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_DOCUMENTATION

      public static final ClassCode ADMINISTRATIVE_DOCUMENTATION
      EN: Administrative documentation.
      DE: Administratives Dokument.
      FR: Document administratif.
      IT: Documento amministrativo.

    • ADVANCE_DIRECTIVE_REPORT

      public static final ClassCode ADVANCE_DIRECTIVE_REPORT
      EN: Advance directive report.
      DE: Patientenverfügung.
      FR: Directives anticipées.
      IT: Direttive del paziente.

    • AUDIT_TRAIL_REPORT

      public static final ClassCode AUDIT_TRAIL_REPORT
      EN: Audit trail report.
      DE: Rückverfolgung der EPD Zugriffe.
      FR: Traçabilité des accès aux DEP.
      IT: Cronologia degli accessi alla CIP.

    • CARE_PLAN

      public static final ClassCode CARE_PLAN
      EN: Care Plan.
      DE: Behandlungsplan.
      FR: Plan de traitement.
      IT: Piano di trattamento.

    • CLINICAL_PROCEDURE_REPORT

      public static final ClassCode CLINICAL_PROCEDURE_REPORT
      EN: Clinical procedure report.
      DE: Interventionsbericht / Untersuchungsresultat.
      FR: Rapport d’intervention / résultat de l’analyse.
      IT: Rapporto operatorio / Referto di analisi.

    • EMERGENCY_MEDICAL_IDENTIFICATION_RECORD

      public static final ClassCode EMERGENCY_MEDICAL_IDENTIFICATION_RECORD
      EN: Emergency medical identification record.
      DE: Notfall-ID / Ausweis.
      FR: ID d’urgence / carte d’urgence.
      IT: Identificativo d'emergenza / scheda d'emergenza.

    • OBSTETRICAL_RECORD

      public static final ClassCode OBSTETRICAL_RECORD
      EN: Obstetrical Record.
      DE: Schwangerschafts-/ Geburtsbericht.
      FR: Rapport de grossesse / de naissance.
      IT: Referto della gravidanza / del parto.

    • ORDER

      public static final ClassCode ORDER
      EN: Order.
      DE: Untersuchungsauftrag.
      FR: Mandat d’analyse.
      IT: Prescrizione di analisi.

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

    • PATIENT_RECORD_TYPE

      public static final ClassCode PATIENT_RECORD_TYPE
      EN: Patient record type.
      DE: Langzeitdokumentation.
      FR: Documentation à long terme.
      IT: Documentazione a lungo termine.

    • PRESCRIPTION_RECORD

      public static final ClassCode PRESCRIPTION_RECORD
      EN: Prescription record.
      DE: Verschreibung / Rezept.
      FR: Prescription / ordonnance.
      IT: Prescrizione medica.

    • RECORD_ARTIFACT

      public static final ClassCode RECORD_ARTIFACT
      EN: Record artifact.
      DE: Nicht näher bezeichnetes Dokument.
      FR: Document non précisé.
      IT: Documento non meglio specificato.

    • RECORD_OF_HEALTH_EVENT

      public static final ClassCode RECORD_OF_HEALTH_EVENT
      EN: Record of health event.
      DE: Dokument zu gesundheitsrelevantem Ereignis.
      FR: Document sur l’événement sanitaire.
      IT: Documento concernente un evento rilevante per la salute.

    • 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: Bericht aufgrund einer Konsultation.
      FR: Rapport suite à une consultation.
      IT: Rapporto di visita medica.

    • SUMMARY_CLINICAL_DOCUMENT

      public static final ClassCode SUMMARY_CLINICAL_DOCUMENT
      EN: Summary clinical document.
      DE: Zusammenfassender Bericht.
      FR: Rapport de synthèse.
      IT: Rapporto riassuntivo.

  • Field Details

    • ADMINISTRATIVE_DOCUMENTATION_CODE

      public static final String ADMINISTRATIVE_DOCUMENTATION_CODE
      EN: Code for Administrative documentation.
      DE: Code für Administratives Dokument.
      FR: Code de Document administratif.
      IT: Code per Documento amministrativo.
      See Also:

    • ADVANCE_DIRECTIVE_REPORT_CODE

      public static final String ADVANCE_DIRECTIVE_REPORT_CODE
      EN: Code for Advance directive report.
      DE: Code für Patientenverfügung.
      FR: Code de Directives anticipées.
      IT: Code per Direttive del paziente.
      See Also:

    • AUDIT_TRAIL_REPORT_CODE

      public static final String AUDIT_TRAIL_REPORT_CODE
      EN: Code for Audit trail report.
      DE: Code für Rückverfolgung der EPD Zugriffe.
      FR: Code de Traçabilité des accès aux DEP.
      IT: Code per Cronologia degli accessi alla CIP.
      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 Plan de traitement.
      IT: Code per Piano di trattamento.
      See Also:

    • CLINICAL_PROCEDURE_REPORT_CODE

      public static final String CLINICAL_PROCEDURE_REPORT_CODE
      EN: Code for Clinical procedure report.
      DE: Code für Interventionsbericht / Untersuchungsresultat.
      FR: Code de Rapport d’intervention / résultat de l’analyse.
      IT: Code per Rapporto operatorio / Referto di analisi.
      See Also:

    • EMERGENCY_MEDICAL_IDENTIFICATION_RECORD_CODE

      public static final String EMERGENCY_MEDICAL_IDENTIFICATION_RECORD_CODE
      EN: Code for Emergency medical identification record.
      DE: Code für Notfall-ID / Ausweis.
      FR: Code de ID d’urgence / carte d’urgence.
      IT: Code per Identificativo d'emergenza / scheda d'emergenza.
      See Also:

    • OBSTETRICAL_RECORD_CODE

      public static final String OBSTETRICAL_RECORD_CODE
      EN: Code for Obstetrical Record.
      DE: Code für Schwangerschafts-/ Geburtsbericht.
      FR: Code de Rapport de grossesse / de naissance.
      IT: Code per Referto della gravidanza / del parto.
      See Also:

    • ORDER_CODE

      public static final String ORDER_CODE
      EN: Code for Order.
      DE: Code für Untersuchungsauftrag.
      FR: Code de Mandat d’analyse.
      IT: Code per Prescrizione di analisi.
      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:

    • PATIENT_RECORD_TYPE_CODE

      public static final String PATIENT_RECORD_TYPE_CODE
      EN: Code for Patient record type.
      DE: Code für Langzeitdokumentation.
      FR: Code de Documentation à long terme.
      IT: Code per Documentazione a lungo termine.
      See Also:

    • PRESCRIPTION_RECORD_CODE

      public static final String PRESCRIPTION_RECORD_CODE
      EN: Code for Prescription record.
      DE: Code für Verschreibung / Rezept.
      FR: Code de Prescription / ordonnance.
      IT: Code per Prescrizione medica.
      See Also:

    • RECORD_ARTIFACT_CODE

      public static final String RECORD_ARTIFACT_CODE
      EN: Code for Record artifact.
      DE: Code für Nicht näher bezeichnetes Dokument.
      FR: Code de Document non précisé.
      IT: Code per Documento non meglio specificato.
      See Also:

    • RECORD_OF_HEALTH_EVENT_CODE

      public static final String RECORD_OF_HEALTH_EVENT_CODE
      EN: Code for Record of health event.
      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:

    • 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 Bericht aufgrund einer Konsultation.
      FR: Code de Rapport suite à une consultation.
      IT: Code per Rapporto di visita medica.
      See Also:

    • SUMMARY_CLINICAL_DOCUMENT_CODE

      public static final String SUMMARY_CLINICAL_DOCUMENT_CODE
      EN: Code for Summary clinical document.
      DE: Code für Zusammenfassender Bericht.
      FR: Code de Rapport de synthèse.
      IT: Code per Rapporto riassuntivo.
      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.