# | | Name | Source | Ver | Description |
1 | | Answer Context Expression | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | A FHIR Query that resolves to one or more resources that can be displayed to the user to help provide context for answering a question. For example, if the question is "Has the patient discussed this issue on any visits in the past year?", the contextExpression might return the set of patient's encounters for the prior 12 month period to help jog the practitioner's memory. If there are multiple repetitions of this extension, then each is providing a distinct set of context. For example, one repetition might expose 'potentially relevant procedures' while another might expose 'potentially relevant encounters'. |
2 | | Answer Expression | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | An expression (FHIRPath, CQL or FHIR Query) that resolves to a list of permitted answers for the question item or that establishes context for a group item. The user may select from among the list to choose answers for the question. |
3 | | Answer Options Toggle Expression | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | A complex expression that provides a list of the allowed options that should be enabled or disabled based on the evaluation of a provided expression. It allows toggling of allowed answers based on context, including the answers provided to other expressions. Any options not listed by one of the answerOptionsToggleExpression occurrences are presumed to be 'enabled' |
4 | | Assemble Context extension | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Indicates a variable that must be available on any node that is referencing the Questionnaire as a sub-questionnaire |
5 | | Assembled From Questionnaire | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Indicates the Questionnaire a variable that must be available on any node that is referencing the Questionnaire as a sub-questionnaire |
6 | | Assembly Expectations for Questionnaire | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | If present, indicates that this questionnaire has expectations with respect to assembly. Specifically, indicates whether this form requires assembly (i.e. it can't be used directly without invoking the [$assemble](OperationDefinition-Questionnaire-assemble.html) operation operation on it) and/or whether it is intended for use only as a 'child' in an assembly process. The assembly processs might mean filling in item metadata based on information looked up from item.definitions and/or retrieving sub-questionnaires pointed to by [sub-questionnaire](StructureDefinition-sdc-questionnaire-subQuestionnaire.html) extensions. |
7 | | Calculated expression | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Calculated value for a question answer as determined by an evaluated expression. |
8 | | Candidate Answers Expression | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | A FHIRPath or CQL expression, or FHIR Query that resolves to a list of candidate answers for the question item or that establishes context for a group item. The user may select from among the candidates to choose answers for the question. |
9 | | Choice column | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Provides guidelines for rendering multi-column choices. I.e. when displaying a list of codes (for `choice` or `open-choice` items) or a list of resources (for `reference` items), this extension allows the drop-down to have multiple columns. For codes, the author can pick additional code system properties to display - such as alternate display names strength or form for drug codes, etc. For references, the author can choose particular columns from the resource (e.g. first name, last name, specialty, address). |
10 | | CMI Effective Data Requirements | hl7.fhir.uv.cmi#current | R4 | A module definition library that contains the effective data requirements for an artifact (i.e. the calculated data requirements for the expressions directly referenced by the artifact structure). |
11 | | Code system for other units | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | If the questionnaire-unit-open extension indicates that additional units other than the set of options provided for the question are allowed, this indicates the code system those units are expected to be drawn from. This extension SHOULD be present on any question where questionnaire-unit-open allows additional coded values. |
12 | | Collapsible | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Indicates whether the child items of a group or question item is displayed in collapsible form. |
13 | | Conceptmap | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | This extension references a ConceptMap that maps to relevant terminologies used in an implementation. |
14 | | CPG Answer Value Set Source Extension | hl7.fhir.uv.cpg#current | R4 | The canonical URL for the source value set for the answer options, when those options are provided directly in the questionnaire. |
15 | | CPG Item Image Extension | hl7.fhir.uv.cpg#current | R4 | An image to display as a visual accompaniment to the question being asked. |
16 | | CPG Response Image Extension | hl7.fhir.uv.cpg#current | R4 | An image to display as a visual accompaniment to the response. |
17 | | CRMI Effective Data Requirements | hl7.fhir.uv.crmi#current | R4 | A module definition library that contains the effective data requirements for an artifact (i.e. the calculated data requirements for the expressions directly referenced by the artifact structure). |
18 | | Design Note | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Information captured by the author/maintainer of the questionnaire for development purposes, not intended to be seen by users. |
19 | | Design Note | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Information captured by the author/maintainer of the questionnaire for development purposes, not intended to be seen by users. |
20 | | Design Note | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Information captured by the author/maintainer of the questionnaire for development purposes, not intended to be seen by users. |
21 | | Enable when expression | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | An expression that returns a boolean value for whether to enable the item. If the expression does not resolve to a boolean, it is considered an error in the design of the Questionnaire. Form renderer behavior is undefined. Some tools may attempt to force the value to be a boolean (e.g. is it a non-empty collection, non-null, non-zero - if so, then true). Systems SHOULD present a warning to the user if a non-boolean valued expression result does not trigger an all-out error. |
22 | | Endpoint | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | The base URL for the server(s) to which questionnaire response associated with this questionnaire should be submitted. If multiple repetitions are present, the completed form should be sent to all listed endpoints. |
23 | | Entry format | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Additional instructions for the user to guide their input (i.e. a human readable version of a regular expression like "nnn-nnn-nnn"). In most UIs this is the placeholder (or 'ghost') text placed directly inside the edit controls and that disappear when the control gets the focus. |
24 | | Entry mode | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Indicates how questions within the questionnaire should be presented to the end-user. Specifically, differentiates whether the questions should be displayed one-at-a-time with no ability to adjust prior entries; one-at-a-time or continuously expanding where all questions up to the current question can be looked at and edited, or random, where all questions can be seen and the questions can be filled out in any order desired. |
25 | | initial.exists().not() | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Initial value for a question answer as determined by an evaluated expression. |
26 | | Is subject? | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | If present and true, indicates that the item establishes a different subject for the group in a response. |
27 | | Item Answer Media | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Media to render/make available as an accompaniment to a specific answer option, for example - an image, video or audio clip. This does not replace the need for answer.value[x]. The attachment.text SHOULD be present as the alternative/accessibility text for systems unable to expose the media and users unable to consume it. Media.contentType SHALL be present. When included in a QuestionnaireResponse it SHALL be the same as the media for the corresponding answerOption in the Questionnaire. |
28 | | Item extraction context | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Specifies a query or other expression that identifies the resource (or set of resources for a repeating item) to be extracted from this item once the QuestionnaireResponse is complete. |
29 | | Item extraction context | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Specifies a query or other expression that identifies the resource (or set of resources for a repeating item) to be extracted from this item once the QuestionnaireResponse is complete. |
30 | | Item Media | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Media to render/make available as an accompaniment to the question being asked, for example - an image, video or audio clip. This does not replace the need for item.text. The attachment.text SHOULD be present as the alternative/accessibility text for systems unable to expose the media and users unable to consume it. Media.contentType SHALL be present. When included in a QuestionnaireResponse it SHALL be the same as the media for the same item in the Questionnaire. |
31 | | Item population context | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Specifies a query or other expression that identifies the resource (or set of resources for a repeating item) that should be used to support the population of this Questionnaire or Questionnaire.item on initial population. When populating the questionnaire, it will set the specified variable name to that resource repetition for use in processing items within the group. |
32 | | Item population context | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Specifies a query or other expression that identifies the resource (or set of resources for a repeating item) that should be used to support the population of this Questionnaire or Questionnaire.item on initial population. When populating the questionnaire, it will set the specified variable name to that resource repetition for use in processing items within the group. |
33 | | Item Weight | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores. Note: This extension used to called http://hl7.org/fhir/StructureDefinition/ordinalValue |
34 | | Label for 'open' items | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | The label text to display beside free-text and/or unrestricted type values for an 'open' choice element. E.g. 'Other, please specify', or 'Additional condition', or 'More reason(s)', etc. |
35 | | Launch context resources | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Resources that provide context for form processing logic (pre-population, flow-control, drop-down selection, etc.) when creating/displaying/editing a QuestionnaireResponse. |
36 | | Lookup questionnaire | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | For items of type reference, the reference can be populated either by picking an existing entity or by creating a new one. In the latter case, this Questionnaire allows specifying the Questionnaire to use in creating the target instance. Typically this will result in a QuestionnaireResponse that can be [extracted](extraction.html) to produce the desired resource. However, if the target resource for the reference is a QuestionnaireResponse, then the QuestionnaireResponse resulting from the Questionnaire can be referenced directly. |
37 | | Max decimal places | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Identifies the maximum number of decimal places that may be specified for the data element. |
38 | | Max quantity | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | The inclusive upper bound on the range of allowed values for a 'quantity' type question. Open Issue: Revisit whether this should be folded into the regular maxValue extension once there are better capabilities around defining conformance expectations regarding extensions. |
39 | | Max size | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | For attachment answers, indicates the maximum size in bytes an attachment can be. |
40 | | Max value | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | The inclusive upper bound on the range of allowed values for the data element. |
41 | | Mime type | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Identifies the kind(s) of attachment allowed to be sent for an element. |
42 | | Min length | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | The minimum number of characters that must be present in the simple data type to be considered a "valid" instance. |
43 | | Min quantity | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | The inclusive lower bound on the range of allowed values for a 'quantity' type question. Open Issue: Revisit whether this should be folded into the regular minValue extension once there are better capabilities around defining conformance expectations regarding extensions. |
44 | | Min value | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | The inclusive lower bound on the range of allowed values for the data element. |
45 | | Obervation link period | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Indicates the time-period (from 'now') to search for observations that match the Questionnaire.item.code and Questionnaire.subject when pre-populating the QuestionnaireResponse. |
46 | | Observation extract | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | If true, indicates that the observation-based approach should be used to extract either the particular item (if extension is defined on an individual question or group based on the code present) or all items in the questionnaire (if defined at the questionnaire root and if they have a code present). |
47 | | Observation extract | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | If true, indicates that the observation-based approach should be used to extract either the particular item (if extension is defined on an individual question or group based on the code present) or all items in the questionnaire (if defined at the questionnaire root and if they have a code present). |
48 | | Observation extract | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | If true, indicates that the observation-based approach should be used to extract either the particular item (if extension is defined on an individual question or group based on the code present) or all items in the questionnaire (if defined at the questionnaire root and if they have a code present). |
49 | | Observation Extract Category | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Indicates the Observation.category value(s) that should appear on extracted Observations for the entire Questionnaire or for the current item and descendant items. If this extension appears at multiple levels in the Questionnaire, those defined on lower-level items override those declared on higher-level items. |
50 | | Observation Extract Category | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Indicates the Observation.category value(s) that should appear on extracted Observations for the entire Questionnaire or for the current item and descendant items. If this extension appears at multiple levels in the Questionnaire, those defined on lower-level items override those declared on higher-level items. |
51 | | Optional Display? | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | This extension is used when defining high-level questionnaires that will then be used as a basis for 'derived' Questionnaires that are further refined for use in specific organizations or contexts. If the extension is present and set to 'true', it means that this item should be considered to be 'optional' from an adaptation perspective and that the question can be removed (i.e. not displayed) in derived questionnaires without impacting the validity of the instrument. Alternatively, the element can be marked as 'hidden' and 'readOnly' and have a value or descendant item values declared using initialValue or initialExpression. If the element with 'optionalDisplay=true' is marked as 'required=true', then this second approach is the only means to exclude the element from display. |
52 | | Performer type | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Indicates the types of resources that can record answers to a Questionnaire. Open Issue: Should this extension be moved to core? |
53 | | Permitted Value Conceptmap | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Expresses the linkage between the internal codes used for storage and the codes used for exchange. |
54 | | Permitted Value Valueset | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Allows expressing the value set that must be stored internally by the system (as distinct from the base value set which defines values for exchange). |
55 | | Preferred terminology server | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Indicates the terminology server(s) that are known to be capable of returning and potentially expanding the value set(s) associated with the whole questionnaire or a particular group or question within the questionnaire (depending on where the extension appears). If a full URL is not provided AND the requested query is a terminology operation (e.g. $lookup or $expand) the client SHOULD execute the operation against (one of) the preferredTerminologyServer(s) rather than the local repository. |
56 | | Preferred terminology server | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Indicates the terminology server(s) that are known to be capable of returning and potentially expanding the value set(s) associated with the whole questionnaire or a particular group or question within the questionnaire (depending on where the extension appears). If a full URL is not provided AND the requested query is a terminology operation (e.g. $lookup or $expand) the client SHOULD execute the operation against (one of) the preferredTerminologyServer(s) rather than the local repository. |
57 | | Questionnaire adaptive | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Marks a questionnaire as being adaptive. Value can either be a boolean (if true, indicates adaptive) or a URL for the base URL of a server that can perform the nextQuestion operation for this particular questionnaire. |
58 | | Questionnaire Base Type | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | This identifies the underlying type in a profile, when a questionnaire is generated from a profile. |
59 | | Questionnaire ChoiceOrientation | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Identifies the desired orientation when rendering a list of choices (typically radio-box or check-box lists). |
60 | | Questionnaire Constraint | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | An invariant that must be satisfied before responses to the questionnaire can be considered "complete". |
61 | | Questionnaire Constraint | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | An invariant that must be satisfied before responses to the questionnaire can be considered "complete". |
62 | | Questionnaire Derivation Type | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Provides more precision about the type of derivation relationship that exists. |
63 | | Questionnaire Display Category | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Describes the intended purpose of the rendered text. For example - instructions, guidance on access control, maintenance information, etc. |
64 | | Questionnaire FHIR Type | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | For questionnaires generated from FHIR profiles, indicates the FHIR data type or resource type that corresponds to this node. |
65 | | Questionnaire Hidden | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | If true, indicates that the extended item should not be displayed to the user. |
66 | | Questionnaire is Definition Based | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | 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. |
67 | | Questionnaire Item Control | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | 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. |
68 | | Questionnaire Max Occurs | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | 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. |
69 | | Questionnaire Min Occurs | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | The minimum number of times the group must appear, or the minimum number of answers for a question - when greater than 1. |
70 | | Questionnaire Option Exclusive | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | If true, indicates that if this answerOption is selected, no other possible answers may be selected, even if the item is a repeating question. |
71 | | Questionnaire Option Prefix | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | The label to list in front of a code when presenting a list of possible values in a questionnaire-like fashion. |
72 | | Questionnaire Option Restriction | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Allows disabling certain questionnaire options for the containing item based on evaluating expressions. |
73 | | Questionnaire Reference Profile | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | 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. |
74 | | Questionnaire Reference Resource | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Where the type for a question is "Reference", indicates a type of resource that is permitted. |
75 | | Questionnaire Signature Required | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Indicates that a signature (of the specified type) is needed when completing the QuestionnaireResponse. |
76 | | Questionnaire Signature Required | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Indicates that a signature (of the specified type) is needed when completing the QuestionnaireResponse. |
77 | | Questionnaire Slider Step Value | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | For slider-based controls, indicates the step size to use when toggling the control up or down. |
78 | | Questionnaire Support Link | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | A URL that resolves to additional supporting information or guidance related to the question. |
79 | | Questionnaire Unit | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | 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. |
80 | | QuestionnaireResponse Unit Option | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | A unit that the user may choose when providing a quantity value. |
81 | | QuestionnaireResponse Unit ValueSet | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | A set of units that the user may choose when providing a quantity value. |
82 | | QuestionnaireResponse Usage Mode | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Identifies that the specified element should only appear in certain "modes" of operation. |
83 | | ReferenceFilter | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | 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.** |
84 | | Replaces | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | This indicates a separate conformance resource instance that is superseded by the current instance. |
85 | | Short text | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | The short text for the item. |
86 | | Source queries for population mapping | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | A Batch Bundle containing a set of queries that should be executed to provide source data for a StructureMap to create a populated QuestionnaireResponse. |
87 | | Source structure map | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | StructureMaps that have this QuestionnaireResponses for this Questionnaire as 'target' - i.e. that can be used to create QuestionnaireResponses that are valid against this Questionnaire. |
88 | | Sub-questionnaire | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Indicates that the display item on which this extension appears should be replaced with the referenced Questionnaire |
89 | | Target structure map | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | StructureMaps that have QuestionnaireResponses of this Questionnaire as 'source'- i.e. that can be used to create other artifacts from QuestionnaireResponses that are valid against this Questionnaire. If multiple maps are specified, then multiple extraction outputs will be produced. Authors can choose between a single output 'transaction' Bundle or multiple outputs depending on the desired behavior and maintenance process. |
90 | | Units open? | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | Indicates whether the list of supported units (conveyed in other extensions) are the exhaustive list from which the user must choose or whether they're able to select alternate codes or specify a string. |
91 | | Variable | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Variable specifying a logic to generate a variable for use in subsequent logic. The name of the variable will be added to FHIRPath's context when processing descendants of the element that contains this extension as well as extensions within the same element. |
92 | | Variable | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Variable specifying a logic to generate a variable for use in subsequent logic. The name of the variable will be added to FHIRPath's context when processing descendants of the element that contains this extension as well as extensions within the same element. |
93 | | Variable | hl7.fhir.uv.extensions.r4#1.0.0 | R4 | Variable specifying a logic to generate a variable for use in subsequent logic. The name of the variable will be added to FHIRPath's context when processing descendants of the element that contains this extension as well as extensions within the same element. |
94 | | Width of column | hl7.fhir.uv.sdc.r4#3.0.0 | R4 | When used with an item control that causes the question to appear as a column in a table, indicates the width to give to the column for this question. |