| Assessment UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
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 |
"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.derivedFromThis field is included for comptability with FHIR. It is not expected that FHIM users would utilize this mechanism to define questions. |
«CS» Code | enableBehavior |
"Controls how multiple enableWhen values are interpreted - whether all or any must be true." - HL7 FHIR, Questionnaire.item.enableBehavior |
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 |
"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.typeNote 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 |
"An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource." - HL7 FHIR, Questionnaire.item.linkIdNote 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 |
"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 |
"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 Abstract | true |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | QuestionnaireItem |
Name Expression | |
Namespace | Assessment |
Owned Template Signature | |
Owner | Assessment |
Owning Template Parameter | |
Package | Assessment |
Qualified Name | FHIM::Assessment::QuestionnaireItem |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
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.derivedFromThis field is included for comptability with FHIR. It is not expected that FHIM users would utilize this mechanism to define questions.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | QuestionnaireItem |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | definition |
Name Expression | |
Namespace | QuestionnaireItem |
Opposite | |
Owner | QuestionnaireItem |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Assessment::QuestionnaireItem::definition |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Private «CS» Code enableBehavior
"Controls how multiple enableWhen values are interpreted - whether all or any must be true." - HL7 FHIR, Questionnaire.item.enableBehavior
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | QuestionnaireItem |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | enableBehavior |
Name Expression | |
Namespace | QuestionnaireItem |
Opposite | |
Owner | QuestionnaireItem |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Assessment::QuestionnaireItem::enableBehavior |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Private |
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
Aggregation | None |
Alias | |
Association | questionnaireItem_enableWhen |
Association End | |
Class | QuestionnaireItem |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | enableWhen |
Name Expression | |
Namespace | QuestionnaireItem |
Opposite | |
Owner | QuestionnaireItem |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Assessment::QuestionnaireItem::enableWhen |
Stereotype | |
Template Parameter | |
Type | EnableWhen |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.typeNote 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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | QuestionnaireItem |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | true |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | kind |
Name Expression | |
Namespace | QuestionnaireItem |
Opposite | |
Owner | QuestionnaireItem |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Assessment::QuestionnaireItem::kind |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.linkIdNote 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.]
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | QuestionnaireItem |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | linkId |
Name Expression | |
Namespace | QuestionnaireItem |
Opposite | |
Owner | QuestionnaireItem |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Assessment::QuestionnaireItem::linkId |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | QuestionnaireItem |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | prefix |
Name Expression | |
Namespace | QuestionnaireItem |
Opposite | |
Owner | QuestionnaireItem |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Assessment::QuestionnaireItem::prefix |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | QuestionnaireItem |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | text |
Name Expression | |
Namespace | QuestionnaireItem |
Opposite | |
Owner | QuestionnaireItem |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Assessment::QuestionnaireItem::text |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Assessment UML Documentation |
Summary:AttributesProperties | Detail:Attributes |