This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). 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. |
Control | 0..* |
Type | Questionnaire |
Alternate Names | Form, CRF, Survey |
Invariants | Defined on this element 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))) que-3: If root group must be "required" (xpath: f:group/f:required/@value='true') |
Questionnaire.id | |
Definition | The logical id of the resource, as used in the url for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
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. Bundles always have an id, though it is usually a generated UUID. |
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. |
Control | 0..1 |
Type | Meta |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
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. |
Control | 0..1 |
Binding | A human language The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | code |
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. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. |
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. |
Control | 0..* |
Type | Resource |
Alternate Names | inline 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-content) | |
Definition | The content of the module, if any. If this is a library, this would be the CQL or ELM representation of the library contents. |
Control | 0..* |
Type | Extension (Extension Type: Attachment) |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.identifier | |
Definition | This records identifiers associated with this question set that are defined by business processed 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). |
Control | 0..* |
Type | Identifier |
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. |
Control | 0..1 |
Type | string |
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 Names | N/A - MIF rather than RIM level |
Questionnaire.status | |
Definition | The lifecycle status of the questionnaire as a whole. |
Control | 1..1 |
Binding | Lifecycle status of the questionnaire The codes SHALL be taken from QuestionnaireStatus |
Type | code |
Is Modifier | true |
Questionnaire.date | |
Definition | The date that this questionnaire was last changed. |
Control | 0..1 |
Type | dateTime |
Alternate Names | Date Created, Date published, Date Issued, Date updated |
Questionnaire.publisher | |
Definition | Organization or person responsible for developing and maintaining the questionnaire. |
Control | 0..1 |
Type | string |
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. |
Control | 0..* |
Type | ContactPoint |
Questionnaire.subjectType | |
Definition | Identifies the types of subjects that can be the subject of the questionnaire. |
Control | 0..* |
Binding | One of the resource types defined as part of FHIR The codes SHALL be taken from ResourceType |
Type | code |
Comments | If none are specified, then the subject is unlimited. |
Questionnaire.group | |
Definition | A collection of related questions (or further groupings of questions). |
Control | 1..1 This element is affected by the following invariants: que-3 |
Type | BackboneElement |
Requirements | Need to be able to logically group answers to grouped questions. |
Alternate Names | Section |
Comments | The Questionnaire itself has one "root" group with the actual contents of the Questionnaire. Information on this root group applies to the questionnaire as a whole. |
Invariants | Defined on this element que-1: Groups may either contain questions or groups but not both (xpath: not(exists(f:group) and exists(f:question))) |
Questionnaire.group.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Questionnaire.group.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-expression) | |
Definition | The name of an expression in a referenced library that describes the logic for a particular context. |
Control | 0..* |
Type | Extension (Extension Type: string) |
Questionnaire.group.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.group.linkId | |
Definition | An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a QuestionnaireResponse resource. |
Control | 0..1 |
Type | string |
Requirements | QuestionnaireResponse does not require omitted groups to be included and may have some groups that repeat, so linkage based on position alone is not sufficient. |
Comments | May be omitted if there is no expectation to link answers back to a questionnaire. This can be a meaningful id (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here. |
Questionnaire.group.title | |
Definition | The human-readable name for this section of the questionnaire. |
Control | 0..1 |
Type | string |
Requirements | When including text for the questionnaire with the answers, sections may have a section header. |
Comments | The title of the "root" group is the title for the questionnaire. |
Questionnaire.group.concept | |
Definition | Identifies a how this group of questions is known in a particular terminology such as LOINC. |
Control | 0..* |
Binding | Codes for groupings of questionnaire questions For example codes, see Questionnaire Question Codes |
Type | Coding |
Requirements | Allows linking of groups of questions (and complete questionnaires) to formal terminologies. |
Comments | The code(s) for the "root" group apply to the questionnaire as a whole. |
Questionnaire.group.text | |
Definition | Additional text for the group, used for display purposes. |
Control | 0..1 |
Type | string |
Requirements | When including text for the questionnaire, each section may contain additional explanations are background text. |
Comments | Common extensions are defined for more specialized types of display text. |
Questionnaire.group.required | |
Definition | If true, indicates that the group must be present and have required questions within it answered. If false, the group may be skipped when answering the questionnaire. |
Control | 0..1 |
Type | boolean |
Default Value | false |
Questionnaire.group.repeats | |
Definition | Whether the group may occur multiple times in the instance, containing multiple sets of answers. |
Control | 0..1 |
Type | boolean |
Requirements | Groups may be used to create set of (related) questions that can be repeated to give multiple answers to such a set. |
Default Value | false |
Questionnaire.group.group | |
Definition | A sub-group within a group. The ordering of groups within this group is relevant. |
Control | 0..* This element is affected by the following invariants: que-1 |
Type | See group |
Requirements | Reports can consist of complex nested groups. |
Questionnaire.group.question | |
Definition | Set of questions within this group. The order of questions within the group is relevant. |
Control | 0..* This element is affected by the following invariants: que-1 |
Type | BackboneElement |
Requirements | Must register answers to questions. |
Alternate Names | Responses, Contents |
Invariants | Defined on this element que-4: A question must use either option or options, not both (xpath: not(f:options and f:option)) |
Questionnaire.group.question.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Questionnaire.group.question.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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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. |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-expression) | |
Definition | The name of an expression in a referenced library that describes the logic for a particular context. |
Control | 0..* |
Type | Extension (Extension Type: string) |
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-expression) | |
Definition | The name of an expression in a referenced library that describes the logic for a particular context. |
Control | 0..* |
Type | Extension (Extension Type: string) |
Questionnaire.group.question.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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, 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.group.question.linkId | |
Definition | An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a QuestionnaireResponse resource. |
Control | 0..1 |
Type | string |
Requirements | QuestionnaireResponse does not require omitted groups to be included and may have some groups that repeat, so linkage based on position alone is not sufficient. |
Comments | May be omitted if there is no expectation to link answers back to a questionnaire. This can be a meaningful id (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here. |
Questionnaire.group.question.concept | |
Definition | Identifies a how this question is known in a particular terminology such as LOINC. |
Control | 0..* |
Binding | Codes corresponding to individual questions For example codes, see Questionnaire Question Codes |
Type | Coding |
Requirements | Allows linking of questions (and their answers) to formal terminologies. |
Questionnaire.group.question.text | |
Definition | The actual question as shown to the user to prompt them for an answer. |
Control | 0..1 |
Type | string |
Requirements | When including text for the questionnaire, each question may contain its actual question display text. |
Alternate Names | Question |
Comments | Common extensions are defined for more specialized types of display text. |
Questionnaire.group.question.type | |
Definition | The expected format of the answer, e.g. the type of input (string, integer) or whether a (multiple) choice is expected. |
Control | 0..1 |
Binding | The expected format of an answer The codes SHALL be taken from AnswerFormat |
Type | code |
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. |
Questionnaire.group.question.required | |
Definition | If true, indicates that the question must be answered and have required groups within it also present. If false, the question and any contained groups may be skipped when answering the questionnaire. |
Control | 0..1 |
Type | boolean |
Default Value | false |
Questionnaire.group.question.repeats | |
Definition | If true, the question may have more than one answer. |
Control | 0..1 |
Type | boolean |
Requirements | Used for "check all that apply" types of questions or "list your top 3", etc. |
Comments | Whether the question itself will be displayed for each answer is a rendering choice typically based on whether there are nested groups. |
Default Value | false |
Questionnaire.group.question.options | |
Definition | Reference to a valueset containing the a list of codes representing permitted answers for the question. |
Control | 0..1 This element is affected by the following invariants: que-4 |
Type | Reference(ValueSet) |
Comments | LOINC defines many useful value sets for questionnaire response. See LOINC Answer Lists. |
Questionnaire.group.question.option | |
Definition | For a "choice" question, identifies one of the permitted answers for the question. |
Control | 0..* This element is affected by the following invariants: que-4 |
Binding | Allowed values to answer questions For example codes, see Questionnaire Answer Codes |
Type | Coding |
Questionnaire.group.question.group | |
Definition | Nested group, containing nested question for this question. The order of groups within the question is relevant. |
Control | 0..* |
Type | See group |
Requirements | It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details. |