Assessment
Class QuestionnaireItem

A question, question-group, or display text element that make up a given Assessment Instrument. This abstract supertype contains that which is common to questions, question-groups and display-text elements.
"A particular question, question grouping or display text that is part of the questionnaire." - HL7 FHIR, Questionnaire.item

Attributes
String definition definition

"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)." - HL7 FHIR, Questionnaire.derivedFrom
This field is included for comptability with FHIR. It is not expected that FHIM users would utilize this mechanism to define questions.

«CS» Code enableBehavior enableBehavior

"Controls how multiple enableWhen values are interpreted - whether all or any must be true." - HL7 FHIR, Questionnaire.item.enableBehavior

EnableWhen enableWhen enableWhen

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

«CS» Code kind kind

"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.)." - HL7 FHIR, Questionnaire.item.type
Note that FHIR has a single structure (called Item), which could be a Display Text, Group, or a Question; this required property is then used to indicate which type is represented in that one structure. In the FHIM this distinction is handled via subtypes, so it is not needed. Therefore this property is included purely for FHIR compatibility and is marked as derived and is optional.

String linkId linkId

"An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource." - HL7 FHIR, Questionnaire.item.linkId

Note that this is a required field in FHIR that is used to link a Questionnaire Response to its corresponding question. In the FHIM, this is handled through a pointer from the QuestionnaireResponse to the AssessmentInstrumentQuestion instance, and would ordinarily not be modeled further, as the FHIM is a logical model and is not concerned with implementation details. Nevertheless, this field is included for compatibility with FHIR, but we made it optional. [In a database, this would hold the primary key of the AssessmentInstrumentQuestion record, while the QuestionnaireResponse record would have a foreign key pointing to this record.]

String prefix 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." - HL7 FHIR, Questionnaire.item.prefix

String text text

"The name of a section, the text of a question or text content for a display item." - HL7 FHIR, Questionnaire.item.text


Properties:

Alias
Classifier Behavior
Is Abstracttrue
Is Activefalse
Is Leaffalse
Keywords
NameQuestionnaireItem
Name Expression
NamespaceAssessment
Owned Template Signature
OwnerAssessment
Owning Template Parameter
PackageAssessment
Qualified NameFHIM::Assessment::QuestionnaireItem
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 definition
Public String definition

"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)." - HL7 FHIR, Questionnaire.derivedFrom
This field is included for comptability with FHIR. It is not expected that FHIM users would utilize this mechanism to define questions.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassQuestionnaireItem
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namedefinition
Name Expression
NamespaceQuestionnaireItem
Opposite
OwnerQuestionnaireItem
Owning Association
Owning Template Parameter
Qualified NameFHIM::Assessment::QuestionnaireItem::definition
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 enableBehavior
Private «CS» Code enableBehavior

"Controls how multiple enableWhen values are interpreted - whether all or any must be true." - HL7 FHIR, Questionnaire.item.enableBehavior

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassQuestionnaireItem
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameenableBehavior
Name Expression
NamespaceQuestionnaireItem
Opposite
OwnerQuestionnaireItem
Owning Association
Owning Template Parameter
Qualified NameFHIM::Assessment::QuestionnaireItem::enableBehavior
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPrivate


 enableWhen
Public EnableWhen enableWhen

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

Constraints:
Properties:

AggregationNone
Alias
AssociationquestionnaireItem_enableWhen
Association End
ClassQuestionnaireItem
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameenableWhen
Name Expression
NamespaceQuestionnaireItem
Opposite
OwnerQuestionnaireItem
Owning Association
Owning Template Parameter
Qualified NameFHIM::Assessment::QuestionnaireItem::enableWhen
Stereotype
Template Parameter
TypeEnableWhen
Upper*
Upper Value(*)
VisibilityPublic


 kind
Public «CS» Code kind

"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.)." - HL7 FHIR, Questionnaire.item.type
Note that FHIR has a single structure (called Item), which could be a Display Text, Group, or a Question; this required property is then used to indicate which type is represented in that one structure. In the FHIM this distinction is handled via subtypes, so it is not needed. Therefore this property is included purely for FHIR compatibility and is marked as derived and is optional.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassQuestionnaireItem
Datatype
Default
Default Value
Is Compositefalse
Is Derivedtrue
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namekind
Name Expression
NamespaceQuestionnaireItem
Opposite
OwnerQuestionnaireItem
Owning Association
Owning Template Parameter
Qualified NameFHIM::Assessment::QuestionnaireItem::kind
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 linkId
Public String linkId

"An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource." - HL7 FHIR, Questionnaire.item.linkId

Note that this is a required field in FHIR that is used to link a Questionnaire Response to its corresponding question. In the FHIM, this is handled through a pointer from the QuestionnaireResponse to the AssessmentInstrumentQuestion instance, and would ordinarily not be modeled further, as the FHIM is a logical model and is not concerned with implementation details. Nevertheless, this field is included for compatibility with FHIR, but we made it optional. [In a database, this would hold the primary key of the AssessmentInstrumentQuestion record, while the QuestionnaireResponse record would have a foreign key pointing to this record.]

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassQuestionnaireItem
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamelinkId
Name Expression
NamespaceQuestionnaireItem
Opposite
OwnerQuestionnaireItem
Owning Association
Owning Template Parameter
Qualified NameFHIM::Assessment::QuestionnaireItem::linkId
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 prefix
Public String 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." - HL7 FHIR, Questionnaire.item.prefix

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassQuestionnaireItem
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameprefix
Name Expression
NamespaceQuestionnaireItem
Opposite
OwnerQuestionnaireItem
Owning Association
Owning Template Parameter
Qualified NameFHIM::Assessment::QuestionnaireItem::prefix
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 text
Public String text

"The name of a section, the text of a question or text content for a display item." - HL7 FHIR, Questionnaire.item.text

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassQuestionnaireItem
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nametext
Name Expression
NamespaceQuestionnaireItem
Opposite
OwnerQuestionnaireItem
Owning Association
Owning Template Parameter
Qualified NameFHIM::Assessment::QuestionnaireItem::text
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic