QuestionnaireItem constructor

const QuestionnaireItem({
  1. @JsonKey(name: 'id') String? fhirId,
  2. @JsonKey(name: 'extension') List<FhirExtension>? extension_,
  3. List<FhirExtension>? modifierExtension,
  4. String? linkId,
  5. @JsonKey(name: '_linkId') Element? linkIdElement,
  6. FhirUri? definition,
  7. @JsonKey(name: '_definition') Element? definitionElement,
  8. List<Coding>? code,
  9. String? prefix,
  10. @JsonKey(name: '_prefix') Element? prefixElement,
  11. String? text,
  12. @JsonKey(name: '_text') Element? textElement,
  13. FhirCode? type,
  14. @JsonKey(name: '_type') Element? typeElement,
  15. List<QuestionnaireEnableWhen>? enableWhen,
  16. FhirCode? enableBehavior,
  17. @JsonKey(name: '_enableBehavior') Element? enableBehaviorElement,
  18. FhirCode? disabledDisplay,
  19. @JsonKey(name: '_disabledDisplay') Element? disabledDisplayElement,
  20. @JsonKey(name: 'required') FhirBoolean? required_,
  21. @JsonKey(name: '_required') Element? requiredElement,
  22. FhirBoolean? repeats,
  23. @JsonKey(name: '_repeats') Element? repeatsElement,
  24. FhirBoolean? readOnly,
  25. @JsonKey(name: '_readOnly') Element? readOnlyElement,
  26. FhirInteger? maxLength,
  27. @JsonKey(name: '_maxLength') Element? maxLengthElement,
  28. FhirCode? answerConstraint,
  29. @JsonKey(name: '_answerConstraint') Element? answerConstraintElement,
  30. FhirCanonical? answerValueSet,
  31. List<QuestionnaireAnswerOption>? answerOption,
  32. List<QuestionnaireInitial>? initial,
  33. List<QuestionnaireItem>? item,
})

QuestionnaireItem 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.

id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extension_ ("extension") 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 managable, 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.

modifierExtension 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 managable, 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).

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

linkIdElement ("_linkId") Extensions for linkId

definition This element is a URI that refers to an ElementDefinition or to an ObservationDefinition 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.

definitionElement ("_definition") Extensions for definition

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

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.

prefixElement ("_prefix") Extensions for prefix

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

textElement ("_text") Extensions for text

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.).

typeElement ("_type") Extensions for type

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

enableBehavior Controls how multiple enableWhen values are interpreted

  • whether all or any must be true.

enableBehaviorElement ("_enableBehavior") Extensions for enableBehavior

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

disabledDisplayElement ("_disabledDisplay") Extensions for disabledDisplay

required_ ("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.

requiredElement ("_required") Extensions for required

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).

repeatsElement ("_repeats") Extensions for repeats

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

readOnlyElement ("_readOnly") Extensions for readOnly

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

maxLengthElement ("_maxLength") Extensions for maxLength

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.

answerConstraintElement ("_answerConstraint") Extensions for answerConstraint

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

answerOption One of the permitted answers for the question.

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

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

Implementation

const factory QuestionnaireItem({
  /// [id] Unique id for the element within a resource (for internal
  ///  references). This may be any string value that does not contain spaces.
  @JsonKey(name: 'id') String? fhirId,

  /// [extension_] ("extension") 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 managable, 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.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [modifierExtension] 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 managable, 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).
  List<FhirExtension>? modifierExtension,

  /// [linkId] An identifier that is unique within the Questionnaire allowing
  ///  linkage to the equivalent item in a QuestionnaireResponse resource.
  String? linkId,

  /// [linkIdElement] ("_linkId") Extensions for linkId
  @JsonKey(name: '_linkId') Element? linkIdElement,

  /// [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.
  FhirUri? definition,

  /// [definitionElement] ("_definition") Extensions for definition
  @JsonKey(name: '_definition') Element? definitionElement,

  /// [code] A terminology code that corresponds to this group or question
  ///  (e.g. a code from LOINC, which defines many questions and answers).
  List<Coding>? code,

  /// [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.
  String? prefix,

  /// [prefixElement] ("_prefix") Extensions for prefix
  @JsonKey(name: '_prefix') Element? prefixElement,

  /// [text] The name of a section, the text of a question or text content
  ///  for a display item.
  String? text,

  /// [textElement] ("_text") Extensions for text
  @JsonKey(name: '_text') Element? textElement,

  /// [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.).
  FhirCode? type,

  /// [typeElement] ("_type") Extensions for type
  @JsonKey(name: '_type') Element? typeElement,

  /// [enableWhen] A constraint indicating that this item should only be
  ///  enabled (displayed/allow answers to be captured) when the specified
  ///  condition is true.
  List<QuestionnaireEnableWhen>? enableWhen,

  /// [enableBehavior] Controls how multiple enableWhen values are
  ///  interpreted -  whether all or any must be true.
  FhirCode? enableBehavior,

  /// [enableBehaviorElement] ("_enableBehavior") Extensions for
  ///  enableBehavior
  @JsonKey(name: '_enableBehavior') Element? enableBehaviorElement,

  /// [disabledDisplay] Indicates if and how items that are disabled (because
  ///  enableWhen evaluates to 'false') should be displayed.
  FhirCode? disabledDisplay,

  /// [disabledDisplayElement] ("_disabledDisplay") Extensions for
  ///  disabledDisplay
  @JsonKey(name: '_disabledDisplay') Element? disabledDisplayElement,

  /// [required_] ("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.
  @JsonKey(name: 'required') FhirBoolean? required_,

  /// [requiredElement] ("_required") Extensions for required
  @JsonKey(name: '_required') Element? requiredElement,

  /// [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).
  FhirBoolean? repeats,

  /// [repeatsElement] ("_repeats") Extensions for repeats
  @JsonKey(name: '_repeats') Element? repeatsElement,

  /// [readOnly] An indication, when true, that the value cannot be changed
  ///  by a human respondent to the Questionnaire.
  FhirBoolean? readOnly,

  /// [readOnlyElement] ("_readOnly") Extensions for readOnly
  @JsonKey(name: '_readOnly') Element? readOnlyElement,

  /// [maxLength] The maximum number of characters that are permitted in the
  ///  answer to be considered a "valid" QuestionnaireResponse.
  FhirInteger? maxLength,

  /// [maxLengthElement] ("_maxLength") Extensions for maxLength
  @JsonKey(name: '_maxLength') Element? maxLengthElement,

  /// [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.
  FhirCode? answerConstraint,

  /// [answerConstraintElement] ("_answerConstraint") Extensions for
  ///  answerConstraint
  @JsonKey(name: '_answerConstraint') Element? answerConstraintElement,

  /// [answerValueSet] A reference to a value set containing a list of values
  ///  representing permitted answers for a question.
  FhirCanonical? answerValueSet,

  /// [answerOption] One of the permitted answers for the question.
  List<QuestionnaireAnswerOption>? answerOption,

  /// [initial] One or more values that should be pre-populated in the answer
  ///  when initially rendering the questionnaire for user input.
  List<QuestionnaireInitial>? initial,

  /// [item] Text, questions and other groups to be nested beneath a question
  ///  or group.
  List<QuestionnaireItem>? item,
}) = _QuestionnaireItem;