Package org.projecthusky.common.enums

Interface CodedMetadataEnumInterface

All Known Subinterfaces:

ValueSetEnumInterface, ValueSetEnumInterfaceAt

All Known Implementing Classes:

ActivePharmaceuticalIngredient, ActStatus, ActStatusCompleted, ActSubstanceAdminSubstitutionCode, AdministrativeGender, AgentRole, AgentRole, AgentRole, AgentRole, AtcdabbrLanguageCode, AtcdabbrLanguageCode, AuditTrailConsumptionEventType, AuditTrailConsumptionEventType, AuditTrailConsumptionEventType, AuditTrailConsumptionEventType, AuthorRole, AuthorRole, AuthorRole, AuthorRole, AuthorRole, AuthorSpeciality, AuthorSpeciality, AuthorSpeciality, AuthorSpeciality, AuthorSpeciality, AvailabilityStatus, ChEmedEprTimeUnit, ChEmedTimingEvent, ClassCode, ClassCode, ClassCode, ClassCode, ClassCode, ClassCode, ClassTypeCodeMapping, ClassTypeCodeMapping, ClassTypeCodeMapping, ClassTypeCodeMapping, CommonLanguages, ConfidentialityCode, ConfidentialityCode, ConfidentialityCode, ConfidentialityCode, ConfidentialityCode, ConfidentialityCode, ConfidentialityCode, ContentTypeCode, ContentTypeCode, ContentTypeCode, ContentTypeCode, DeletionStatus, DeletionStatus, DeletionStatus, DeletionStatus, DispenseSupplyType, 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, FormatCode, FormatCode, FormatCode, FormatCode, FormatCode, FormatCode, GeneralAddressUse, HcpProfession, HcpProfession, HcpProfession, HcpProfession, HcpProfessionSpecialisationMap, HcpProfessionSpecialisationMap, HcpProfessionSpecialisationMap, HcpProfessionSpecialisationMap, HcpSpecialisation, HcpSpecialisation, HcpSpecialisation, HcpSpecialisation, HealthcareFacilityTypeCode, HealthcareFacilityTypeCode, HealthcareFacilityTypeCode, HealthcareFacilityTypeCode, HealthcareFacilityTypeCode, HealthcareFacilityTypeCode, Hl7LanguageAbilityMode, Hl7LanguageAbilityMode, Hl7ProficiencyLevelCode, Hl7ProficiencyLevelCode, MimeType, MimeType, MimeType, MimeType, MimeType, NameQualifier, NameUse, NullFlavor, ObservationInterpretation, OriginalProviderRole, OriginalProviderRole, OriginalProviderRole, OriginalProviderRole, ParticipationType, PharmaceuticalDoseFormEdqm, PostalAddressUse, PracticeSettingCode, PracticeSettingCode, PracticeSettingCode, PracticeSettingCode, PracticeSettingCode, PracticeSettingCode, PurposeOfUse, PurposeOfUse, PurposeOfUse, PurposeOfUse, RegularUnitCodeAmbu, ReligiousAffiliation, Role, Role, Role, Role, RouteOfAdministrationAmbu, RouteOfAdministrationEdqm, ServiceEventCode, SourcePatientInfo, SourcePatientInfo, SourcePatientInfo, SourcePatientInfo, SubmissionSetAuthorRole, SubmissionSetAuthorRole, SubmissionSetAuthorRole, SubmissionSetAuthorRole, SubstanceAdministrationSubstitutionCode, TargetAwareness, TelecomAddressUse, TimingEventAmbu, TypeCode, TypeCode, TypeCode, TypeCode, TypeCode, TypeCode, UnitCode

public interface CodedMetadataEnumInterface

Since:

Sep 22, 2015 10:00:45 AM

Method Summary

Modifier and Type	Method	Description
@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 org.openehealth.ipf.commons.ihe.xds.core.metadata.Code	getIpfCode()	Gets the IPF metadata Code.
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.
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.

Method Details

getIpfCode

@NonNull org.openehealth.ipf.commons.ihe.xds.core.metadata.Code getIpfCode()

Gets the IPF metadata Code.

Returns:

the IPF code.

isEqualTo

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.

Parameters:

code - The code to compare.

Returns:

true if they are equal, false otherwise.

isContainedIn

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.

Parameters:

codes - The collection of codes.

Returns:

true if the collection contains the value set code, false otherwise.

getCodedString

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

Returns:

the encoded IHE Coded String.