---
type: "resource-definitions"
title: "Questionnaire Definitions"
resource: "Questionnaire"
---
# Questionnaire Definitions
## Questionnaire
A structured set of questions
**Definition:** 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.
**Aliases:** Form, CRF, Survey
**Cardinality:** 0..*
**Constraints:** cnl-0 | warning | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'); que-2 | error | The link ids for groups and questions must be unique within the questionnaire | repeat(item).linkId.isDistinct()
**Mappings:** workflow=Definition; rim=Observation[moodCode=DEF]; w5=infrastructure.information
## Questionnaire.url
Canonical identifier for this questionnaire, represented as an absolute URI (globally unique)
**Definition:** An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers.
**Comments:** Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.
The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension.
Questionnaire.url SHOULD always be populated unless the Questionnaire is a contained resource (in which case it will be pointed to by the containing resource using id, not url. E.g. QuestionnaireResponse.questionnaire using '#[ContainedQuestionnaire.id]')
**Requirements:** Allows the questionnaire to be referenced by a single globally unique identifier.
This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for.
**Cardinality:** 0..1
**Type:** [uri](/uri)
**Summary:** true
**Constraints:** cnl-1 | warning | URL should not contain | or # - these characters make processing canonical references problematic | exists() implies matches('^[^|# ]+$')
**Mappings:** workflow=Definition.url; w5=FiveWs.identifier; rim=.identifier[scope=BUSN;reliability=ISS]
## Questionnaire.identifier
Business identifier for questionnaire
**Definition:** A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.
**Requirements:** Allows externally provided and/or usable business identifiers to be easily associated with the questionnaire.
**Cardinality:** 0..*
**Type:** [Identifier](/Identifier)
**Summary:** true
**Mappings:** workflow=Definition.identifier; w5=FiveWs.identifier; rim=.identifier; objimpl=no-gen-base
## Questionnaire.version
Business version of the questionnaire
**Definition:** The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
**Comments:** There may be different questionnaires that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the questionnaire with the format. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).
**Cardinality:** 0..1
**Type:** [string](/string)
**Summary:** true
**Mappings:** workflow=Definition.version; w5=FiveWs.version; rim=N/A (to add?)
## Questionnaire.versionAlgorithm[x]
How to compare versions
**Definition:** Indicates the mechanism used to compare versions to determine which is more current.
**Comments:** If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
**Cardinality:** 0..1
**Type:** [string](/string), [Coding](/Coding)
**Binding:** extensible:[version-algorithm](/valueset-version-algorithm)
**Summary:** true
**Mappings:** workflow=Definition.versionAlgorithm
## Questionnaire.name
Name for this questionnaire (computer friendly)
**Definition:** A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.
**Comments:** The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly.
**Requirements:** Supports code generation.
**Conditions:** cnl-0
**Cardinality:** 0..1
**Type:** [string](/string)
**Summary:** true
**Mappings:** workflow=Definition.name; rim=N/A
## Questionnaire.title
Name for this questionnaire (human friendly)
**Definition:** A short, descriptive, user-friendly title for the questionnaire.
**Comments:** This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
**Cardinality:** 0..1
**Type:** [string](/string)
**Summary:** true
**Mappings:** workflow=Definition.title; rim=.title
## Questionnaire.derivedFrom
Based on Questionnaire
**Definition:** The URL of a Questionnaire that this Questionnaire is based on.
**Comments:** This element covers a broad range of relationships, from 'somewhat inspired by' to 'fully compliant with'.
There is a standard extensionthat allows clearer differentiation between the specifics of the derivation relationship where
this is needed - e.g. to determine substitutability and validation expectations -
[[[http://hl7.org/fhir/StructureDefinition/questionnaire-derivationType]]].
**Requirements:** Allows a Questionnaire to be created based on another Questionnaire.
**Cardinality:** 0..*
**Type:** [canonical](/canonical)
**Summary:** true
**Mappings:** workflow=Definition.derivedFromCanonical; rim=.outboundRelationship[typeCode=DRIV].target[classCode=OBS, moodCode=DEFN]
## Questionnaire.status
draft | active | retired | unknown
**Definition:** The current state of this questionnaire.
**Comments:** A nominal state-transition diagram can be found in the] documentation
Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
**Requirements:** Enables tracking the lifecycle of the content and filtering of questionnaires that are appropriate for use versus not.
**Conditions:** que-1a
**Cardinality:** 1..1
**Type:** [code](/code)
**Binding:** required:[publication-status](/valueset-publication-status)
**Summary:** true
**Is Modifier:** true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
**Mappings:** workflow=Definition.status; w5=FiveWs.status; rim=.status
## Questionnaire.experimental
For testing only - never for real usage
**Definition:** A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.
**Comments:** Allows filtering of questionnaires that are appropriate for use versus not.. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc
**Requirements:** Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire.
**Meaning if Missing:** If absent, this resource is treated as though it is not experimental.
**Cardinality:** 0..1
**Type:** [boolean](/boolean)
**Summary:** true
**Mappings:** workflow=Definition.experimental; w5=FiveWs.class; rim=N/A
## Questionnaire.subjectType
Resource that can be subject of QuestionnaireResponse
**Definition:** The types of subjects that can be the subject of responses created for the questionnaire.
**Comments:** If none are specified, then the subject is unlimited.
**Requirements:** Allows enforcing that a QuestionnaireResponse only has a .subject element of the appropriate type.
**Cardinality:** 0..*
**Type:** [code](/code)
**Binding:** required:[resource-types](/valueset-resource-types)
**Summary:** true
**Mappings:** workflow=Definition.subject[x]; w5=FiveWs.subject,FiveWs.what[x]; rim=.outboundRelationship[typeCode=META].target[classCode=OBS, moodCode=DEFN, isCriterion=true].participation.role.classCode
## Questionnaire.date
Date last changed
**Definition:** The date (and optionally time) when the questionnaire was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes.
**Comments:** The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the questionnaire. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
**Aliases:** Revision Date
**Cardinality:** 0..1
**Type:** [dateTime](/dateTime)
**Summary:** true
**Mappings:** workflow=Definition.date; w5=FiveWs.recorded; rim=.participation[typeCode=AUT].time
## Questionnaire.publisher
Name of the publisher/steward (organization or individual)
**Definition:** The name of the organization or individual responsible for the release and ongoing maintenance of the questionnaire.
**Comments:** Usually an organization but may be an individual. The publisher (or steward) of the questionnaire is the organization or individual primarily responsible for the maintenance and upkeep of the questionnaire. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the questionnaire. This item SHOULD be populated unless the information is available from context.
**Requirements:** Helps establish the "authority/credibility" of the questionnaire. May also allow for contact.
**Cardinality:** 0..1
**Type:** [string](/string)
**Summary:** true
**Mappings:** workflow=Definition.publisher; w5=FiveWs.author; rim=.participation[typeCode=AUT].role
## Questionnaire.contact
Contact details for the publisher
**Definition:** Contact details to assist a user in finding and communicating with the publisher.
**Comments:** May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
**Cardinality:** 0..*
**Type:** [ContactDetail](/ContactDetail)
**Summary:** true
**Mappings:** workflow=Definition.contact; rim=.participation[typeCode=CALLBCK].role
## Questionnaire.description
Natural language description of the questionnaire
**Definition:** A free text natural language description of the questionnaire from a consumer's perspective.
**Comments:** This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the questionnaire as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context. (E.g. the language of the questionnaire is presumed to be the predominant language in the place the questionnaire was created).
**Cardinality:** 0..1
**Type:** [markdown](/markdown)
**Summary:** true
**Mappings:** workflow=Definition.description; rim=.text
## Questionnaire.useContext
The context that the content is intended to support
**Definition:** The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaires.
**Comments:** When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.
**Requirements:** Assist in searching for appropriate content.
**Cardinality:** 0..*
**Type:** [UsageContext](/UsageContext)
**Summary:** true
**Mappings:** workflow=Definition.useContext; rim=N/A (to add?)
## Questionnaire.jurisdiction
Jurisdiction of the authority that maintains the questionnaire (if applicable)
**Definition:** A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.
**Comments:** It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
**Cardinality:** 0..*
**Type:** [CodeableConcept](/CodeableConcept)
**Binding:** extensible:[jurisdiction](/valueset-jurisdiction)
**Summary:** true
**Mappings:** workflow=Definition.jurisdiction; rim=N/A (to add?)
## Questionnaire.purpose
Why this questionnaire is defined
**Definition:** Explanation of why this questionnaire is needed and why it has been designed as it has.
**Comments:** This element does not describe the usage of the questionnaire. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this questionnaire.
**Cardinality:** 0..1
**Type:** [markdown](/markdown)
**Mappings:** workflow=Definition.purpose; w5=FiveWs.why[x]; rim=.reasonCode.text; objimpl=no-gen-base
## Questionnaire.copyright
Notice about intellectual property ownership, can include restrictions on use
**Definition:** A copyright statement relating to the questionnaire and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the questionnaire.
**Requirements:** Consumers of the questionnaire must be able to determine any legal restrictions on the use of the artifact and/or its content.
**Aliases:** License, Restrictions
**Cardinality:** 0..1
**Type:** [markdown](/markdown)
**Mappings:** workflow=Definition.copyright; rim=N/A (to add?); objimpl=no-gen-base
## Questionnaire.copyrightLabel
Copyright holder and year(s)
**Definition:** A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').
**Comments:** The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
**Requirements:** Defines the content expected to be rendered in all representations of the artifact.
**Cardinality:** 0..1
**Type:** [string](/string)
**Mappings:** workflow=Definition.copyrightLabel
## Questionnaire.approvalDate
When the questionnaire was approved by publisher
**Definition:** The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
**Comments:** The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
**Cardinality:** 0..1
**Type:** [date](/date)
**Mappings:** workflow=Definition.approvalDate; rim=.outboundRelationship[typeCode="SUBJ"].act[classCode=CACT;moodCode=EVN;code="approval"].effectiveTime; objimpl=no-gen-base
## Questionnaire.lastReviewDate
When the questionnaire was last reviewed by the publisher
**Definition:** The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
**Comments:** If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
**Requirements:** Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
**Cardinality:** 0..1
**Type:** [date](/date)
**Mappings:** workflow=Definition.lastReviewDate; rim=.outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;moodCode=EVN;code="review"].effectiveTime; objimpl=no-gen-base
## Questionnaire.effectivePeriod
When the questionnaire is expected to be used
**Definition:** The period during which the questionnaire content was or is planned to be in active use.
**Comments:** The effective period for a questionnaire determines when the content is applicable for usage and is independent of publication and review dates. For example, a questionnaire intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
**Requirements:** Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the questionnaire are or are expected to be used instead.
**Cardinality:** 0..1
**Type:** [Period](/Period)
**Summary:** true
**Mappings:** workflow=Definition.effectivePeriod; rim=N/A (to add?); objimpl=no-gen-base
## Questionnaire.code
Concept that represents the overall questionnaire
**Definition:** An identifier for this collection of questions in a particular terminology such as LOINC.
**Requirements:** Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "panels" of questions to be identified by a code.
**Cardinality:** 0..*
**Type:** [Coding](/Coding)
**Binding:** example:[questionnaire-questions](/valueset-questionnaire-questions)
**Summary:** true
**Mappings:** rim=.code; workflow=Definition.code
## Questionnaire.item
Questions and sections within the Questionnaire
**Definition:** A particular question, question grouping or display text that is part of the questionnaire.
**Comments:** The content of the questionnaire is constructed from an ordered, hierarchical collection of items.
**Cardinality:** 0..*
**Type:** [BackboneElement](/BackboneElement)
**Constraints:** que-9 | error | Read-only can't be specified for "display" items | type!='display' or readOnly.empty(); que-8 | error | Initial values can't be specified for groups or display items | (type!='group' and type!='display') or initial.empty(); que-6 | error | Required and repeat aren't permitted for display items | type!='display' or (required.empty() and repeats.empty()); que-5 | error | Only coding, decimal, integer, date, dateTime, time, string, quantity, reference, or uri items can have answerOption | (('coding' | 'decimal' | 'integer' | 'date' | 'dateTime' | 'time' | 'string' | 'quantity' | 'reference' | 'uri') contains type) or answerOption.empty(); que-5b | error | Only coding, decimal, integer, date, dateTime, time, string or quantity items can have answerOption | (('coding' | 'string' | 'uri') contains type) or answerValueSet.empty(); que-4 | error | A question cannot have both answerOption and answerValueSet | answerOption.empty() or answerValueSet.empty(); que-3 | error | Display items cannot have a "code" asserted | type!='display' or code.empty(); que-10 | error | Maximum length can only be declared for simple question types | (type in ('string' | 'decimal' | 'integer' | 'text' | 'date' | 'dateTime' | 'time' | 'url')) or answerConstraint='optionOrString' or maxLength.empty(); que-1a | error | Group items must have nested items when Questionanire is active | (type='group' and %resource.status='active') implies item.empty().not(); que-1b | warning | Groups should have items | type='group' implies item.empty().not(); que-1c | error | Display items cannot have child items | type='display' implies item.empty(); que-13 | error | Can only have multiple initial values for repeating items | repeats=true or initial.count() <= 1; que-11 | error | If one or more answerOption is present, initial cannot be present. Use answerOption.initialSelected instead | answerOption.empty() or initial.empty(); que-12 | error | If there are more than one enableWhen, enableBehavior must be specified | enableWhen.count() > 1 implies enableBehavior.exists(); que-14 | warning | Can only have answerConstraint if answerOption or answerValueSet are present. (This is a warning because extensions may serve the same purpose) | answerConstraint.exists() implies answerOption.exists() or answerValueSet.exists(); que-17 | error | If question is non-repeating, cannot have more than one initialSelected answer option | repeats.not() implies answerOption.where(initialSelected=true).count() <= 1; que-18a | error | The types of any specified answerOptions must align with the item type | answerOption.value.exists() implies defineVariable('type', type).trace('type', %type).answerOption.value.type().name.distinct().select(iif($this='simplequantity', 'quantity', $this.lower())).where(%type!=$this and (%type='text' and $this='string').not() and (%type='url' and $this='uri').not()).trace('Unmatched answerOption type(s)').empty(); que-18b | error | The types of any specified initial values must align with the item type | initial.value.exists() implies defineVariable('type', type).trace('type', %type).initial.value.type().name.distinct().select(iif($this='simplequantity', 'quantity', $this.lower())).where(%type!=$this and (%type='text' and $this='string').not() and (%type='url' and $this='uri').not()).trace('Unmatched initial value type(s)').empty()
**Mappings:** rim=.outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=DEF]
## Questionnaire.item.linkId
Unique id for item in questionnaire
**Definition:** An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.
**Comments:** This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.
LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such
**Requirements:** [QuestionnaireResponse](questionnaireresponse.html#) does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient.
**Conditions:** que-2
**Cardinality:** 1..1
**Type:** [string](/string)
**Constraints:** que-15 | warning | Link ids should be 255 characters or less | $this.length() <= 255; que-16 | error | LinkId cannot have leading or trailing spaces or intevening whitespace other than single space characters | $this.matches('[^\\s]+( [^\\s]+)*')
**Mappings:** rim=.id
## Questionnaire.item.definition
ElementDefinition - details for the item
**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.
**Comments:** The uri refers to an ElementDefinition in a [StructureDefinition](structuredefinition.html#) or to an [ObservationDefinition](observationdefinition.html) and always starts with the [canonical URL](references.html#canonical) for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id [Element.id](types-definitions.html#Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. In the absence of a fragment identifier, the first/root element definition in the target is the matching element definition.
**Requirements:** A common pattern is to define a set of data elements and then build multiple questionnaires for different circumstances to gather the data. This element provides traceability to the common definition and allows the content for the question to come from the underlying definition.
**Cardinality:** 0..*
**Type:** [uri](/uri)
**Mappings:** rim=.outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]
## Questionnaire.item.code
Corresponding concept for this item in a terminology
**Definition:** A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).
**Comments:** The value may come from the ElementDefinition referred to by .definition.
**Requirements:** Allows linking of groups of questions to formal terminologies.
**Conditions:** que-3
**Cardinality:** 0..*
**Type:** [Coding](/Coding)
**Binding:** example:[questionnaire-questions](/valueset-questionnaire-questions)
**Mappings:** rim=.code
## Questionnaire.item.prefix
E.g. "1(a)", "2.5.3"
**Definition:** 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.
**Comments:** These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed. Typically, these won't be used for "display" items, though such use is not prohibited. Systems SHOULD NOT generate their own prefixes if prefixes are defined for any items within a Questionnaire.
**Requirements:** Separating the label from the question text allows improved rendering. Also, instructions will often refer to specific prefixes, so there's a need for the questionnaire design to have control over what labels are used.
**Aliases:** label
**Cardinality:** 0..1
**Type:** [string](/string)
**Mappings:** rim=Not supported
## Questionnaire.item.text
Primary text for the item
**Definition:** The name of a section, the text of a question or text content for a display item.
**Comments:** When using this element to represent the name of a section, use group type item and also make sure to limit the text element to a short string suitable for display as a section heading. Group item instructions should be included as a display type item within the group.
**Cardinality:** 0..1
**Type:** [string](/string)
**Mappings:** rim=.text
## Questionnaire.item.type
group | display | boolean | decimal | integer | date | dateTime +
**Definition:** 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.).
**Comments:** Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.
**Requirements:** Defines the format in which the user is to be prompted for the answer.
**Conditions:** que-9, que-8, que-6, que-5, que-3, que-10, que-1a, que-1b, que-1c
**Cardinality:** 1..1
**Type:** [code](/code)
**Binding:** required:[item-type-useable](/valueset-item-type-useable)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.enableWhen
Only allow data when
**Definition:** A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.
**Comments:** If multiple repetitions of this extension are present, the interpretation is driven by enableBehavior (either all repetitions must evaluate to true for this item to be enabled, or only one must evaluate to true for the item to be enabled). If the enableWhen.question has multiple answers, the condition evaluates to true if *any* of the answers for the referenced item match the enableWhen condition. This element is a modifier because if enableWhen is present for an item, "required" is ignored unless one of the enableWhen conditions is met. When an item is disabled, all of its descendants are disabled, regardless of what their own enableWhen logic might evaluate to. If enableWhen logic depends on an item that is disabled, the logic should proceed as though the item is not valued - even if a default value or other value might be retained in memory in the event of the item being re-enabled. In some cases, the comparison between the indicated answer and the specified value may differ only by precision. For example, the enableWhen might be Q1 > 1970, but the answer to Q1 is 1970-10-15. There is not a clear answer as to whether 1970-10-15 should be considered 'greater' than 1970, given that it is an imprecise value. In these indeterminate situations, the form filler has the option of refusing to render the form. If the form **is** displayed, items where enableWhen is indeterminate SHOULD be treated as enabled with a warning indicating that the questionnaire logic was faulty and it is possible that the item should not be enabled. Questionnaires SHOULD be designed to take into account challenges around varying precision to minimize non-deterministic situations by setting constraints around expected precision, etc.
**Requirements:** Allows questionnaires to adapt based on answers to other questions. E.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions.
**Conditions:** que-12
**Cardinality:** 0..*
**Type:** [BackboneElement](/BackboneElement)
**Is Modifier:** true (Reason: If enableWhen is present and the condition evaluates to false, then the Questionnaire behaves as though the elements weren't actually present)
**Constraints:** que-7 | error | If the operator is 'exists', the value must be a boolean | operator = 'exists' implies (answer is boolean); que-18 | warning | Referenced questions SHOULD exist in the Questionnaire (unless still in draft, working with modular forms, etc.) | question.exists() implies (%resource.repeat(item).linkId contains question)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.enableWhen.question
The linkId of question that determines whether item is enabled/disabled
**Definition:** The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.
**Comments:** If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the "ancestor" axis and then the "preceding" axis and then the "following" axis. If there are multiple items with the same linkId and all are equadistant (e.g. a question references a question that appears in a separate repeating group), that is an error. (Consider using the enableWhenExpression extension to define logic to handle such a situation.)
**Conditions:** que-18
**Cardinality:** 1..1
**Type:** [string](/string)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.enableWhen.operator
exists | = | != | > | < | >= | <=
**Definition:** Specifies the criteria by which the question is enabled.
**Conditions:** que-7
**Cardinality:** 1..1
**Type:** [code](/code)
**Binding:** required:[questionnaire-enable-operator](/valueset-questionnaire-enable-operator)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.enableWhen.answer[x]
Value for question comparison based on operator
**Definition:** A value that the referenced question is tested using the specified operator in order for the item to be enabled. If there are multiple answers, a match on any of the answers suffices. If different behavior is desired (all must match, at least 2 must match, etc.), consider using the enableWhenExpression extension.
**Conditions:** que-7
**Cardinality:** 1..1
**Type:** [boolean](/boolean), [decimal](/decimal), [integer](/integer), [date](/date), [dateTime](/dateTime), [time](/time), [string](/string), [Coding](/Coding), [SimpleQuantity](/SimpleQuantity), Reference([Resource](/Resource)), [uri](/uri), [Attachment](/Attachment)
**Binding:** example:[questionnaire-answers](/valueset-questionnaire-answers)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.enableBehavior
all | any
**Definition:** Controls how multiple enableWhen values are interpreted - whether all or any must be true.
**Comments:** This element must be specified if more than one enableWhen value is provided.
**Conditions:** que-12
**Cardinality:** 0..1
**Type:** [code](/code)
**Binding:** required:[questionnaire-enable-behavior](/valueset-questionnaire-enable-behavior)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.disabledDisplay
hidden | protected
**Definition:** Indicates if and how items that are disabled (because enableWhen evaluates to 'false') should be displayed.
**Comments:** If not specified, rendering behavior is up to the client. This element is only meaningful if enableWhen or an equivalent extension is present
**Cardinality:** 0..1
**Type:** [code](/code)
**Binding:** required:[questionnaire-disabled-display](/valueset-questionnaire-disabled-display)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.required
Whether the item must be included in data results
**Definition:** 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.
**Comments:** If the required item is a question, it must have a direct answer (i.e. an answer to the question itself, not merely answers to child questions) in order for the QuestionnaireResponse to be complete. If the required item is a group, it must have at least one descendant question which has an answer Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. It also only has meaning if the parent element is present. If a non-required 'group' item contains a 'required' question item, it's completely fine to omit the group (because it's not required) despite it having a required child. Similarly, if an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one descendant item with a populated answer). The value for 'required' may come from the ElementDefinition referred to by .definition.
**Meaning if Missing:** Items are assumed not to be required unless explicitly specified, though extensions may impose additional expectations
**Conditions:** que-6
**Cardinality:** 0..1
**Type:** [boolean](/boolean)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.repeats
Whether the item may repeat
**Definition:** 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).
**Comments:** If a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition (i.e. "repeat the question") or to simply allow entry/selection of multiple answers for the question (repeat the answers). Which is most appropriate visually may depend on the type of answer as well as whether there are nested items.
The resulting QuestionnaireResponse will be populated the same way regardless of rendering - one 'question' item with multiple answer values.
The value may come from the ElementDefinition referred to by .definition. When repeats=true for a group, it'll be represented with multiple items with the same linkId in the QuestionnaireResponse. For a question, it'll be represented by a single item with that linkId with multiple answers.
**Requirements:** Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.
**Meaning if Missing:** Items are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value
**Conditions:** que-6, que-13
**Cardinality:** 0..1
**Type:** [boolean](/boolean)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.readOnly
Don't allow human editing
**Definition:** An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.
**Comments:** If specified on a 'group', then all items beneath the specified group are read only. For questions, this only marks the answer associated with the specific item read only. Descendant questions are not impacted. The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers.
**Requirements:** Allows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc.
**Conditions:** que-9
**Cardinality:** 0..1
**Type:** [boolean](/boolean)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.maxLength
No more than these many characters
**Definition:** The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.
**Comments:** For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. The value may come from the ElementDefinition referred to by .definition.
**Conditions:** que-10
**Cardinality:** 0..1
**Type:** [integer](/integer)
**Mappings:** v2=N/A; rim=N/A - MIF rather than RIM level
## Questionnaire.item.answerConstraint
optionsOnly | optionsOrType | optionsOrString
**Definition:** For items that have a defined set of allowed answers (via answerOption or answerValueSet), indicates whether values *other* than those specified can be selected.
**Requirements:** Introduces the ability for questions to have 'other' answers
**Meaning if Missing:** If not specified, answerConstraint is presumed to be 'optionsOnly'
**Conditions:** que-10, que-14
**Cardinality:** 0..1
**Type:** [code](/code)
**Binding:** required:[questionnaire-answer-constraint](/valueset-questionnaire-answer-constraint)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.answerValueSet
ValueSet containing permitted answers
**Definition:** A reference to a value set containing a list of values representing permitted answers for a question.
**Comments:** LOINC defines many useful value sets for questionnaire responses. See [LOINC Answer Lists](https://terminology.hl7.org/LOINC.html). The value may come from the ElementDefinition referred to by .definition.
For items of type Coding, the value set indicates the allowed code + system matches. For items of type 'string' the display values in the value set expansion are taken as the allowed values for the item. For items of type 'uri', the code values in the value set expansion are taken as the allowed values for the item. If the ValueSet requires a terminology server to provide an expansion, a preferred terminology server can be provided with an [extension](https://www.hl7.org/fhir/extensions/StructureDefinition-preferredTerminologyServer.html) on the Questionnaire item, an ancestor item, or the Questionnaire root.
**Conditions:** que-5b, que-4, que-14
**Cardinality:** 0..1
**Type:** [canonical](/canonical)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.answerOption
Permitted answer
**Definition:** One of the permitted answers for the question.
**Comments:** This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes.
**Conditions:** que-5, que-4, que-11, que-14
**Cardinality:** 0..*
**Type:** [BackboneElement](/BackboneElement)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.answerOption.value[x]
Answer value
**Definition:** A potential answer that's allowed as the answer to this question.
**Comments:** The data type of the value must agree with the item.type.
**Conditions:** que-18a
**Cardinality:** 1..1
**Type:** [decimal](/decimal), [integer](/integer), [date](/date), [dateTime](/dateTime), [time](/time), [string](/string), [uri](/uri), [Coding](/Coding), [SimpleQuantity](/SimpleQuantity), Reference([Resource](/Resource))
**Binding:** example:[questionnaire-answers](/valueset-questionnaire-answers)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.answerOption.initialSelected
Whether option is selected by default
**Definition:** Indicates whether the answer value is selected when the list of possible answers is initially shown.
**Meaning if Missing:** Only selected items explicitly marked to be selected
**Conditions:** que-17
**Cardinality:** 0..1
**Type:** [boolean](/boolean)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.initial
Initial value(s) when item is first rendered
**Definition:** One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.
**Comments:** The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. Note that initial values can influence results. The data type of initial.answer[x] must agree with the item.type, and only repeating items can have more then one initial value.
**Requirements:** In some workflows, having defaults saves time.
**Conditions:** que-8, que-13, que-11
**Cardinality:** 0..*
**Type:** [BackboneElement](/BackboneElement)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.initial.value[x]
Actual value for initializing the question
**Definition:** The actual value to for an initial answer.
**Comments:** The type of the initial value must be consistent with the type of the item.
**Conditions:** que-18b
**Cardinality:** 1..1
**Type:** [boolean](/boolean), [decimal](/decimal), [integer](/integer), [date](/date), [dateTime](/dateTime), [time](/time), [string](/string), [uri](/uri), [Attachment](/Attachment), [Coding](/Coding), [SimpleQuantity](/SimpleQuantity), Reference([Resource](/Resource))
**Binding:** example:[questionnaire-answers](/valueset-questionnaire-answers)
**Mappings:** rim=N/A - MIF rather than RIM level
## Questionnaire.item.item
Nested questionnaire items
**Definition:** Text, questions and other groups to be nested beneath a question or group.
**Comments:** There is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting.
**Requirements:** Reports can consist of complex nested groups.
**Cardinality:** 0..*
**Mappings:** rim=.outboundRelationship[typeCode=COMP].target