Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

FHIR Infrastructure icon Work GroupMaturity Level: 5 Trial UseSecurity Category: Business Compartments: No defined compartments

Detailed Descriptions for the elements in the Questionnaire resource.

Questionnaire
Element IdQuestionnaire
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.

Short DisplayA structured set of questions
Cardinality0..*
TypeMetadataResource
Requirements

To support structured, hierarchical registration of data gathered using digital forms and other questionnaires. Questionnaires provide greater control over presentation and allow capture of data in a domain-independent way (i.e. capturing information that would otherwise require multiple distinct types of resources).

Alternate NamesForm; CRF; Survey
Summaryfalse
Invariants
Defined on this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
que-2Rule The link ids for groups and questions must be unique within the questionnairedescendants().linkId.isDistinct()
Questionnaire.url
Element IdQuestionnaire.url
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.

Short DisplayCanonical identifier for this questionnaire, represented as an absolute URI (globally unique)
Cardinality0..1
Typeuri
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.

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

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

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
Questionnaire.identifier
Element IdQuestionnaire.identifier
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.

Short DisplayBusiness identifier for questionnaire
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the questionnaire.

Summarytrue
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this questionnaire outside of FHIR, where it is not possible to use the logical URI.

Questionnaire.version
Element IdQuestionnaire.version
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.

Short DisplayBusiness version of the questionnaire
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
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.

Questionnaire.versionAlgorithm[x]
Element IdQuestionnaire.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which is more current.

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
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.

Questionnaire.name
Element IdQuestionnaire.name
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.

Short DisplayName for this questionnaire (computer friendly)
Cardinality0..1
Typestring
Requirements

Supports code generation.

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

Invariants
Affect this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
Questionnaire.title
Element IdQuestionnaire.title
Definition

A short, descriptive, user-friendly title for the questionnaire.

Short DisplayName for this questionnaire (human friendly)
Cardinality0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Questionnaire.derivedFrom
Element IdQuestionnaire.derivedFrom
Definition

The URL of a Questionnaire that this Questionnaire is based on.

Short DisplayBased on Questionnaire
Cardinality0..*
Typecanonical(Questionnaire)
Requirements

Allows a Questionnaire to be created based on another Questionnaire.

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

Questionnaire.status
Element IdQuestionnaire.status
Definition

The current state of this questionnaire.

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Requirements

Enables tracking the lifecycle of the content and filtering of questionnaires that are appropriate for use versus not.

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

Invariants
Affect this element
que-1aRule Group items must have nested items when Questionanire is complete(type='group' and %resource.status='complete') implies item.empty().not()
Questionnaire.experimental
Element IdQuestionnaire.experimental
Definition

A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.

Short DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire.

Summarytrue
Comments

Allows filtering of questionnaires that are appropriate for use versus not.

Questionnaire.subjectType
Element IdQuestionnaire.subjectType
Definition

The types of subjects that can be the subject of responses created for the questionnaire.

Short DisplayResource that can be subject of QuestionnaireResponse
Cardinality0..*
Terminology BindingResource Types (Required)
Typecode
Requirements

Allows enforcing that a QuestionnaireResponse only has a .subject element of the appropriate type.

Summarytrue
Comments

If none are specified, then the subject is unlimited.

Questionnaire.date
Element IdQuestionnaire.date
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.

Short DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
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.

Questionnaire.publisher
Element IdQuestionnaire.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the questionnaire.

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the questionnaire. May also allow for contact.

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

Questionnaire.contact
Element IdQuestionnaire.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

Questionnaire.description
Element IdQuestionnaire.description
Definition

A free text natural language description of the questionnaire from a consumer's perspective.

Short DisplayNatural language description of the questionnaire
Cardinality0..1
Typemarkdown
Summarytrue
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).

Questionnaire.useContext
Element IdQuestionnaire.useContext
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.

Short DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.

Questionnaire.jurisdiction
Standards StatusThis element has a standards status of "Deprecated" which is different from the status of the whole resource
Element IdQuestionnaire.jurisdiction
Definition

A legal or geographic region in which the questionnaire is intended to be used.

Short DisplayIntended jurisdiction for questionnaire (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
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.)

Questionnaire.purpose
Element IdQuestionnaire.purpose
Definition

Explanation of why this questionnaire is needed and why it has been designed as it has.

Short DisplayWhy this questionnaire is defined
Cardinality0..1
Typemarkdown
Summaryfalse
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.

Questionnaire.copyright
Element IdQuestionnaire.copyright
Definition

A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.

Short DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

Consumers of the questionnaire must be able to determine any legal restrictions on the use of the artifact and/or its content.

Alternate NamesLicense; Restrictions
Summaryfalse
Questionnaire.copyrightLabel
Element IdQuestionnaire.copyrightLabel
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 resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Summaryfalse
Comments

The (c) symbol 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.

Questionnaire.approvalDate
Element IdQuestionnaire.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Short DisplayWhen the questionnaire was approved by publisher
Cardinality0..1
Typedate
Summaryfalse
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.

Questionnaire.lastReviewDate
Element IdQuestionnaire.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Short DisplayWhen the questionnaire was last reviewed by the publisher
Cardinality0..1
Typedate
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.

Summaryfalse
Comments

If specified, this date follows the original approval date.

See guidance around (not) making local changes to elements here.

Questionnaire.effectivePeriod
Element IdQuestionnaire.effectivePeriod
Definition

The period during which the questionnaire content was or is planned to be in active use.

Short DisplayWhen the questionnaire is expected to be used
Cardinality0..1
TypePeriod
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.

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

Questionnaire.code
Element IdQuestionnaire.code
Definition

An identifier for this collection of questions in a particular terminology such as LOINC.

Short DisplayConcept that represents the overall questionnaire
Cardinality0..*
Terminology BindingQuestionnaire Question Codes (Example)
TypeCoding
Requirements

Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "panels" of questions to be identified by a code.

Summarytrue
Questionnaire.item
Element IdQuestionnaire.item
Definition

A particular question, question grouping or display text that is part of the questionnaire.

Short DisplayQuestions and sections within the Questionnaire
Cardinality0..*
Summaryfalse
Comments

The content of the questionnaire is constructed from an ordered, hierarchical collection of items.

Invariants
Defined on this element
que-1aRule Group items must have nested items when Questionanire is complete(type='group' and %resource.status='complete') implies item.empty().not()
que-1bWarning Groups should have itemstype='group' implies item.empty().not()
que-1cRule Display items cannot have child itemstype='display' implies item.empty()
que-3Rule Display items cannot have a "code" assertedtype!='display' or code.empty()
que-4Rule A question cannot have both answerOption and answerValueSetanswerOption.empty() or answerValueSet.empty()
que-5Rule Only coding, decimal, integer, date, dateTime, time, string or quantity items can have answerOption or answerValueSet(type='coding' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())
que-6Rule Required and repeat aren't permitted for display itemstype!='display' or (required.empty() and repeats.empty())
que-8Rule Initial values can't be specified for groups or display items(type!='group' and type!='display') or initial.empty()
que-9Rule Read-only can't be specified for "display" itemstype!='display' or readOnly.empty()
que-10Rule Maximum length can only be declared for simple question types(type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or answerConstraint='optionOrString' or maxLength.empty()
que-11Rule If one or more answerOption is present, initial cannot be present. Use answerOption.initialSelected insteadanswerOption.empty() or initial.empty()
que-12Rule If there are more than one enableWhen, enableBehavior must be specifiedenableWhen.count() > 1 implies enableBehavior.exists()
que-13Rule Can only have multiple initial values for repeating itemsrepeats=true or initial.count() <= 1
que-14Warning 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()
Questionnaire.item.linkId
Element IdQuestionnaire.item.linkId
Definition

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

Short DisplayUnique id for item in questionnaire
Cardinality1..1
Typestring
Requirements

QuestionnaireResponse does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient.

Summaryfalse
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

Invariants
Defined on this element
que-15Warning Link ids should be 255 characters or less$this.length() <= 255
Affect this element
que-2Rule The link ids for groups and questions must be unique within the questionnairedescendants().linkId.isDistinct()
Questionnaire.item.definition
Element IdQuestionnaire.item.definition
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.

Short DisplayElementDefinition - details for the item
Cardinality0..1
Typeuri
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.

Summaryfalse
Comments

The uri refers to an ElementDefinition in a StructureDefinition or to an ObservationDefinition and always starts with the canonical URL for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id 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.

Questionnaire.item.code
Element IdQuestionnaire.item.code
Definition

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

Short DisplayCorresponding concept for this item in a terminology
Cardinality0..*
Terminology BindingQuestionnaire Question Codes (Example)
TypeCoding
Requirements

Allows linking of groups of questions to formal terminologies.

Summaryfalse
Comments

The value may come from the ElementDefinition referred to by .definition.

Invariants
Affect this element
que-3Rule Display items cannot have a "code" assertedtype!='display' or code.empty()
Questionnaire.item.prefix
Element IdQuestionnaire.item.prefix
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.

Short DisplayE.g. "1(a)", "2.5.3"
Cardinality0..1
Typestring
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.

Alternate Nameslabel
Summaryfalse
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.

Questionnaire.item.text
Element IdQuestionnaire.item.text
Definition

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

Short DisplayPrimary text for the item
Cardinality0..1
Typestring
Summaryfalse
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.

Questionnaire.item.type
Element IdQuestionnaire.item.type
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.).

Short Displaygroup | display | boolean | decimal | integer | date | dateTime +
Cardinality1..1
Terminology BindingQuestionnaire Item Type (Required)
Typecode
Requirements

Defines the format in which the user is to be prompted for the answer.

Summaryfalse
Comments

Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.

Invariants
Affect this element
que-9Rule Read-only can't be specified for "display" itemstype!='display' or readOnly.empty()
que-8Rule Initial values can't be specified for groups or display items(type!='group' and type!='display') or initial.empty()
que-6Rule Required and repeat aren't permitted for display itemstype!='display' or (required.empty() and repeats.empty())
que-5Rule Only coding, decimal, integer, date, dateTime, time, string or quantity items can have answerOption or answerValueSet(type='coding' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())
que-3Rule Display items cannot have a "code" assertedtype!='display' or code.empty()
que-10Rule Maximum length can only be declared for simple question types(type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or answerConstraint='optionOrString' or maxLength.empty()
que-1aRule Group items must have nested items when Questionanire is complete(type='group' and %resource.status='complete') implies item.empty().not()
que-1bWarning Groups should have itemstype='group' implies item.empty().not()
que-1cRule Display items cannot have child itemstype='display' implies item.empty()
Questionnaire.item.enableWhen
Element IdQuestionnaire.item.enableWhen
Definition

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

Short DisplayOnly allow data when
Cardinality0..*
Is Modifiertrue (Reason: If enableWhen is present and the condition evaluates to false, then the Questionnaire behaves as though the elements weren't actually present)
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.

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

Invariants
Defined on this element
que-7Rule If the operator is 'exists', the value must be a booleanoperator = 'exists' implies (answer is boolean)
Affect this element
que-12Rule If there are more than one enableWhen, enableBehavior must be specifiedenableWhen.count() > 1 implies enableBehavior.exists()
Questionnaire.item.enableWhen.question
Element IdQuestionnaire.item.enableWhen.question
Definition

The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.

Short DisplayThe linkId of question that determines whether item is enabled/disabled
Cardinality1..1
Typestring
Summaryfalse
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.)

Questionnaire.item.enableWhen.operator
Element IdQuestionnaire.item.enableWhen.operator
Definition

Specifies the criteria by which the question is enabled.

Short Displayexists | = | != | > | < | >= | <=
Cardinality1..1
Terminology BindingQuestionnaire Item Operator (Required)
Typecode
Summaryfalse
Invariants
Affect this element
que-7Rule If the operator is 'exists', the value must be a booleanoperator = 'exists' implies (answer is boolean)
Questionnaire.item.enableWhen.answer[x]
Element IdQuestionnaire.item.enableWhen.answer[x]
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.

Short DisplayValue for question comparison based on operator
Cardinality1..1
Terminology BindingQuestionnaire Answer Codes (Example)
Typeboolean|decimal|integer|date|dateTime|time|string|Coding|Quantity|Reference(Any)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
Invariants
Affect this element
que-7Rule If the operator is 'exists', the value must be a booleanoperator = 'exists' implies (answer is boolean)
Questionnaire.item.enableBehavior
Element IdQuestionnaire.item.enableBehavior
Definition

Controls how multiple enableWhen values are interpreted - whether all or any must be true.

Short Displayall | any
Cardinality0..1
Terminology BindingEnable When Behavior (Required)
Typecode
Summaryfalse
Comments

This element must be specified if more than one enableWhen value is provided.

Invariants
Affect this element
que-12Rule If there are more than one enableWhen, enableBehavior must be specifiedenableWhen.count() > 1 implies enableBehavior.exists()
Questionnaire.item.disabledDisplay
Element IdQuestionnaire.item.disabledDisplay
Definition

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

Short Displayhidden | protected
Cardinality0..1
Terminology BindingQuestionnaire Item Disabled Display (Required)
Typecode
Summaryfalse
Comments

If not specified, rendering behavior is up to the client. This element is only meaningful if enableWhen or an equivalent extension is present

Questionnaire.item.required
Element IdQuestionnaire.item.required
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.

Short DisplayWhether the item must be included in data results
Cardinality0..1
Typeboolean
Meaning if MissingItems are assumed not to be required unless explicitly specified, though extensions may impose additional expectations
Summaryfalse
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.

Invariants
Affect this element
que-6Rule Required and repeat aren't permitted for display itemstype!='display' or (required.empty() and repeats.empty())
Questionnaire.item.repeats
Element IdQuestionnaire.item.repeats
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).

Short DisplayWhether the item may repeat
Cardinality0..1
Typeboolean
Meaning if MissingItems are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value
Requirements

Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.

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

Invariants
Affect this element
que-6Rule Required and repeat aren't permitted for display itemstype!='display' or (required.empty() and repeats.empty())
que-13Rule Can only have multiple initial values for repeating itemsrepeats=true or initial.count() <= 1
Questionnaire.item.readOnly
Element IdQuestionnaire.item.readOnly
Definition

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

Short DisplayDon't allow human editing
Cardinality0..1
Typeboolean
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.

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

Invariants
Affect this element
que-9Rule Read-only can't be specified for "display" itemstype!='display' or readOnly.empty()
Questionnaire.item.maxLength
Element IdQuestionnaire.item.maxLength
Definition

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

Short DisplayNo more than these many characters
Cardinality0..1
Typeinteger
Summaryfalse
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.

Invariants
Affect this element
que-10Rule Maximum length can only be declared for simple question types(type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or answerConstraint='optionOrString' or maxLength.empty()
Questionnaire.item.answerConstraint
Element IdQuestionnaire.item.answerConstraint
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.

Short DisplayoptionsOnly | optionsOrType | optionsOrString
Cardinality0..1
Terminology BindingQuestionnaire answer constraints value set (Required)
Typecode
Meaning if MissingIf not specified, answerConstraint is presumed to be 'optionsOnly'
Requirements

Introduces the ability for questions to have 'other' answers

Summaryfalse
Invariants
Affect this element
que-10Rule Maximum length can only be declared for simple question types(type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or answerConstraint='optionOrString' or maxLength.empty()
que-14Warning 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()
Questionnaire.item.answerValueSet
Element IdQuestionnaire.item.answerValueSet
Definition

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

Short DisplayValueSet containing permitted answers
Cardinality0..1
Typecanonical(ValueSet)
Summaryfalse
Comments

LOINC defines many useful value sets for questionnaire responses. See LOINC Answer Lists icon. The value may come from the ElementDefinition referred to by .definition.

Invariants
Affect this element
que-5Rule Only coding, decimal, integer, date, dateTime, time, string or quantity items can have answerOption or answerValueSet(type='coding' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())
que-4Rule A question cannot have both answerOption and answerValueSetanswerOption.empty() or answerValueSet.empty()
que-14Warning 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()
Questionnaire.item.answerOption
Element IdQuestionnaire.item.answerOption
Definition

One of the permitted answers for the question.

Short DisplayPermitted answer
Cardinality0..*
Summaryfalse
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.

Invariants
Affect this element
que-5Rule Only coding, decimal, integer, date, dateTime, time, string or quantity items can have answerOption or answerValueSet(type='coding' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())
que-4Rule A question cannot have both answerOption and answerValueSetanswerOption.empty() or answerValueSet.empty()
que-11Rule If one or more answerOption is present, initial cannot be present. Use answerOption.initialSelected insteadanswerOption.empty() or initial.empty()
que-14Warning 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()
Questionnaire.item.answerOption.value[x]
Element IdQuestionnaire.item.answerOption.value[x]
Definition

A potential answer that's allowed as the answer to this question.

Short DisplayAnswer value
Cardinality1..1
Terminology BindingQuestionnaire Answer Codes (Example)
Typeinteger|date|time|string|Coding|Reference(Any)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
Comments

The data type of the value must agree with the item.type.

Questionnaire.item.answerOption.initialSelected
Element IdQuestionnaire.item.answerOption.initialSelected
Definition

Indicates whether the answer value is selected when the list of possible answers is initially shown.

Short DisplayWhether option is selected by default
Cardinality0..1
Typeboolean
Meaning if MissingOnly selected items explicitly marked to be selected
Summaryfalse
Questionnaire.item.initial
Element IdQuestionnaire.item.initial
Definition

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

Short DisplayInitial value(s) when item is first rendered
Cardinality0..*
Requirements

In some workflows, having defaults saves time.

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

Invariants
Affect this element
que-8Rule Initial values can't be specified for groups or display items(type!='group' and type!='display') or initial.empty()
que-13Rule Can only have multiple initial values for repeating itemsrepeats=true or initial.count() <= 1
que-11Rule If one or more answerOption is present, initial cannot be present. Use answerOption.initialSelected insteadanswerOption.empty() or initial.empty()
Questionnaire.item.initial.value[x]
Element IdQuestionnaire.item.initial.value[x]
Definition

The actual value to for an initial answer.

Short DisplayActual value for initializing the question
Cardinality1..1
Terminology BindingQuestionnaire Answer Codes (Example)
Typeboolean|decimal|integer|date|dateTime|time|string|uri|Attachment|Coding|Quantity|Reference(Any)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
Comments

The type of the initial value must be consistent with the type of the item.

Questionnaire.item.item
Element IdQuestionnaire.item.item
Definition

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

Short DisplayNested questionnaire items
Cardinality0..*
TypeSee Questionnaire.item
Requirements

Reports can consist of complex nested groups.

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