Scope and Usage

This profile sets expectations for use of the QuestionnaireResponse resource within the Structured Data Capture implementation guide. This includes identifying which core elements and extensions must be supported.

For the purposes of this profile, Supported means that clients SHALL be capable of processing the element/extension and use the information to control the display and information capture associated with the QuestionnaireResponse resource. It means that servers SHALL be capable of persisting those elements and returning them in response to requests.

Boundaries and Relationships

This profile is related to the SDC Base Questionnaire Profile which defines the characteristic of a form "design". This profile focuses on the constraints appropriate to capturing the "answer(s)" to a pre-defined form.

This structure is derived from SDCQuestionnaireResponseCommon

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
QuestionnaireResponse		0..*	SDCQuestionnaireResponseCommon	Standard Questionnaire Response
questionnaire		1..1	canonical(SDC Base Questionnaire)	Form being answered
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:questionnaireDisplay	S	0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
Documentation for this format

This structure is derived from SDCQuestionnaireResponseCommon

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
QuestionnaireResponse	C	0..*	SDCQuestionnaireResponseCommon	Standard Questionnaire Response Constraints: sdcqr-1, sdcqr-2, sdcqr-3
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:adheresTo		0..*	(Complex)	Follows rules from URL: http://hl7.org/fhir/StructureDefinition/workflow-adheresTo
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/workflow-adheresTo"
value[x]		1..1		Value of extension
valueCanonical			canonical(ActivityDefinition | PlanDefinition)
valueReference			Reference(ActivityDefinition | PlanDefinition)
valueUri			uri
extension:triggeredBy		0..1	(Complex)	Created because of following URL: http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy"
value[x]		1..1		Value of extension
valueCanonical			canonical(ActivityDefinition | PlanDefinition)
valueReference			Reference(ActivityDefinition | PlanDefinition)
valueUri			uri
extension:signature		0..*	Signature	A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
extension:completionMode		0..1	CodeableConcept	E.g. Verbal, written, electronic URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode Binding: QuestionnaireResponseMode (required): Codes indicating how the questionnaire was completed.
extension:source		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source"
value[x]		1..1	Reference(Device | Organization)	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..1	Identifier	Unique id for this set of answers
questionnaire	SΣ	1..1	canonical(SDC Base Questionnaire)	Form being answered
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:questionnaireDisplay	S	0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
status	?!SΣ	1..1	code	in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.
subject	SΣ	0..1	Reference(Resource)	The subject of the questions
authored	SΣ	1..1	dateTime	Date the answers were gathered
author	SΣ	0..1	Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)	Person who received and recorded the answers
item	SC	0..*	BackboneElement	Groups and questions Constraints: qrs-1, qrs-2
Slices for extension				Content/Rules for all slices
extension:itemMedia		0..1	Attachment	Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia
extension:ItemSignature		0..*	Signature	A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
linkId	S	1..1	string	Pointer to specific item from Questionnaire
text	S	0..1	string	Name for group or question text
answer	S	0..*	BackboneElement	The response(s) to the question
Slices for extension				Content/Rules for all slices
extension:itemAnswerMedia		0..1	Attachment	Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia
extension:itemWeight		0..1	decimal	Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/itemWeight
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
value[x]	S	0..1		Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.
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	S	0..*	See item (QuestionnaireResponse)	Nested groups and questions
item	S	0..*	See item (QuestionnaireResponse)	Nested questionnaire response items
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
QuestionnaireResponse.status	required	QuestionnaireResponseStatus http://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1 From the FHIR Standard
QuestionnaireResponse.item.answer.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	QuestionnaireResponse	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	QuestionnaireResponse	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	QuestionnaireResponse	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	QuestionnaireResponse	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	QuestionnaireResponse	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()
qrs-1	error	QuestionnaireResponse.item	Nested item can't be beneath both item and answer : (answer.exists() and item.exists()).not()
qrs-2	error	QuestionnaireResponse.item	Repeated answers are combined in the answers array of a single item : repeat(answer|item).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue()
sdcqr-1	best practice	QuestionnaireResponse	Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. : subject.exists()
sdcqr-2	best practice	QuestionnaireResponse	When repeats=true for a group, it'll be represented with multiple items with the same linkId in the QuestionnaireResponse. For a question, it'll be represented by a single item with that linkId with multiple answers. : (QuestionnaireResponse|repeat(answer|item)).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue()
sdcqr-3	error	QuestionnaireResponse	Can either have source or source extension, but not both : source.count() + extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source').count() <=1

Differential View

This structure is derived from SDCQuestionnaireResponseCommon

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
QuestionnaireResponse		0..*	SDCQuestionnaireResponseCommon	Standard Questionnaire Response
questionnaire		1..1	canonical(SDC Base Questionnaire)	Form being answered
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:questionnaireDisplay	S	0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
QuestionnaireResponse	C	0..*	SDCQuestionnaireResponseCommon	Standard Questionnaire Response Constraints: sdcqr-1, sdcqr-2, sdcqr-3
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:adheresTo		0..*	(Complex)	Follows rules from URL: http://hl7.org/fhir/StructureDefinition/workflow-adheresTo
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/workflow-adheresTo"
value[x]		1..1		Value of extension
valueCanonical			canonical(ActivityDefinition | PlanDefinition)
valueReference			Reference(ActivityDefinition | PlanDefinition)
valueUri			uri
extension:triggeredBy		0..1	(Complex)	Created because of following URL: http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy"
value[x]		1..1		Value of extension
valueCanonical			canonical(ActivityDefinition | PlanDefinition)
valueReference			Reference(ActivityDefinition | PlanDefinition)
valueUri			uri
extension:signature		0..*	Signature	A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
extension:completionMode		0..1	CodeableConcept	E.g. Verbal, written, electronic URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode Binding: QuestionnaireResponseMode (required): Codes indicating how the questionnaire was completed.
extension:source		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source"
value[x]		1..1	Reference(Device | Organization)	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..1	Identifier	Unique id for this set of answers
basedOn	Σ	0..*	Reference(CarePlan | ServiceRequest)	Request fulfilled by this QuestionnaireResponse
partOf	Σ	0..*	Reference(Observation | Procedure)	Part of this action
questionnaire	SΣ	1..1	canonical(SDC Base Questionnaire)	Form being answered
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:questionnaireDisplay	S	0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
value		0..1	string	Primitive value for canonical
status	?!SΣ	1..1	code	in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.
subject	SΣ	0..1	Reference(Resource)	The subject of the questions
encounter	Σ	0..1	Reference(Encounter)	Encounter created as part of
authored	SΣ	1..1	dateTime	Date the answers were gathered
author	SΣ	0..1	Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)	Person who received and recorded the answers
source	Σ	0..1	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)	The person who answered the questions
item	SC	0..*	BackboneElement	Groups and questions Constraints: qrs-1, qrs-2
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:itemMedia		0..1	Attachment	Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia
extension:ItemSignature		0..*	Signature	A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
linkId	S	1..1	string	Pointer to specific item from Questionnaire
definition		0..1	uri	ElementDefinition - details for the item
text	S	0..1	string	Name for group or question text
answer	S	0..*	BackboneElement	The response(s) to the question
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:itemAnswerMedia		0..1	Attachment	Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia
extension:itemWeight		0..1	decimal	Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/itemWeight
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
value[x]	S	0..1		Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.
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	S	0..*	See item (QuestionnaireResponse)	Nested groups and questions
item	S	0..*	See item (QuestionnaireResponse)	Nested questionnaire response items
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
QuestionnaireResponse.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
QuestionnaireResponse.status	required	QuestionnaireResponseStatus http://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1 From the FHIR Standard
QuestionnaireResponse.item.answer.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	QuestionnaireResponse	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	QuestionnaireResponse	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	QuestionnaireResponse	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	QuestionnaireResponse	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	QuestionnaireResponse	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()
qrs-1	error	QuestionnaireResponse.item	Nested item can't be beneath both item and answer : (answer.exists() and item.exists()).not()
qrs-2	error	QuestionnaireResponse.item	Repeated answers are combined in the answers array of a single item : repeat(answer|item).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue()
sdcqr-1	best practice	QuestionnaireResponse	Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. : subject.exists()
sdcqr-2	best practice	QuestionnaireResponse	When repeats=true for a group, it'll be represented with multiple items with the same linkId in the QuestionnaireResponse. For a question, it'll be represented by a single item with that linkId with multiple answers. : (QuestionnaireResponse|repeat(answer|item)).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue()
sdcqr-3	error	QuestionnaireResponse	Can either have source or source extension, but not both : source.count() + extension.where(url='http://hl7.org/fhir/5.0/StructureDefinition/extension-QuestionnaireResponse.source').count() <=1

This structure is derived from SDCQuestionnaireResponseCommon