This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

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

Resource Profile: CRMI Publishable Questionnaire

Supports declaration of the Questionnaire metadata required by HL7 and other organizations that share and publish questionnaires with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

Usage:

• Examples for this Resource Profile: ANCB5Publishable

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
Slices for extension				Content/Rules for all slices
usage	S	0..1	markdown	Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
identifier	S	0..*	Identifier	Additional identifier for the questionnaire
date	S	1..1	dateTime	Date last changed
contact	S	0..*	ContactDetail	Contact details for the publisher
useContext	S	0..*	UsageContext	The context that the content is intended to support
jurisdiction	S	0..*	CodeableConcept	Intended jurisdiction for questionnaire (if applicable)
purpose	S	0..1	markdown	Why this questionnaire is defined
copyright	S	0..1	markdown	Use and/or publishing restrictions
approvalDate	S	0..1	date	When the questionnaire was approved by publisher
lastReviewDate	S	0..1	date	When the questionnaire was last reviewed
effectivePeriod	S	0..1	Period	When the questionnaire is expected to be used
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Questionnaire	C	1..1	Questionnaire	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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
usage	S	0..1	markdown	Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Additional identifier for the questionnaire
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
date	SΣ	1..1	dateTime	Date last changed
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	0..*	CodeableConcept	Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose	S	0..1	markdown	Why this questionnaire is defined
copyright	S	0..1	markdown	Use and/or publishing restrictions
approvalDate	S	0..1	date	When the questionnaire was approved by publisher
lastReviewDate	S	0..1	date	When the questionnaire was last reviewed
effectivePeriod	SΣ	0..1	Period	When the questionnaire is expected to be used
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.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard

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 que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation que-2: The link ids for groups and questions must be unique within the questionnaire
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. 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
usage	S	0..1	markdown	Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	0..1	uri	Canonical identifier for this questionnaire, represented as a URI (globally unique)
identifier	SΣ	0..*	Identifier	Additional identifier for the questionnaire
version	Σ	0..1	string	Business version of the questionnaire
name	ΣC	0..1	string	Name for this questionnaire (computer friendly)
title	Σ	0..1	string	Name for this questionnaire (human friendly)
derivedFrom		0..*	canonical(Questionnaire)	Instantiates protocol or definition
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	0..1	boolean	For testing purposes, not real usage
subjectType	Σ	0..*	code	Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
date	SΣ	1..1	dateTime	Date last changed
publisher	Σ	0..1	string	Name of the publisher (organization or individual)
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
description		0..1	markdown	Natural language description of the questionnaire
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	0..*	CodeableConcept	Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose	S	0..1	markdown	Why this questionnaire is defined
copyright	S	0..1	markdown	Use and/or publishing restrictions
approvalDate	S	0..1	date	When the questionnaire was approved by publisher
lastReviewDate	S	0..1	date	When the questionnaire was last reviewed
effectivePeriod	SΣ	0..1	Period	When the questionnaire is expected to be used
code	Σ	0..*	Coding	Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.
item	C	0..*	BackboneElement	Questions and sections within the Questionnaire que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only 'choice' and 'open-choice' items can have answerValueSet que-6: Required and repeat aren't permitted for display items que-8: Initial values can't be specified for groups or display items que-9: Read-only can't be specified for "display" items que-10: Maximum length can only be declared for simple question types que-11: If one or more answerOption is present, initial[x] must be missing que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items
id		0..1	string	Unique id for inter-element referencing
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 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	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	URI
Questionnaire.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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

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: 1 element
Must-Support: 18 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/artifact-usage
• http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
• http://hl7.org/fhir/StructureDefinition/artifact-topic
• http://hl7.org/fhir/StructureDefinition/artifact-author
• http://hl7.org/fhir/StructureDefinition/artifact-editor
• http://hl7.org/fhir/StructureDefinition/artifact-reviewer
• http://hl7.org/fhir/StructureDefinition/artifact-endorser
• http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact

Maturity: 3

Differential View

This structure is derived from Questionnaire

Name	Flags	Card.	Type	Description & Constraints
Questionnaire		1..1	Questionnaire	A structured set of questions
Slices for extension				Content/Rules for all slices
usage	S	0..1	markdown	Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
identifier	S	0..*	Identifier	Additional identifier for the questionnaire
date	S	1..1	dateTime	Date last changed
contact	S	0..*	ContactDetail	Contact details for the publisher
useContext	S	0..*	UsageContext	The context that the content is intended to support
jurisdiction	S	0..*	CodeableConcept	Intended jurisdiction for questionnaire (if applicable)
purpose	S	0..1	markdown	Why this questionnaire is defined
copyright	S	0..1	markdown	Use and/or publishing restrictions
approvalDate	S	0..1	date	When the questionnaire was approved by publisher
lastReviewDate	S	0..1	date	When the questionnaire was last reviewed
effectivePeriod	S	0..1	Period	When the questionnaire is expected to be used
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Questionnaire	C	1..1	Questionnaire	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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
usage	S	0..1	markdown	Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Additional identifier for the questionnaire
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
date	SΣ	1..1	dateTime	Date last changed
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	0..*	CodeableConcept	Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose	S	0..1	markdown	Why this questionnaire is defined
copyright	S	0..1	markdown	Use and/or publishing restrictions
approvalDate	S	0..1	date	When the questionnaire was approved by publisher
lastReviewDate	S	0..1	date	When the questionnaire was last reviewed
effectivePeriod	SΣ	0..1	Period	When the questionnaire is expected to be used
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.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard

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 que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation que-2: The link ids for groups and questions must be unique within the questionnaire
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. 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
usage	S	0..1	markdown	Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	0..1	uri	Canonical identifier for this questionnaire, represented as a URI (globally unique)
identifier	SΣ	0..*	Identifier	Additional identifier for the questionnaire
version	Σ	0..1	string	Business version of the questionnaire
name	ΣC	0..1	string	Name for this questionnaire (computer friendly)
title	Σ	0..1	string	Name for this questionnaire (human friendly)
derivedFrom		0..*	canonical(Questionnaire)	Instantiates protocol or definition
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	0..1	boolean	For testing purposes, not real usage
subjectType	Σ	0..*	code	Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
date	SΣ	1..1	dateTime	Date last changed
publisher	Σ	0..1	string	Name of the publisher (organization or individual)
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
description		0..1	markdown	Natural language description of the questionnaire
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	0..*	CodeableConcept	Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose	S	0..1	markdown	Why this questionnaire is defined
copyright	S	0..1	markdown	Use and/or publishing restrictions
approvalDate	S	0..1	date	When the questionnaire was approved by publisher
lastReviewDate	S	0..1	date	When the questionnaire was last reviewed
effectivePeriod	SΣ	0..1	Period	When the questionnaire is expected to be used
code	Σ	0..*	Coding	Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.
item	C	0..*	BackboneElement	Questions and sections within the Questionnaire que-1: Group items must have nested items, display items cannot have nested items que-3: Display items cannot have a "code" asserted que-4: A question cannot have both answerOption and answerValueSet que-5: Only 'choice' and 'open-choice' items can have answerValueSet que-6: Required and repeat aren't permitted for display items que-8: Initial values can't be specified for groups or display items que-9: Read-only can't be specified for "display" items que-10: Maximum length can only be declared for simple question types que-11: If one or more answerOption is present, initial[x] must be missing que-12: If there are more than one enableWhen, enableBehavior must be specified que-13: Can only have multiple initial values for repeating items
id		0..1	string	Unique id for inter-element referencing
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 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	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	URI
Questionnaire.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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

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: 1 element
Must-Support: 18 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/artifact-usage
• http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
• http://hl7.org/fhir/StructureDefinition/artifact-topic
• http://hl7.org/fhir/StructureDefinition/artifact-author
• http://hl7.org/fhir/StructureDefinition/artifact-editor
• http://hl7.org/fhir/StructureDefinition/artifact-reviewer
• http://hl7.org/fhir/StructureDefinition/artifact-endorser
• http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact

Maturity: 3

Other representations of profile: CSV, Excel, Schematron