Package org.hl7.fhir.r5.model

Class Questionnaire.QuestionnaireItemComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.model.Questionnaire.QuestionnaireItemComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

Questionnaire

public static class Questionnaire.QuestionnaireItemComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected Enumeration<Questionnaire.QuestionnaireAnswerConstraint>	answerConstraint	For items that have a defined set of allowed answers (via answerOption or answerValueSet), indicates whether values *other* than those specified can be selected.
protected List<Questionnaire.QuestionnaireItemAnswerOptionComponent>	answerOption	One of the permitted answers for the question.
protected CanonicalType	answerValueSet	A reference to a value set containing a list of values representing permitted answers for a question.
protected List<Coding>	code	A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).
protected UriType	definition	This element is a URI that refers to an [ElementDefinition](elementdefinition.html) or to an [ObservationDefinition](observationdefinition.html) that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource.
protected Enumeration<Questionnaire.QuestionnaireItemDisabledDisplay>	disabledDisplay	Indicates if and how items that are disabled (because enableWhen evaluates to 'false') should be displayed.
protected Enumeration<Questionnaire.EnableWhenBehavior>	enableBehavior	Controls how multiple enableWhen values are interpreted - whether all or any must be true.
protected List<Questionnaire.QuestionnaireItemEnableWhenComponent>	enableWhen	A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.
protected List<Questionnaire.QuestionnaireItemInitialComponent>	initial	One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.
protected List<Questionnaire.QuestionnaireItemComponent>	item	Text, questions and other groups to be nested beneath a question or group.
protected StringType	linkId	An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.
protected IntegerType	maxLength	The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.
protected StringType	prefix	A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.
protected BooleanType	readOnly	An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.
protected BooleanType	repeats	An indication, if true, that a QuestionnaireResponse for this item may include multiple answers associated with a single instance of this item (for question-type items) or multiple repetitions of the item (for group-type items).
protected BooleanType	required	An indication, if true, that the item must be present in a "completed" QuestionnaireResponse.
protected StringType	text	The name of a section, the text of a question or text content for a display item.
protected Enumeration<Questionnaire.QuestionnaireItemType>	type	The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, Coding, etc.).

Fields inherited from class org.hl7.fhir.r5.model.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.r5.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
QuestionnaireItemComponent()	Constructor
QuestionnaireItemComponent(String linkId, Questionnaire.QuestionnaireItemType type)	Constructor

Method Summary

Modifier and Type	Method	Description
Questionnaire.QuestionnaireItemAnswerOptionComponent	addAnswerOption()
Questionnaire.QuestionnaireItemComponent	addAnswerOption(Questionnaire.QuestionnaireItemAnswerOptionComponent t)
Base	addChild(String name)
Coding	addCode()
Questionnaire.QuestionnaireItemComponent	addCode(Coding t)
Questionnaire.QuestionnaireItemEnableWhenComponent	addEnableWhen()
Questionnaire.QuestionnaireItemComponent	addEnableWhen(Questionnaire.QuestionnaireItemEnableWhenComponent t)
Questionnaire.QuestionnaireItemInitialComponent	addInitial()
Questionnaire.QuestionnaireItemComponent	addInitial(Questionnaire.QuestionnaireItemInitialComponent t)
Questionnaire.QuestionnaireItemComponent	addItem()
Questionnaire.QuestionnaireItemComponent	addItem(Questionnaire.QuestionnaireItemComponent t)
boolean	containsQuestion(Questionnaire.QuestionnaireItemComponent q)
Questionnaire.QuestionnaireItemComponent	copy()
void	copyValues(Questionnaire.QuestionnaireItemComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Questionnaire.QuestionnaireAnswerConstraint	getAnswerConstraint()
Enumeration<Questionnaire.QuestionnaireAnswerConstraint>	getAnswerConstraintElement()
List<Questionnaire.QuestionnaireItemAnswerOptionComponent>	getAnswerOption()
Questionnaire.QuestionnaireItemAnswerOptionComponent	getAnswerOptionFirstRep()
String	getAnswerValueSet()
CanonicalType	getAnswerValueSetElement()
List<Coding>	getCode()
Coding	getCodeFirstRep()
Questionnaire.QuestionnaireItemComponent	getCommonGroup(Questionnaire.QuestionnaireItemComponent q1, Questionnaire.QuestionnaireItemComponent q2)
String	getDefinition()
UriType	getDefinitionElement()
Questionnaire.QuestionnaireItemDisabledDisplay	getDisabledDisplay()
Enumeration<Questionnaire.QuestionnaireItemDisabledDisplay>	getDisabledDisplayElement()
Questionnaire.EnableWhenBehavior	getEnableBehavior()
Enumeration<Questionnaire.EnableWhenBehavior>	getEnableBehaviorElement()
List<Questionnaire.QuestionnaireItemEnableWhenComponent>	getEnableWhen()
Questionnaire.QuestionnaireItemEnableWhenComponent	getEnableWhenFirstRep()
List<Questionnaire.QuestionnaireItemInitialComponent>	getInitial()
Questionnaire.QuestionnaireItemInitialComponent	getInitialFirstRep()
List<Questionnaire.QuestionnaireItemComponent>	getItem()
Questionnaire.QuestionnaireItemComponent	getItemFirstRep()
String	getLinkId()
StringType	getLinkIdElement()
int	getMaxLength()
IntegerType	getMaxLengthElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
String	getPrefix()
StringType	getPrefixElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
Questionnaire.QuestionnaireItemComponent	getQuestion(String linkId)
boolean	getReadOnly()
BooleanType	getReadOnlyElement()
boolean	getRepeats()
BooleanType	getRepeatsElement()
boolean	getRequired()
BooleanType	getRequiredElement()
String	getText()
StringType	getTextElement()
Questionnaire.QuestionnaireItemType	getType()
Enumeration<Questionnaire.QuestionnaireItemType>	getTypeElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAnswerConstraint()
boolean	hasAnswerConstraintElement()
boolean	hasAnswerOption()
boolean	hasAnswerValueSet()
boolean	hasAnswerValueSetElement()
boolean	hasCode()
boolean	hasDefinition()
boolean	hasDefinitionElement()
boolean	hasDisabledDisplay()
boolean	hasDisabledDisplayElement()
boolean	hasEnableBehavior()
boolean	hasEnableBehaviorElement()
boolean	hasEnableWhen()
boolean	hasInitial()
boolean	hasItem()
boolean	hasLinkId()
boolean	hasLinkIdElement()
boolean	hasMaxLength()
boolean	hasMaxLengthElement()
boolean	hasPrefix()
boolean	hasPrefixElement()
boolean	hasReadOnly()
boolean	hasReadOnlyElement()
boolean	hasRepeats()
boolean	hasRepeatsElement()
boolean	hasRequired()
boolean	hasRequiredElement()
boolean	hasText()
boolean	hasTextElement()
boolean	hasType()
boolean	hasTypeElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Questionnaire.QuestionnaireItemComponent	setAnswerConstraint(Questionnaire.QuestionnaireAnswerConstraint value)
Questionnaire.QuestionnaireItemComponent	setAnswerConstraintElement(Enumeration<Questionnaire.QuestionnaireAnswerConstraint> value)
Questionnaire.QuestionnaireItemComponent	setAnswerOption(List<Questionnaire.QuestionnaireItemAnswerOptionComponent> theAnswerOption)
Questionnaire.QuestionnaireItemComponent	setAnswerValueSet(String value)
Questionnaire.QuestionnaireItemComponent	setAnswerValueSetElement(CanonicalType value)
Questionnaire.QuestionnaireItemComponent	setCode(List<Coding> theCode)
Questionnaire.QuestionnaireItemComponent	setDefinition(String value)
Questionnaire.QuestionnaireItemComponent	setDefinitionElement(UriType value)
Questionnaire.QuestionnaireItemComponent	setDisabledDisplay(Questionnaire.QuestionnaireItemDisabledDisplay value)
Questionnaire.QuestionnaireItemComponent	setDisabledDisplayElement(Enumeration<Questionnaire.QuestionnaireItemDisabledDisplay> value)
Questionnaire.QuestionnaireItemComponent	setEnableBehavior(Questionnaire.EnableWhenBehavior value)
Questionnaire.QuestionnaireItemComponent	setEnableBehaviorElement(Enumeration<Questionnaire.EnableWhenBehavior> value)
Questionnaire.QuestionnaireItemComponent	setEnableWhen(List<Questionnaire.QuestionnaireItemEnableWhenComponent> theEnableWhen)
Questionnaire.QuestionnaireItemComponent	setInitial(List<Questionnaire.QuestionnaireItemInitialComponent> theInitial)
Questionnaire.QuestionnaireItemComponent	setItem(List<Questionnaire.QuestionnaireItemComponent> theItem)
Questionnaire.QuestionnaireItemComponent	setLinkId(String value)
Questionnaire.QuestionnaireItemComponent	setLinkIdElement(StringType value)
Questionnaire.QuestionnaireItemComponent	setMaxLength(int value)
Questionnaire.QuestionnaireItemComponent	setMaxLengthElement(IntegerType value)
Questionnaire.QuestionnaireItemComponent	setPrefix(String value)
Questionnaire.QuestionnaireItemComponent	setPrefixElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Questionnaire.QuestionnaireItemComponent	setReadOnly(boolean value)
Questionnaire.QuestionnaireItemComponent	setReadOnlyElement(BooleanType value)
Questionnaire.QuestionnaireItemComponent	setRepeats(boolean value)
Questionnaire.QuestionnaireItemComponent	setRepeatsElement(BooleanType value)
Questionnaire.QuestionnaireItemComponent	setRequired(boolean value)
Questionnaire.QuestionnaireItemComponent	setRequiredElement(BooleanType value)
Questionnaire.QuestionnaireItemComponent	setText(String value)
Questionnaire.QuestionnaireItemComponent	setTextElement(StringType value)
Questionnaire.QuestionnaireItemComponent	setType(Questionnaire.QuestionnaireItemType value)
Questionnaire.QuestionnaireItemComponent	setTypeElement(Enumeration<Questionnaire.QuestionnaireItemType> value)

Methods inherited from class org.hl7.fhir.r5.model.BackboneElement

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionValue, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r5.model.Element

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

getUserData, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

linkId

protected StringType linkId

An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.

definition

protected UriType definition

This element is a URI that refers to an [ElementDefinition](elementdefinition.html) or to an [ObservationDefinition](observationdefinition.html) that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in [Comments](questionnaire.html#definition), below.

code

protected List<Coding> code

A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).

prefix

protected StringType prefix

A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.

text

protected StringType text

The name of a section, the text of a question or text content for a display item.

type

protected Enumeration<Questionnaire.QuestionnaireItemType> type

The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, Coding, etc.).

enableWhen

protected List<Questionnaire.QuestionnaireItemEnableWhenComponent> enableWhen

A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.

enableBehavior

protected Enumeration<Questionnaire.EnableWhenBehavior> enableBehavior

Controls how multiple enableWhen values are interpreted - whether all or any must be true.

disabledDisplay

protected Enumeration<Questionnaire.QuestionnaireItemDisabledDisplay> disabledDisplay

Indicates if and how items that are disabled (because enableWhen evaluates to 'false') should be displayed.

required

protected BooleanType required

An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.

repeats

protected BooleanType repeats

An indication, if true, that a QuestionnaireResponse for this item may include multiple answers associated with a single instance of this item (for question-type items) or multiple repetitions of the item (for group-type items).

readOnly

protected BooleanType readOnly

An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.

maxLength

protected IntegerType maxLength

The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.

answerConstraint

protected Enumeration<Questionnaire.QuestionnaireAnswerConstraint> answerConstraint

For items that have a defined set of allowed answers (via answerOption or answerValueSet), indicates whether values *other* than those specified can be selected.

answerValueSet

protected CanonicalType answerValueSet

A reference to a value set containing a list of values representing permitted answers for a question.

answerOption

protected List<Questionnaire.QuestionnaireItemAnswerOptionComponent> answerOption

One of the permitted answers for the question.

initial

protected List<Questionnaire.QuestionnaireItemInitialComponent> initial

One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.

item

protected List<Questionnaire.QuestionnaireItemComponent> item

Text, questions and other groups to be nested beneath a question or group.

Constructor Details

QuestionnaireItemComponent

public QuestionnaireItemComponent()

Constructor

QuestionnaireItemComponent

public QuestionnaireItemComponent(String linkId,
 Questionnaire.QuestionnaireItemType type)

Constructor

Method Details

getLinkIdElement

public StringType getLinkIdElement()

Returns:

linkId (An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.). This is the underlying object with id, value and extensions. The accessor "getLinkId" gives direct access to the value

hasLinkIdElement

public boolean hasLinkIdElement()

hasLinkId

public boolean hasLinkId()

setLinkIdElement

public Questionnaire.QuestionnaireItemComponent setLinkIdElement(StringType value)

Parameters:

value - linkId (An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.). This is the underlying object with id, value and extensions. The accessor "getLinkId" gives direct access to the value

getLinkId

public String getLinkId()

Returns:

An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.

setLinkId

public Questionnaire.QuestionnaireItemComponent setLinkId(String value)

Parameters:

value - An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.

getDefinitionElement

public UriType getDefinitionElement()

Returns:

definition (This element is a URI that refers to an [ElementDefinition](elementdefinition.html) or to an [ObservationDefinition](observationdefinition.html) that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in [Comments](questionnaire.html#definition), below.). This is the underlying object with id, value and extensions. The accessor "getDefinition" gives direct access to the value

hasDefinitionElement

public boolean hasDefinitionElement()

hasDefinition

public boolean hasDefinition()

setDefinitionElement

public Questionnaire.QuestionnaireItemComponent setDefinitionElement(UriType value)

Parameters:

value - definition (This element is a URI that refers to an [ElementDefinition](elementdefinition.html) or to an [ObservationDefinition](observationdefinition.html) that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in [Comments](questionnaire.html#definition), below.). This is the underlying object with id, value and extensions. The accessor "getDefinition" gives direct access to the value

getDefinition

public String getDefinition()

Returns:

This element is a URI that refers to an [ElementDefinition](elementdefinition.html) or to an [ObservationDefinition](observationdefinition.html) that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in [Comments](questionnaire.html#definition), below.

setDefinition

public Questionnaire.QuestionnaireItemComponent setDefinition(String value)

Parameters:

value - This element is a URI that refers to an [ElementDefinition](elementdefinition.html) or to an [ObservationDefinition](observationdefinition.html) that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in [Comments](questionnaire.html#definition), below.

getCode

public List<Coding> getCode()

Returns:

code (A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).)

setCode

public Questionnaire.QuestionnaireItemComponent setCode(List<Coding> theCode)

Returns:

Returns a reference to this for easy method chaining

hasCode

public boolean hasCode()

addCode

public Coding addCode()

addCode

public Questionnaire.QuestionnaireItemComponent addCode(Coding t)

getCodeFirstRep

public Coding getCodeFirstRep()

Returns:

The first repetition of repeating field code, creating it if it does not already exist {3}

getPrefixElement

public StringType getPrefixElement()

Returns:

prefix (A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.). This is the underlying object with id, value and extensions. The accessor "getPrefix" gives direct access to the value

hasPrefixElement

public boolean hasPrefixElement()

hasPrefix

public boolean hasPrefix()

setPrefixElement

public Questionnaire.QuestionnaireItemComponent setPrefixElement(StringType value)

Parameters:

value - prefix (A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.). This is the underlying object with id, value and extensions. The accessor "getPrefix" gives direct access to the value

getPrefix

public String getPrefix()

Returns:

A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.

setPrefix

public Questionnaire.QuestionnaireItemComponent setPrefix(String value)

Parameters:

value - A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.

getTextElement

public StringType getTextElement()

Returns:

text (The name of a section, the text of a question or text content for a display item.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value

hasTextElement

public boolean hasTextElement()

hasText

public boolean hasText()

setTextElement

public Questionnaire.QuestionnaireItemComponent setTextElement(StringType value)

Parameters:

value - text (The name of a section, the text of a question or text content for a display item.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value

getText

public String getText()

Returns:

The name of a section, the text of a question or text content for a display item.

setText

public Questionnaire.QuestionnaireItemComponent setText(String value)

Parameters:

value - The name of a section, the text of a question or text content for a display item.

getTypeElement

public Enumeration<Questionnaire.QuestionnaireItemType> getTypeElement()

Returns:

type (The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, Coding, etc.).). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

hasTypeElement

public boolean hasTypeElement()

hasType

public boolean hasType()

setTypeElement

public Questionnaire.QuestionnaireItemComponent setTypeElement(Enumeration<Questionnaire.QuestionnaireItemType> value)

Parameters:

value - type (The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, Coding, etc.).). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

getType

public Questionnaire.QuestionnaireItemType getType()

Returns:

The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, Coding, etc.).

setType

public Questionnaire.QuestionnaireItemComponent setType(Questionnaire.QuestionnaireItemType value)

Parameters:

value - The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, Coding, etc.).

getEnableWhen

public List<Questionnaire.QuestionnaireItemEnableWhenComponent> getEnableWhen()

Returns:

enableWhen (A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.)

setEnableWhen

public Questionnaire.QuestionnaireItemComponent setEnableWhen(List<Questionnaire.QuestionnaireItemEnableWhenComponent> theEnableWhen)

Returns:

Returns a reference to this for easy method chaining

hasEnableWhen

public boolean hasEnableWhen()

addEnableWhen

public Questionnaire.QuestionnaireItemEnableWhenComponent addEnableWhen()

addEnableWhen

public Questionnaire.QuestionnaireItemComponent addEnableWhen(Questionnaire.QuestionnaireItemEnableWhenComponent t)

getEnableWhenFirstRep

public Questionnaire.QuestionnaireItemEnableWhenComponent getEnableWhenFirstRep()

Returns:

The first repetition of repeating field enableWhen, creating it if it does not already exist {3}

getEnableBehaviorElement

public Enumeration<Questionnaire.EnableWhenBehavior> getEnableBehaviorElement()

Returns:

enableBehavior (Controls how multiple enableWhen values are interpreted - whether all or any must be true.). This is the underlying object with id, value and extensions. The accessor "getEnableBehavior" gives direct access to the value

hasEnableBehaviorElement

public boolean hasEnableBehaviorElement()

hasEnableBehavior

public boolean hasEnableBehavior()

setEnableBehaviorElement

public Questionnaire.QuestionnaireItemComponent setEnableBehaviorElement(Enumeration<Questionnaire.EnableWhenBehavior> value)

Parameters:

value - enableBehavior (Controls how multiple enableWhen values are interpreted - whether all or any must be true.). This is the underlying object with id, value and extensions. The accessor "getEnableBehavior" gives direct access to the value

getEnableBehavior

public Questionnaire.EnableWhenBehavior getEnableBehavior()

Returns:

Controls how multiple enableWhen values are interpreted - whether all or any must be true.

setEnableBehavior

public Questionnaire.QuestionnaireItemComponent setEnableBehavior(Questionnaire.EnableWhenBehavior value)

Parameters:

value - Controls how multiple enableWhen values are interpreted - whether all or any must be true.

getDisabledDisplayElement

public Enumeration<Questionnaire.QuestionnaireItemDisabledDisplay> getDisabledDisplayElement()

Returns:

disabledDisplay (Indicates if and how items that are disabled (because enableWhen evaluates to 'false') should be displayed.). This is the underlying object with id, value and extensions. The accessor "getDisabledDisplay" gives direct access to the value

hasDisabledDisplayElement

public boolean hasDisabledDisplayElement()

hasDisabledDisplay

public boolean hasDisabledDisplay()

setDisabledDisplayElement

public Questionnaire.QuestionnaireItemComponent setDisabledDisplayElement(Enumeration<Questionnaire.QuestionnaireItemDisabledDisplay> value)

Parameters:

value - disabledDisplay (Indicates if and how items that are disabled (because enableWhen evaluates to 'false') should be displayed.). This is the underlying object with id, value and extensions. The accessor "getDisabledDisplay" gives direct access to the value

getDisabledDisplay

public Questionnaire.QuestionnaireItemDisabledDisplay getDisabledDisplay()

Returns:

Indicates if and how items that are disabled (because enableWhen evaluates to 'false') should be displayed.

setDisabledDisplay

public Questionnaire.QuestionnaireItemComponent setDisabledDisplay(Questionnaire.QuestionnaireItemDisabledDisplay value)

Parameters:

value - Indicates if and how items that are disabled (because enableWhen evaluates to 'false') should be displayed.

getRequiredElement

public BooleanType getRequiredElement()

Returns:

required (An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.). This is the underlying object with id, value and extensions. The accessor "getRequired" gives direct access to the value

hasRequiredElement

public boolean hasRequiredElement()

hasRequired

public boolean hasRequired()

setRequiredElement

public Questionnaire.QuestionnaireItemComponent setRequiredElement(BooleanType value)

Parameters:

value - required (An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.). This is the underlying object with id, value and extensions. The accessor "getRequired" gives direct access to the value

getRequired

public boolean getRequired()

Returns:

An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.

setRequired

public Questionnaire.QuestionnaireItemComponent setRequired(boolean value)

Parameters:

value - An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.

getRepeatsElement

public BooleanType getRepeatsElement()

Returns:

repeats (An indication, if true, that a QuestionnaireResponse for this item may include multiple answers associated with a single instance of this item (for question-type items) or multiple repetitions of the item (for group-type items).). This is the underlying object with id, value and extensions. The accessor "getRepeats" gives direct access to the value

hasRepeatsElement

public boolean hasRepeatsElement()

hasRepeats

public boolean hasRepeats()

setRepeatsElement

public Questionnaire.QuestionnaireItemComponent setRepeatsElement(BooleanType value)

Parameters:

value - repeats (An indication, if true, that a QuestionnaireResponse for this item may include multiple answers associated with a single instance of this item (for question-type items) or multiple repetitions of the item (for group-type items).). This is the underlying object with id, value and extensions. The accessor "getRepeats" gives direct access to the value

getRepeats

public boolean getRepeats()

Returns:

An indication, if true, that a QuestionnaireResponse for this item may include multiple answers associated with a single instance of this item (for question-type items) or multiple repetitions of the item (for group-type items).

setRepeats

public Questionnaire.QuestionnaireItemComponent setRepeats(boolean value)

Parameters:

value - An indication, if true, that a QuestionnaireResponse for this item may include multiple answers associated with a single instance of this item (for question-type items) or multiple repetitions of the item (for group-type items).

getReadOnlyElement

public BooleanType getReadOnlyElement()

Returns:

readOnly (An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.). This is the underlying object with id, value and extensions. The accessor "getReadOnly" gives direct access to the value

hasReadOnlyElement

public boolean hasReadOnlyElement()

hasReadOnly

public boolean hasReadOnly()

setReadOnlyElement

public Questionnaire.QuestionnaireItemComponent setReadOnlyElement(BooleanType value)

Parameters:

value - readOnly (An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.). This is the underlying object with id, value and extensions. The accessor "getReadOnly" gives direct access to the value

getReadOnly

public boolean getReadOnly()

Returns:

An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.

setReadOnly

public Questionnaire.QuestionnaireItemComponent setReadOnly(boolean value)

Parameters:

value - An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.

getMaxLengthElement

public IntegerType getMaxLengthElement()

Returns:

maxLength (The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.). This is the underlying object with id, value and extensions. The accessor "getMaxLength" gives direct access to the value

hasMaxLengthElement

public boolean hasMaxLengthElement()

hasMaxLength

public boolean hasMaxLength()

setMaxLengthElement

public Questionnaire.QuestionnaireItemComponent setMaxLengthElement(IntegerType value)

Parameters:

value - maxLength (The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.). This is the underlying object with id, value and extensions. The accessor "getMaxLength" gives direct access to the value

getMaxLength

public int getMaxLength()

Returns:

The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.

setMaxLength

public Questionnaire.QuestionnaireItemComponent setMaxLength(int value)

Parameters:

value - The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.

getAnswerConstraintElement

public Enumeration<Questionnaire.QuestionnaireAnswerConstraint> getAnswerConstraintElement()

Returns:

answerConstraint (For items that have a defined set of allowed answers (via answerOption or answerValueSet), indicates whether values *other* than those specified can be selected.). This is the underlying object with id, value and extensions. The accessor "getAnswerConstraint" gives direct access to the value

hasAnswerConstraintElement

public boolean hasAnswerConstraintElement()

hasAnswerConstraint

public boolean hasAnswerConstraint()

setAnswerConstraintElement

public Questionnaire.QuestionnaireItemComponent setAnswerConstraintElement(Enumeration<Questionnaire.QuestionnaireAnswerConstraint> value)

Parameters:

value - answerConstraint (For items that have a defined set of allowed answers (via answerOption or answerValueSet), indicates whether values *other* than those specified can be selected.). This is the underlying object with id, value and extensions. The accessor "getAnswerConstraint" gives direct access to the value

getAnswerConstraint

public Questionnaire.QuestionnaireAnswerConstraint getAnswerConstraint()

Returns:

For items that have a defined set of allowed answers (via answerOption or answerValueSet), indicates whether values *other* than those specified can be selected.

setAnswerConstraint

public Questionnaire.QuestionnaireItemComponent setAnswerConstraint(Questionnaire.QuestionnaireAnswerConstraint value)

Parameters:

value - For items that have a defined set of allowed answers (via answerOption or answerValueSet), indicates whether values *other* than those specified can be selected.

getAnswerValueSetElement

public CanonicalType getAnswerValueSetElement()

Returns:

answerValueSet (A reference to a value set containing a list of values representing permitted answers for a question.). This is the underlying object with id, value and extensions. The accessor "getAnswerValueSet" gives direct access to the value

hasAnswerValueSetElement

public boolean hasAnswerValueSetElement()

hasAnswerValueSet

public boolean hasAnswerValueSet()

setAnswerValueSetElement

public Questionnaire.QuestionnaireItemComponent setAnswerValueSetElement(CanonicalType value)

Parameters:

value - answerValueSet (A reference to a value set containing a list of values representing permitted answers for a question.). This is the underlying object with id, value and extensions. The accessor "getAnswerValueSet" gives direct access to the value

getAnswerValueSet

public String getAnswerValueSet()

Returns:

A reference to a value set containing a list of values representing permitted answers for a question.

setAnswerValueSet

public Questionnaire.QuestionnaireItemComponent setAnswerValueSet(String value)

Parameters:

value - A reference to a value set containing a list of values representing permitted answers for a question.

getAnswerOption

public List<Questionnaire.QuestionnaireItemAnswerOptionComponent> getAnswerOption()

Returns:

answerOption (One of the permitted answers for the question.)

setAnswerOption

public Questionnaire.QuestionnaireItemComponent setAnswerOption(List<Questionnaire.QuestionnaireItemAnswerOptionComponent> theAnswerOption)

Returns:

Returns a reference to this for easy method chaining

hasAnswerOption

public boolean hasAnswerOption()

addAnswerOption

public Questionnaire.QuestionnaireItemAnswerOptionComponent addAnswerOption()

addAnswerOption

public Questionnaire.QuestionnaireItemComponent addAnswerOption(Questionnaire.QuestionnaireItemAnswerOptionComponent t)

getAnswerOptionFirstRep

public Questionnaire.QuestionnaireItemAnswerOptionComponent getAnswerOptionFirstRep()

Returns:

The first repetition of repeating field answerOption, creating it if it does not already exist {3}

getInitial

public List<Questionnaire.QuestionnaireItemInitialComponent> getInitial()

Returns:

initial (One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.)

setInitial

public Questionnaire.QuestionnaireItemComponent setInitial(List<Questionnaire.QuestionnaireItemInitialComponent> theInitial)

Returns:

Returns a reference to this for easy method chaining

hasInitial

public boolean hasInitial()

addInitial

public Questionnaire.QuestionnaireItemInitialComponent addInitial()

addInitial

public Questionnaire.QuestionnaireItemComponent addInitial(Questionnaire.QuestionnaireItemInitialComponent t)

getInitialFirstRep

public Questionnaire.QuestionnaireItemInitialComponent getInitialFirstRep()

Returns:

The first repetition of repeating field initial, creating it if it does not already exist {3}

getItem

public List<Questionnaire.QuestionnaireItemComponent> getItem()

Returns:

item (Text, questions and other groups to be nested beneath a question or group.)

setItem

public Questionnaire.QuestionnaireItemComponent setItem(List<Questionnaire.QuestionnaireItemComponent> theItem)

Returns:

Returns a reference to this for easy method chaining

hasItem

public boolean hasItem()

addItem

public Questionnaire.QuestionnaireItemComponent addItem()

addItem

public Questionnaire.QuestionnaireItemComponent addItem(Questionnaire.QuestionnaireItemComponent t)

getItemFirstRep

public Questionnaire.QuestionnaireItemComponent getItemFirstRep()

Returns:

The first repetition of repeating field item, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public Questionnaire.QuestionnaireItemComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(Questionnaire.QuestionnaireItemComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneElement

Returns:

the FHIR type name of the instance (not the java class name)

getQuestion

public Questionnaire.QuestionnaireItemComponent getQuestion(String linkId)

getCommonGroup

public Questionnaire.QuestionnaireItemComponent getCommonGroup(Questionnaire.QuestionnaireItemComponent q1,
 Questionnaire.QuestionnaireItemComponent q2)

containsQuestion

public boolean containsQuestion(Questionnaire.QuestionnaireItemComponent q)