Enum Class FormatCode
- All Implemented Interfaces:
Serializable
,Comparable<FormatCode>
,Constable
,CodedMetadataEnumInterface
,TranslatedEnumInterface
,ValueSetEnumInterface
EN: Document format as per Annex; EPRO-FDHA. This unambiguous code defines the format of the XDS document. Together with the mimetype, this should provide the potential consumer with sufficient information as to whether they are in a position to process the document.
DE: Format des Dokumentes gemäss Anhang 3 EPDV-EDI. Dieser eindeutige Code definiert das Format des XDS Dokumentes. Zusammen mit dem mimeType, sollte es dem potentiellen Konsumenten genügend Informationen liefern, ob er in der Lage ist, das Dokument zu verarbeiten.
FR: Format du document selon l'annexe 3 ODEP-DFI. Ce code univoque définit le format du document XDS. Combiné au mimeType, il doit fournir à l'utilisateur suffisamment d'informations pour savoir s'il est en mesure de traiter le document.
IT: Formato del documento secondo l'allegato 3 OCIP-DFI. Questo codice univoco definisce il formato del documento XDS. Insieme al tipo MIME, intende fornire al potenziale consumatore sufficienti informazioni per capire se è in grado o meno di elaborare il documento.
Identifier: 2.16.756.5.30.1.127.3.10.1.9
Effective date: 2024-11-19 16:26
Version: 202406.2-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 ConstantsEnum ConstantDescriptionEN: CDA Imaging Report with Structured Headings.
DE: CDA Imaging Report with Structured Headings.
FR: CDA Imaging Report with Structured Headings.
IT: CDA Imaging Report with Structured Headings.EN: CDA Laboratory Report.
DE: CDA Laboratory Report.
FR: CDA Laboratory Report.
IT: CDA Laboratory Report.EN: CDA Wrapped Text Report.
DE: CDA Wrapped Text Report.
FR: CDA Wrapped Text Report.
IT: CDA Wrapped Text Report.EN: CH AllergyIntolerance document.
DE: CH AllergyIntolerance document.
FR: CH AllergyIntolerance document.
IT: CH AllergyIntolerance document.EN: CH EMED Medication Card document.
DE: CH EMED Medication Card document.
FR: CH EMED Medication Card document.
IT: CH EMED Medication Card document.EN: CH EMED Medication Dispense document.
DE: CH EMED Medication Dispense document.
FR: CH EMED Medication Dispense document.
IT: CH EMED Medication Dispense document.EN: CH EMED Medication List document.
DE: CH EMED Medication List document.
FR: CH EMED Medication List document.
IT: CH EMED Medication List document.EN: CH EMED Medication Prescription document.
DE: CH EMED Medication Prescription document.
FR: CH EMED Medication Prescription document.
IT: CH EMED Medication Prescription document.EN: CH EMED Medication Treatment Plan document.
DE: CH EMED Medication Treatment Plan document.
FR: CH EMED Medication Treatment Plan document.
IT: CH EMED Medication Treatment Plan document.EN: CH EMED Pharmaceutical Advice document.
DE: CH EMED Pharmaceutical Advice document.
FR: CH EMED Pharmaceutical Advice document.
IT: CH EMED Pharmaceutical Advice document.EN: CH VACD Immunization Administration.
DE: CH VACD Immunization Administration.
FR: CH VACD Immunization Administration.
IT: CH VACD Immunization Administration.EN: CH VACD Vaccination Record.
DE: CH VACD Vaccination Record.
FR: CH VACD Vaccination Record.
IT: CH VACD Vaccination Record.EN: Community Dispense.
DE: Community Dispense.
FR: Community Dispense.
IT: Community Dispense.EN: Community Medication List.
DE: Community Medication List.
FR: Community Medication List.
IT: Community Medication List.EN: Community Medication Treatment Plan.
DE: Community Medication Treatment Plan.
FR: Community Medication Treatment Plan.
IT: Community Medication Treatment Plan.EN: Community Pharmaceutical Advice.
DE: Community Pharmaceutical Advice.
FR: Community Pharmaceutical Advice.
IT: Community Pharmaceutical Advice.EN: Community Prescription.
DE: Community Prescription.
FR: Community Prescription.
IT: Community Prescription.EN: IHE KOS document.
DE: KOS Dokument.
FR: Document KOS.
IT: Documento KOS .EN: Immunization Content (IC).
DE: Immunization Content (IC).
FR: Immunization Content (IC).
IT: Immunization Content (IC).EN: Immunization Registry Content (IRC).
DE: Immunization Registry Content (IRC).
FR: Immunization Registry Content (IRC).
IT: Immunization Registry Content (IRC).EN: MimeType sufficient.
DE: MimeType sufficient.
FR: MimeType sufficient.
IT: MimeType sufficient.EN: PDF embedded in CDA per XDS-SD profile.
DE: PDF embedded in CDA per XDS-SD profile.
FR: PDF embedded in CDA per XDS-SD profile.
IT: PDF embedded in CDA per XDS-SD profile.EN: PDF Radiology Report.
DE: PDF Radiology Report.
FR: PDF Radiology Report.
IT: PDF Radiology Report.EN: Text embedded in CDA per XDS-SD profile.
DE: Text embedded in CDA per XDS-SD profile.
FR: Text embedded in CDA per XDS-SD profile.
IT: Text embedded in CDA per XDS-SD profile.EN: Unstructured EPR document.
DE: Unstrukturiertes EPD Dokument.
FR: Document DEP non structuré.
IT: Documento CIP non strutturato. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
EN: Code for CDA Imaging Report with Structured Headings.
DE: Code für CDA Imaging Report with Structured Headings.
FR: Code de CDA Imaging Report with Structured Headings.
IT: Code per CDA Imaging Report with Structured Headings.static final String
EN: Code for CDA Laboratory Report.
DE: Code für CDA Laboratory Report.
FR: Code de CDA Laboratory Report.
IT: Code per CDA Laboratory Report.static final String
EN: Code for CDA Wrapped Text Report.
DE: Code für CDA Wrapped Text Report.
FR: Code de CDA Wrapped Text Report.
IT: Code per CDA Wrapped Text Report.static final String
EN: Code for CH AllergyIntolerance document.
DE: Code für CH AllergyIntolerance document.
FR: Code de CH AllergyIntolerance document.
IT: Code per CH AllergyIntolerance document.static final String
EN: Code for CH EMED Medication Card document.
DE: Code für CH EMED Medication Card document.
FR: Code de CH EMED Medication Card document.
IT: Code per CH EMED Medication Card document.static final String
EN: Code for CH EMED Medication Dispense document.
DE: Code für CH EMED Medication Dispense document.
FR: Code de CH EMED Medication Dispense document.
IT: Code per CH EMED Medication Dispense document.static final String
EN: Code for CH EMED Medication List document.
DE: Code für CH EMED Medication List document.
FR: Code de CH EMED Medication List document.
IT: Code per CH EMED Medication List document.static final String
EN: Code for CH EMED Medication Prescription document.
DE: Code für CH EMED Medication Prescription document.
FR: Code de CH EMED Medication Prescription document.
IT: Code per CH EMED Medication Prescription document.static final String
EN: Code for CH EMED Medication Treatment Plan document.
DE: Code für CH EMED Medication Treatment Plan document.
FR: Code de CH EMED Medication Treatment Plan document.
IT: Code per CH EMED Medication Treatment Plan document.static final String
EN: Code for CH EMED Pharmaceutical Advice document.
DE: Code für CH EMED Pharmaceutical Advice document.
FR: Code de CH EMED Pharmaceutical Advice document.
IT: Code per CH EMED Pharmaceutical Advice document.static final String
EN: Code for CH VACD Immunization Administration.
DE: Code für CH VACD Immunization Administration.
FR: Code de CH VACD Immunization Administration.
IT: Code per CH VACD Immunization Administration.static final String
EN: Code for CH VACD Vaccination Record.
DE: Code für CH VACD Vaccination Record.
FR: Code de CH VACD Vaccination Record.
IT: Code per CH VACD Vaccination Record.static final String
EN: Code for Community Dispense.
DE: Code für Community Dispense.
FR: Code de Community Dispense.
IT: Code per Community Dispense.static final String
EN: Code for Community Medication List.
DE: Code für Community Medication List.
FR: Code de Community Medication List.
IT: Code per Community Medication List.static final String
EN: Code for Community Medication Treatment Plan.
DE: Code für Community Medication Treatment Plan.
FR: Code de Community Medication Treatment Plan.
IT: Code per Community Medication Treatment Plan.static final String
EN: Code for Community Pharmaceutical Advice.
DE: Code für Community Pharmaceutical Advice.
FR: Code de Community Pharmaceutical Advice.
IT: Code per Community Pharmaceutical Advice.static final String
EN: Code for Community Prescription.
DE: Code für Community Prescription.
FR: Code de Community Prescription.
IT: Code per Community Prescription.static final String
EN: Code for IHE KOS document.
DE: Code für KOS Dokument.
FR: Code de Document KOS.
IT: Code per Documento KOS .static final String
EN: Code for Immunization Content (IC).
DE: Code für Immunization Content (IC).
FR: Code de Immunization Content (IC).
IT: Code per Immunization Content (IC).static final String
EN: Code for Immunization Registry Content (IRC).
DE: Code für Immunization Registry Content (IRC).
FR: Code de Immunization Registry Content (IRC).
IT: Code per Immunization Registry Content (IRC).static final String
EN: Code for MimeType sufficient.
DE: Code für MimeType sufficient.
FR: Code de MimeType sufficient.
IT: Code per MimeType sufficient.static final String
EN: Code for PDF embedded in CDA per XDS-SD profile.
DE: Code für PDF embedded in CDA per XDS-SD profile.
FR: Code de PDF embedded in CDA per XDS-SD profile.
IT: Code per PDF embedded in CDA per XDS-SD profile.static final String
EN: Code for PDF Radiology Report.
DE: Code für PDF Radiology Report.
FR: Code de PDF Radiology Report.
IT: Code per PDF Radiology Report.static final String
EN: Code for Text embedded in CDA per XDS-SD profile.
DE: Code für Text embedded in CDA per XDS-SD profile.
FR: Code de Text embedded in CDA per XDS-SD profile.
IT: Code per Text embedded in CDA per XDS-SD profile.static final String
EN: Code for Unstructured EPR document.
DE: Code für Unstrukturiertes EPD Dokument.
FR: Code de Document DEP non structuré.
IT: Code per Documento CIP non strutturato.static final String
Identifier of the value set.static final String
Name of the value set. -
Method Summary
Modifier and TypeMethodDescription@NonNull String
Gets the code system identifier.@NonNull String
Gets the code system name.@NonNull String
Gets the code value as a string.@NonNull String
getDisplayName
(@Nullable LanguageCode languageCode) Gets the display name defined by the language param.static @Nullable FormatCode
Gets the Enum with a given code.@NonNull String
Gets the value set identifier.@NonNull String
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 FormatCode
Returns the enum constant of this class with the specified name.static FormatCode[]
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 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
-
CDA_IMAGING_REPORT_WITH_STRUCTURED_HEADINGS
EN: CDA Imaging Report with Structured Headings.
DE: CDA Imaging Report with Structured Headings.
FR: CDA Imaging Report with Structured Headings.
IT: CDA Imaging Report with Structured Headings. -
CDA_LABORATORY_REPORT
EN: CDA Laboratory Report.
DE: CDA Laboratory Report.
FR: CDA Laboratory Report.
IT: CDA Laboratory Report. -
CDA_WRAPPED_TEXT_REPORT
EN: CDA Wrapped Text Report.
DE: CDA Wrapped Text Report.
FR: CDA Wrapped Text Report.
IT: CDA Wrapped Text Report. -
CH_ALLERGYINTOLERANCE_DOCUMENT
EN: CH AllergyIntolerance document.
DE: CH AllergyIntolerance document.
FR: CH AllergyIntolerance document.
IT: CH AllergyIntolerance document. -
CH_EMED_MEDICATION_CARD_DOCUMENT
EN: CH EMED Medication Card document.
DE: CH EMED Medication Card document.
FR: CH EMED Medication Card document.
IT: CH EMED Medication Card document. -
CH_EMED_MEDICATION_DISPENSE_DOCUMENT
EN: CH EMED Medication Dispense document.
DE: CH EMED Medication Dispense document.
FR: CH EMED Medication Dispense document.
IT: CH EMED Medication Dispense document. -
CH_EMED_MEDICATION_LIST_DOCUMENT
EN: CH EMED Medication List document.
DE: CH EMED Medication List document.
FR: CH EMED Medication List document.
IT: CH EMED Medication List document. -
CH_EMED_MEDICATION_PRESCRIPTION_DOCUMENT
EN: CH EMED Medication Prescription document.
DE: CH EMED Medication Prescription document.
FR: CH EMED Medication Prescription document.
IT: CH EMED Medication Prescription document. -
CH_EMED_MEDICATION_TREATMENT_PLAN_DOCUMENT
EN: CH EMED Medication Treatment Plan document.
DE: CH EMED Medication Treatment Plan document.
FR: CH EMED Medication Treatment Plan document.
IT: CH EMED Medication Treatment Plan document. -
CH_EMED_PHARMACEUTICAL_ADVICE_DOCUMENT
EN: CH EMED Pharmaceutical Advice document.
DE: CH EMED Pharmaceutical Advice document.
FR: CH EMED Pharmaceutical Advice document.
IT: CH EMED Pharmaceutical Advice document. -
CH_VACD_IMMUNIZATION_ADMINISTRATION
EN: CH VACD Immunization Administration.
DE: CH VACD Immunization Administration.
FR: CH VACD Immunization Administration.
IT: CH VACD Immunization Administration. -
CH_VACD_VACCINATION_RECORD
EN: CH VACD Vaccination Record.
DE: CH VACD Vaccination Record.
FR: CH VACD Vaccination Record.
IT: CH VACD Vaccination Record. -
COMMUNITY_DISPENSE
EN: Community Dispense.
DE: Community Dispense.
FR: Community Dispense.
IT: Community Dispense. -
COMMUNITY_MEDICATION_LIST
EN: Community Medication List.
DE: Community Medication List.
FR: Community Medication List.
IT: Community Medication List. -
COMMUNITY_MEDICATION_TREATMENT_PLAN
EN: Community Medication Treatment Plan.
DE: Community Medication Treatment Plan.
FR: Community Medication Treatment Plan.
IT: Community Medication Treatment Plan. -
COMMUNITY_PHARMACEUTICAL_ADVICE
EN: Community Pharmaceutical Advice.
DE: Community Pharmaceutical Advice.
FR: Community Pharmaceutical Advice.
IT: Community Pharmaceutical Advice. -
COMMUNITY_PRESCRIPTION
EN: Community Prescription.
DE: Community Prescription.
FR: Community Prescription.
IT: Community Prescription. -
IHE_KOS_DOCUMENT
EN: IHE KOS document.
DE: KOS Dokument.
FR: Document KOS.
IT: Documento KOS . -
IMMUNIZATION_CONTENT
EN: Immunization Content (IC).
DE: Immunization Content (IC).
FR: Immunization Content (IC).
IT: Immunization Content (IC). -
IMMUNIZATION_REGISTRY_CONTENT_IRC
EN: Immunization Registry Content (IRC).
DE: Immunization Registry Content (IRC).
FR: Immunization Registry Content (IRC).
IT: Immunization Registry Content (IRC). -
MIMETYPE_SUFFICIENT
EN: MimeType sufficient.
DE: MimeType sufficient.
FR: MimeType sufficient.
IT: MimeType sufficient. -
PDF_EMBEDDED_IN_CDA_PER_XDS_SD_PROFILE
EN: PDF embedded in CDA per XDS-SD profile.
DE: PDF embedded in CDA per XDS-SD profile.
FR: PDF embedded in CDA per XDS-SD profile.
IT: PDF embedded in CDA per XDS-SD profile. -
PDF_RADIOLOGY_REPORT
EN: PDF Radiology Report.
DE: PDF Radiology Report.
FR: PDF Radiology Report.
IT: PDF Radiology Report. -
TEXT_EMBEDDED_IN_CDA_PER_XDS_SD_PROFILE
EN: Text embedded in CDA per XDS-SD profile.
DE: Text embedded in CDA per XDS-SD profile.
FR: Text embedded in CDA per XDS-SD profile.
IT: Text embedded in CDA per XDS-SD profile. -
UNSTRUCTURED_EPR_DOCUMENT
EN: Unstructured EPR document.
DE: Unstrukturiertes EPD Dokument.
FR: Document DEP non structuré.
IT: Documento CIP non strutturato.
-
-
Field Details
-
CDA_IMAGING_REPORT_WITH_STRUCTURED_HEADINGS_CODE
EN: Code for CDA Imaging Report with Structured Headings.
DE: Code für CDA Imaging Report with Structured Headings.
FR: Code de CDA Imaging Report with Structured Headings.
IT: Code per CDA Imaging Report with Structured Headings.- See Also:
-
CDA_LABORATORY_REPORT_CODE
EN: Code for CDA Laboratory Report.
DE: Code für CDA Laboratory Report.
FR: Code de CDA Laboratory Report.
IT: Code per CDA Laboratory Report.- See Also:
-
CDA_WRAPPED_TEXT_REPORT_CODE
EN: Code for CDA Wrapped Text Report.
DE: Code für CDA Wrapped Text Report.
FR: Code de CDA Wrapped Text Report.
IT: Code per CDA Wrapped Text Report.- See Also:
-
CH_ALLERGYINTOLERANCE_DOCUMENT_CODE
EN: Code for CH AllergyIntolerance document.
DE: Code für CH AllergyIntolerance document.
FR: Code de CH AllergyIntolerance document.
IT: Code per CH AllergyIntolerance document.- See Also:
-
CH_EMED_MEDICATION_CARD_DOCUMENT_CODE
EN: Code for CH EMED Medication Card document.
DE: Code für CH EMED Medication Card document.
FR: Code de CH EMED Medication Card document.
IT: Code per CH EMED Medication Card document.- See Also:
-
CH_EMED_MEDICATION_DISPENSE_DOCUMENT_CODE
EN: Code for CH EMED Medication Dispense document.
DE: Code für CH EMED Medication Dispense document.
FR: Code de CH EMED Medication Dispense document.
IT: Code per CH EMED Medication Dispense document.- See Also:
-
CH_EMED_MEDICATION_LIST_DOCUMENT_CODE
EN: Code for CH EMED Medication List document.
DE: Code für CH EMED Medication List document.
FR: Code de CH EMED Medication List document.
IT: Code per CH EMED Medication List document.- See Also:
-
CH_EMED_MEDICATION_PRESCRIPTION_DOCUMENT_CODE
EN: Code for CH EMED Medication Prescription document.
DE: Code für CH EMED Medication Prescription document.
FR: Code de CH EMED Medication Prescription document.
IT: Code per CH EMED Medication Prescription document.- See Also:
-
CH_EMED_MEDICATION_TREATMENT_PLAN_DOCUMENT_CODE
EN: Code for CH EMED Medication Treatment Plan document.
DE: Code für CH EMED Medication Treatment Plan document.
FR: Code de CH EMED Medication Treatment Plan document.
IT: Code per CH EMED Medication Treatment Plan document.- See Also:
-
CH_EMED_PHARMACEUTICAL_ADVICE_DOCUMENT_CODE
EN: Code for CH EMED Pharmaceutical Advice document.
DE: Code für CH EMED Pharmaceutical Advice document.
FR: Code de CH EMED Pharmaceutical Advice document.
IT: Code per CH EMED Pharmaceutical Advice document.- See Also:
-
CH_VACD_IMMUNIZATION_ADMINISTRATION_CODE
EN: Code for CH VACD Immunization Administration.
DE: Code für CH VACD Immunization Administration.
FR: Code de CH VACD Immunization Administration.
IT: Code per CH VACD Immunization Administration.- See Also:
-
CH_VACD_VACCINATION_RECORD_CODE
EN: Code for CH VACD Vaccination Record.
DE: Code für CH VACD Vaccination Record.
FR: Code de CH VACD Vaccination Record.
IT: Code per CH VACD Vaccination Record.- See Also:
-
COMMUNITY_DISPENSE_CODE
EN: Code for Community Dispense.
DE: Code für Community Dispense.
FR: Code de Community Dispense.
IT: Code per Community Dispense.- See Also:
-
COMMUNITY_MEDICATION_LIST_CODE
EN: Code for Community Medication List.
DE: Code für Community Medication List.
FR: Code de Community Medication List.
IT: Code per Community Medication List.- See Also:
-
COMMUNITY_MEDICATION_TREATMENT_PLAN_CODE
EN: Code for Community Medication Treatment Plan.
DE: Code für Community Medication Treatment Plan.
FR: Code de Community Medication Treatment Plan.
IT: Code per Community Medication Treatment Plan.- See Also:
-
COMMUNITY_PHARMACEUTICAL_ADVICE_CODE
EN: Code for Community Pharmaceutical Advice.
DE: Code für Community Pharmaceutical Advice.
FR: Code de Community Pharmaceutical Advice.
IT: Code per Community Pharmaceutical Advice.- See Also:
-
COMMUNITY_PRESCRIPTION_CODE
EN: Code for Community Prescription.
DE: Code für Community Prescription.
FR: Code de Community Prescription.
IT: Code per Community Prescription.- See Also:
-
IHE_KOS_DOCUMENT_CODE
EN: Code for IHE KOS document.
DE: Code für KOS Dokument.
FR: Code de Document KOS.
IT: Code per Documento KOS .- See Also:
-
IMMUNIZATION_CONTENT_CODE
EN: Code for Immunization Content (IC).
DE: Code für Immunization Content (IC).
FR: Code de Immunization Content (IC).
IT: Code per Immunization Content (IC).- See Also:
-
IMMUNIZATION_REGISTRY_CONTENT_IRC_CODE
EN: Code for Immunization Registry Content (IRC).
DE: Code für Immunization Registry Content (IRC).
FR: Code de Immunization Registry Content (IRC).
IT: Code per Immunization Registry Content (IRC).- See Also:
-
MIMETYPE_SUFFICIENT_CODE
EN: Code for MimeType sufficient.
DE: Code für MimeType sufficient.
FR: Code de MimeType sufficient.
IT: Code per MimeType sufficient.- See Also:
-
PDF_EMBEDDED_IN_CDA_PER_XDS_SD_PROFILE_CODE
EN: Code for PDF embedded in CDA per XDS-SD profile.
DE: Code für PDF embedded in CDA per XDS-SD profile.
FR: Code de PDF embedded in CDA per XDS-SD profile.
IT: Code per PDF embedded in CDA per XDS-SD profile.- See Also:
-
PDF_RADIOLOGY_REPORT_CODE
EN: Code for PDF Radiology Report.
DE: Code für PDF Radiology Report.
FR: Code de PDF Radiology Report.
IT: Code per PDF Radiology Report.- See Also:
-
TEXT_EMBEDDED_IN_CDA_PER_XDS_SD_PROFILE_CODE
EN: Code for Text embedded in CDA per XDS-SD profile.
DE: Code für Text embedded in CDA per XDS-SD profile.
FR: Code de Text embedded in CDA per XDS-SD profile.
IT: Code per Text embedded in CDA per XDS-SD profile.- See Also:
-
UNSTRUCTURED_EPR_DOCUMENT_CODE
EN: Code for Unstructured EPR document.
DE: Code für Unstrukturiertes EPD Dokument.
FR: Code de Document DEP non structuré.
IT: Code per Documento CIP non strutturato.- See Also:
-
VALUE_SET_ID
Identifier of the value set.- See Also:
-
VALUE_SET_NAME
Name of the value set.- See Also:
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getEnum
Gets the Enum with a given code.- Parameters:
code
- The code value.- Returns:
- the enum value found or
null
.
-
isEnumOfValueSet
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
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
Gets the code system identifier.- Specified by:
getCodeSystemId
in interfaceValueSetEnumInterface
- Returns:
- the code system identifier.
-
getCodeSystemName
Gets the code system name.- Specified by:
getCodeSystemName
in interfaceValueSetEnumInterface
- Returns:
- the code system name.
-
getCodeValue
Gets the code value as a string.- Specified by:
getCodeValue
in interfaceValueSetEnumInterface
- Returns:
- the code value.
-
getDisplayName
Gets the display name defined by the language param.- Specified by:
getDisplayName
in interfaceTranslatedEnumInterface
- 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
Gets the value set identifier.- Specified by:
getValueSetId
in interfaceValueSetEnumInterface
- Returns:
- the value set identifier.
-
getValueSetName
Gets the value set name.- Specified by:
getValueSetName
in interfaceValueSetEnumInterface
- Returns:
- the value set name.
-