Package org.hl7.fhir.r4.model.codesystems

Enum GuideParameterCode

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      APPLY
      If the value of this string 0..* parameter is one of the metadata fields then all conformance resources will have any specified [Resource].[field] overwritten with the ImplementationGuide.[field], where field is one of: version, date, status, publisher, contact, copyright, experimental, jurisdiction, useContext.
      EXPANSIONPARAMETER
      The value of this string 0..* parameter is a parameter (name=value) when expanding value sets for this implementation guide.
      GENERATEJSON
      The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in JSON format.
      GENERATETURTLE
      The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in Turtle format.
      GENERATEXML
      The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in XML format.
      HTMLTEMPLATE
      The value of this string singleton parameter is the name of the file to use as the builder template for each generated page (see templating).
      NULL
      added to help the parsers
      PATHPAGES
      The value of this string 0..1 parameter is a subfolder of the build context's location that contains files that are part of the html content processed by the builder.
      PATHRESOURCE
      The value of this string 0..* parameter is a subfolder of the build context's location that is to be scanned to load resources.
      PATHTXCACHE
      The value of this string 0..1 parameter is a subfolder of the build context's location that is used as the terminology cache.
      RULEBROKENLINKS
      The value of this string 0..1 parameter is either "warning" or "error" (default = "error").

    • Enum Constant Detail

      • APPLY

        public static final GuideParameterCode APPLY
        If the value of this string 0..* parameter is one of the metadata fields then all conformance resources will have any specified [Resource].[field] overwritten with the ImplementationGuide.[field], where field is one of: version, date, status, publisher, contact, copyright, experimental, jurisdiction, useContext.

      • PATHRESOURCE

        public static final GuideParameterCode PATHRESOURCE
        The value of this string 0..* parameter is a subfolder of the build context's location that is to be scanned to load resources. Scope is (if present) a particular resource type.

      • PATHPAGES

        public static final GuideParameterCode PATHPAGES
        The value of this string 0..1 parameter is a subfolder of the build context's location that contains files that are part of the html content processed by the builder.

      • PATHTXCACHE

        public static final GuideParameterCode PATHTXCACHE
        The value of this string 0..1 parameter is a subfolder of the build context's location that is used as the terminology cache. If this is not present, the terminology cache is on the local system, not under version control.

      • EXPANSIONPARAMETER

        public static final GuideParameterCode EXPANSIONPARAMETER
        The value of this string 0..* parameter is a parameter (name=value) when expanding value sets for this implementation guide. This is particularly used to specify the versions of published terminologies such as SNOMED CT.

      • RULEBROKENLINKS

        public static final GuideParameterCode RULEBROKENLINKS
        The value of this string 0..1 parameter is either "warning" or "error" (default = "error"). If the value is "warning" then IG build tools allow the IG to be considered successfully build even when there is no internal broken links.

      • GENERATEXML

        public static final GuideParameterCode GENERATEXML
        The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in XML format. If not present, the Publication Tool decides whether to generate XML.

      • GENERATEJSON

        public static final GuideParameterCode GENERATEJSON
        The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in JSON format. If not present, the Publication Tool decides whether to generate JSON.

      • GENERATETURTLE

        public static final GuideParameterCode GENERATETURTLE
        The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in Turtle format. If not present, the Publication Tool decides whether to generate Turtle.

      • HTMLTEMPLATE

        public static final GuideParameterCode HTMLTEMPLATE
        The value of this string singleton parameter is the name of the file to use as the builder template for each generated page (see templating).

    • Method Detail

      • values

        public static GuideParameterCode[] 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 (GuideParameterCode c : GuideParameterCode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static GuideParameterCode 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

      • fromCode

        public static GuideParameterCode fromCode​(String codeString)
                                   throws org.hl7.fhir.exceptions.FHIRException
        Throws:
        org.hl7.fhir.exceptions.FHIRException