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 QuestionnaireResponse

Name	Flags	Card.	Type	Description & Constraints
QuestionnaireResponse	C	0..*	QuestionnaireResponse	SDC Questionnaire Response sdcqr-1: Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. sdcqr-2: 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.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
signature		0..*	Signature	A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
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.
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
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
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	S	0..*	BackboneElement	Groups and questions
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
itemMedia		0..1	Attachment	Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia
ItemSignature		0..*	Signature	A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
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		0..*	Extension	Extension Slice: Unordered, Open by value:url
itemAnswerMedia		0..1	Attachment	Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia
ordinalValue		0..1	decimal	Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue
value[x]	S	0..1	boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)	Single-valued answer to the question
item	S	0..*	See item (QuestionnaireResponse)	Nested groups and questions
item	S	0..*	See item (QuestionnaireResponse)	Nested questionnaire response items
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from QuestionnaireResponse

Differential View

This structure is derived from QuestionnaireResponse

Name	Flags	Card.	Type	Description & Constraints
QuestionnaireResponse	C	0..*	QuestionnaireResponse	SDC Questionnaire Response sdcqr-1: Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. sdcqr-2: 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.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
signature		0..*	Signature	A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
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.
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
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
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	S	0..*	BackboneElement	Groups and questions
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
itemMedia		0..1	Attachment	Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia
ItemSignature		0..*	Signature	A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
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		0..*	Extension	Extension Slice: Unordered, Open by value:url
itemAnswerMedia		0..1	Attachment	Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia
ordinalValue		0..1	decimal	Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue
value[x]	S	0..1	boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)	Single-valued answer to the question
item	S	0..*	See item (QuestionnaireResponse)	Nested groups and questions
item	S	0..*	See item (QuestionnaireResponse)	Nested questionnaire response items
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
QuestionnaireResponse	C	0..*	QuestionnaireResponse	SDC Questionnaire Response sdcqr-1: Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. sdcqr-2: 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.
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
signature		0..*	Signature	A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
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.
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
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
itemMedia		0..1	Attachment	Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia
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		0..*	Extension	Extension Slice: Unordered, Open by value:url
itemAnswerMedia		0..1	Attachment	Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia
ordinalValue		0..1	decimal	Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue
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
QuestionnaireResponse.status	required	QuestionnaireResponseStatus
QuestionnaireResponse.item.answer.value[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
QuestionnaireResponse	C	0..*	QuestionnaireResponse	SDC Questionnaire Response sdcqr-1: Subject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject. sdcqr-2: 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.
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
signature		0..*	Signature	A signature attesting to the content URL: http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
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.
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
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
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
itemMedia		0..1	Attachment	Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemMedia
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
itemAnswerMedia		0..1	Attachment	Answer Media to display URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemAnswerMedia
ordinalValue		0..1	decimal	Assigned Ordinal Value URL: http://hl7.org/fhir/StructureDefinition/ordinalValue
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
QuestionnaireResponse.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
QuestionnaireResponse.status	required	QuestionnaireResponseStatus
QuestionnaireResponse.item.answer.value[x]	example	QuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from QuestionnaireResponse