Package com.ibm.fhir.model.type.code

Class GuideParameterCode

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class GuideParameterCode
extends Code

    • Field Detail

      • APPLY

        public static final GuideParameterCode APPLY
        Apply Metadata Value

        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.

      • PATH_RESOURCE

        public static final GuideParameterCode PATH_RESOURCE
        Resource Path

        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.

      • PATH_PAGES

        public static final GuideParameterCode PATH_PAGES
        Pages Path

        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.

      • PATH_TX_CACHE

        public static final GuideParameterCode PATH_TX_CACHE
        Terminology Cache Path

        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.

      • EXPANSION_PARAMETER

        public static final GuideParameterCode EXPANSION_PARAMETER
        Expansion Profile

        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.

      • RULE_BROKEN_LINKS

        public static final GuideParameterCode RULE_BROKEN_LINKS
        Broken Links Rule

        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.

      • GENERATE_XML

        public static final GuideParameterCode GENERATE_XML
        Generate XML

        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.

      • GENERATE_JSON

        public static final GuideParameterCode GENERATE_JSON
        Generate JSON

        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.

      • GENERATE_TURTLE

        public static final GuideParameterCode GENERATE_TURTLE
        Generate Turtle

        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.

      • HTML_TEMPLATE

        public static final GuideParameterCode HTML_TEMPLATE
        HTML Template

        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

      • of

        public static GuideParameterCode of​(String value)
        Factory method for creating GuideParameterCode objects from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value

      • string

        public static String string​(String value)
        Inherited factory method for creating GuideParameterCode objects from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value

      • code

        public static Code code​(String value)
        Inherited factory method for creating GuideParameterCode objects from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value

      • equals

        public boolean equals​(Object obj)
        Overrides:
        equals in class Code

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Code