This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot2: STU1 Ballot 2) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

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

Resource Profile: CRMI Shareable Questionnaire

Enforces the minimum information set for the questionnaire metadata required by HL7 and other organizations that share and publish questionnaires

Usage:

• Examples for this Resource Profile: ANCB5Shareable

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 Questionnaire

Name	Flags	Card.	Type	Description & Constraints
Questionnaire		1..1	Questionnaire	A structured set of questions
knowledgeCapability	S	0..*	code	shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
knowledgeRepresentationLevel	S	0..*	code	narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required)
artifactComment	S	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
versionAlgorithm	S	0..1	string, Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
versionPolicy	S	0..1	CodeableConcept	metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
url	S	1..1	uri	Canonical identifier for this questionnaire, represented as a URI (globally unique)
version	S	1..1	string	Business version of the questionnaire
name	S	0..1	string	Name for this questionnaire (computer friendly)
title	S	1..1	string	Name for this questionnaire (human friendly)
status	S	1..1	code	draft | active | retired | unknown
experimental	S	1..1	boolean	For testing purposes, not real usage
publisher	S	0..1	string	Name of the publisher (organization or individual)
description	S	1..1	markdown	Natural language description of the questionnaire
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Questionnaire	C	1..1	Questionnaire	A structured set of questions
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
knowledgeCapability	S	0..*	code	shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
knowledgeRepresentationLevel	S	0..*	code	narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required)
artifactComment	S	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
versionAlgorithm	S	0..1	string, Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
versionPolicy	S	0..1	CodeableConcept	metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	SΣ	1..1	uri	Canonical identifier for this questionnaire, represented as a URI (globally unique)
version	SΣ	1..1	string	Business version of the questionnaire
name	SΣC	0..1	string	Name for this questionnaire (computer friendly)
title	SΣ	1..1	string	Name for this questionnaire (human friendly)
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	SΣ	1..1	boolean	For testing purposes, not real usage
publisher	SΣ	0..1	string	Name of the publisher (organization or individual)
description	S	1..1	markdown	Natural language description of the questionnaire
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Questionnaire.status	required	PublicationStatus

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Questionnaire	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Questionnaire	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 : 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-4	error	Questionnaire	If 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-5	error	Questionnaire	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Questionnaire	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
que-0	warning	Questionnaire	Name 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}')
que-2	error	Questionnaire	The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct()

Name	Flags	Card.	Type	Description & Constraints
Questionnaire	C	1..1	Questionnaire	A structured set of questions
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		0..*	Extension	Extension Slice: Unordered, Open by value:url
knowledgeCapability	S	0..*	code	shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
knowledgeRepresentationLevel	S	0..*	code	narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required)
artifactComment	S	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
versionAlgorithm	S	0..1	string, Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
versionPolicy	S	0..1	CodeableConcept	metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
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Σ	1..1	string	Business version of the questionnaire
name	SΣC	0..1	string	Name for this questionnaire (computer friendly)
title	SΣ	1..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	SΣ	1..1	boolean	For testing purposes, not real usage
subjectType	Σ	0..*	code	Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
date	Σ	0..1	dateTime	Date last changed
publisher	SΣ	0..1	string	Name of the publisher (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description	S	1..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	C	0..*	BackboneElement	Questions and sections within the Questionnaire
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
linkId		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		0..1	string	E.g. "1(a)", "2.5.3"
text		0..1	string	Primary text for the item
type		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
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	C	0..1	boolean	Whether the item must be included in data results
repeats	C	0..1	boolean	Whether the item may repeat
readOnly	C	0..1	boolean	Don't allow human editing
maxLength	C	0..1	integer	No more than this many characters
answerValueSet	C	0..1	canonical(ValueSet)	Valueset containing permitted answers
answerOption	C	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]		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	C	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]		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	C	0..*	See item (Questionnaire)	Nested questionnaire items
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Questionnaire.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Questionnaire.status	required	PublicationStatus
Questionnaire.subjectType	required	ResourceType
Questionnaire.jurisdiction	extensible	Jurisdiction ValueSet
Questionnaire.code	example	QuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.code	example	QuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.type	required	QuestionnaireItemType
Questionnaire.item.enableWhen.operator	required	QuestionnaireItemOperator
Questionnaire.item.enableWhen.answer[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.enableBehavior	required	EnableWhenBehavior
Questionnaire.item.answerOption.value[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.initial.value[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Questionnaire	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Questionnaire	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 : 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-4	error	Questionnaire	If 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-5	error	Questionnaire	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Questionnaire	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
que-0	warning	Questionnaire	Name 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}')
que-1	error	Questionnaire.item	Group 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-2	error	Questionnaire	The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct()
que-3	error	Questionnaire.item	Display items cannot have a "code" asserted : type!='display' or code.empty()
que-4	error	Questionnaire.item	A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty()
que-5	error	Questionnaire.item	Only '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-6	error	Questionnaire.item	Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty())
que-7	error	Questionnaire.item.enableWhen	If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean)
que-8	error	Questionnaire.item	Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty()
que-9	error	Questionnaire.item	Read-only can't be specified for "display" items : type!='display' or readOnly.empty()
que-10	error	Questionnaire.item	Maximum length can only be declared for simple question types : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11	error	Questionnaire.item	If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty()
que-12	error	Questionnaire.item	If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists()
que-13	error	Questionnaire.item	Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1

This structure is derived from Questionnaire

Summary

Mandatory: 5 elements
Must-Support: 13 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
• http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
• http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
• http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
• http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy

Maturity: 4

Differential View

This structure is derived from Questionnaire

Name	Flags	Card.	Type	Description & Constraints
Questionnaire		1..1	Questionnaire	A structured set of questions
knowledgeCapability	S	0..*	code	shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
knowledgeRepresentationLevel	S	0..*	code	narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required)
artifactComment	S	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
versionAlgorithm	S	0..1	string, Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
versionPolicy	S	0..1	CodeableConcept	metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
url	S	1..1	uri	Canonical identifier for this questionnaire, represented as a URI (globally unique)
version	S	1..1	string	Business version of the questionnaire
name	S	0..1	string	Name for this questionnaire (computer friendly)
title	S	1..1	string	Name for this questionnaire (human friendly)
status	S	1..1	code	draft | active | retired | unknown
experimental	S	1..1	boolean	For testing purposes, not real usage
publisher	S	0..1	string	Name of the publisher (organization or individual)
description	S	1..1	markdown	Natural language description of the questionnaire
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Questionnaire	C	1..1	Questionnaire	A structured set of questions
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
knowledgeCapability	S	0..*	code	shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
knowledgeRepresentationLevel	S	0..*	code	narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required)
artifactComment	S	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
versionAlgorithm	S	0..1	string, Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
versionPolicy	S	0..1	CodeableConcept	metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	SΣ	1..1	uri	Canonical identifier for this questionnaire, represented as a URI (globally unique)
version	SΣ	1..1	string	Business version of the questionnaire
name	SΣC	0..1	string	Name for this questionnaire (computer friendly)
title	SΣ	1..1	string	Name for this questionnaire (human friendly)
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	SΣ	1..1	boolean	For testing purposes, not real usage
publisher	SΣ	0..1	string	Name of the publisher (organization or individual)
description	S	1..1	markdown	Natural language description of the questionnaire
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Questionnaire.status	required	PublicationStatus

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Questionnaire	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Questionnaire	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 : 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-4	error	Questionnaire	If 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-5	error	Questionnaire	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Questionnaire	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
que-0	warning	Questionnaire	Name 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}')
que-2	error	Questionnaire	The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Questionnaire	C	1..1	Questionnaire	A structured set of questions
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		0..*	Extension	Extension Slice: Unordered, Open by value:url
knowledgeCapability	S	0..*	code	shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
knowledgeRepresentationLevel	S	0..*	code	narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required)
artifactComment	S	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
versionAlgorithm	S	0..1	string, Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
versionPolicy	S	0..1	CodeableConcept	metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
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Σ	1..1	string	Business version of the questionnaire
name	SΣC	0..1	string	Name for this questionnaire (computer friendly)
title	SΣ	1..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	SΣ	1..1	boolean	For testing purposes, not real usage
subjectType	Σ	0..*	code	Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
date	Σ	0..1	dateTime	Date last changed
publisher	SΣ	0..1	string	Name of the publisher (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description	S	1..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	C	0..*	BackboneElement	Questions and sections within the Questionnaire
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
linkId		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		0..1	string	E.g. "1(a)", "2.5.3"
text		0..1	string	Primary text for the item
type		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
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	C	0..1	boolean	Whether the item must be included in data results
repeats	C	0..1	boolean	Whether the item may repeat
readOnly	C	0..1	boolean	Don't allow human editing
maxLength	C	0..1	integer	No more than this many characters
answerValueSet	C	0..1	canonical(ValueSet)	Valueset containing permitted answers
answerOption	C	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]		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	C	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]		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	C	0..*	See item (Questionnaire)	Nested questionnaire items
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Questionnaire.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Questionnaire.status	required	PublicationStatus
Questionnaire.subjectType	required	ResourceType
Questionnaire.jurisdiction	extensible	Jurisdiction ValueSet
Questionnaire.code	example	QuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.code	example	QuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.type	required	QuestionnaireItemType
Questionnaire.item.enableWhen.operator	required	QuestionnaireItemOperator
Questionnaire.item.enableWhen.answer[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.enableBehavior	required	EnableWhenBehavior
Questionnaire.item.answerOption.value[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.initial.value[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Questionnaire	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Questionnaire	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 : 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-4	error	Questionnaire	If 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-5	error	Questionnaire	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Questionnaire	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
que-0	warning	Questionnaire	Name 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}')
que-1	error	Questionnaire.item	Group 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-2	error	Questionnaire	The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct()
que-3	error	Questionnaire.item	Display items cannot have a "code" asserted : type!='display' or code.empty()
que-4	error	Questionnaire.item	A question cannot have both answerOption and answerValueSet : answerOption.empty() or answerValueSet.empty()
que-5	error	Questionnaire.item	Only '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-6	error	Questionnaire.item	Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty())
que-7	error	Questionnaire.item.enableWhen	If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean)
que-8	error	Questionnaire.item	Initial values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty()
que-9	error	Questionnaire.item	Read-only can't be specified for "display" items : type!='display' or readOnly.empty()
que-10	error	Questionnaire.item	Maximum length can only be declared for simple question types : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11	error	Questionnaire.item	If one or more answerOption is present, initial[x] must be missing : answerOption.empty() or initial.empty()
que-12	error	Questionnaire.item	If there are more than one enableWhen, enableBehavior must be specified : enableWhen.count() > 2 implies enableBehavior.exists()
que-13	error	Questionnaire.item	Can only have multiple initial values for repeating items : repeats=true or initial.count() <= 1

This structure is derived from Questionnaire

Summary

Mandatory: 5 elements
Must-Support: 13 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
• http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
• http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
• http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
• http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy

Maturity: 4

Other representations of profile: CSV, Excel, Schematron