2.7.0 - STU 3 (2nd ballot)

This page is part of the Structured Data Capture FHIR IG (v2.7.0: STU 3 Ballot 2) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: QuestionnaireRender

The official URL for this profile is: 

http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-render

Scope and Usage

This profile expands adds additional constraints and extensions to the base SDC questionnaire profile that support the design of questionnaires with more sophisticated rendering, including tables, specialized controls, styled text, etc. This profile identifies which core elements and extensions must be supported and highlights other elements that, while not required, may be relevant to the questionnaire rendering use-case. Further information on how this use-case is implemented as well as guidance on on the elements and extensions included in the profile can be found on the Advanced Rendering page.

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 0..*Advanced Rendering Questionnaire
... rendering-styleSensitive S0..1booleanAre styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
... title 0..1string
.... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
... item 1..*BackboneElement
.... sdc-questionnaire-optionalDisplay 0..1booleanCan suppress from display to user
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay
.... questionnaire-hidden S0..1booleanDon't display to user
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden
.... questionnaire-itemControl S0..1CodeableConceptE.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl
Binding: QuestionnaireItemUIControlCodes (extensible)
.... questionnaire-choiceOrientation 0..1codehorizontal | vertical
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation
Binding: ChoiceListOrientation (required)
.... questionnaire-displayCategory S0..1CodeableConceptPurpose of rendered text
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory
Binding: QuestionnaireTextCategories (extensible)
.... questionnaire-supportLink 0..*uriSupporting information
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink
.... sdc-questionnaire-choiceColumn 0..*(Complex)Guide for rendering multi-column choices
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn
.... sdc-questionnaire-width 0..1QuantityWidth of column for question
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-width
.... questionnaire-sliderStepValue 0..1integerIncrement value for slider
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue
.... entryFormat S0..1stringUser prompt for format
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
.... prefix 0..1string
..... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... text 0..1string
..... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... answerOption 0..*BackboneElement

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire I0..*Advanced Rendering Questionnaire
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... designNote I0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
... sdc-questionnaire-preferredTerminologyServer I0..*uriPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
... rendering-styleSensitive S0..1booleanAre styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive"
.... valueBoolean 0..1booleanValue of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the questionnaire
... version SΣ0..1stringBusiness version of the questionnaire
... name ΣI0..1stringName for this questionnaire (computer friendly)
... title Σ0..1stringName for this questionnaire (human friendly)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... rendering-style I0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.... rendering-xhtml I0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... value 0..1Primitive value for string
Max Length: 1048576
... derivedFrom 0..*canonical(Questionnaire)Instantiates protocol or definition
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... subjectType SΣ1..1codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the questionnaire
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose 0..1markdownWhy this questionnaire is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the questionnaire was approved by publisher
... lastReviewDate 0..1dateWhen the questionnaire was last reviewed
... effectivePeriod Σ0..1PeriodWhen the questionnaire is expected to be used
... code Σ0..*CodingConcept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example)
... item I1..*BackboneElementQuestions and sections within the Questionnaire
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... designNote I0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... sdc-questionnaire-preferredTerminologyServer I0..*uriPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
.... sdc-questionnaire-optionalDisplay 0..1booleanCan suppress from display to user
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay"
..... valueBoolean 0..1booleanValue of extension
.... questionnaire-hidden S0..1booleanDon't display to user
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-hidden"
..... valueBoolean 0..1booleanValue of extension
.... questionnaire-itemControl S0..1CodeableConceptE.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl
Binding: QuestionnaireItemUIControlCodes (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl"
..... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: QuestionnaireItemUIControlCodes (extensible)
.... questionnaire-choiceOrientation 0..1codehorizontal | vertical
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation
Binding: ChoiceListOrientation (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation"
..... valueCode 0..1codeValue of extension
Binding: ChoiceListOrientation (required)
.... questionnaire-displayCategory S0..1CodeableConceptPurpose of rendered text
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory
Binding: QuestionnaireTextCategories (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory"
..... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: QuestionnaireTextCategories (extensible)
.... questionnaire-supportLink 0..*uriSupporting information
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink"
..... valueUri 0..1uriValue of extension
.... sdc-questionnaire-choiceColumn 0..*(Complex)Guide for rendering multi-column choices
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... extension 1..1ExtensionColumn path
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"path"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionColumn label
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"label"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionWidth of column
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"width"
...... valueQuantity 0..1QuantityValue of extension
..... extension 0..1ExtensionUse for display ?
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"forDisplay"
...... valueBoolean 0..1booleanValue of extension
..... url 1..1uri"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn"
.... sdc-questionnaire-width 0..1QuantityWidth of column for question
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-width
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-width"
..... valueQuantity 0..1QuantityValue of extension
.... questionnaire-sliderStepValue 0..1integerIncrement value for slider
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue"
..... valueInteger 0..1integerValue of extension
.... entryFormat S0..1stringUser prompt for format
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/entryFormat"
..... valueString 0..1stringValue of extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code I0..*CodingCorresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example)
.... prefix 0..1stringE.g. "1(a)", "2.5.3"
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... rendering-style I0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... rendering-xhtml I0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... value 0..1Primitive value for string
Max Length: 1048576
.... text 0..1stringPrimary text for the item
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... rendering-style I0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... rendering-xhtml I0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... value 0..1Primitive value for string
Max Length: 1048576
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required)
.... enableWhen ?!I0..*BackboneElementOnly allow data when
que-7: If the operator is 'exists', the value must be a boolean
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... question 1..1stringQuestion that determines whether item is enabled
..... operator 1..1codeexists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required)
..... answer[x] I1..1boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource)Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example)
.... enableBehavior I0..1codeall | any
Binding: EnableWhenBehavior (required)
.... required SI0..1booleanWhether the item must be included in data results
.... repeats SI0..1booleanWhether the item may repeat
.... readOnly SI0..1booleanDon't allow human editing
.... maxLength SI0..1integerNo more than this many characters
.... answerValueSet SI0..1canonical(SDCValueSet)Valueset containing permitted answers
.... answerOption I0..*BackboneElementPermitted answer
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1integer, date, time, string, Coding, Reference(Resource)Answer value
Binding: QuestionnaireAnswerCodes (example)
..... initialSelected 0..1booleanWhether option is selected by default
.... initial SI0..*BackboneElementInitial value(s) when item is first rendered
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] S1..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example)
.... item SI0..*Unknown reference to #Questionnaire.item
Nested questionnaire items

doco Documentation for this format

Differential View

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 0..*Advanced Rendering Questionnaire
... rendering-styleSensitive S0..1booleanAre styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
... title 0..1string
.... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
... item 1..*BackboneElement
.... sdc-questionnaire-optionalDisplay 0..1booleanCan suppress from display to user
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay
.... questionnaire-hidden S0..1booleanDon't display to user
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden
.... questionnaire-itemControl S0..1CodeableConceptE.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl
Binding: QuestionnaireItemUIControlCodes (extensible)
.... questionnaire-choiceOrientation 0..1codehorizontal | vertical
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation
Binding: ChoiceListOrientation (required)
.... questionnaire-displayCategory S0..1CodeableConceptPurpose of rendered text
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory
Binding: QuestionnaireTextCategories (extensible)
.... questionnaire-supportLink 0..*uriSupporting information
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink
.... sdc-questionnaire-choiceColumn 0..*(Complex)Guide for rendering multi-column choices
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn
.... sdc-questionnaire-width 0..1QuantityWidth of column for question
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-width
.... questionnaire-sliderStepValue 0..1integerIncrement value for slider
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue
.... entryFormat S0..1stringUser prompt for format
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
.... prefix 0..1string
..... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... text 0..1string
..... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... answerOption 0..*BackboneElement

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire I0..*Advanced Rendering Questionnaire
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... designNote I0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
... sdc-questionnaire-preferredTerminologyServer I0..*uriPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
... rendering-styleSensitive S0..1booleanAre styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive"
.... valueBoolean 0..1booleanValue of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the questionnaire
... version SΣ0..1stringBusiness version of the questionnaire
... name ΣI0..1stringName for this questionnaire (computer friendly)
... title Σ0..1stringName for this questionnaire (human friendly)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... rendering-style I0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.... rendering-xhtml I0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... value 0..1Primitive value for string
Max Length: 1048576
... derivedFrom 0..*canonical(Questionnaire)Instantiates protocol or definition
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... subjectType SΣ1..1codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the questionnaire
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose 0..1markdownWhy this questionnaire is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the questionnaire was approved by publisher
... lastReviewDate 0..1dateWhen the questionnaire was last reviewed
... effectivePeriod Σ0..1PeriodWhen the questionnaire is expected to be used
... code Σ0..*CodingConcept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example)
... item I1..*BackboneElementQuestions and sections within the Questionnaire
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... designNote I0..1markdownDesign comments
URL: http://hl7.org/fhir/StructureDefinition/designNote
.... sdc-questionnaire-preferredTerminologyServer I0..*uriPreferred terminology server
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-preferredTerminologyServer
.... sdc-questionnaire-optionalDisplay 0..1booleanCan suppress from display to user
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay"
..... valueBoolean 0..1booleanValue of extension
.... questionnaire-hidden S0..1booleanDon't display to user
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-hidden"
..... valueBoolean 0..1booleanValue of extension
.... questionnaire-itemControl S0..1CodeableConceptE.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl
Binding: QuestionnaireItemUIControlCodes (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl"
..... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: QuestionnaireItemUIControlCodes (extensible)
.... questionnaire-choiceOrientation 0..1codehorizontal | vertical
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation
Binding: ChoiceListOrientation (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation"
..... valueCode 0..1codeValue of extension
Binding: ChoiceListOrientation (required)
.... questionnaire-displayCategory S0..1CodeableConceptPurpose of rendered text
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory
Binding: QuestionnaireTextCategories (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory"
..... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: QuestionnaireTextCategories (extensible)
.... questionnaire-supportLink 0..*uriSupporting information
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink"
..... valueUri 0..1uriValue of extension
.... sdc-questionnaire-choiceColumn 0..*(Complex)Guide for rendering multi-column choices
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... extension 1..1ExtensionColumn path
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"path"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionColumn label
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"label"
...... valueString 0..1stringValue of extension
..... extension 0..1ExtensionWidth of column
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"width"
...... valueQuantity 0..1QuantityValue of extension
..... extension 0..1ExtensionUse for display ?
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"forDisplay"
...... valueBoolean 0..1booleanValue of extension
..... url 1..1uri"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn"
.... sdc-questionnaire-width 0..1QuantityWidth of column for question
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-width
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-width"
..... valueQuantity 0..1QuantityValue of extension
.... questionnaire-sliderStepValue 0..1integerIncrement value for slider
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue"
..... valueInteger 0..1integerValue of extension
.... entryFormat S0..1stringUser prompt for format
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/entryFormat"
..... valueString 0..1stringValue of extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code I0..*CodingCorresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example)
.... prefix 0..1stringE.g. "1(a)", "2.5.3"
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... rendering-style I0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... rendering-xhtml I0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... value 0..1Primitive value for string
Max Length: 1048576
.... text 0..1stringPrimary text for the item
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... rendering-style I0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... rendering-xhtml I0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... value 0..1Primitive value for string
Max Length: 1048576
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required)
.... enableWhen ?!I0..*BackboneElementOnly allow data when
que-7: If the operator is 'exists', the value must be a boolean
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... question 1..1stringQuestion that determines whether item is enabled
..... operator 1..1codeexists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required)
..... answer[x] I1..1boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource)Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example)
.... enableBehavior I0..1codeall | any
Binding: EnableWhenBehavior (required)
.... required SI0..1booleanWhether the item must be included in data results
.... repeats SI0..1booleanWhether the item may repeat
.... readOnly SI0..1booleanDon't allow human editing
.... maxLength SI0..1integerNo more than this many characters
.... answerValueSet SI0..1canonical(SDCValueSet)Valueset containing permitted answers
.... answerOption I0..*BackboneElementPermitted answer
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1integer, date, time, string, Coding, Reference(Resource)Answer value
Binding: QuestionnaireAnswerCodes (example)
..... initialSelected 0..1booleanWhether option is selected by default
.... initial SI0..*BackboneElementInitial value(s) when item is first rendered
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] S1..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example)
.... item SI0..*Unknown reference to #Questionnaire.item
Nested questionnaire items

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Questionnaire.statusrequiredPublicationStatus
Questionnaire.subjectTyperequiredResourceType
Questionnaire.item.typerequiredQuestionnaireItemType
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes

Constraints

IdPathDetailsRequirements
dom-2QuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4QuestionnaireIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3QuestionnaireIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6QuestionnaireA resource should have narrative for robust management
: text.div.exists()
dom-5QuestionnaireIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
que-2QuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-0QuestionnaireName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ele-1Questionnaire.title.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Questionnaire.title.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.title.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Questionnaire.title.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.title.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Questionnaire.title.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.itemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
que-9Questionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-8Questionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-6Questionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-5Questionnaire.itemOnly 'choice' and 'open-choice' items can have answerValueSet
: (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())
que-4Questionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-3Questionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-10Questionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-1Questionnaire.itemGroup items must have nested items, display items cannot have nested items
: (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())
que-13Questionnaire.itemCan only have multiple initial values for repeating items
: repeats=true or initial.count() <= 1
que-11Questionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12Questionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
ele-1Questionnaire.item.prefix.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Questionnaire.item.prefix.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.prefix.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Questionnaire.item.prefix.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.prefix.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Questionnaire.item.prefix.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.text.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Questionnaire.item.text.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.text.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Questionnaire.item.text.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.text.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Questionnaire.item.text.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.enableWhenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
que-7Questionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
ele-1Questionnaire.item.answerOptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Questionnaire.item.initialAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())