Skip to main content

Questionnaire

PropertyValue
Publisher
NameQuestionnaire
URLhttp://hl7.org/fhir/StructureDefinition/Questionnaire
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Questionnaire0..*QuestionnaireA 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.
Questionnaire.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Questionnaire.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Questionnaire.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Questionnaire.language0..1codeThe base language in which the resource is written.
Questionnaire.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can 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.
Questionnaire.contained0..*ResourceThese 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.
Questionnaire.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Questionnaire.modifierExtension0..*ExtensionMay 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Questionnaire.url0..1uriAn 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 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.
Questionnaire.identifier0..*IdentifierA 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.
Questionnaire.version0..1stringThe 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.
Questionnaire.name0..1stringA 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.
Questionnaire.title0..1stringA short, descriptive, user-friendly title for the questionnaire.
Questionnaire.derivedFrom0..*canonicalThe URL of a Questionnaire that this Questionnaire is based on.
Questionnaire.status1..1codeThe status of this questionnaire. Enables tracking the life-cycle of the content.
Questionnaire.experimental0..1booleanA Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Questionnaire.subjectType0..*codeThe types of subjects that can be the subject of responses created for the questionnaire.
Questionnaire.date0..1dateTimeThe date (and optionally time) when the questionnaire was published. 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.
Questionnaire.publisher0..1stringThe name of the organization or individual that published the questionnaire.
Questionnaire.contact0..*ContactDetailContact details to assist a user in finding and communicating with the publisher.
Questionnaire.description0..1markdownA free text natural language description of the questionnaire from a consumer's perspective.
Questionnaire.useContext0..*UsageContextThe 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 questionnaire instances.
Questionnaire.jurisdiction0..*CodeableConceptA legal or geographic region in which the questionnaire is intended to be used.
Questionnaire.purpose0..1markdownExplanation of why this questionnaire is needed and why it has been designed as it has.
Questionnaire.copyright0..1markdownA copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.
Questionnaire.approvalDate0..1dateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
Questionnaire.lastReviewDate0..1dateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
Questionnaire.effectivePeriod0..1PeriodThe period during which the questionnaire content was or is planned to be in active use.
Questionnaire.code0..*CodingAn identifier for this question or group of questions in a particular terminology such as LOINC.
Questionnaire.item0..*BackboneElementA particular question, question grouping or display text that is part of the questionnaire.
Questionnaire.item.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Questionnaire.item.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Questionnaire.item.modifierExtension0..*ExtensionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Questionnaire.item.linkId1..1stringAn identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.
Questionnaire.item.definition0..1uriThis element is a URI that refers to an ElementDefinition 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. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value:* code (ElementDefinition.code) * type (ElementDefinition.type) * required (ElementDefinition.min) * repeats (ElementDefinition.max) * maxLength (ElementDefinition.maxLength) * answerValueSet (ElementDefinition.binding)* options (ElementDefinition.binding).
Questionnaire.item.code0..*CodingA terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).
Questionnaire.item.prefix0..1stringA short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.
Questionnaire.item.text0..1stringThe name of a section, the text of a question or text content for a display item.
Questionnaire.item.type1..1codeThe 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.).
Questionnaire.item.enableWhen0..*BackboneElementA constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.
Questionnaire.item.enableWhen.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Questionnaire.item.enableWhen.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Questionnaire.item.enableWhen.modifierExtension0..*ExtensionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Questionnaire.item.enableWhen.question1..1stringThe linkId for the question whose answer (or lack of answer) governs whether this item is enabled.
Questionnaire.item.enableWhen.operator1..1codeSpecifies the criteria by which the question is enabled.
Questionnaire.item.enableWhen.answer[x]1..1booleanA value that the referenced question is tested using the specified operator in order for the item to be enabled.
Questionnaire.item.enableBehavior0..1codeControls how multiple enableWhen values are interpreted - whether all or any must be true.
Questionnaire.item.required0..1booleanAn indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.
Questionnaire.item.repeats0..1booleanAn indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups.
Questionnaire.item.readOnly0..1booleanAn indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.
Questionnaire.item.maxLength0..1integerThe maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.
Questionnaire.item.answerValueSet0..1canonicalA reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question.
Questionnaire.item.answerOption0..*BackboneElementOne of the permitted answers for a "choice" or "open-choice" question.
Questionnaire.item.answerOption.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Questionnaire.item.answerOption.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Questionnaire.item.answerOption.modifierExtension0..*ExtensionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Questionnaire.item.answerOption.value[x]1..1integerA potential answer that's allowed as the answer to this question.
Questionnaire.item.answerOption.initialSelected0..1booleanIndicates whether the answer value is selected when the list of possible answers is initially shown.
Questionnaire.item.initial0..*BackboneElementOne or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.
Questionnaire.item.initial.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Questionnaire.item.initial.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Questionnaire.item.initial.modifierExtension0..*ExtensionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Questionnaire.item.initial.value[x]1..1booleanThe actual value to for an initial answer.
Questionnaire.item.item0..*QuestionnaireText, questions and other groups to be nested beneath a question or group.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
codetokenA code that corresponds to one of its items in the questionnaireQuestionnaire.item.code
contexttokenA use context assigned to the questionnaire(Questionnaire.useContext.value.ofType(CodeableConcept))
context-quantityquantityA quantity- or range-valued use context assigned to the questionnaire(Questionnaire.useContext.value.ofType(Quantity)) / (Questionnaire.useContext.value.ofType(Range))
context-typetokenA type of use context assigned to the questionnaireQuestionnaire.useContext.code
datedateThe questionnaire publication dateQuestionnaire.date
definitionuriElementDefinition - details for the itemQuestionnaire.item.definition
descriptionstringThe description of the questionnaireQuestionnaire.description
effectivedateThe time during which the questionnaire is intended to be in useQuestionnaire.effectivePeriod
identifiertokenExternal identifier for the questionnaireQuestionnaire.identifier
jurisdictiontokenIntended jurisdiction for the questionnaireQuestionnaire.jurisdiction
namestringComputationally friendly name of the questionnaireQuestionnaire.name
publisherstringName of the publisher of the questionnaireQuestionnaire.publisher
statustokenThe current status of the questionnaireQuestionnaire.status
subject-typetokenResource that can be subject of QuestionnaireResponseQuestionnaire.subjectType
titlestringThe human-friendly name of the questionnaireQuestionnaire.title
urluriThe uri that identifies the questionnaireQuestionnaire.url
versiontokenThe business version of the questionnaireQuestionnaire.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the questionnaireQuestionnaire.useContext
context-type-valuecompositeA use context type and value assigned to the questionnaireQuestionnaire.useContext