Package org.projecthusky.communication.ch.enums.r202212

Enum Class FormatCode

java.lang.Object
java.lang.Enum<FormatCode>
org.projecthusky.communication.ch.enums.r202212.FormatCode
All Implemented Interfaces:
Serializable, Comparable<FormatCode>, Constable, CodedMetadataEnumInterface, TranslatedEnumInterface, ValueSetEnumInterface
@Generated(value="org.projecthusky.codegenerator.ch.valuesets.UpdateValueSets", date="2023-05-10") public enum FormatCode extends Enum<FormatCode> implements ValueSetEnumInterface
Enumeration of DocumentEntry.formatCode values

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: 2021-04-01 17:06
Version: 202104.0-stable
Status: DEPRECATED

  • Enum Constant Details

    • CDA_IMAGING_REPORT_WITH_STRUCTURED_HEADINGS

      public static final FormatCode 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

      public static final FormatCode CDA_LABORATORY_REPORT
      EN: CDA Laboratory Report.
      DE: CDA Laboratory Report.
      FR: CDA Laboratory Report.
      IT: CDA Laboratory Report.

    • CDA_WRAPPED_TEXT_REPORT

      public static final FormatCode CDA_WRAPPED_TEXT_REPORT
      EN: CDA Wrapped Text Report.
      DE: CDA Wrapped Text Report.
      FR: CDA Wrapped Text Report.
      IT: CDA Wrapped Text Report.

    • COMMUNITY_DISPENSE

      public static final FormatCode COMMUNITY_DISPENSE
      EN: Community Dispense.
      DE: Community Dispense.
      FR: Community Dispense.
      IT: Community Dispense.

    • COMMUNITY_MEDICATION_LIST

      public static final FormatCode COMMUNITY_MEDICATION_LIST
      EN: Community Medication List.
      DE: Community Medication List.
      FR: Community Medication List.
      IT: Community Medication List.

    • COMMUNITY_MEDICATION_TREATMENT_PLAN

      public static final FormatCode 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

      public static final FormatCode COMMUNITY_PHARMACEUTICAL_ADVICE
      EN: Community Pharmaceutical Advice.
      DE: Community Pharmaceutical Advice.
      FR: Community Pharmaceutical Advice.
      IT: Community Pharmaceutical Advice.

    • COMMUNITY_PRESCRIPTION

      public static final FormatCode COMMUNITY_PRESCRIPTION
      EN: Community Prescription.
      DE: Community Prescription.
      FR: Community Prescription.
      IT: Community Prescription.

    • IHE_KOS_DOCUMENT

      public static final FormatCode IHE_KOS_DOCUMENT
      EN: IHE KOS document.
      DE: KOS Dokument.
      FR: Document KOS.
      IT: Documento KOS .

    • IMMUNIZATION_CONTENT

      public static final FormatCode IMMUNIZATION_CONTENT
      EN: Immunization Content (IC).
      DE: Immunization Content (IC).
      FR: Immunization Content (IC).
      IT: Immunization Content (IC).

    • MIMETYPE_SUFFICIENT

      public static final FormatCode MIMETYPE_SUFFICIENT
      EN: MimeType sufficient.
      DE: MimeType sufficient.
      FR: MimeType sufficient.
      IT: MimeType sufficient.

    • PDF_EMBEDDED_IN_CDA_PER_XDS_SD_PROFILE

      public static final FormatCode 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

      public static final FormatCode 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

      public static final FormatCode 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

      public static final FormatCode 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

      public static final String 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

      public static final String 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

      public static final String 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:

    • COMMUNITY_DISPENSE_CODE

      public static final String 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

      public static final String 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

      public static final String 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

      public static final String 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

      public static final String 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

      public static final String 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

      public static final String 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:

    • MIMETYPE_SUFFICIENT_CODE

      public static final String 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

      public static final String 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

      public static final String 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

      public static final String 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

      public static final String 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

      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 FormatCode[] 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 FormatCode 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 FormatCode 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.