HS.FHIRModel.R4.QuestionnaireX.Item
class HS.FHIRModel.R4.QuestionnaireX.Item extends HS.FHIRModel.FHIRClassSuper
******************************************* QuestionnaireX.Item generated class schema
*****************************************
A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
Property Inventory
- _definition
- _enableBehavior
- _linkId
- _maxLength
- _prefix
- _readOnly
- _repeats
- _required
- _text
- _type
- answerOption
- answerValueSet
- code
- definition
- enableBehavior
- enableWhen
- extension
- fhirID
- initial
- item
- linkId
- maxLength
- modifierExtension
- prefix
- readOnly
- repeats
- required
- text
- type
Method Inventory
- IncludeAnswerOption()
- IncludeCode()
- IncludeEnableWhen()
- IncludeExtension()
- IncludeInitial()
- IncludeItem()
- IncludeModifierExtension()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_QUESTIONNAIREX_ITEM;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is
empty then the class name will be used to construct a default XML type.
The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.
Properties
property _definition as HS.FHIRModel.R4.Element;
Extensions for definition
Property methods: _definitionGet(), _definitionGetSwizzled(), _definitionIsValid(), _definitionNewObject(), _definitionSet()
property _enableBehavior as HS.FHIRModel.R4.Element;
Extensions for enableBehavior
Property methods: _enableBehaviorGet(), _enableBehaviorGetSwizzled(), _enableBehaviorIsValid(), _enableBehaviorNewObject(), _enableBehaviorSet()
property _linkId as HS.FHIRModel.R4.Element;
Extensions for linkId
Property methods: _linkIdGet(), _linkIdGetSwizzled(), _linkIdIsValid(), _linkIdNewObject(), _linkIdSet()
property _maxLength as HS.FHIRModel.R4.Element;
Extensions for maxLength
Property methods: _maxLengthGet(), _maxLengthGetSwizzled(), _maxLengthIsValid(), _maxLengthNewObject(), _maxLengthSet()
property _prefix as HS.FHIRModel.R4.Element;
Extensions for prefix
Property methods: _prefixGet(), _prefixGetSwizzled(), _prefixIsValid(), _prefixNewObject(), _prefixSet()
property _readOnly as HS.FHIRModel.R4.Element;
Extensions for readOnly
Property methods: _readOnlyGet(), _readOnlyGetSwizzled(), _readOnlyIsValid(), _readOnlyNewObject(), _readOnlySet()
property _repeats as HS.FHIRModel.R4.Element;
Extensions for repeats
Property methods: _repeatsGet(), _repeatsGetSwizzled(), _repeatsIsValid(), _repeatsNewObject(), _repeatsSet()
property _required as HS.FHIRModel.R4.Element;
Extensions for required
Property methods: _requiredGet(), _requiredGetSwizzled(), _requiredIsValid(), _requiredNewObject(), _requiredSet()
property _text as HS.FHIRModel.R4.Element;
Extensions for text
Property methods: _textGet(), _textGetSwizzled(), _textIsValid(), _textNewObject(), _textSet()
property _type as HS.FHIRModel.R4.Element;
Extensions for type
Property methods: _typeGet(), _typeGetSwizzled(), _typeIsValid(), _typeNewObject(), _typeSet()
property answerOption as HS.FHIRModel.R4.QuestionnaireX.SeqOfQuestionnaireXAnswerOption;
One of the permitted answers for a "choice" or "open-choice" question.
Property methods: answerOptionGet(), answerOptionGetSwizzled(), answerOptionIsValid(), answerOptionNewObject(), answerOptionSet()
property answerValueSet as %String;
A reference to a value set containing a list of codes representing
permitted answers for a "choice" or "open-choice" question.
Property methods: answerValueSetDisplayToLogical(), answerValueSetGet(), answerValueSetIsValid(), answerValueSetLogicalToDisplay(), answerValueSetLogicalToOdbc(), answerValueSetNormalize(), answerValueSetSet()
property code as HS.FHIRModel.R4.SeqOfCoding;
A terminology code that corresponds to this group or question (e.g.
a code from LOINC, which defines many questions and answers).
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property definition as %String;
This element is a URI that refers to an [[[ElementDefinition]]] 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, below. If this element is present then the
following element values MAY be derived from the Element Definition
if the corresponding elements of this Questionnaire resource instance
have no value: * code (ElementDefinition.code) * type (ElementDefinition.type)
* required (ElementDefinition.min) * repeats (ElementDefinition.max)
* maxLength (ElementDefinition.maxLength) * answerValueSet (ElementDefinition.binding) *
options (ElementDefinition.binding).
Property methods: definitionDisplayToLogical(), definitionGet(), definitionIsValid(), definitionLogicalToDisplay(), definitionLogicalToOdbc(), definitionNormalize(), definitionSet()
property enableBehavior as %String (VALUELIST = ",all,any");
Controls how multiple enableWhen values are interpreted - whether
all or any must be true.
Property methods: enableBehaviorDisplayToLogical(), enableBehaviorGet(), enableBehaviorIsValid(), enableBehaviorLogicalToDisplay(), enableBehaviorLogicalToOdbc(), enableBehaviorNormalize(), enableBehaviorSet()
property enableWhen as HS.FHIRModel.R4.QuestionnaireX.SeqOfQuestionnaireXEnableWhen;
A constraint indicating that this item should only be enabled (displayed/allow
answers to be captured) when the specified condition is true.
Property methods: enableWhenGet(), enableWhenGetSwizzled(), enableWhenIsValid(), enableWhenNewObject(), enableWhenSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the element. To make the use of extensions
safe and manageable, there is a strict set of governance applied
to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references).
This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property initial as HS.FHIRModel.R4.QuestionnaireX.SeqOfQuestionnaireXInitial;
One or more values that should be pre-populated in the answer when
initially rendering the questionnaire for user input.
Property methods: initialGet(), initialGetSwizzled(), initialIsValid(), initialNewObject(), initialSet()
property item as HS.FHIRModel.R4.QuestionnaireX.SeqOfQuestionnaireXItem;
Text, questions and other groups to be nested beneath a question
or group.
Property methods: itemGet(), itemGetSwizzled(), itemIsValid(), itemNewObject(), itemSet()
property linkId as %String;
An identifier that is unique within the Questionnaire allowing linkage
to the equivalent item in a QuestionnaireResponse resource.
Property methods: linkIdDisplayToLogical(), linkIdGet(), linkIdIsValid(), linkIdLogicalToDisplay(), linkIdLogicalToOdbc(), linkIdNormalize(), linkIdSet()
property maxLength as %Integer;
The maximum number of characters that are permitted in the answer
to be considered a "valid" QuestionnaireResponse.
Property methods: maxLengthDisplayToLogical(), maxLengthGet(), maxLengthIsValid(), maxLengthLogicalToDisplay(), maxLengthNormalize(), maxLengthSet(), maxLengthXSDToLogical()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the element and that modifies the understanding
of the element in which it is contained and/or the understanding
of the containing element's descendants. Usually modifier elements
provide negation or qualification. To make the use of extensions
safe and manageable, there is a strict set of governance applied
to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension. Applications
processing a resource are required to check for modifier extensions. Modifier
extensions SHALL NOT change the meaning of any elements on Resource
or DomainResource (including cannot change the meaning of modifierExtension
itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property prefix as %String;
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.
Property methods: prefixDisplayToLogical(), prefixGet(), prefixIsValid(), prefixLogicalToDisplay(), prefixLogicalToOdbc(), prefixNormalize(), prefixSet()
property readOnly as %Boolean;
An indication, when true, that the value cannot be changed by a human
respondent to the Questionnaire.
Property methods: readOnlyDisplayToLogical(), readOnlyGet(), readOnlyIsValid(), readOnlyLogicalToDisplay(), readOnlyLogicalToXSD(), readOnlyNormalize(), readOnlySet(), readOnlyXSDToLogical()
property repeats as %Boolean;
An indication, if true, that the item may occur multiple times in
the response, collecting multiple answers for questions or multiple
sets of answers for groups.
Property methods: repeatsDisplayToLogical(), repeatsGet(), repeatsIsValid(), repeatsLogicalToDisplay(), repeatsLogicalToXSD(), repeatsNormalize(), repeatsSet(), repeatsXSDToLogical()
property required as %Boolean;
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.
Property methods: requiredDisplayToLogical(), requiredGet(), requiredIsValid(), requiredLogicalToDisplay(), requiredLogicalToXSD(), requiredNormalize(), requiredSet(), requiredXSDToLogical()
property text as %String;
The name of a section, the text of a question or text content for
a display item.
Property methods: textDisplayToLogical(), textGet(), textIsValid(), textLogicalToDisplay(), textLogicalToOdbc(), textNormalize(), textSet()
property type as %String (VALUELIST = ",group,display,boolean,decimal,integer,date,dateTime,time,string,text,url,choice,open-choice,attachment,reference,quantity");
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, coded choice, etc.).
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
Methods
method IncludeAnswerOption()
method IncludeCode()
method IncludeEnableWhen()
method IncludeExtension()
method IncludeInitial()
method IncludeItem()
method IncludeModifierExtension()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.QuestionnaireX.Item
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()