Example QuestionnaireResponse resource (GAD7)
- James Price
This page contains the JSON for a QuestionnaireResponse generated from the advanced questionnaires feature. This QuestionnaireResponse was generated from a patient completing the GAD7 Questionnaire. This is the format you will receive the QuestionnaireResponse in when you retrieve it from the QuestionnaireResponse endpoint. This page is intended as a guide for how to read a QuestionnaireResponse resource retrieved from the PKB FHIR QuestionnaireResponse endpoint, to define various fields within the QuestionnaireResponse, and to show where the resource references other PKB FHIR resources.
JSON
{
"resourceType": "QuestionnaireResponse",
"id": "2ccf20d2-1f36-4ef0-b99e-9b1f9f859c28",
"meta": {
"extension": [
{
"url": "ex:createdAt",
"valueInstant": "2024-12-09T10:32:39.165941Z"
}
],
"versionId": "17168",
"lastUpdated": "2024-12-09T10:33:10.344586Z"
},
"basedOn": [
{
"reference": "ServiceRequest/61a84963-df7d-48f8-a3a1-1096c4548865"
}
],
"questionnaire": "http://fhir.patientsknowbest.com/questionnaire/gad7|1.0",
"status": "completed",
"subject": {
"reference": "Patient/6935a405-efdc-4e4f-b330-862bcf0ae36a"
},
"authored": "2024-12-09T10:33:10.226Z",
"author": {
"reference": "Patient/6935a405-efdc-4e4f-b330-862bcf0ae36a"
},
"source": {
"reference": "Patient/6935a405-efdc-4e4f-b330-862bcf0ae36a"
},
"item": [
{
"linkId": "48DwCGiy",
"text": "Is this questionnaire being completed by you? ",
"answer": [
{
"valueCoding": {
"code": "yes",
"display": "Yes"
}
}
]
},
{
"linkId": "69725-0",
"text": "Feeling nervous, anxious, or on edge",
"answer": [
{
"valueCoding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/ordinalValue",
"valueDecimal": 1
}
],
"system": "http://loinc.org",
"code": "LA6569-3",
"display": "Several days"
}
}
]
},
{
"linkId": "68509-9",
"text": "Not being able to stop or control worrying",
"answer": [
{
"valueCoding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/ordinalValue",
"valueDecimal": 0
}
],
"system": "http://loinc.org",
"code": "LA6568-5",
"display": "Not at all"
}
}
]
},
{
"linkId": "69733-4",
"text": "Worrying too much about different things",
"answer": [
{
"valueCoding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/ordinalValue",
"valueDecimal": 3
}
],
"system": "http://loinc.org",
"code": "LA6571-9",
"display": "Nearly every day"
}
}
]
},
{
"linkId": "69734-2",
"text": "Trouble relaxing",
"answer": [
{
"valueCoding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/ordinalValue",
"valueDecimal": 2
}
],
"system": "http://loinc.org",
"code": "LA6570-1",
"display": "More than half the days"
}
}
]
},
{
"linkId": "69735-9",
"text": "Being so restless that it is hard to sit still",
"answer": [
{
"valueCoding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/ordinalValue",
"valueDecimal": 0
}
],
"system": "http://loinc.org",
"code": "LA6568-5",
"display": "Not at all"
}
}
]
},
{
"linkId": "69689-8",
"text": "Becoming easily annoyed or irritable",
"answer": [
{
"valueCoding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/ordinalValue",
"valueDecimal": 1
}
],
"system": "http://loinc.org",
"code": "LA6569-3",
"display": "Several days"
}
}
]
},
{
"linkId": "69736-7",
"text": "Feeling afraid, as if something awful might happen",
"answer": [
{
"valueCoding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/ordinalValue",
"valueDecimal": 2
}
],
"system": "http://loinc.org",
"code": "LA6570-1",
"display": "More than half the days"
}
}
]
},
{
"linkId": "/70274-6",
"text": "GAD-7 Anxiety Severity Score",
"answer": [
{
"valueDecimal": 9
}
]
}
]
}QuestionnaireResponse field definitions
The above QuestionnaireResponse resource is in JSON format and adheres to the FHIR R4 standard. The FHIR QuestionnaireResponse resource spec can be found here. Key information it contains includes:
Field | Description | Reference to other resource | Supported search parameter? | Notes |
|---|---|---|---|---|
id | Logical ID for the QuestionnaireResponse |
| Y |
|
basedOn | The ServiceRequest that was generated when the questionnaire request was sent | ServiceRequest | Y | Can be included in the response using the _include search parameter |
questionnaire | The canonical URL representing the Questionnaire that this response was generated from |
| N | Also on the Questionnaire resource in the url field. |
status | The status of the QuestionnaireResponse |
|
| Updates as the patient starts and completes the questionnaire. Statuses listed here. |
subject | The patient that the questionnaire request was sent to | Patient | Y |
|
authored | The date and time that the answers were submitted. |
| Y | Updates if the answers are amended by a patient or professional. |
author | The individual that entered the answers into the UI | Patient Practitioner | N | This will usually be the same as subject, apart from where a professional has amended a patient’s answers, when it will reference this professional’s Practitioner resource. |
source | The individual who answered the questions | Patient | Y | This is functionally the same as subject in advanced questionnaires |
item.linkId | ID representing the question |
|
| Links the question on the Questionnaire and QuestionnaireResponse resources |
item.text | Question text |
|
|
|
item.answer | Answer to the question |
|
|
|
item.answer.valueCoding.code | Clinical code representing an answer option, for multiple choice questions |
|
|
|
item.answer.valuecoding.display | Display value for the item.answer.valueCoding.code |
|
|
|
item.answer.valueCoding.system | System for item.answer.valueCoding.code |
|
|
|
ordinalValue extension | An ordinal value assigned to answer options, for multiple choice questions |
|
| Used in calculations within questionnaires |