This page is part of the FHIR Specification (v1.4.0: STU 3 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 sdc-questionnaire Profile.
Questionnaire(SDC-Questionnaire) | |
Definition | Sets minimum expectations for questionnaire support for SDC-conformant systems, including a number of extensions around display and behavior. |
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))) |
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 | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Questionnaire.extension (http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-endpoint) | |
Definition | The base URL for the server to which questionnaire response associated with this questionnaire should be submitted. |
Control | 0..* |
Type | Extension (Extension Type: uri) |
Comments | Indicates that the form has been designed with an expectation that it will be submitted to the specified URI. If multiple endpoints are specified, expectation is that answers are submitted to all endpoints. If no end-point is specified, then the form is not exclusively designed to be submitted to a specific site. If and where the form needs to be submitted or how the form should be internally processed must be inferred from external context or system business rules. |
Questionnaire.extension (http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-provenanceSignatureRequred) | |
Definition | If true, indicates that QuestionnaireResponse instances created against this questionnaire must have an associated Provenance record. |
Control | 0..1 |
Type | Extension (Extension Type: boolean) |
Comments | Systems may choose to require that the QuestionnaireResponse and referencing Provenance instance be submitted together as a single transaction using Bundle. |
Questionnaire.extension (http://hl7.org/fhir/StructureDefinition/styleSensitive) | |
Definition | Indicates that the style extensions in this resource are essential to the interpretation of the styled text and that it cannot be rendered without the style without losing essential information. |
Control | 0..1 |
Type | Extension (Extension Type: boolean) |
Comments | If set to true, all systems that claim to support this extension and which render elements of the resource containing this extension SHALL either render the content as required by the style extensions defined by this profile that are present in the resource or shall (if safe to do so based on their own rules), omit entirely the styled content they cannot render in accordance with the extensions. |
Questionnaire.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-deMap) | |
Definition | Identifies a map that links the questionnaire (source) to a DataElement server and identifies which questions correspond to which data elements (by linkId and local identifier, respectively). |
Control | 0..1 |
Type | Extension (Extension Type: Reference(ConceptMap)) |
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.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. |
Control | 1..1 |
Type | uri |
Must Support | true |
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). |
Control | 0..* |
Type | Identifier |
Must Support | true |
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 |
Must Support | true |
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 |
Must Support | true |
Questionnaire.date | |
Definition | Identifies when this version of the form was created. Changes whenever the form is updated. |
Control | 1..1 |
Type | dateTime |
Must Support | true |
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 |
Must Support | true |
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.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. |
Control | 0..* |
Binding | Indicates 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 |
Type | CodeableConcept |
Must Support | true |
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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Used for display, searching. |
Questionnaire.title.id | |
Definition | unique id for the element within a resource (for internal references) |
Control | 0..1 |
Type | id |
Questionnaire.title.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Questionnaire.title.extension (http://hl7.org/fhir/StructureDefinition/style) | |
Definition | Identifies how the specified element should be rendered when displayed. |
Control | 0..1 |
Type | Extension (Extension Type: string) |
Comments | This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension. |
Questionnaire.title.extension (http://hl7.org/fhir/StructureDefinition/markup) | |
Definition | This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc. |
Control | 0..1 |
Type | Extension (Extension Type: string) |
Questionnaire.title.value | |
Definition | The actual value |
Control | 0..1 |
Max Length | 1048576 |
Questionnaire.concept | |
Definition | Identifies a how this question or group of questions is known in a particular terminology such as LOINC. |
Control | 0..1 |
Binding | Codes for questionnaires, groups and individual questions For example codes, see Questionnaire Question Codes |
Type | Coding |
Must Support | true |
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. |
Control | 0..* |
Binding | One of the resource types defined as part of FHIR. The codes SHALL be taken from ResourceType |
Type | code |
Must Support | true |
Comments | If none are specified, then the subject is unlimited. |
Questionnaire.item | |
Definition | The questions and groupings of questions that make up the questionnaire. |
Control | 0..* This element is affected by the following invariants: que-3 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element 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-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). |
Control | 0..1 |
Type | id |
Questionnaire.item.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs) | |
Definition | The minimum number of times the group must appear or the minimum number of answers for a question - when greater than 1. |
Control | 0..1 |
Type | Extension (Extension Type: integer) |
Comments | Default assumption for "required" elements is minOccurs=1. |
Invariants | Defined on this element inv-1: minOccurs can't be more than one if required is false (xpath: f:valueInteger/@value=0 or parent::*/f:required/@value=true()) inv-3: minOccurs can't exist for display items (xpath: not(parent::*/f:type/@value='display')) |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs) | |
Definition | The maximum number of times the group must appear or the minimum number of answers for a question - when greater than 1 and not unlimited. |
Control | 0..1 |
Type | Extension (Extension Type: integer) |
Comments | Only relevant if the element has repeats=true and there's a need to constrain the number of allowed repetitions. |
Invariants | Defined on this element inv-2: maxOccurs can't be more than one if repeats is false (xpath: f:valueInteger/@value<=1 or parent::*/f:repeats/@value=true()) inv-4: maxOccurs can't exist for display items (xpath: not(parent::*/f:type/@value='display')) |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-optionalDisplay) | |
Definition | If set to true, it means that the system displaying the form (or the individual encoding the form for data capture) can choose to omit the item from display to the user. |
Control | 0..1 |
Type | Extension (Extension Type: boolean) |
Comments | If a group or question that contains other groups or questions is marked as "optional", all of its contents are automatically also treated as optional. |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-hidden) | |
Definition | If true, indicates that the extended item should not be displayed to the user. |
Control | 0..1 |
Type | Extension (Extension Type: boolean) |
Comments | If an item is hidden, all descendant items are hidden as well. |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl) | |
Definition | The type of data entry control or structure that should be used to render the item. |
Control | 0..1 |
Type | Extension (Extension Type: CodeableConcept) |
Comments | Different controls may be appropriate for different item types. It is up to the system rendering a questionnaire as to what controls it will support and for which data types. |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation) | |
Definition | Identifies the desired orientation when rendering a list of choices (typically radio-box or check-box lists). |
Control | 0..1 |
Type | Extension (Extension Type: code) |
Comments | Systems may choose to wrap answers rather than attempting to display them all in one row or column. Language conventions may determine the order in which the choices are listed (left-to-right or right-to-left, etc.). |
Invariants | Defined on this element inv-6: choiceOrientation can only be present on elements of type "choice" or "open-choice" (xpath: parent::*/f:type/@value=('choice', 'open-choice')) |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/minLength) | |
Definition | The minimum number of characters that must be present in the simple data type to be considered a "valid" instance. |
Control | 0..1 |
Type | Extension (Extension Type: integer) |
Comments | For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/regex) | |
Definition | A regular expression that defines the syntax for the data element to be considered valid. |
Control | 0..1 |
Type | Extension (Extension Type: string) |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/entryFormat) | |
Definition | A syntax intended for display to the user to guide their input (i.e. a human readable version of a regular expression). For example "nnn-nnn-nnn". |
Control | 0..1 |
Type | Extension (Extension Type: string) |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/minValue) | |
Definition | The inclusive lower bound on the range of allowed values for the data element. |
Control | 0..1 |
Type | Extension (Extension Type: Choice of: date, dateTime, time, instant, decimal, integer) |
Comments | Data type specified must be the same as the data type for the data element. |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/maxValue) | |
Definition | The inclusive upper bound on the range of allowed values for the data element. |
Control | 0..1 |
Type | Extension (Extension Type: Choice of: date, dateTime, time, instant, decimal, integer) |
Comments | Data type specified must be the same as the data type for the data element. |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces) | |
Definition | Identifies the maximum number of decimal places that may be specified for the data element. |
Control | 0..1 |
Type | Extension (Extension Type: integer) |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/mimeType) | |
Definition | Identifies the kind(s) of attachmemt allowed to be sent for an element. |
Control | 0..* |
Type | Extension (Extension Type: code) |
Comments | This extension only has meaning if the element has a type of Attachment. |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/maxSize) | |
Definition | For attachment answers, indicates the maximum size an attachment can be. |
Control | 0..1 |
Type | Extension (Extension Type: decimal) |
Comments | This extension only has meaning if the element has a type of Attachment. |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-unit) | |
Definition | Provides a computable unit of measure associated with numeric questions to support subsequent computation on responses. |
Control | 0..1 |
Type | Extension (Extension Type: Coding) |
Comments | The human-readable unit is conveyed as a display element. This element is for computation purposes. |
Invariants | Defined on this element inv-16: Lookup Questionnaire can only be specified for questions with a type of "integer" or "decimal" (xpath: parent::*/f:type/@value=('integer', 'decimal')) |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-deReference) | |
Definition | A reference to the Data Element that corresponds to the question text and answer constraints for this question. |
Control | 0..1 |
Type | Extension (Extension Type: Reference(DataElement)) |
Comments | If a code applies to a question, that code should still be conveyed on the question, even if the same code is also referenced as a DataElement.code in the referenced data element. This extension must not be used in place of specifying the Questionnaire.item.concept element. |
Invariants | Defined on this element inv-9: Data Element references can't be specified for "display" items (xpath: not(parent::*/f:type/@value='display')) |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource) | |
Definition | Where the type for a question is "Reference", indicates a type of resource that is permitted. |
Control | 0..* |
Type | Extension (Extension Type: code) |
Comments | This extension only has meaning if the question.type = Reference. If no allowedResource extensions are present, the presumption is that any type of resource is permitted. If multiple are present, then any of the specified types are permitted. |
Invariants | Defined on this element inv-10: Allowed resource can only be specified for items of type 'reference' (xpath: parent::*/f:type/@value='reference') |
Questionnaire.item.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory) | |
Definition | Describes the intended purpose of the rendered text. For example - instructions, guidance on access control, maintenance information, etc. |
Control | 0..1 |
Type | Extension (Extension Type: CodeableConcept) |
Invariants | Defined on this element inv-11: Display category can only be specified for items of type display (xpath: parent::*/f:type/@value='display') |
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. |
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.item.linkId | |
Definition | An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource. |
Control | 1..1 |
Type | string |
Must Support | true |
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 | May be omitted if there is no expectation to link answers back to a Questionnaire. 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.concept | |
Definition | Identifies a how this group of questions is known in a particular terminology such as LOINC. |
Control | 0..1 This element is affected by the following invariants: que-3 |
Binding | Codes for questionnaires, groups and individual questions For example codes, see Questionnaire Question Codes |
Type | Coding |
Must Support | true |
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. |
Questionnaire.item.prefix | |
Definition | A short label for a particular group, question or set of display text within the questionnaire. |
Control | 0..1 |
Type | string |
Must Support | true |
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 Names | label |
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.prefix.id | |
Definition | unique id for the element within a resource (for internal references) |
Control | 0..1 |
Type | id |
Questionnaire.item.prefix.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Questionnaire.item.prefix.extension (http://hl7.org/fhir/StructureDefinition/style) | |
Definition | Identifies how the specified element should be rendered when displayed. |
Control | 0..1 |
Type | Extension (Extension Type: string) |
Comments | This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension. |
Questionnaire.item.prefix.extension (http://hl7.org/fhir/StructureDefinition/markup) | |
Definition | This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc. |
Control | 0..1 |
Type | Extension (Extension Type: string) |
Questionnaire.item.prefix.value | |
Definition | The actual value |
Control | 0..1 |
Max Length | 1048576 |
Questionnaire.item.text | |
Definition | The name of a section, the text of a question or text content for a text item. |
Control | 0..1 |
Type | string |
Must Support | true |
Questionnaire.item.text.id | |
Definition | unique id for the element within a resource (for internal references) |
Control | 0..1 |
Type | id |
Questionnaire.item.text.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Questionnaire.item.text.extension (http://hl7.org/fhir/StructureDefinition/style) | |
Definition | Identifies how the specified element should be rendered when displayed. |
Control | 0..1 |
Type | Extension (Extension Type: string) |
Comments | This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension. |
Questionnaire.item.text.extension (http://hl7.org/fhir/StructureDefinition/markup) | |
Definition | This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc. |
Control | 0..1 |
Type | Extension (Extension Type: string) |
Questionnaire.item.text.value | |
Definition | The actual value |
Control | 0..1 |
Max Length | 1048576 |
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.). |
Control | 1..1 |
Binding | Distinguishes groups from questions and display text and indicates data type for questions The codes SHALL be taken from QuestionnaireItemType |
Type | code |
Must Support | true |
Requirements | Defines the format in which the user is to be prompted for the answer. |
Comments | Time is handled using "string". File is handled using Attachment. (Content can be sent as a contained binary). |
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. |
Control | 0..* |
Type | BackboneElement |
Is Modifier | true |
Must Support | true |
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. |
Invariants | Defined on this element 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). |
Control | 0..1 |
Type | id |
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. |
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. |
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. |
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.item.enableWhen.question | |
Definition | The linkId for the question whose answer (or lack of answer) governs whether this item is enabled. |
Control | 1..1 |
Type | string |
Must Support | true |
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.answered | |
Definition | If present, indicates that this item should be enabled only if the specified question is answered or not answered. |
Control | 0..1 This element is affected by the following invariants: que-7 |
Type | boolean |
Must Support | true |
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. |
Control | 0..1 This element is affected by the following invariants: que-7 |
Type | Choice of: boolean, decimal, integer, date, dateTime, instant, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
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. |
Control | 0..1 This element is affected by the following invariants: que-6 |
Type | boolean |
Must Support | true |
Comments | 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). |
Default Value | false |
Questionnaire.item.repeats | |
Definition | Whether the item may occur multiple times in the instance, containing multiple sets of answers. |
Control | 0..1 This element is affected by the following invariants: que-6 |
Type | boolean |
Must Support | true |
Requirements | Items 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.item.readOnly | |
Definition | If true, the value cannot be changed by a human respondent to the Questionnaire. |
Control | 0..1 This element is affected by the following invariants: que-9 |
Type | boolean |
Must Support | true |
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. |
Control | 0..1 This element is affected by the following invariants: que-10 |
Type | integer |
Must Support | true |
Comments | For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. |
Questionnaire.item.options | |
Definition | Reference to a value set containing a list of codes representing permitted answers for the question. |
Control | 0..1 This element is affected by the following invariants: que-4, que-5 |
Type | Reference(ValueSet) |
Must Support | true |
Comments | LOINC defines many useful value sets for questionnaire response. See LOINC Answer Lists. |
Questionnaire.item.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, que-5 |
Type | BackboneElement |
Must Support | true |
Questionnaire.item.option.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Questionnaire.item.option.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix) | |
Definition | The label to list in front of a code when presenting a list of possible values in a questionnaire-like fashion. |
Control | 0..1 |
Type | Extension (Extension Type: string) |
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. |
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.item.option.value[x] | |
Definition | Identifies a specific answer that's allowed as the answer to a question. |
Control | 1..1 |
Binding | Allowed values to answer questions. For example codes, see Questionnaire Answer Codes |
Type | Choice of: integer, date, time, string, Coding |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Questionnaire.item.initial[x] | |
Definition | The value that should be pre-populated when rendering the questionnaire for user input. |
Control | 0..1 This element is affected by the following invariants: que-8 |
Type | Choice of: boolean, decimal, integer, date, dateTime, instant, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Requirements | In some workflows, having defaults saves time. |
Questionnaire.item.item | |
Definition | Allows text, questions and other groups to be nested beneath a question or group. |
Control | 0..* This element is affected by the following invariants: que-1 |
Type | See item |
Must Support | true |
Requirements | Reports can consist of complex nested groups. |