Package org.projecthusky.common.enums

Interface ValueSetEnumInterface

All Superinterfaces:
CodedMetadataEnumInterface, TranslatedEnumInterface
All Known Subinterfaces:
ValueSetEnumInterfaceAt
All Known Implementing Classes:
ActivePharmaceuticalIngredient, ActStatus, ActStatusCompleted, ActSubstanceAdminSubstitutionCode, AddressLineType, AdministrativeGender, AgentRole, AgentRole, AgentRole, AgentRole, AgentRole, AgentRole, AtcdabbrLanguageCode, AtcdabbrLanguageCode, AuditTrailConsumptionEventType, AuditTrailConsumptionEventType, AuditTrailConsumptionEventType, AuditTrailConsumptionEventType, AuditTrailConsumptionEventType, AuditTrailConsumptionEventType, AuthorRole, AuthorRole, AuthorRole, AuthorRole, AuthorRole, AuthorRole, AuthorRole, AuthorSpeciality, AuthorSpeciality, AuthorSpeciality, AuthorSpeciality, AuthorSpeciality, AuthorSpeciality, AuthorSpeciality, AvailabilityStatus, ChEmedEprTimeUnit, ChEmedTimingEvent, ClassCode, ClassCode, ClassCode, ClassCode, ClassCode, ClassCode, ClassCode, ClassCode, ClassTypeCodeMapping, ClassTypeCodeMapping, ClassTypeCodeMapping, ClassTypeCodeMapping, ClassTypeCodeMapping, ClassTypeCodeMapping, CommonLanguages, ConfidentialityCode, ConfidentialityCode, ConfidentialityCode, ConfidentialityCode, ConfidentialityCode, ConfidentialityCode, ConfidentialityCode, ConfidentialityCode, ConfidentialityCode, ContentTypeCode, ContentTypeCode, ContentTypeCode, ContentTypeCode, ContentTypeCode, ContentTypeCode, DeletionStatus, DeletionStatus, DeletionStatus, DeletionStatus, DeletionStatus, DeletionStatus, DispenseSupplyType, DocumentLanguage, DocumentLanguage, DocumentLanguage, DocumentLanguage, DocumentLanguage, DocumentLanguage, DocumentLanguage, EImpfAntikoerperbestimmungVs, EImpfHistorischeImpfstoffeVs, EImpfHistorischeImpfstoffeVs, EImpfHistorischeImpfstoffeVs, EImpfImmunizationTargetVs, EImpfImpfdosisVs, EImpfImpfdosisVs, EImpfImpfgrundVs, EImpfImpfgrundVs, EImpfImpfrollenVs, EImpfImpfrollenVs, EImpfImpfrollenVs, EImpfImpfschemaVs, EImpfImpfschemaVs, EImpfImpfstoffeVs, EImpfImpfstoffeVs, EImpfImpfstoffeVs, EImpfSpecialCaseVaccinationVs, EImpfSpecialSituationIndicationVs, EImpfZusatzklassifikationVs, EImpfZusatzklassifikationVs, ElgaAbsentOrUnknownAllergies, ElgaAbsentOrUnknownDevices, ElgaAbsentOrUnknownMedication, ElgaAbsentOrUnknownProblems, ElgaAbsentOrUnknownProcedures, ElgaActCodeAbgInfo, ElgaActCodeAbgInfo, ElgaActCodePatInfo, ElgaActCodePatInfo, ElgaActEncounterCode, ElgaActEncounterCode, ElgaActEncounterCode, ElgaAdministrativeGender, ElgaAdministrativeGender, ElgaAdministrativeGender, ElgaAdministrativeGender, ElgaAdministrativeGender, ElgaAlcoholConsumption, ElgaAllergyOrIntolerance, ElgaAllergyReaction, ElgaAllergyStatusCode, ElgaAuthorSpeciality, ElgaAuthorSpeciality, ElgaAuthorSpeciality, ElgaAuthorSpeciality, ElgaAuthorSpeciality, ElgaConditionStatusCode, ElgaConditionVerificationStatus, ElgaCriticalityObservationValue, ElgaCurrentSmokingStatus, ElgaDiagnosesicherheit, ElgaEinnahmezeitpunkte, ElgaEinnahmezeitpunkte, ElgaEntityNamePartQualifierVs, ElgaEntityNamePartQualifierVs, ElgaEntityNamePartQualifierVs, ElgaEventCodeList, ElgaExpectedDeliveryDateMethod, ElgaHumanActSite, ElgaHumanActSite, ElgaHumanLanguage, ElgaHumanLanguage, ElgaHumanLanguage, ElgaHumanLanguage, ElgaHumanLanguage, ElgaInformationRecipientType, ElgaInformationRecipientType, ElgaInsuredAssocEntity, ElgaInsuredAssocEntity, ElgaLaborstruktur, ElgaLaborstruktur, ElgaLanguageAbilityMode, ElgaLanguageAbilityMode, ElgaMaritalStatus, ElgaMaritalStatus, ElgaMaritalStatus, ElgaMaritalStatus, ElgaMedicalDevices, ElgaMedientyp, ElgaMedientyp, ElgaMedikationAbgabeArt, ElgaMedikationAbgabeArt, ElgaMedikationFrequenz, ElgaMedikationFrequenz, ElgaMedikationMengenart, ElgaMedikationMengenartAlternativ, ElgaMedikationMengenartAlternativ, ElgaMedikationMengenartAlternativ, ElgaMedikationMengenartAlternativ, ElgaMedikationMengenartVs, ElgaMedikationMengenartVs, ElgaMedikationMengenartVs, ElgaMedikationPharmazeutischeEmpfehlungStatus, ElgaMedikationRezeptart, ElgaMedikationTherapieArt, ElgaMedikationTherapieArt, ElgaObservationInterpretation, ElgaObservationInterpretation, ElgaObservationInterpretation, ElgaObservationInterpretation, ElgaPersonalRelationship, ElgaPersonalRelationship, ElgaPersonalRelationship, ElgaPregnanciesSummary, ElgaProblemarten, ElgaProblems, ElgaProblemSeverity, ElgaProcedureApproachSite, ElgaProcedures, ElgaProceduresMethod, ElgaProcedureTargetSite, ElgaProficiencyLevelCode, ElgaProficiencyLevelCode, ElgaReligiousAffiliation, ElgaReligiousAffiliation, ElgaReligiousAffiliation, ElgaReligiousAffiliation, ElgaSections, ElgaServiceEventPerformer, ElgaServiceEventPerformer, ElgaServiceEventPerformer, ElgaServiceEventPerformer, ElgaServiceEventsLabor, ElgaSignificantPathogens, ElgaSignificantPathogens, ElgaSpecimenType, EmsLebensmittelbedingteIntoxikationenVs, EntityCode, EntityNameUse, EpimsEmsmaterial, EpimsEmstaetigkeitsbereich, EpimsKrankheitsmerkmale, EpimsMaterialMethod, EpimsMeldepflichtigeKrankheiten, EpimsReiseland, EpimsVsBetreuung, EpimsVsHospitalisierung, EpimsVsImpfstatus, EpimsVsKlinischeManifestation, EventCodeList, EventCodeList, EventCodeList, EventCodeList, EventCodeList, EventCodeList, FormatCode, FormatCode, FormatCode, FormatCode, FormatCode, FormatCode, FormatCode, FormatCode, GeneralAddressUse, HcpProfession, HcpProfession, HcpProfession, HcpProfession, HcpProfession, HcpProfession, HcpProfessionSpecialisationMap, HcpProfessionSpecialisationMap, HcpProfessionSpecialisationMap, HcpProfessionSpecialisationMap, HcpProfessionSpecialisationMap, HcpProfessionSpecialisationMap, HcpSpecialisation, HcpSpecialisation, HcpSpecialisation, HcpSpecialisation, HcpSpecialisation, HcpSpecialisation, HealthcareFacilityTypeCode, HealthcareFacilityTypeCode, HealthcareFacilityTypeCode, HealthcareFacilityTypeCode, HealthcareFacilityTypeCode, HealthcareFacilityTypeCode, HealthcareFacilityTypeCode, HealthcareFacilityTypeCode, Hl7LanguageAbilityMode, Hl7LanguageAbilityMode, Hl7ProficiencyLevelCode, Hl7ProficiencyLevelCode, MimeType, MimeType, MimeType, MimeType, MimeType, MimeType, MimeType, NameQualifier, NameUse, NullFlavor, ObservationInterpretation, OriginalProviderRole, OriginalProviderRole, OriginalProviderRole, OriginalProviderRole, OriginalProviderRole, OriginalProviderRole, ParticipationType, PharmaceuticalDoseFormEdqm, PostalAddressUse, PracticeSettingCode, PracticeSettingCode, PracticeSettingCode, PracticeSettingCode, PracticeSettingCode, PracticeSettingCode, PracticeSettingCode, PracticeSettingCode, PurposeOfUse, PurposeOfUse, PurposeOfUse, PurposeOfUse, PurposeOfUse, PurposeOfUse, RegularUnitCodeAmbu, ReligiousAffiliation, Role, Role, Role, Role, Role, Role, RouteOfAdministrationAmbu, RouteOfAdministrationEdqm, ServiceEventCode, SourcePatientInfo, SourcePatientInfo, SourcePatientInfo, SourcePatientInfo, SourcePatientInfo, SourcePatientInfo, SubmissionSetAuthorRole, SubmissionSetAuthorRole, SubmissionSetAuthorRole, SubmissionSetAuthorRole, SubmissionSetAuthorRole, SubmissionSetAuthorRole, SubstanceAdministrationSubstitutionCode, TargetAwareness, TelecomAddressUse, TimeUnitCodeAmbu, TimingEventAmbu, TypeCode, TypeCode, TypeCode, TypeCode, TypeCode, TypeCode, TypeCode, TypeCode, UnitCode
public interface ValueSetEnumInterface extends CodedMetadataEnumInterface, TranslatedEnumInterface
Interface for all dynamically created/updated value sets.

  • Method Summary

    Modifier and Type
    Method
    Description
    default @NonNull CD
    getCD()
    Gets the HL7 CD.
    default @NonNull CD
    getCD(@Nullable LanguageCode languageCode)
    Gets the HL7 CD.
    default @NonNull CE
    getCE()
    Gets the HL7 CE.
    default @NonNull CE
    getCE(@Nullable LanguageCode languageCode)
    Gets the HL7 CE in the given language.
    default @NonNull Code
    getCode()
    Gets the husky Code Object.
    default @NonNull Code
    getCode(@Nullable LanguageCode languageCode)
    Gets the husky Code Object.
    default @NonNull String
    getCodedString()
    Encodes an eHC value set code to an IHE Coded String, as defined in ITI TF-3 Table 4.2.3.1.7-2.
    @NonNull String
    getCodeSystemId()
    Gets the code system identifier.
    @NonNull String
    getCodeSystemName()
    Gets the code system name.
    @NonNull String
    getCodeValue()
    Gets the actual Code as string.
    default @NonNull org.openehealth.ipf.commons.ihe.xds.core.metadata.Code
    getIpfCode()
    Gets the IPF metadata Code.
    @NonNull String
    getValueSetId()
    Gets the value set identifier.
    @NonNull String
    getValueSetName()
    Gets the value set name.
    default boolean
    isContainedIn(@NonNull Collection<org.openehealth.ipf.commons.ihe.xds.core.metadata.Code> codes)
    Checks whether a collection of codes contains a particular value set code.
    default boolean
    isEqualTo(@NonNull org.openehealth.ipf.commons.ihe.xds.core.metadata.Code code)
    Verifies if the current instance and a Code are coding the same value in the same system.
    @NonNull String
    name()
    Get the enum constant name

    Methods inherited from interface org.projecthusky.common.enums.TranslatedEnumInterface

    getDisplayName, getDisplayName

  • Method Details

    • getCE

      default @NonNull CE getCE()
      Gets the HL7 CE.
      Returns:
      the HL7 CE.

    • getCE

      default @NonNull CE getCE(@Nullable LanguageCode languageCode)
      Gets the HL7 CE in the given language.
      Parameters:
      languageCode - The language code to get the display name for, null to get the default display name.
      Returns:
      the HL7 CE.

    • getCD

      default @NonNull CD getCD()
      Gets the HL7 CD.
      Returns:
      the HL7 CD.

    • getCD

      default @NonNull CD getCD(@Nullable LanguageCode languageCode)
      Gets the HL7 CD.
      Parameters:
      languageCode - The language code to get the display name for, null to get the default display name.
      Returns:
      the HL7 CD.

    • getCode

      default @NonNull Code getCode()
      Gets the husky Code Object.
      Returns:
      the code.

    • getCode

      default @NonNull Code getCode(@Nullable LanguageCode languageCode)
      Gets the husky Code Object.
      Parameters:
      languageCode - The language code to get the display name for, null to get the default display name.
      Returns:
      the code.

    • getIpfCode

      default @NonNull org.openehealth.ipf.commons.ihe.xds.core.metadata.Code getIpfCode()
      Gets the IPF metadata Code.
      Specified by:
      getIpfCode in interface CodedMetadataEnumInterface
      Returns:
      the IPF code.

    • isEqualTo

      default boolean isEqualTo(@NonNull org.openehealth.ipf.commons.ihe.xds.core.metadata.Code code)
      Verifies if the current instance and a Code are coding the same value in the same system.
      Specified by:
      isEqualTo in interface CodedMetadataEnumInterface
      Parameters:
      code - The code to compare.
      Returns:
      true if they are equal, false otherwise.

    • isContainedIn

      default boolean isContainedIn(@NonNull Collection<org.openehealth.ipf.commons.ihe.xds.core.metadata.Code> codes)
      Checks whether a collection of codes contains a particular value set code.
      Specified by:
      isContainedIn in interface CodedMetadataEnumInterface
      Parameters:
      codes - The collection of codes.
      Returns:
      true if the collection contains the value set code, false otherwise.

    • getCodedString

      default @NonNull String getCodedString()
      Encodes an eHC value set code to an IHE Coded String, as defined in ITI TF-3 Table 4.2.3.1.7-2. It is mostly an HL7 V2.5 CX field. The code is escaped, the code system ID shall be an OID so escaping it shouldn't be needed.
      Specified by:
      getCodedString in interface CodedMetadataEnumInterface
      Returns:
      the encoded IHE Coded String.

    • getCodeSystemId

      @NonNull String getCodeSystemId()
      Gets the code system identifier.
      Returns:
      the code system identifier.

    • getCodeSystemName

      @NonNull String getCodeSystemName()
      Gets the code system name.
      Returns:
      the code system name.

    • getCodeValue

      @NonNull String getCodeValue()
      Gets the actual Code as string.
      Returns:
      the code.

    • getValueSetId

      @NonNull String getValueSetId()
      Gets the value set identifier.
      Returns:
      the value set identifier.

    • getValueSetName

      @NonNull String getValueSetName()
      Gets the value set name.
      Returns:
      the value set name.

    • name

      @NonNull String name()
      Get the enum constant name
      Returns:
      the name of this enum constant