Da Vinci - Documentation Templates and Rules
2.1.0 - STU 2.1
Da Vinci - Documentation Templates and Rules
2.1.0 - STU 2.1
This page is part of the Documentation Templates and Rules (v2.1.0: STU 2.1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-std-questionnaire | Version: 2.1.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: DTRStdQuestionnaire | ||
Takes a subset of extensions and constraints from the SDC rendering, behavior, and population profiles, reflecting agreed expectations around which data elements might be relevant as well as which must be supported for DTR purposes.
Elements that are not mustSupport are presented here as elements that may be of interest to certain payers, but can only be used if the payer is aware that the invoking EHR or SMART App can support them. Further guidance on the use of these elements should be found in the underlying SDC specification.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Questionnaire |
C | 0..* | SDCBaseQuestionnaire | A structured set of questions 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 |
Content/Rules for all slices | |||
  designNote |
0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| terminologyServer |
S | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| performerType |
S | 0..* | code | Resource that can record answers to this Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 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 | |
| entryMode |
S | 0..* | code | sequential | prior-edit | random URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| signatureRequired |
S | 0..1 | CodeableConcept | There's a cost to support this. URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| constraint |
0..* | (Complex) | A constraint on the target resource URL: http://hl7.org/fhir/StructureDefinition/targetConstraint ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| 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 | |
| launchContext |
S | 0..* | (Complex) | Context resources needed for Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| variable |
S | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 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 |
| url |
SΣ | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) ele-1: All FHIR elements must have a @value or children |
| version |
SΣ | 0..1 | string | Business version of the questionnaire ele-1: All FHIR elements must have a @value or children |
| title |
SΣ | 0..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 | |
| 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 |
| subjectType |
SΣ | 1..1 | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. ele-1: All FHIR elements must have a @value or children Required Pattern: Patient |
| effectivePeriod |
SΣ | 0..1 | Period | When the questionnaire is expected to be used 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 sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present. |
| Slices for extension |
Content/Rules for all slices | |||
| designNote |
0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| terminologyServer |
0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer 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 | |
| itemOptionalDisplay |
0..1 | boolean | Can suppress from display to user URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay 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 | |
| itemHidden |
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 |
| 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 | |
| usageMode |
0..1 | code | capture | display | display-non-empty | capture-display | capture-display-non-empty URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| itemSignatureRequired |
0..1 | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| minOccurs |
0..1 | integer | Minimum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| maxOccurs |
0..1 | integer | Maximum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| minLength |
0..1 | integer | At least this many characters URL: http://hl7.org/fhir/StructureDefinition/minLength ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| regex |
0..1 | string | Regular expression pattern URL: http://hl7.org/fhir/StructureDefinition/regex ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| minValue |
0..1 | date, dateTime, time, decimal, integer, Quantity | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| maxValue |
0..1 | date, dateTime, time, decimal, integer, Quantity | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| minQuantity |
0..1 | Quantity | Must be >= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| maxQuantity |
0..1 | Quantity | Must be <= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| maxDecimalPlaces |
0..1 | integer | Maximum digits after decimal URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| mimeType |
S | 0..1 | code | Type of attachment URL: http://hl7.org/fhir/StructureDefinition/mimeType Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| maxSize |
0..1 | decimal | Max size in bytes URL: http://hl7.org/fhir/StructureDefinition/maxSize ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| answerOptionsToggleExpression |
0..1 | (Complex) | Expression constraining allowed answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| unitOption |
S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| unitValueSet |
S | 0..1 | canonical(ValueSet) | Unit choices URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| referenceResource |
S | 0..* | code | Allowed resource for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| referenceProfile |
S | 0..* | canonical(StructureDefinition) | Allowed profile for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile 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 |
| lookupQuestionnaire |
S | 0..1 | canonical() | Questionnaire to populate a reference URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| itemConstraint |
0..* | (Complex) | A constraint on the target resource URL: http://hl7.org/fhir/StructureDefinition/targetConstraint 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 |
| calculatedExpression |
S | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| enableWhenExpression |
S | 0..1 | Expression | Expression for when to enable the item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression 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 | |
| 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 | 0..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 |
| itemTextCqfExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression 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 |
| enableWhen |
?!SC | 0..* | BackboneElement | Only allow data when ele-1: All FHIR elements must have a @value or children que-7: If the operator is 'exists', the value must be a boolean |
| 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 |
| question |
1..1 | string | Question that determines whether item is enabled ele-1: All FHIR elements must have a @value or children | |
| operator |
1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. ele-1: All FHIR elements must have a @value or children | |
 answer[x] |
C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
| answerBoolean |
boolean | |||
| answerDecimal |
decimal | |||
| answerInteger |
integer | |||
| answerDate |
date | |||
| answerDateTime |
dateTime | |||
| answerTime |
time | |||
| answerString |
string | |||
| answerCoding |
Coding | |||
| answerQuantity |
Quantity | |||
 answerReference |
Reference(Resource) | |||
| enableBehavior |
SC | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. 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 |
| value |
0..1 | boolean | Primitive value for boolean | |
| 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 | |
| requiredExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| repeats |
SC | 0..1 | boolean | Whether the item may repeat ele-1: All FHIR elements must have a @value or children |
| value |
0..1 | boolean | Primitive value for boolean | |
| 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 | |
| repeatsExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| readOnly |
SC | 0..1 | boolean | Don't allow human editing ele-1: All FHIR elements must have a @value or children |
| value |
0..1 | boolean | Primitive value for boolean | |
| 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 | |
| readOnlyExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| maxLength |
SC | 0..1 | integer | No more than this many characters ele-1: All FHIR elements must have a @value or children |
| answerValueSet |
SC | 0..1 | canonical(SDC ValueSet) | Valueset containing permitted answers ele-1: All FHIR elements must have a @value or children |
| value |
0..1 | string | Primitive value for canonical | |
| 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 | |
| answerValueSetExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| 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 | |
| optionExclusive |
S | 0..1 | boolean | Option is exclusive URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| ordinalValue |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue 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 | |
 value[x]All Types |
Content/Rules for all Types | |||
 Slices for extension |
Content/Rules for all slices | |||
| answerOptionRenderingXhtml |
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 |
| 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 / Code | 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.subjectType | required | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-types|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.enableBehavior | required | EnableWhenBehaviorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1from 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 SDCBaseQuestionnaire
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCBaseQuestionnaire | A structured set of questions 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 |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| designNote |
0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |||||
| terminologyServer |
S | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | ||||
| performerType |
S | 0..* | code | Resource that can record answers to this Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire. | ||||
| 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 | |||||
| entryMode |
S | 0..* | code | sequential | prior-edit | random URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire | ||||
| signatureRequired |
S | 0..1 | CodeableConcept | There's a cost to support this. URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. | ||||
| constraint |
0..* | (Complex) | A constraint on the target resource URL: http://hl7.org/fhir/StructureDefinition/targetConstraint | |||||
| 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 | |||||
| launchContext |
S | 0..* | (Complex) | Context resources needed for Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext | ||||
| variable |
S | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable | ||||
| 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 | ||||
| url |
SΣ | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) | ||||
| 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Σ | 0..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 |
0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
| 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 |
SΣ | 1..1 | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. Required Pattern: Patient | ||||
| 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 | When the questionnaire is expected to be used | ||||
| 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 sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| designNote |
0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |||||
| terminologyServer |
0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |||||
| itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |||||
| itemOptionalDisplay |
0..1 | boolean | Can suppress from display to user URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay | |||||
| shortText |
0..1 | string | Short text for the item. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-shortText | |||||
| itemHidden |
S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden | ||||
| 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. | |||||
| usageMode |
0..1 | code | capture | display | display-non-empty | capture-display | capture-display-non-empty URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item. | |||||
| itemSignatureRequired |
0..1 | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. | |||||
| minOccurs |
0..1 | integer | Minimum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs | |||||
| maxOccurs |
0..1 | integer | Maximum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs | |||||
| minLength |
0..1 | integer | At least this many characters URL: http://hl7.org/fhir/StructureDefinition/minLength | |||||
| regex |
0..1 | string | Regular expression pattern URL: http://hl7.org/fhir/StructureDefinition/regex | |||||
| minValue |
0..1 | date, dateTime, time, decimal, integer, Quantity | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue | |||||
| maxValue |
0..1 | date, dateTime, time, decimal, integer, Quantity | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue | |||||
| minQuantity |
0..1 | Quantity | Must be >= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity | |||||
| maxQuantity |
0..1 | Quantity | Must be <= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity | |||||
| maxDecimalPlaces |
0..1 | integer | Maximum digits after decimal URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces | |||||
| mimeType |
S | 0..1 | code | Type of attachment URL: http://hl7.org/fhir/StructureDefinition/mimeType Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) | ||||
| maxSize |
0..1 | decimal | Max size in bytes URL: http://hl7.org/fhir/StructureDefinition/maxSize | |||||
| answerOptionsToggleExpression |
0..1 | (Complex) | Expression constraining allowed answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression | |||||
| unitOption |
S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption | ||||
| unitValueSet |
S | 0..1 | canonical(ValueSet) | Unit choices URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet | ||||
| referenceResource |
S | 0..* | code | Allowed resource for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| referenceProfile |
S | 0..* | canonical(StructureDefinition) | Allowed profile for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile | ||||
| candidateExpression |
S | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression | ||||
| lookupQuestionnaire |
S | 0..1 | canonical() | Questionnaire to populate a reference URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire | ||||
| itemConstraint |
0..* | (Complex) | A constraint on the target resource URL: http://hl7.org/fhir/StructureDefinition/targetConstraint | |||||
| initialExpression |
S | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression | ||||
| calculatedExpression |
S | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression | ||||
| enableWhenExpression |
S | 0..1 | Expression | Expression for when to enable the item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression | ||||
| unit |
0..1 | Coding | Unit for numeric answer URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit | |||||
| 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 | 0..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 | ||||
| itemTextCqfExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | |||||
| 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. | ||||
| enableWhen |
?!SC | 0..* | BackboneElement | Only allow data when que-7: If the operator is 'exists', the value must be a boolean | ||||
| 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 | ||||
| question |
1..1 | string | Question that determines whether item is enabled | |||||
| operator |
1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |||||
| answer[x] |
C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| answerBoolean |
boolean | |||||||
| answerDecimal |
decimal | |||||||
| answerInteger |
integer | |||||||
| answerDate |
date | |||||||
| answerDateTime |
dateTime | |||||||
| answerTime |
time | |||||||
| answerString |
string | |||||||
| answerCoding |
Coding | |||||||
| answerQuantity |
Quantity | |||||||
| answerReference |
Reference(Resource) | |||||||
| enableBehavior |
SC | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. | ||||
| required |
SC | 0..1 | boolean | Whether the item must be included in data results | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| requiredExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| repeats |
SC | 0..1 | boolean | Whether the item may repeat | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| repeatsExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| readOnly |
SC | 0..1 | boolean | Don't allow human editing | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| readOnlyExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| maxLength |
SC | 0..1 | integer | No more than this many characters | ||||
| answerValueSet |
SC | 0..1 | canonical(SDC ValueSet) | Valueset containing permitted answers | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| value |
0..1 | string | Primitive value for canonical | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| answerValueSetExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| 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 | |||||
| optionExclusive |
S | 0..1 | boolean | Option is exclusive URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive | ||||
| ordinalValue |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue | |||||
| 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. | |||||
| value[x]All Types |
Content/Rules for all Types | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| answerOptionRenderingXhtml |
S | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | ||||
| 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 / Code | 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 | Pattern: Patienthttp://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.enableBehavior | required | EnableWhenBehaviorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1from 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 SDCBaseQuestionnaire
Summary
Mandatory: 2 elements
Must-Support: 28 elements
Prohibited: 2 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..* | SDCBaseQuestionnaire | A structured set of questions 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 |
Content/Rules for all slices | |||
| designNote |
0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| terminologyServer |
S | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| performerType |
S | 0..* | code | Resource that can record answers to this Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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 | |
| entryMode |
S | 0..* | code | sequential | prior-edit | random URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| signatureRequired |
S | 0..1 | CodeableConcept | There's a cost to support this. URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| constraint |
0..* | (Complex) | A constraint on the target resource URL: http://hl7.org/fhir/StructureDefinition/targetConstraint ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| 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 | |
| launchContext |
S | 0..* | (Complex) | Context resources needed for Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| variable |
S | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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 |
| url |
SΣ | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) ele-1: All FHIR elements must have a @value or children |
| version |
SΣ | 0..1 | string | Business version of the questionnaire ele-1: All FHIR elements must have a @value or children |
| title |
SΣ | 0..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 | |
| 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 |
| subjectType |
SΣ | 1..1 | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. ele-1: All FHIR elements must have a @value or children Required Pattern: Patient |
| effectivePeriod |
SΣ | 0..1 | Period | When the questionnaire is expected to be used 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 sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present. |
| Slices for extension |
Content/Rules for all slices | |||
| designNote |
0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| terminologyServer |
0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer 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 | |
| itemOptionalDisplay |
0..1 | boolean | Can suppress from display to user URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay 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 | |
| itemHidden |
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 |
| 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 | |
| usageMode |
0..1 | code | capture | display | display-non-empty | capture-display | capture-display-non-empty URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| itemSignatureRequired |
0..1 | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| minOccurs |
0..1 | integer | Minimum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| maxOccurs |
0..1 | integer | Maximum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| minLength |
0..1 | integer | At least this many characters URL: http://hl7.org/fhir/StructureDefinition/minLength ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| regex |
0..1 | string | Regular expression pattern URL: http://hl7.org/fhir/StructureDefinition/regex ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| minValue |
0..1 | date, dateTime, time, decimal, integer, Quantity | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| maxValue |
0..1 | date, dateTime, time, decimal, integer, Quantity | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| minQuantity |
0..1 | Quantity | Must be >= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| maxQuantity |
0..1 | Quantity | Must be <= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| maxDecimalPlaces |
0..1 | integer | Maximum digits after decimal URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| mimeType |
S | 0..1 | code | Type of attachment URL: http://hl7.org/fhir/StructureDefinition/mimeType Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| maxSize |
0..1 | decimal | Max size in bytes URL: http://hl7.org/fhir/StructureDefinition/maxSize ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| answerOptionsToggleExpression |
0..1 | (Complex) | Expression constraining allowed answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| unitOption |
S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| unitValueSet |
S | 0..1 | canonical(ValueSet) | Unit choices URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| referenceResource |
S | 0..* | code | Allowed resource for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| referenceProfile |
S | 0..* | canonical(StructureDefinition) | Allowed profile for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile 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 |
| lookupQuestionnaire |
S | 0..1 | canonical() | Questionnaire to populate a reference URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| itemConstraint |
0..* | (Complex) | A constraint on the target resource URL: http://hl7.org/fhir/StructureDefinition/targetConstraint 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 |
| calculatedExpression |
S | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| enableWhenExpression |
S | 0..1 | Expression | Expression for when to enable the item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression 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 | |
| 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 | 0..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 |
| itemTextCqfExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression 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 |
| enableWhen |
?!SC | 0..* | BackboneElement | Only allow data when ele-1: All FHIR elements must have a @value or children que-7: If the operator is 'exists', the value must be a boolean |
| 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 |
| question |
1..1 | string | Question that determines whether item is enabled ele-1: All FHIR elements must have a @value or children | |
| operator |
1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. ele-1: All FHIR elements must have a @value or children | |
| answer[x] |
C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children | |
| answerBoolean |
boolean | |||
| answerDecimal |
decimal | |||
| answerInteger |
integer | |||
| answerDate |
date | |||
| answerDateTime |
dateTime | |||
| answerTime |
time | |||
| answerString |
string | |||
| answerCoding |
Coding | |||
| answerQuantity |
Quantity | |||
| answerReference |
Reference(Resource) | |||
| enableBehavior |
SC | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. 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 |
| value |
0..1 | boolean | Primitive value for boolean | |
| 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 | |
| requiredExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| repeats |
SC | 0..1 | boolean | Whether the item may repeat ele-1: All FHIR elements must have a @value or children |
| value |
0..1 | boolean | Primitive value for boolean | |
| 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 | |
| repeatsExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| readOnly |
SC | 0..1 | boolean | Don't allow human editing ele-1: All FHIR elements must have a @value or children |
| value |
0..1 | boolean | Primitive value for boolean | |
| 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 | |
| readOnlyExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| maxLength |
SC | 0..1 | integer | No more than this many characters ele-1: All FHIR elements must have a @value or children |
| answerValueSet |
SC | 0..1 | canonical(SDC ValueSet) | Valueset containing permitted answers ele-1: All FHIR elements must have a @value or children |
| value |
0..1 | string | Primitive value for canonical | |
| 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 | |
| answerValueSetExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| 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 | |
| optionExclusive |
S | 0..1 | boolean | Option is exclusive URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| ordinalValue |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue 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 | |
| value[x]All Types |
Content/Rules for all Types | |||
| Slices for extension |
Content/Rules for all slices | |||
| answerOptionRenderingXhtml |
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 |
| 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 / Code | 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.subjectType | required | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-types|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.enableBehavior | required | EnableWhenBehaviorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1from 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 SDCBaseQuestionnaire
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire |
C | 0..* | SDCBaseQuestionnaire | A structured set of questions 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 |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| designNote |
0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |||||
| terminologyServer |
S | 0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | ||||
| performerType |
S | 0..* | code | Resource that can record answers to this Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-performerType Binding: Questionnaire Performer Type (required): Resources that can record answers to a questionnaire. | ||||
| 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 | |||||
| entryMode |
S | 0..* | code | sequential | prior-edit | random URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-entryMode Binding: Questionnaire Entry Mode (required): Entry modes when completing a questionnaire | ||||
| signatureRequired |
S | 0..1 | CodeableConcept | There's a cost to support this. URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. | ||||
| constraint |
0..* | (Complex) | A constraint on the target resource URL: http://hl7.org/fhir/StructureDefinition/targetConstraint | |||||
| 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 | |||||
| launchContext |
S | 0..* | (Complex) | Context resources needed for Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext | ||||
| variable |
S | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable | ||||
| 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 | ||||
| url |
SΣ | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) | ||||
| 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Σ | 0..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 |
0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
| 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 |
SΣ | 1..1 | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. Required Pattern: Patient | ||||
| 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 | When the questionnaire is expected to be used | ||||
| 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 sdc-1: An item cannot have an answerExpression if answerOption or answerValueSet is already present. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| designNote |
0..1 | markdown | Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote | |||||
| terminologyServer |
0..* | url | Preferred terminology server URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer | |||||
| itemMedia |
0..1 | Attachment | Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia | |||||
| itemOptionalDisplay |
0..1 | boolean | Can suppress from display to user URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay | |||||
| shortText |
0..1 | string | Short text for the item. URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-shortText | |||||
| itemHidden |
S | 0..1 | boolean | Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden | ||||
| 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. | |||||
| usageMode |
0..1 | code | capture | display | display-non-empty | capture-display | capture-display-non-empty URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode Binding: QuestionnaireItemUsageMode (required): Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item. | |||||
| itemSignatureRequired |
0..1 | CodeableConcept | Is signature needed? URL: http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired Binding: SignatureTypeCodes (preferred): The type of signature needed. | |||||
| minOccurs |
0..1 | integer | Minimum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs | |||||
| maxOccurs |
0..1 | integer | Maximum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs | |||||
| minLength |
0..1 | integer | At least this many characters URL: http://hl7.org/fhir/StructureDefinition/minLength | |||||
| regex |
0..1 | string | Regular expression pattern URL: http://hl7.org/fhir/StructureDefinition/regex | |||||
| minValue |
0..1 | date, dateTime, time, decimal, integer, Quantity | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue | |||||
| maxValue |
0..1 | date, dateTime, time, decimal, integer, Quantity | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue | |||||
| minQuantity |
0..1 | Quantity | Must be >= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-minQuantity | |||||
| maxQuantity |
0..1 | Quantity | Must be <= this value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-maxQuantity | |||||
| maxDecimalPlaces |
0..1 | integer | Maximum digits after decimal URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces | |||||
| mimeType |
S | 0..1 | code | Type of attachment URL: http://hl7.org/fhir/StructureDefinition/mimeType Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) | ||||
| maxSize |
0..1 | decimal | Max size in bytes URL: http://hl7.org/fhir/StructureDefinition/maxSize | |||||
| answerOptionsToggleExpression |
0..1 | (Complex) | Expression constraining allowed answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression | |||||
| unitOption |
S | 0..* | Coding | Unit choice URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption | ||||
| unitValueSet |
S | 0..1 | canonical(ValueSet) | Unit choices URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet | ||||
| referenceResource |
S | 0..* | code | Allowed resource for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| referenceProfile |
S | 0..* | canonical(StructureDefinition) | Allowed profile for reference URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile | ||||
| candidateExpression |
S | 0..1 | Expression | Expression for possible answers URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-candidateExpression | ||||
| lookupQuestionnaire |
S | 0..1 | canonical() | Questionnaire to populate a reference URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-lookupQuestionnaire | ||||
| itemConstraint |
0..* | (Complex) | A constraint on the target resource URL: http://hl7.org/fhir/StructureDefinition/targetConstraint | |||||
| initialExpression |
S | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression | ||||
| calculatedExpression |
S | 0..1 | Expression | Expression-determined initial value URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression | ||||
| enableWhenExpression |
S | 0..1 | Expression | Expression for when to enable the item URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression | ||||
| unit |
0..1 | Coding | Unit for numeric answer URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit | |||||
| 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 | 0..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 | ||||
| itemTextCqfExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | |||||
| 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. | ||||
| enableWhen |
?!SC | 0..* | BackboneElement | Only allow data when que-7: If the operator is 'exists', the value must be a boolean | ||||
| 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 | ||||
| question |
1..1 | string | Question that determines whether item is enabled | |||||
| operator |
1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |||||
| answer[x] |
C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| answerBoolean |
boolean | |||||||
| answerDecimal |
decimal | |||||||
| answerInteger |
integer | |||||||
| answerDate |
date | |||||||
| answerDateTime |
dateTime | |||||||
| answerTime |
time | |||||||
| answerString |
string | |||||||
| answerCoding |
Coding | |||||||
| answerQuantity |
Quantity | |||||||
| answerReference |
Reference(Resource) | |||||||
| enableBehavior |
SC | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. | ||||
| required |
SC | 0..1 | boolean | Whether the item must be included in data results | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| requiredExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| repeats |
SC | 0..1 | boolean | Whether the item may repeat | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| repeatsExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| readOnly |
SC | 0..1 | boolean | Don't allow human editing | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| readOnlyExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| maxLength |
SC | 0..1 | integer | No more than this many characters | ||||
| answerValueSet |
SC | 0..1 | canonical(SDC ValueSet) | Valueset containing permitted answers | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| value |
0..1 | string | Primitive value for canonical | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| answerValueSetExpression |
0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| 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 | |||||
| optionExclusive |
S | 0..1 | boolean | Option is exclusive URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive | ||||
| ordinalValue |
0..1 | decimal | Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue | |||||
| 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. | |||||
| value[x]All Types |
Content/Rules for all Types | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| answerOptionRenderingXhtml |
S | 0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | ||||
| 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 / Code | 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 | Pattern: Patienthttp://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.enableBehavior | required | EnableWhenBehaviorhttp://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1from 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 SDCBaseQuestionnaire
Summary
Mandatory: 2 elements
Must-Support: 28 elements
Prohibited: 2 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