Package org.hl7.fhir.r4.model

Enum Class ImplementationGuide.GuideParameterCode

java.lang.Object

java.lang.Enum<ImplementationGuide.GuideParameterCode>

org.hl7.fhir.r4.model.ImplementationGuide.GuideParameterCode

All Implemented Interfaces:

Serializable, Comparable<ImplementationGuide.GuideParameterCode>, Constable

Enclosing class:

ImplementationGuide

public static enum ImplementationGuide.GuideParameterCode
extends Enum<ImplementationGuide.GuideParameterCode>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

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].
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 with the generic types
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").

Method Summary

Modifier and Type	Method	Description
static ImplementationGuide.GuideParameterCode	fromCode(String codeString)
String	getDefinition()
String	getDisplay()
String	getSystem()
String	toCode()
static ImplementationGuide.GuideParameterCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ImplementationGuide.GuideParameterCode[]	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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

APPLY

public static final ImplementationGuide.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 ImplementationGuide.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 ImplementationGuide.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 ImplementationGuide.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 ImplementationGuide.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 ImplementationGuide.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 ImplementationGuide.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 ImplementationGuide.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 ImplementationGuide.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 ImplementationGuide.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).

NULL

public static final ImplementationGuide.GuideParameterCode NULL

added to help the parsers with the generic types

Method Details

values

public static ImplementationGuide.GuideParameterCode[] 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 ImplementationGuide.GuideParameterCode 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

fromCode

public static ImplementationGuide.GuideParameterCode fromCode(String codeString)
                                                       throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

toCode

public String toCode()

getSystem

public String getSystem()

getDefinition

public String getDefinition()

getDisplay

public String getDisplay()