Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B

FHIR Infrastructure icon Work GroupMaturity Level: N/AStandards Status: Informative

The core extensions provide HL7 provided extensions to the Questionnaire resource.

Extensions:
questionnaire-definitionBasedDefinitionBased :

If true, indicates that the Questionnaire relies on metadata from the ElementDefinitions referenced by item.definition and that rendering or validating the Questionnaire is likely to be unsafe if the system isn't capable of resolving the definition and using the metadata found there.

questionnaire-optionRestrictionQuestionnaireOptionRestriction :

Allows disabling certain questionnaire options for the containing item based on evaluating expressions.

questionnaire-minOccursminOccurs :

The minimum number of times the group must appear, or the minimum number of answers for a question - when greater than 1.

questionnaire-maxOccursmaxOccurs :

The maximum number of times the group must appear, or the maximum number of answers for a question - when greater than 1 and not unlimited.

questionnaire-hiddenhidden :

If true, indicates that the extended item should not be displayed to the user.

questionnaire-itemControlitemControl :

The type of data entry control or structure that should be used to render the item. Certain item controls only make sense for certain types of items. For example, a radio button doesn't make sense for a question where repeats=true; few systems will know how to implement a 'slider' control if the question type is 'Attachment', etc. Form fillers are allowed to ignore item controls that don't make sense (or that they don't know how to handle) for the type of item the extension appears on. If the extension is ignored, the form filler will use whatever display control it supports that works best for the type of item present. Similarly, form authoring tools may raise validation issues or prohibit the selection of certain control types based on the characteristics of the item.

questionnaire-choiceOrientationchoiceOrientation :

Identifies the desired orientation when rendering a list of choices (typically radio-box or check-box lists).

questionnaire-referenceResourcereferenceResource :

Where the type for a question is "Reference", indicates a type of resource that is permitted.

questionnaire-referenceProfilereferenceProfile :

Where the type for a question is "Reference", indicates a profile that the resource instances pointed to in answers to this question must be valid against.

questionnaire-referenceFilterreferenceFilter :

Identifies a filter to apply when looking up candidate answers for the question. This extension has been replaced by the Structured Data Capture candidateExpression extension.

questionnaire-displayCategorydisplayCategory :

Describes the intended purpose of the rendered text. For example - instructions, guidance on access control, maintenance information, etc.

questionnaire-fhirTypefhirType :

For questionnaires generated from FHIR profiles, indicates the FHIR data type or resource type that corresponds to this node.

questionnaire-unitunit :

Provides a computable unit of measure associated with numeric questions to support subsequent computation on responses. This is for use on items of type integer and decimal, and its purpose is to support converting the integer or decimal answer into a Quantity when extracting the data into a resource. If a 'display' value is provided for valueCoding of this extension and the associated question item does not have a child 'display' item with an itemControl extension of 'unit', then form fillers SHOULD take the display value of this extension and use it as as the unit display.

questionnaire-unitOptionunitOption :

A unit that the user may choose when providing a quantity value.

questionnaire-unitValueSetunitValueSet :

A set of units that the user may choose when providing a quantity value.

questionnaire-optionPrefixoptionPrefix :

The label to list in front of a code when presenting a list of possible values in a questionnaire-like fashion.

questionnaire-optionExclusiveoptionExclusive :

If true, indicates that if this answerOption is selected, no other possible answers may be selected, even if the item is a repeating question.

questionnaire-usageModeusageMode :

Identifies that the specified element should only appear in certain "modes" of operation.

questionnaire-supportLinksupportLink :

A URL that resolves to additional supporting information or guidance related to the question.

questionnaire-baseTypebaseType :

This identifies the underlying type in a profile, when a questionnaire is generated from a profile.

questionnaire-signatureRequiredsignatureRequired :

Indicates that a signature (of the specified type) is needed when completing the QuestionnaireResponse.

questionnaire-constraintconstraint :

An invariant that must be satisfied before responses to the questionnaire can be considered "complete".

questionnaire-sliderStepValuesliderStepValue :

For slider-based controls, indicates the step size to use when toggling the control up or down.