QuestionnaireResponse resource implementation guidance
Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully develop applications using the FHIR® CDS API.
QuestionnaireResponse: Implementation Guidance
Usage
The responses to a Questionnaire sent by the CDSS are communicated back by the EMS using the QuestionnaireResponse resource. The EMS will present the question and the set of possible responses received from the CDSS to the user during an ongoing clinical evaluation process and any answers from the user will be used to populate a QuestionnaireResponse.
Detailed implementation guidance for a QuestionnaireResponse resource in the scope of this implementation guide is given below:
| Name | Cardinality | Type | FHIR Documentation | CDS Implementation Guidance |
|---|---|---|---|---|
id |
0..1 |
id | Logical id of this artifact | Note that this will always be populated except when the resource is being created (initial creation call) |
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. Common Languages (Extensible but limited to All Languages) |
|
text |
0..1 |
Narrative | Text summary of the resource, for human interpretation | |
contained |
0..* |
Resource | Contained, inline Resources | This SHOULD NOT be populated |
extension |
0..* |
Extension | Additional Content defined by implementations | |
modifierExtension |
0..* |
Extension | Extensions that cannot be ignored | |
identifier |
0..1 |
Identifier | Unique id for this set of answers | |
basedOn |
0..* |
Reference | (ReferralRequest | CarePlan | ProcedureRequest) |
Request fulfilled by this QuestionnaireResponse | This MUST NOT be populated. |
parent |
0..* |
Reference | (Observation | Procedure) |
Part of this action | This MUST NOT be populated. |
questionnaire |
0..1 |
Reference | (Questionnaire) |
Form being answered | This MUST be populated with a reference to the Questionnaire to which this QuestionnaireResponse is responding. |
status |
1..1 |
code | in-progress | completed | amended | entered-in-error | stopped QuestionnaireResponseStatus (Required). | This MUST be populated with either 'completed', 'amended' or 'entered-in-error'.
Other statuses are not valid. |
subject |
0..1 |
Reference(Any) | The subject of the questions | This MUST be populated with the Patient. |
context |
0..1 |
Reference | (Encounter | EpisodeOfCare) |
Encounter or Episode during which questionnaire was completed | This MUST be populated with the Encounter for this journey, which is the same as the ServiceDefinition.$evaluate.encounter
|
authored |
0..1 |
dateTime | Date the answers were gathered | This MUST be populated with the date and/or time that this set of answers was entered or last changed. |
author |
0..1 |
Reference | (Device | Practitioner | Patient | RelatedPerson) |
Person who received and recorded the answers | This SHOULD be the user of the Encounter Management System. |
source |
0..1 |
Reference | (Patient | Practitioner | RelatedPerson) |
The person who answered the questions | This MUST be either the patient or the third party acting on behalf of the patient.
This MUST NOT be the practitioner. |
item |
0..* |
BackboneElement | Groups and questions | The population of this element and its children MUST reflect the item nesting in the Questionnaire to which this QuestionnaireResponse is responding. |
item.linkId |
1..1 |
string | Pointer to specific item from Questionnaire | |
item.definition |
0..1 |
uri | ElementDefinition - details for the item | This MUST NOT be populated. |
item.text |
0..1 |
string | Name for group or question text | This MUST NOT be populated. |
item.subject |
1..1 |
Reference | (Any) | The subject this group's answers are about | This MUST be populated with the Patient. |
item.answer |
0..* |
BackboneElement | The response(s) to the question | |
item.answer.value[x] |
0..1 |
boolean | decimal | integer | date | dateTime | time | string | uri | Attachment | Coding | Quantity | Reference(Any) |
Single-valued answer to the question Questionnaire Answer Codes (Example) | |
answer.item |
0..* |
BackboneElement | Nested groups and questions | |
item.item |
0..* |
BackboneElement | Nested questionnaire response items |
Example Scenario
Answer to Yes, No or Don’t know question
This answer corresponds to the example for the Questionnaire resource.
<QuestionnaireResponse xmlns="http://hl7.org/fhir">
<id value="72"></id>
<questionnaire>
<reference value="Questionnaire/palpitations2.hasPalpitations"></reference>
</questionnaire>
<status value="completed"></status>
<subject>
<reference value="Patient/1"></reference>
</subject>
<context>
<reference value="Encounter/10"></reference>
</context>
<authored value="2020-03-13T15:19:15+00:00"></authored>
<source>
<reference value="Patient/1"></reference>
</source>
<item>
<linkId value="q"></linkId>
<subject>
<reference value="Patient/1"></reference>
</subject>
<answer>
<valueCoding>
<code value="Y"></code>
<display value="Yes"></display>
</valueCoding>
</answer>
</item>
</QuestionnaireResponse>
