Da Vinci - Documentation Templates and Rules
2.1.0 - STU 2.1
Da Vinci - Documentation Templates and Rules
2.1.0 - STU 2.1
Da Vinci - Documentation Templates and Rules, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-dtr/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-questionnaire-adapt | Version: 2.1.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: DTRQuestionnaireAdapt | ||
The DTR Adaptive Questionnaire is used to represent an adaptive Questionnaire when actually filling out a QuestionnaireResponse.
NOTE: This profile does not realistically need the questionnaireAdaptive extension, but will remain intact due to potential impacts on Structured Data Capture (SDC) requirements. (Efforts will be made in an attempt to get the SDC requirements on this extension loosened in a future release)
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Questionnaire |
C | 0..* | SDCQuestionnaireAdapt | Adaptive Questionnaire dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation que-2: The link ids for groups and questions must be unique within the questionnaire |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  text |
1..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |
 status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. ele-1: All FHIR elements must have a @value or children | |
 div |
C | 1..1 | xhtml | Limited xhtml content ele-1: All FHIR elements must have a @value or children txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content |
 Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
  questionnaireAdaptive |
S | 1..1 | (Complex) | Marks a questionnaire as being adaptive. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
  extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive" | |
 value[x] |
0..1 | url | Value of extension ele-1: All FHIR elements must have a @value or children | |
| styleSensitive |
0..1 | (Complex) | Are styles important for processing? URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive" | |
| value[x] |
1..1 | boolean | Value of extension ele-1: All FHIR elements must have a @value or children Required Pattern: false | |
| cqf-library |
S | 0..* | (Complex) | The library can contain CQL, FHIRPath or x-fhir-query. The implementers must handle any of the above. URL: http://hl7.org/fhir/StructureDefinition/cqf-library ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-library" | |
| value[x] |
1..1 | canonical(SDCLibrary) | Value of extension ele-1: All FHIR elements must have a @value or children | |
 itemPopulationContext |
S | 0..* | Expression | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemPopulationContext ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| version |
SΣ | 0..1 | string | Business version of the questionnaire ele-1: All FHIR elements must have a @value or children |
| title |
SΣ | 1..1 | string | Name for this questionnaire (human friendly) ele-1: All FHIR elements must have a @value or children |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
  titleRenderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| titleRenderingXhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| derivedFrom |
S | 1..1 | canonical(Questionnaire) | Base Questionnaire this adaptive instance is drivenen from ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
| effectivePeriod |
SΣ | 0..1 | Period | Validity period for the Questionnaire ele-1: All FHIR elements must have a @value or children |
| item |
SC | 0..* | BackboneElement | Questions and sections within the Questionnaire ele-1: All FHIR elements must have a @value or children que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only 'choice' and 'open-choice' items can have answerValueSet que-6: Required and repeat aren't permitted for display items que-8: Initial values can't be specified for groups or display items que-9: Read-only can't be specified for "display" items que-10: Maximum length can only be declared for simple question types que-11: If one or more answerOption is present, initial[x] must be missing que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items |
 Slices for extension |
Content/Rules for all slices | |||
| hidden |
S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| shortText |
0..1 | string | Short text for the item. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-shortText ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| openLabel |
0..1 | string | Image to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-openLabel ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| itemControl |
S | 0..1 | CodeableConcept | E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc. URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| choiceOrientation |
0..1 | code | horizontal | vertical URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation Binding: ChoiceListOrientation (required): Direction in which lists of possible answers should be displayed. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| displayCategory |
0..1 | CodeableConcept | Purpose of rendered text URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory Binding: QuestionnaireDisplayCategories (extensible): Identifies the purpose for a "display" item. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| supportLink |
S | 0..* | uri | Supporting information URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| choiceColumn |
0..* | (Complex) | Guide for rendering multi-column choices URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| width |
0..1 | Quantity | Width of column for question URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-width ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| sliderStepValue |
0..1 | integer | Increment value for slider URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| entryFormat |
0..1 | string | User prompt for format URL: http://hl7.org/fhir/StructureDefinition/entryFormat ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| collapsible |
0..1 | code | Indicates whether the child items of a group or question item is displayed in collapsible form. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-collapsible Binding: Questionnaire Item Collapsible (required): Defines mechanism of displaying child items. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| initialExpression |
S | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| unit |
0..1 | Coding | Unit for numeric answer URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| candidateExpression |
S | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| contextExpression |
S | 0..* | (Complex) | Expression for information to guide answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-contextExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| linkId |
S | 1..1 | string | Unique id for item in questionnaire ele-1: All FHIR elements must have a @value or children |
| prefix |
S | 0..1 | string | E.g. "1(a)", "2.5.3" ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| itemPrefixRenderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| itemPrefixRenderingXhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| text |
S | 1..1 | string | Primary text for the item ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| itemTextRenderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| itemTextRenderingXhtml |
S | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| type |
S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. ele-1: All FHIR elements must have a @value or children |
| required |
SC | 0..1 | boolean | Whether the item must be included in data results ele-1: All FHIR elements must have a @value or children |
| repeats |
SC | 0..1 | boolean | Whether the item may repeat ele-1: All FHIR elements must have a @value or children |
| readOnly |
SC | 0..1 | boolean | Don't allow human editing ele-1: All FHIR elements must have a @value or children |
| answerValueSet |
C | 0..1 | canonical(ValueSet) | Valueset containing permitted answers ele-1: All FHIR elements must have a @value or children |
| answerOption |
SC | 0..* | BackboneElement | Permitted answer ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| itemAnswerMedia |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 value[x] |
S | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
| valueInteger |
integer | |||
| valueDate |
date | |||
| valueTime |
time | |||
| valueString |
string | |||
| valueCoding |
Coding | |||
 valueReference |
Reference(Resource) | |||
| initial |
SC | 0..* | BackboneElement | Initial value(s) when item is first rendered ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value[x] |
S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
| valueBoolean |
boolean | |||
| valueDecimal |
decimal | |||
| valueInteger |
integer | |||
| valueDate |
date | |||
| valueDateTime |
dateTime | |||
| valueTime |
time | |||
| valueString |
string | |||
| valueUri |
uri | |||
| valueAttachment |
Attachment | |||
| valueCoding |
Coding | |||
| valueQuantity |
Quantity | |||
| valueReference |
Reference(Resource) | |||
 item |
SC | 0..* | See item (Questionnaire) | Nested questionnaire items ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Questionnaire.text.status | required | NarrativeStatushttp://hl7.org/fhir/ValueSet/narrative-status|4.0.1from the FHIR Standard | |
| Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|4.0.1from the FHIR Standard | |
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1from the FHIR Standard | |
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | |
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | |
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard |
This structure is derived from SDCQuestionnaireAdapt
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCQuestionnaireAdapt | Adaptive Questionnaire que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation que-2: The link ids for groups and questions must be unique within the questionnaire | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
1..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content | ||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| questionnaireAdaptive |
S | 1..1 | (Complex) | Marks a questionnaire as being adaptive. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive" | |||||
| value[x] |
0..1 | url | Value of extension | |||||
| styleSensitive |
0..1 | (Complex) | Are styles important for processing? URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive" | |||||
| value[x] |
1..1 | boolean | Value of extension Required Pattern: false | |||||
| cqf-library |
S | 0..* | (Complex) | The library can contain CQL, FHIRPath or x-fhir-query. The implementers must handle any of the above. URL: http://hl7.org/fhir/StructureDefinition/cqf-library | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-library" | |||||
| value[x] |
1..1 | canonical(SDCLibrary) | Value of extension | |||||
| itemPopulationContext |
S | 0..* | Expression | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemPopulationContext | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the questionnaire | ||||
| version |
SΣ | 0..1 | string | Business version of the questionnaire | ||||
| name |
ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
| title |
SΣ | 1..1 | string | Name for this questionnaire (human friendly) | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| titleRenderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| titleRenderingXhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| derivedFrom |
S | 1..1 | canonical(Questionnaire) | Base Questionnaire this adaptive instance is drivenen from | ||||
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| subjectType |
Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
0..1 | markdown | Natural language description of the questionnaire | |||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this questionnaire is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the questionnaire was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the questionnaire was last reviewed | |||||
| effectivePeriod |
SΣ | 0..1 | Period | Validity period for the Questionnaire | ||||
| code |
Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| item |
SC | 0..* | BackboneElement | Questions and sections within the Questionnaire que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only 'choice' and 'open-choice' items can have answerValueSet que-6: Required and repeat aren't permitted for display items que-8: Initial values can't be specified for groups or display items que-9: Read-only can't be specified for "display" items que-10: Maximum length can only be declared for simple question types que-11: If one or more answerOption is present, initial[x] must be missing que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| hidden |
S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden | ||||
| itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |||||
| shortText |
0..1 | string | Short text for the item. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-shortText | |||||
| openLabel |
0..1 | string | Image to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-openLabel | |||||
| itemControl |
S | 0..1 | CodeableConcept | E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc. URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. | ||||
| choiceOrientation |
0..1 | code | horizontal | vertical URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation Binding: ChoiceListOrientation (required): Direction in which lists of possible answers should be displayed. | |||||
| displayCategory |
0..1 | CodeableConcept | Purpose of rendered text URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory Binding: QuestionnaireDisplayCategories (extensible): Identifies the purpose for a "display" item. | |||||
| supportLink |
S | 0..* | uri | Supporting information URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink | ||||
| choiceColumn |
0..* | (Complex) | Guide for rendering multi-column choices URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn | |||||
| width |
0..1 | Quantity | Width of column for question URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-width | |||||
| sliderStepValue |
0..1 | integer | Increment value for slider URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue | |||||
| entryFormat |
0..1 | string | User prompt for format URL: http://hl7.org/fhir/StructureDefinition/entryFormat | |||||
| collapsible |
0..1 | code | Indicates whether the child items of a group or question item is displayed in collapsible form. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-collapsible Binding: Questionnaire Item Collapsible (required): Defines mechanism of displaying child items. | |||||
| initialExpression |
S | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression | ||||
| unit |
0..1 | Coding | Unit for numeric answer URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit | |||||
| candidateExpression |
S | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression | ||||
| contextExpression |
S | 0..* | (Complex) | Expression for information to guide answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-contextExpression | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| linkId |
S | 1..1 | string | Unique id for item in questionnaire | ||||
| definition |
0..1 | uri | ElementDefinition - details for the item | |||||
| code |
C | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| prefix |
S | 0..1 | string | E.g. "1(a)", "2.5.3" | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| itemPrefixRenderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| itemPrefixRenderingXhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| text |
S | 1..1 | string | Primary text for the item | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| itemTextRenderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| itemTextRenderingXhtml |
S | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | ||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| type |
S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. | ||||
| required |
SC | 0..1 | boolean | Whether the item must be included in data results | ||||
| repeats |
SC | 0..1 | boolean | Whether the item may repeat | ||||
| readOnly |
SC | 0..1 | boolean | Don't allow human editing | ||||
| maxLength |
C | 0..1 | integer | No more than this many characters | ||||
| answerValueSet |
C | 0..1 | canonical(ValueSet) | Valueset containing permitted answers | ||||
| answerOption |
SC | 0..* | BackboneElement | Permitted answer | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| itemAnswerMedia |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| value[x] |
S | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| valueInteger |
integer | |||||||
| valueDate |
date | |||||||
| valueTime |
time | |||||||
| valueString |
string | |||||||
| valueCoding |
Coding | |||||||
| valueReference |
Reference(Resource) | |||||||
| initialSelected |
0..1 | boolean | Whether option is selected by default | |||||
| initial |
SC | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| value[x] |
S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| valueBoolean |
boolean | |||||||
| valueDecimal |
decimal | |||||||
| valueInteger |
integer | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueTime |
time | |||||||
| valueString |
string | |||||||
| valueUri |
uri | |||||||
| valueAttachment |
Attachment | |||||||
| valueCoding |
Coding | |||||||
| valueQuantity |
Quantity | |||||||
| valueReference |
Reference(Resource) | |||||||
| item |
SC | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Questionnaire.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Questionnaire.text.status | required | NarrativeStatushttp://hl7.org/fhir/ValueSet/narrative-status|4.0.1from the FHIR Standard | ||||
| Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| Questionnaire.subjectType | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1from the FHIR Standard | ||||
| Questionnaire.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questionsfrom the FHIR Standard | ||||
| Questionnaire.item.code | example | QuestionnaireQuestionCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questionsfrom the FHIR Standard | ||||
| Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|4.0.1from the FHIR Standard | ||||
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1from the FHIR Standard | ||||
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | ||||
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | ||||
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard |
This structure is derived from SDCQuestionnaireAdapt
Summary
Mandatory: 2 elements
Must-Support: 9 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCQuestionnaireAdapt | Adaptive Questionnaire dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation que-2: The link ids for groups and questions must be unique within the questionnaire |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| text |
1..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. ele-1: All FHIR elements must have a @value or children | |
| div |
C | 1..1 | xhtml | Limited xhtml content ele-1: All FHIR elements must have a @value or children txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| questionnaireAdaptive |
S | 1..1 | (Complex) | Marks a questionnaire as being adaptive. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive" | |
| value[x] |
0..1 | url | Value of extension ele-1: All FHIR elements must have a @value or children | |
| styleSensitive |
0..1 | (Complex) | Are styles important for processing? URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive" | |
| value[x] |
1..1 | boolean | Value of extension ele-1: All FHIR elements must have a @value or children Required Pattern: false | |
| cqf-library |
S | 0..* | (Complex) | The library can contain CQL, FHIRPath or x-fhir-query. The implementers must handle any of the above. URL: http://hl7.org/fhir/StructureDefinition/cqf-library ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-library" | |
| value[x] |
1..1 | canonical(SDCLibrary) | Value of extension ele-1: All FHIR elements must have a @value or children | |
| itemPopulationContext |
S | 0..* | Expression | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemPopulationContext ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| version |
SΣ | 0..1 | string | Business version of the questionnaire ele-1: All FHIR elements must have a @value or children |
| title |
SΣ | 1..1 | string | Name for this questionnaire (human friendly) ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| titleRenderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| titleRenderingXhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| derivedFrom |
S | 1..1 | canonical(Questionnaire) | Base Questionnaire this adaptive instance is drivenen from ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
| effectivePeriod |
SΣ | 0..1 | Period | Validity period for the Questionnaire ele-1: All FHIR elements must have a @value or children |
| item |
SC | 0..* | BackboneElement | Questions and sections within the Questionnaire ele-1: All FHIR elements must have a @value or children que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only 'choice' and 'open-choice' items can have answerValueSet que-6: Required and repeat aren't permitted for display items que-8: Initial values can't be specified for groups or display items que-9: Read-only can't be specified for "display" items que-10: Maximum length can only be declared for simple question types que-11: If one or more answerOption is present, initial[x] must be missing que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items |
| Slices for extension |
Content/Rules for all slices | |||
| hidden |
S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| shortText |
0..1 | string | Short text for the item. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-shortText ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| openLabel |
0..1 | string | Image to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-openLabel ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| itemControl |
S | 0..1 | CodeableConcept | E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc. URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| choiceOrientation |
0..1 | code | horizontal | vertical URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation Binding: ChoiceListOrientation (required): Direction in which lists of possible answers should be displayed. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| displayCategory |
0..1 | CodeableConcept | Purpose of rendered text URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory Binding: QuestionnaireDisplayCategories (extensible): Identifies the purpose for a "display" item. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| supportLink |
S | 0..* | uri | Supporting information URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| choiceColumn |
0..* | (Complex) | Guide for rendering multi-column choices URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| width |
0..1 | Quantity | Width of column for question URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-width ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| sliderStepValue |
0..1 | integer | Increment value for slider URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| entryFormat |
0..1 | string | User prompt for format URL: http://hl7.org/fhir/StructureDefinition/entryFormat ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| collapsible |
0..1 | code | Indicates whether the child items of a group or question item is displayed in collapsible form. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-collapsible Binding: Questionnaire Item Collapsible (required): Defines mechanism of displaying child items. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| initialExpression |
S | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| unit |
0..1 | Coding | Unit for numeric answer URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| candidateExpression |
S | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| contextExpression |
S | 0..* | (Complex) | Expression for information to guide answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-contextExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| linkId |
S | 1..1 | string | Unique id for item in questionnaire ele-1: All FHIR elements must have a @value or children |
| prefix |
S | 0..1 | string | E.g. "1(a)", "2.5.3" ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| itemPrefixRenderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| itemPrefixRenderingXhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| text |
S | 1..1 | string | Primary text for the item ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| itemTextRenderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| itemTextRenderingXhtml |
S | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| type |
S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. ele-1: All FHIR elements must have a @value or children |
| required |
SC | 0..1 | boolean | Whether the item must be included in data results ele-1: All FHIR elements must have a @value or children |
| repeats |
SC | 0..1 | boolean | Whether the item may repeat ele-1: All FHIR elements must have a @value or children |
| readOnly |
SC | 0..1 | boolean | Don't allow human editing ele-1: All FHIR elements must have a @value or children |
| answerValueSet |
C | 0..1 | canonical(ValueSet) | Valueset containing permitted answers ele-1: All FHIR elements must have a @value or children |
| answerOption |
SC | 0..* | BackboneElement | Permitted answer ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| itemAnswerMedia |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value[x] |
S | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
| valueInteger |
integer | |||
| valueDate |
date | |||
| valueTime |
time | |||
| valueString |
string | |||
| valueCoding |
Coding | |||
| valueReference |
Reference(Resource) | |||
| initial |
SC | 0..* | BackboneElement | Initial value(s) when item is first rendered ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value[x] |
S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
| valueBoolean |
boolean | |||
| valueDecimal |
decimal | |||
| valueInteger |
integer | |||
| valueDate |
date | |||
| valueDateTime |
dateTime | |||
| valueTime |
time | |||
| valueString |
string | |||
| valueUri |
uri | |||
| valueAttachment |
Attachment | |||
| valueCoding |
Coding | |||
| valueQuantity |
Quantity | |||
| valueReference |
Reference(Resource) | |||
| item |
SC | 0..* | See item (Questionnaire) | Nested questionnaire items ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Questionnaire.text.status | required | NarrativeStatushttp://hl7.org/fhir/ValueSet/narrative-status|4.0.1from the FHIR Standard | |
| Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|4.0.1from the FHIR Standard | |
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1from the FHIR Standard | |
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | |
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | |
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard |
Differential View
This structure is derived from SDCQuestionnaireAdapt
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCQuestionnaireAdapt | Adaptive Questionnaire que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation que-2: The link ids for groups and questions must be unique within the questionnaire | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
1..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content | ||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| questionnaireAdaptive |
S | 1..1 | (Complex) | Marks a questionnaire as being adaptive. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-questionnaireAdaptive" | |||||
| value[x] |
0..1 | url | Value of extension | |||||
| styleSensitive |
0..1 | (Complex) | Are styles important for processing? URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive" | |||||
| value[x] |
1..1 | boolean | Value of extension Required Pattern: false | |||||
| cqf-library |
S | 0..* | (Complex) | The library can contain CQL, FHIRPath or x-fhir-query. The implementers must handle any of the above. URL: http://hl7.org/fhir/StructureDefinition/cqf-library | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/cqf-library" | |||||
| value[x] |
1..1 | canonical(SDCLibrary) | Value of extension | |||||
| itemPopulationContext |
S | 0..* | Expression | Establishes mapping context for a Questionnaire item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemPopulationContext | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the questionnaire | ||||
| version |
SΣ | 0..1 | string | Business version of the questionnaire | ||||
| name |
ΣC | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
| title |
SΣ | 1..1 | string | Name for this questionnaire (human friendly) | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| titleRenderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| titleRenderingXhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| derivedFrom |
S | 1..1 | canonical(Questionnaire) | Base Questionnaire this adaptive instance is drivenen from | ||||
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| subjectType |
Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
0..1 | markdown | Natural language description of the questionnaire | |||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this questionnaire is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the questionnaire was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the questionnaire was last reviewed | |||||
| effectivePeriod |
SΣ | 0..1 | Period | Validity period for the Questionnaire | ||||
| code |
Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| item |
SC | 0..* | BackboneElement | Questions and sections within the Questionnaire que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only 'choice' and 'open-choice' items can have answerValueSet que-6: Required and repeat aren't permitted for display items que-8: Initial values can't be specified for groups or display items que-9: Read-only can't be specified for "display" items que-10: Maximum length can only be declared for simple question types que-11: If one or more answerOption is present, initial[x] must be missing que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| hidden |
S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden | ||||
| itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |||||
| shortText |
0..1 | string | Short text for the item. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-shortText | |||||
| openLabel |
0..1 | string | Image to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-openLabel | |||||
| itemControl |
S | 0..1 | CodeableConcept | E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc. URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: QuestionnaireItemUIControlCodes (extensible): User interface controls or widgets used for questionnaire items. | ||||
| choiceOrientation |
0..1 | code | horizontal | vertical URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation Binding: ChoiceListOrientation (required): Direction in which lists of possible answers should be displayed. | |||||
| displayCategory |
0..1 | CodeableConcept | Purpose of rendered text URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory Binding: QuestionnaireDisplayCategories (extensible): Identifies the purpose for a "display" item. | |||||
| supportLink |
S | 0..* | uri | Supporting information URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink | ||||
| choiceColumn |
0..* | (Complex) | Guide for rendering multi-column choices URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn | |||||
| width |
0..1 | Quantity | Width of column for question URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-width | |||||
| sliderStepValue |
0..1 | integer | Increment value for slider URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue | |||||
| entryFormat |
0..1 | string | User prompt for format URL: http://hl7.org/fhir/StructureDefinition/entryFormat | |||||
| collapsible |
0..1 | code | Indicates whether the child items of a group or question item is displayed in collapsible form. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-collapsible Binding: Questionnaire Item Collapsible (required): Defines mechanism of displaying child items. | |||||
| initialExpression |
S | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression | ||||
| unit |
0..1 | Coding | Unit for numeric answer URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit | |||||
| candidateExpression |
S | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression | ||||
| contextExpression |
S | 0..* | (Complex) | Expression for information to guide answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-contextExpression | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| linkId |
S | 1..1 | string | Unique id for item in questionnaire | ||||
| definition |
0..1 | uri | ElementDefinition - details for the item | |||||
| code |
C | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| prefix |
S | 0..1 | string | E.g. "1(a)", "2.5.3" | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| itemPrefixRenderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| itemPrefixRenderingXhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| text |
S | 1..1 | string | Primary text for the item | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| itemTextRenderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| itemTextRenderingXhtml |
S | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | ||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| type |
S | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. | ||||
| required |
SC | 0..1 | boolean | Whether the item must be included in data results | ||||
| repeats |
SC | 0..1 | boolean | Whether the item may repeat | ||||
| readOnly |
SC | 0..1 | boolean | Don't allow human editing | ||||
| maxLength |
C | 0..1 | integer | No more than this many characters | ||||
| answerValueSet |
C | 0..1 | canonical(ValueSet) | Valueset containing permitted answers | ||||
| answerOption |
SC | 0..* | BackboneElement | Permitted answer | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| itemAnswerMedia |
0..1 | Attachment | Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| value[x] |
S | 1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| valueInteger |
integer | |||||||
| valueDate |
date | |||||||
| valueTime |
time | |||||||
| valueString |
string | |||||||
| valueCoding |
Coding | |||||||
| valueReference |
Reference(Resource) | |||||||
| initialSelected |
0..1 | boolean | Whether option is selected by default | |||||
| initial |
SC | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| value[x] |
S | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| valueBoolean |
boolean | |||||||
| valueDecimal |
decimal | |||||||
| valueInteger |
integer | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueTime |
time | |||||||
| valueString |
string | |||||||
| valueUri |
uri | |||||||
| valueAttachment |
Attachment | |||||||
| valueCoding |
Coding | |||||||
| valueQuantity |
Quantity | |||||||
| valueReference |
Reference(Resource) | |||||||
| item |
SC | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Questionnaire.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Questionnaire.text.status | required | NarrativeStatushttp://hl7.org/fhir/ValueSet/narrative-status|4.0.1from the FHIR Standard | ||||
| Questionnaire.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| Questionnaire.subjectType | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1from the FHIR Standard | ||||
| Questionnaire.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| Questionnaire.code | example | QuestionnaireQuestionCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questionsfrom the FHIR Standard | ||||
| Questionnaire.item.code | example | QuestionnaireQuestionCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/questionnaire-questionsfrom the FHIR Standard | ||||
| Questionnaire.item.type | required | QuestionnaireItemTypehttp://hl7.org/fhir/ValueSet/item-type|4.0.1from the FHIR Standard | ||||
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperatorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1from the FHIR Standard | ||||
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | ||||
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard | ||||
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT)http://hl7.org/fhir/ValueSet/questionnaire-answersfrom the FHIR Standard |
This structure is derived from SDCQuestionnaireAdapt
Summary
Mandatory: 2 elements
Must-Support: 9 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.us.davinci-dtr#2.1.0 based on FHIR 4.0.1. Generated 2024-12-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change