Package com.ibm.fhir.schema.control

Enum FhirSchemaVersion

  • All Implemented Interfaces:
    Serializable, Comparable<FhirSchemaVersion>
    public enum FhirSchemaVersion
extends Enum<FhirSchemaVersion>
    Tracks the incremental changes to the FHIR schema as it evolves. Incremental changes to the schema should be recorded here to create a new version number and this enum can then be used to identify the schema objects associated with a particular version.

    • Method Detail

      • values

        public static FhirSchemaVersion[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (FhirSchemaVersion c : FhirSchemaVersion.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static FhirSchemaVersion valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
        NullPointerException - if the argument is null

      • vid

        public int vid()
        Getter for the version number used by VERSION_HISTORY. We use vid here as a short name to improve readability where this value is used
        Returns:

      • getDescription

        public String getDescription()
        Getter for the text description of the schema change
        Returns:

      • isParameterStorageUpdated

        public boolean isParameterStorageUpdated()
        Determines if the version change affects parameter storage
        Returns:

      • getLatestParameterStorageUpdate

        public static FhirSchemaVersion getLatestParameterStorageUpdate()
        Gets the latest version that included a parameter storage update, which would require all resources to reindex all search parameters, even if the search parameters and extracted values did not change.
        Returns:
        latest version that included a parameter storage update