This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions
FHIR Infrastructure Work Group | Maturity Level: 5 | Trial Use | Security Category: Business | Compartments: No defined compartments |
Detailed Descriptions for the elements in the Questionnaire resource.
Questionnaire | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Display | A structured set of questions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | MetadataResource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Names | Form; CRF; Survey | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.url | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.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 Display | Canonical identifier for this questionnaire, represented as an absolute URI (globally unique) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.identifier | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.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 Display | Business identifier for questionnaire | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the questionnaire. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.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 Display | Business version of the questionnaire | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.versionAlgorithm[x] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Indicates the mechanism used to compare versions to determine which is more current. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | How to compare versions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Version Algorithm (Extensible) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string|Coding | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.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 Display | Name for this questionnaire (computer friendly) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Supports code generation. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.title | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.title | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | A short, descriptive, user-friendly title for the questionnaire. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Name for this questionnaire (human friendly) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.derivedFrom | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.derivedFrom | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The URL of a Questionnaire that this Questionnaire is based on. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Based on Questionnaire | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | canonical(Questionnaire) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Allows a Questionnaire to be created based on another Questionnaire. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The current state of this questionnaire. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | draft | active | retired | unknown | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | PublicationStatus (Required) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.experimental | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.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 Display | For testing purposes, not real usage | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Meaning if Missing | If 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | Allows filtering of questionnaires that are appropriate for use versus not. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.subjectType | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.subjectType | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The types of subjects that can be the subject of responses created for the questionnaire. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Resource that can be subject of QuestionnaireResponse | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Resource Types (Required) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Allows enforcing that a QuestionnaireResponse only has a .subject element of the appropriate type. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | If none are specified, then the subject is unlimited. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.date | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.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 Display | Date last changed | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | dateTime | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | Revision Date | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.publisher | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the questionnaire. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Name of the publisher/steward (organization or individual) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Helps establish the "authority/credibility" of the questionnaire. May also allow for contact. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.contact | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Contact details for the publisher | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | A free text natural language description of the questionnaire from a consumer's perspective. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Natural language description of the questionnaire | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.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 Display | The context that the content is intended to support | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | UsageContext | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Assist in searching for appropriate content. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.jurisdiction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Standards Status | This element has a standards status of "Deprecated" which is different from the status of the whole resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.jurisdiction | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | A legal or geographic region in which the questionnaire is intended to be used. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Intended jurisdiction for questionnaire (if applicable) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Jurisdiction ValueSet (Extensible) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.purpose | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Explanation of why this questionnaire is needed and why it has been designed as it has. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Why this questionnaire is defined | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.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 Display | Use and/or publishing restrictions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Consumers of the questionnaire must be able to determine any legal restrictions on the use of the artifact and/or its content. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Alternate Names | License; Restrictions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.copyrightLabel | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.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 Display | Copyright holder and year(s) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Defines the content expected to be rendered in all representations of the artifact. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.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 Display | When the questionnaire was approved by publisher | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | date | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.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 Display | When the questionnaire was last reviewed by the publisher | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | date | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.effectivePeriod | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.effectivePeriod | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The period during which the questionnaire content was or is planned to be in active use. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | When the questionnaire is expected to be used | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Period | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | An identifier for this collection of questions in a particular terminology such as LOINC. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Concept that represents the overall questionnaire | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Questionnaire Question Codes (Example) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Coding | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "panels" of questions to be identified by a code. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.item | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | A particular question, question grouping or display text that is part of the questionnaire. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Questions and sections within the Questionnaire | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | The content of the questionnaire is constructed from an ordered, hierarchical collection of items. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.linkId | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.item.linkId | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Unique id for item in questionnaire | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.definition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.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 Display | ElementDefinition - details for the item | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.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 Display | Corresponding concept for this item in a terminology | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Questionnaire Question Codes (Example) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Coding | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Allows linking of groups of questions to formal terminologies. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | The value may come from the ElementDefinition referred to by .definition. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.prefix | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.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 Display | E.g. "1(a)", "2.5.3" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.item.text | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The name of a section, the text of a question or text content for a display item. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Primary text for the item | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.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 Display | group | display | boolean | decimal | integer | date | dateTime + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Questionnaire Item Type (Required) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Defines the format in which the user is to be prompted for the answer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.enableWhen | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.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 Display | Only allow data when | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (Reason: If enableWhen is present and the condition evaluates to false, then the Questionnaire behaves as though the elements weren't actually present) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.enableWhen.question | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.item.enableWhen.question | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The linkId for the question whose answer (or lack of answer) governs whether this item is enabled. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | The linkId of question that determines whether item is enabled/disabled | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.item.enableWhen.operator | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Specifies the criteria by which the question is enabled. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | exists | = | != | > | < | >= | <= | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Questionnaire Item Operator (Required) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.enableWhen.answer[x] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.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 Display | Value for question comparison based on operator | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Questionnaire Answer Codes (Example) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | boolean|decimal|integer|date|dateTime|time|string|Coding|Quantity|Reference(Any) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.enableBehavior | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.item.enableBehavior | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Controls how multiple enableWhen values are interpreted - whether all or any must be true. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | all | any | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Enable When Behavior (Required) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | This element must be specified if more than one enableWhen value is provided. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.disabledDisplay | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.item.disabledDisplay | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Indicates if and how items that are disabled (because enableWhen evaluates to 'false') should be displayed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | hidden | protected | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Questionnaire Item Disabled Display (Required) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Id | Questionnaire.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 Display | Whether the item must be included in data results | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Meaning if Missing | Items are assumed not to be required unless explicitly specified, though extensions may impose additional expectations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.repeats | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.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 Display | Whether the item may repeat | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Meaning if Missing | Items 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.readOnly | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.item.readOnly | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Don't allow human editing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.maxLength | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.item.maxLength | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | No more than these many characters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.answerConstraint | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.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 Display | optionsOnly | optionsOrType | optionsOrString | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Questionnaire answer constraints value set (Required) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Meaning if Missing | If not specified, answerConstraint is presumed to be 'optionsOnly' | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Introduces the ability for questions to have 'other' answers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.answerValueSet | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.item.answerValueSet | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | A reference to a value set containing a list of values representing permitted answers for a question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | ValueSet containing permitted answers | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | canonical(ValueSet) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | LOINC defines many useful value sets for questionnaire responses. See LOINC Answer Lists . The value may come from the ElementDefinition referred to by .definition. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.answerOption | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.item.answerOption | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | One of the permitted answers for the question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Permitted answer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.answerOption.value[x] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.item.answerOption.value[x] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | A potential answer that's allowed as the answer to this question. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Answer value | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Questionnaire Answer Codes (Example) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | integer|date|time|string|Coding|Reference(Any) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | The data type of the value must agree with the item.type. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.answerOption.initialSelected | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.item.answerOption.initialSelected | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Indicates whether the answer value is selected when the list of possible answers is initially shown. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Whether option is selected by default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Meaning if Missing | Only selected items explicitly marked to be selected | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.initial | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.item.initial | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Initial value(s) when item is first rendered | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | In some workflows, having defaults saves time. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.initial.value[x] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.item.initial.value[x] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | The actual value to for an initial answer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Actual value for initializing the question | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Questionnaire Answer Codes (Example) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | boolean|decimal|integer|date|dateTime|time|string|uri|Attachment|Coding|Quantity|Reference(Any) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comments | The type of the initial value must be consistent with the type of the item. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Questionnaire.item.item | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Element Id | Questionnaire.item.item | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Definition | Text, questions and other groups to be nested beneath a question or group. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short Display | Nested questionnaire items | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | See Questionnaire.item | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Requirements | Reports can consist of complex nested groups. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |