Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: SDC Modular Questionnaire

Indicates expectations for questionnaires that draw their item content (not just codes) from other resources

Usage:

• Examples for this Resource Profile: QuestionnaireSDCModularContact, QuestionnaireSDCModularName and QuestionnaireSDCModularRoot

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from SDCBaseQuestionnaire

Name	Flags	Card.	Type	Description & Constraints
Questionnaire		0..*	SDCBaseQuestionnaire	A structured set of questions
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:assemble-expectation		1..1	AssembleExpectation	Questionnaire is modular
assembleContext	S	0..*	string	Variable name to be available from referencing Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleContext
item
Slices for extension				Content/Rules for all slices
subQuestionnaire	S	0..*	canonical()	Questionnaire to substitute here URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-subQuestionnaire
Documentation for this format

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 cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation sdc-2: If version is present, versionAlgorithm must be present. sdc-3: Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes
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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
versionAlgorithm	S	0..1	string, Coding	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x] ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
copyrightLabel		0..1	string	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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
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
assemble-expectation	S	1..1	code	Questionnaire is modular URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation Binding: Questionnaire Assemble Expectation (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
assembleContext	S	0..*	string	Variable name to be available from referencing Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleContext 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ΣC	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 cnl-1: Warning Questionnaire.url URL should not contain | or # - these characters make processing canonical references problematic
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
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Σ	0..*	code	Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. 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. que-1a: Group items must have nested items when Questionanire is complete que-1b: Groups should have items que-1c: Display items cannot have child items que-14: Can only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose)
Slices for extension				Content/Rules for all slices
hidden	S	0..1	boolean	Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
answerConstraint		0..1	code	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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
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
subQuestionnaire	S	0..*	canonical()	Questionnaire to substitute here URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-subQuestionnaire 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	SC	1..1	string	Unique id for item in questionnaire ele-1: All FHIR elements must have a @value or children que-15: Link ids must be 255 characters or less
prefix	S	0..1	string	E.g. "1(a)", "2.5.3" ele-1: All FHIR elements must have a @value or children
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	?!C	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)
required	SC	0..1	boolean	Whether the item must be included in data results ele-1: All FHIR elements must have a @value or children
repeats	SC	0..1	boolean	Whether the item may repeat ele-1: All FHIR elements must have a @value or children
readOnly	SC	0..1	boolean	Don't allow human editing ele-1: All FHIR elements must have a @value or children
answerValueSet	SC	0..1	canonical(SDC Value Set)	Valueset containing permitted answers ele-1: All FHIR elements must have a @value or children
answerOption	SC	0..*	BackboneElement	Permitted answer ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
value[x]	S	1..1		Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children
valueInteger			integer
valueDate			date
valueTime			time
valueString			string
valueCoding			Coding
valueReference			Reference(Resource)
initial	SC	0..*	BackboneElement	Initial value(s) when item is first rendered ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
value[x]	S	1..1		Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children
valueBoolean			boolean
valueDecimal			decimal
valueInteger			integer
valueDate			date
valueDateTime			dateTime
valueTime			time
valueString			string
valueUri			uri
valueAttachment			Attachment
valueCoding			Coding
valueQuantity			Quantity
valueReference			Reference(Resource)
item	SC	0..*	See item (Questionnaire)	Nested questionnaire items ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Questionnaire.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
Questionnaire.subjectType	required	ResourceType http://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard
Questionnaire.item.type	required	QuestionnaireItemType http://hl7.org/fhir/ValueSet/item-type|4.0.1 from the FHIR Standard
Questionnaire.item.enableWhen.operator	required	QuestionnaireItemOperator http://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1 from the FHIR Standard
Questionnaire.item.enableWhen.answer[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT) http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard
Questionnaire.item.answerOption.value[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT) http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard
Questionnaire.item.initial.value[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT) http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard

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 cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation sdc-2: If version is present, versionAlgorithm must be present. sdc-3: Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
versionAlgorithm	S	0..1	string, Coding	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]
copyrightLabel		0..1	string	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel
designNote		0..1	markdown	Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote
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.
assemble-expectation	S	1..1	code	Questionnaire is modular URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation Binding: Questionnaire Assemble Expectation (required)
assembleContext	S	0..*	string	Variable name to be available from referencing Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleContext
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	SΣC	1..1	uri	Canonical identifier for this questionnaire, represented as a URI (globally unique) cnl-1: Warning Questionnaire.url URL should not contain | or # - these characters make processing canonical references problematic
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)
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Σ	0..*	code	Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
date	Σ	0..1	dateTime	Date last changed
publisher	Σ	0..1	string	Name of the publisher (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description		0..1	markdown	Natural language description of the questionnaire
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose		0..1	markdown	Why this questionnaire is defined
copyright		0..1	markdown	Use and/or publishing restrictions
approvalDate		0..1	date	When the questionnaire was approved by publisher
lastReviewDate		0..1	date	When the questionnaire was last reviewed
effectivePeriod	Σ	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. que-1a: Group items must have nested items when Questionanire is complete que-1b: Groups should have items que-1c: Display items cannot have child items que-14: Can only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
hidden	S	0..1	boolean	Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden
answerConstraint		0..1	code	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint
designNote		0..1	markdown	Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote
itemOptionalDisplay		0..1	boolean	Can suppress from display to user URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay
subQuestionnaire	S	0..*	canonical()	Questionnaire to substitute here URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-subQuestionnaire
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
linkId	SC	1..1	string	Unique id for item in questionnaire que-15: Link ids must be 255 characters or less
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"
text		0..1	string	Primary text for the item
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	?!C	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	C	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
repeats	SC	0..1	boolean	Whether the item may repeat
readOnly	SC	0..1	boolean	Don't allow human editing
maxLength	C	0..1	integer	No more than this many characters
answerValueSet	SC	0..1	canonical(SDC Value Set)	Valueset containing permitted answers
answerOption	SC	0..*	BackboneElement	Permitted answer
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		Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
valueInteger			integer
valueDate			date
valueTime			time
valueString			string
valueCoding			Coding
valueReference			Reference(Resource)
initialSelected		0..1	boolean	Whether option is selected by default
initial	SC	0..*	BackboneElement	Initial value(s) when item is first rendered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
value[x]	S	1..1		Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
valueBoolean			boolean
valueDecimal			decimal
valueInteger			integer
valueDate			date
valueDateTime			dateTime
valueTime			time
valueString			string
valueUri			uri
valueAttachment			Attachment
valueCoding			Coding
valueQuantity			Quantity
valueReference			Reference(Resource)
item	SC	0..*	See item (Questionnaire)	Nested questionnaire items
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Questionnaire.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Questionnaire.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
Questionnaire.subjectType	required	ResourceType http://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard
Questionnaire.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard
Questionnaire.code	example	QuestionnaireQuestionCodes (a valid code from LOINC) http://hl7.org/fhir/ValueSet/questionnaire-questions from the FHIR Standard
Questionnaire.item.code	example	QuestionnaireQuestionCodes (a valid code from LOINC) http://hl7.org/fhir/ValueSet/questionnaire-questions from the FHIR Standard
Questionnaire.item.type	required	QuestionnaireItemType http://hl7.org/fhir/ValueSet/item-type|4.0.1 from the FHIR Standard
Questionnaire.item.enableWhen.operator	required	QuestionnaireItemOperator http://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1 from the FHIR Standard
Questionnaire.item.enableWhen.answer[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT) http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard
Questionnaire.item.enableBehavior	required	EnableWhenBehavior http://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1 from the FHIR Standard
Questionnaire.item.answerOption.value[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT) http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard
Questionnaire.item.initial.value[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT) http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard

This structure is derived from SDCBaseQuestionnaire

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleContext
• http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-subQuestionnaire

Maturity: 4

Differential View

This structure is derived from SDCBaseQuestionnaire

Name	Flags	Card.	Type	Description & Constraints
Questionnaire		0..*	SDCBaseQuestionnaire	A structured set of questions
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:assemble-expectation		1..1	AssembleExpectation	Questionnaire is modular
assembleContext	S	0..*	string	Variable name to be available from referencing Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleContext
item
Slices for extension				Content/Rules for all slices
subQuestionnaire	S	0..*	canonical()	Questionnaire to substitute here URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-subQuestionnaire
Documentation for this format

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 cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation sdc-2: If version is present, versionAlgorithm must be present. sdc-3: Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes
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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
versionAlgorithm	S	0..1	string, Coding	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x] ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
copyrightLabel		0..1	string	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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
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
assemble-expectation	S	1..1	code	Questionnaire is modular URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation Binding: Questionnaire Assemble Expectation (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
assembleContext	S	0..*	string	Variable name to be available from referencing Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleContext 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ΣC	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 cnl-1: Warning Questionnaire.url URL should not contain | or # - these characters make processing canonical references problematic
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
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Σ	0..*	code	Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. 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. que-1a: Group items must have nested items when Questionanire is complete que-1b: Groups should have items que-1c: Display items cannot have child items que-14: Can only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose)
Slices for extension				Content/Rules for all slices
hidden	S	0..1	boolean	Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
answerConstraint		0..1	code	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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
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
subQuestionnaire	S	0..*	canonical()	Questionnaire to substitute here URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-subQuestionnaire 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	SC	1..1	string	Unique id for item in questionnaire ele-1: All FHIR elements must have a @value or children que-15: Link ids must be 255 characters or less
prefix	S	0..1	string	E.g. "1(a)", "2.5.3" ele-1: All FHIR elements must have a @value or children
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	?!C	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)
required	SC	0..1	boolean	Whether the item must be included in data results ele-1: All FHIR elements must have a @value or children
repeats	SC	0..1	boolean	Whether the item may repeat ele-1: All FHIR elements must have a @value or children
readOnly	SC	0..1	boolean	Don't allow human editing ele-1: All FHIR elements must have a @value or children
answerValueSet	SC	0..1	canonical(SDC Value Set)	Valueset containing permitted answers ele-1: All FHIR elements must have a @value or children
answerOption	SC	0..*	BackboneElement	Permitted answer ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
value[x]	S	1..1		Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children
valueInteger			integer
valueDate			date
valueTime			time
valueString			string
valueCoding			Coding
valueReference			Reference(Resource)
initial	SC	0..*	BackboneElement	Initial value(s) when item is first rendered ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
value[x]	S	1..1		Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. ele-1: All FHIR elements must have a @value or children
valueBoolean			boolean
valueDecimal			decimal
valueInteger			integer
valueDate			date
valueDateTime			dateTime
valueTime			time
valueString			string
valueUri			uri
valueAttachment			Attachment
valueCoding			Coding
valueQuantity			Quantity
valueReference			Reference(Resource)
item	SC	0..*	See item (Questionnaire)	Nested questionnaire items ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Questionnaire.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
Questionnaire.subjectType	required	ResourceType http://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard
Questionnaire.item.type	required	QuestionnaireItemType http://hl7.org/fhir/ValueSet/item-type|4.0.1 from the FHIR Standard
Questionnaire.item.enableWhen.operator	required	QuestionnaireItemOperator http://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1 from the FHIR Standard
Questionnaire.item.enableWhen.answer[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT) http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard
Questionnaire.item.answerOption.value[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT) http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard
Questionnaire.item.initial.value[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT) http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard

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 cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation sdc-2: If version is present, versionAlgorithm must be present. sdc-3: Semver is the preferred version algorithm - package machinery doesn't work well with artifacts using alternate versioning schemes
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
versionAlgorithm	S	0..1	string, Coding	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.versionAlgorithm[x]
copyrightLabel		0..1	string	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.copyrightLabel
designNote		0..1	markdown	Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote
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.
assemble-expectation	S	1..1	code	Questionnaire is modular URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assemble-expectation Binding: Questionnaire Assemble Expectation (required)
assembleContext	S	0..*	string	Variable name to be available from referencing Questionnaire URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleContext
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	SΣC	1..1	uri	Canonical identifier for this questionnaire, represented as a URI (globally unique) cnl-1: Warning Questionnaire.url URL should not contain | or # - these characters make processing canonical references problematic
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)
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Σ	0..*	code	Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
date	Σ	0..1	dateTime	Date last changed
publisher	Σ	0..1	string	Name of the publisher (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description		0..1	markdown	Natural language description of the questionnaire
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose		0..1	markdown	Why this questionnaire is defined
copyright		0..1	markdown	Use and/or publishing restrictions
approvalDate		0..1	date	When the questionnaire was approved by publisher
lastReviewDate		0..1	date	When the questionnaire was last reviewed
effectivePeriod	Σ	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. que-1a: Group items must have nested items when Questionanire is complete que-1b: Groups should have items que-1c: Display items cannot have child items que-14: Can only have answerConstraint if answerOption, answerValueSet, or answerExpression are present. (This is a warning because other extensions may serve the same purpose)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
hidden	S	0..1	boolean	Don't display to user URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden
answerConstraint		0..1	code	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint
designNote		0..1	markdown	Design comments URL: http://hl7.org/fhir/StructureDefinition/designNote
itemOptionalDisplay		0..1	boolean	Can suppress from display to user URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay
subQuestionnaire	S	0..*	canonical()	Questionnaire to substitute here URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-subQuestionnaire
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
linkId	SC	1..1	string	Unique id for item in questionnaire que-15: Link ids must be 255 characters or less
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"
text		0..1	string	Primary text for the item
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	?!C	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	C	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
repeats	SC	0..1	boolean	Whether the item may repeat
readOnly	SC	0..1	boolean	Don't allow human editing
maxLength	C	0..1	integer	No more than this many characters
answerValueSet	SC	0..1	canonical(SDC Value Set)	Valueset containing permitted answers
answerOption	SC	0..*	BackboneElement	Permitted answer
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		Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
valueInteger			integer
valueDate			date
valueTime			time
valueString			string
valueCoding			Coding
valueReference			Reference(Resource)
initialSelected		0..1	boolean	Whether option is selected by default
initial	SC	0..*	BackboneElement	Initial value(s) when item is first rendered
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
value[x]	S	1..1		Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
valueBoolean			boolean
valueDecimal			decimal
valueInteger			integer
valueDate			date
valueDateTime			dateTime
valueTime			time
valueString			string
valueUri			uri
valueAttachment			Attachment
valueCoding			Coding
valueQuantity			Quantity
valueReference			Reference(Resource)
item	SC	0..*	See item (Questionnaire)	Nested questionnaire items
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Questionnaire.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Questionnaire.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
Questionnaire.subjectType	required	ResourceType http://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard
Questionnaire.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard
Questionnaire.code	example	QuestionnaireQuestionCodes (a valid code from LOINC) http://hl7.org/fhir/ValueSet/questionnaire-questions from the FHIR Standard
Questionnaire.item.code	example	QuestionnaireQuestionCodes (a valid code from LOINC) http://hl7.org/fhir/ValueSet/questionnaire-questions from the FHIR Standard
Questionnaire.item.type	required	QuestionnaireItemType http://hl7.org/fhir/ValueSet/item-type|4.0.1 from the FHIR Standard
Questionnaire.item.enableWhen.operator	required	QuestionnaireItemOperator http://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1 from the FHIR Standard
Questionnaire.item.enableWhen.answer[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT) http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard
Questionnaire.item.enableBehavior	required	EnableWhenBehavior http://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1 from the FHIR Standard
Questionnaire.item.answerOption.value[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT) http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard
Questionnaire.item.initial.value[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT) http://hl7.org/fhir/ValueSet/questionnaire-answers from the FHIR Standard

This structure is derived from SDCBaseQuestionnaire

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-assembleContext
• http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-subQuestionnaire

Maturity: 4

Other representations of profile: CSV, Excel, Schematron