STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Definitions for the cqif-questionnaire Profile.

Questionnaire(CQIF-Questionnaire)
Definition

A CQIF questionnaire is a questionnaire with the added ability to describe behavior associated with questions. For example, whether or not to display a particular question or group of questions, or automatically calculating the value of an answer based on the answers to previous questions.

Control0..*
Alternate NamesForm, CRF, Survey
InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (xpath: not(parent::f:contained and f:text))
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (xpath: not(parent::f:contained and f:contained))
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (xpath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])))
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (xpath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated)))
que-2: The link ids for groups and questions must be unique within the questionnaire (xpath: count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value)))
Questionnaire.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Questionnaire.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Questionnaire.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

Questionnaire.language
Definition

The base language in which the resource is written.

Control0..1
Terminology BindingA human language.
The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Questionnaire.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

Questionnaire.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Questionnaire.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-library)
Definition

A reference to a Library containing the formal logic used by the artifact.

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: Reference(Library))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Questionnaire.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Questionnaire.url
Definition

An absolute URL that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this questionnaire is (or will be) published.

Control0..1
Typeuri
Questionnaire.identifier
Definition

This records identifiers associated with this question set that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

Control0..*
TypeIdentifier
Requirements

Need to allow connection to a wider workflow.

Questionnaire.version
Definition

The version number assigned by the publisher for business reasons. It may remain the same when the resource is updated.

Control0..1
Typestring
Requirements

In some cases, separate resource instances might be created for each version (if an older version can be maintained once a new version exists).

Alternate NamesN/A - MIF rather than RIM level
Questionnaire.status
Definition

The lifecycle status of the questionnaire as a whole.

Control1..1
Terminology BindingLifecycle status of the questionnaire.
The codes SHALL be taken from QuestionnaireStatus
Typecode
Is Modifiertrue
Questionnaire.date
Definition

The date that this questionnaire was last changed.

Control0..1
TypedateTime
Alternate NamesDate created, Date published, Date issued, Date updated
Questionnaire.publisher
Definition

Organization or person responsible for developing and maintaining the questionnaire.

Control0..1
Typestring
Requirements

Conveys responsibility for the questions and their organization and also helps evaluate the questionnaire's "authority".

Questionnaire.telecom
Definition

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

Control0..*
TypeContactPoint
Questionnaire.useContext
Definition

A code that identifies the questionnaire as falling into a particular group of like questionnaires; e.g. "Pediatric", "Admissions", "Research", "Demographic", "Opinion Survey", etc.

Control0..*
Terminology BindingIndicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use.
The codes SHALL be taken from Context of Use ValueSet; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

Allows discovery of questionnaires. Also allows organization of lists of questionnaires into groups for presentation.

Questionnaire.title
Definition

The name or label associated with this questionnaire.

Control0..1
Typestring
Requirements

Used for display, searching.

Questionnaire.concept
Definition

Identifies how this question or group of questions is known in a particular terminology such as LOINC.

Control0..*
Terminology BindingCodes for questionnaires, groups and individual questions
For example codes, see Questionnaire Question Codes
TypeCoding
Requirements

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

Questionnaire.subjectType
Definition

Identifies the types of subjects that can be the subject of the questionnaire.

Control0..*
Terminology BindingOne of the resource types defined as part of FHIR.
The codes SHALL be taken from ResourceType
Typecode
Comments

If none are specified, then the subject is unlimited.

Questionnaire.item
Definition

The questions and groupings of questions that make up the questionnaire.

Control0..* This element is affected by the following invariants: que-3
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
que-1: Group items must have nested items, display items cannot have nested items (xpath: not((f:type/@value='group' and not(f:item)) or (f:type/@value='display' and f:item)))
que-10: Maximum length can only be declared for simple question types (xpath: f:type/@value=('boolean', 'decimal', 'integer', 'open-choice', 'string', 'text', 'url') or not(f:maxLength))
que-11: Type is required if a definition is not provided (xpath: not(exists(f:type)) or exists(f:definition))
que-3: Display items cannot have a "concept" asserted (xpath: not(f:type/@value='display' and f:concept))
que-4: A question cannot have both option and options (xpath: not(f:options and f:option))
que-5: Only 'choice' items can have options (xpath: f:type/@value=('choice','open-choice') or not(f:option or f:options))
que-6: Required and repeat aren't permitted for display items (xpath: not(f:type/@value='display' and (f:required or f:repeats)))
que-8: Default values can't be specified for groups or display items (xpath: not(f:type/@value=('group', 'display') and f:*[starts-with(local-name(.), 'initial')]))
que-9: Read-only can't be specified for "display" items (xpath: not(f:type/@value='display' and f:readOnly))
Questionnaire.item.id
Definition

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

Control0..1
Typestring
Questionnaire.item.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-condition)
Definition

The name of a condition expression that determines the applicability of the item. For example, when appearing on a question in a questionnaire, if the expression evaluates to true, the question is applicable, otherwise, the question is not applicable.

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-initialValue)
Definition

The name of an expression in a referenced library that determines an initial value.

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-calculatedValue)
Definition

The name of an expression in a referenced library that determines a calculated value.

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
Questionnaire.item.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Questionnaire.item.linkId
Definition

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

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

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.

Questionnaire.item.definition
Definition

A reference to an ElementDefinition that provides the details for the item. If a definition is provided, then the following element values can be inferred from the definition:

  • concept (ElementDefinition.code)
  • type (ElementDefinition.type)
  • required (ElementDefinition.min)
  • repeats (ElementDefinition.max)
  • maxLength (ElementDefinition.maxLength)
  • options (ElementDefinition.binding)

Any information provided in these elements overrides the information from the definition.

Control0..1 This element is affected by the following invariants: que-11
Typeuri
Requirements

A common pattern is to define a set of data elements, and then build multiple different 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.

Comments

The ElementDefinition must be in a StructureDefinition or a DataElement, and must have a fragment identifier that identifies the specific data element by it's id (Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x].

Questionnaire.item.concept
Definition

Terminology code that corresponds to this group or question (e.g. LOINC).

Control0..* This element is affected by the following invariants: que-3
Terminology BindingCodes for questionnaires, groups and individual questions
For example codes, see Questionnaire Question Codes
TypeCoding
Requirements

Allows linking of groups of questions (and complete Questionnaire resources) to formal terminologies.

Comments

The code(s) for the "root" group apply to the questionnaire as a whole. Value may come from the ElementDefinition referred to by .definition.

Questionnaire.item.prefix
Definition

A short label for a particular group, question or set of display text within the questionnaire.

Control0..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
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 "text" 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
Definition

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

Control0..1
Typestring
Questionnaire.item.type
Definition

Identifies the type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).

Control0..1 This element is affected by the following invariants: que-11
Terminology BindingDistinguishes groups from questions and display text and indicates data type for questions
The codes SHALL be taken from QuestionnaireItemType
Typecode
Requirements

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

Comments

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

Questionnaire.item.enableWhen
Definition

If present, indicates that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.

Control0..*
TypeBackboneElement
Is Modifiertrue
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.

Comments

If multiple repetitions of this extension are present, the item should be enabled when the condition for any of the repetitions is true. I.e. Treat "enableWhen"s as being joined by an "or" clause.

If enableWhen is present for an item, "required" is ignored unless one of the enableWhen conditions is met.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
que-7: enableWhen must contain either an 'answer' or an 'answered' element (xpath: count(*[starts-with(local-name(.), 'answer')]|answered) = 1)
Questionnaire.item.enableWhen.id
Definition

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

Control0..1
Typestring
Questionnaire.item.enableWhen.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Questionnaire.item.enableWhen.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Questionnaire.item.enableWhen.question
Definition

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

Control1..1
Typestring
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.

Questionnaire.item.enableWhen.hasAnswer
Definition

If present, indicates that this item should be enabled only if the specified question is answered or not answered.

Control0..1 This element is affected by the following invariants: que-7
Typeboolean
Comments

If answered=false and answer values are also provided, then they are treated as "or". I.e. "Enable if the question is unanswered or the answer is one of the specified values". If answered=true and answers are present, one of the specified answers must be met. (So there's little reason to specify answered=true if answers are present.).

Questionnaire.item.enableWhen.answer[x]
Definition

If present, then the answer for the referenced question must match this answer for all components present in the enableWhen.answer.

Control0..1 This element is affected by the following invariants: que-7
TypeChoice of: boolean, decimal, integer, date, dateTime, instant, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

Components not specified in the answer do not need to match. For example, if enableWhen specifies code + system for a Coding, it's ok if the answer has a "display" element.

The dataType of this element must be the same as the data type of the question being referenced.

Questionnaire.item.required
Definition

If true, indicates that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.

Control0..1 This element is affected by the following invariants: que-6
Typeboolean
Comments

Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. 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 child element). Value may come from the ElementDefinition referred to by .definition.

Default Valuefalse
Questionnaire.item.repeats
Definition

Whether the item may occur multiple times in the instance, containing multiple sets of answers.

Control0..1 This element is affected by the following invariants: que-6
Typeboolean
Requirements

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

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 or to simply list each of the answers beneath the question. (Which is most appropriate visually may depend on the type of answer as well as whether there are nested items.). Value may come from the ElementDefinition referred to by .definition.

Default Valuefalse
Questionnaire.item.readOnly
Definition

If true, the value cannot be changed by a human respondent to the Questionnaire.

Control0..1 This element is affected by the following invariants: que-9
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.

Comments

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.

Questionnaire.item.maxLength
Definition

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

Control0..1 This element is affected by the following invariants: que-10
Typeinteger
Comments

For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. Value may come from the ElementDefinition referred to by .definition.

Questionnaire.item.options
Definition

Reference to a value set containing a list of codes representing permitted answers for the question.

Control0..1 This element is affected by the following invariants: que-4, que-5
TypeReference(ValueSet)
Comments

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

Questionnaire.item.option
Definition

For a "choice" question, identifies one of the permitted answers for the question.

Control0..* This element is affected by the following invariants: que-4, que-5
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
Questionnaire.item.option.id
Definition

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

Control0..1
Typestring
Questionnaire.item.option.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Questionnaire.item.option.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Questionnaire.item.option.value[x]
Definition

Identifies a specific answer that's allowed as the answer to a question.

Control1..1
Terminology BindingAllowed values to answer questions.
For example codes, see Questionnaire Answer Codes
TypeChoice of: integer, date, time, string, Coding
[x] NoteSee Choice of Data Types for further information about how to use [x]
Questionnaire.item.initial[x]
Definition

The value that should be defaulted when rendering the questionnaire for user input.

Control0..1 This element is affected by the following invariants: que-8
TypeChoice of: boolean, decimal, integer, date, dateTime, instant, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

In some workflows, having defaults saves time.

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.

Questionnaire.item.item
Definition

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

Control0..* This element is affected by the following invariants: que-1
TypeSee Questionnaire:cqif-questionnaire.item
Requirements

Reports can consist of complex nested groups.