Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page contains example 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.

JSON

Code Block
{
    "questionnaireresourceType": "http://base-url.com/fhir/Questionnaire/gad7|1.0"QuestionnaireResponse",
    "id": "5560befe-b763-473a-9680-b497293dd352",
    "meta": {

  "profile": [     "urn:fhir:extension":SDCQuestionnaireResponseRules", [
    "urn:fhir:extension:SDCQuestionnaireResponseScores"    ],    "lastUpdated": "2023-08-22T11:38:09.462038Z",{
    "createdAt": "2023-08-22T11:38:01.087930Z",    "versionId": "89"   },   "itemurl": [
"ex:createdAt",
  {     "text": "Feeling nervous, anxious, or on edge",     "answervalueInstant": ["2024-06-14T17:50:08.464309Z"
     {       "value":}
{        "Coding": {],
        "codeversionId": "LA6569-35074",
        "scorelastUpdated": 1"2024-06-14T17:50:19.075565Z",
        "systemprofile": "http://loinc.org", [
            "display": "Several days"urn:fhir:extension:SDCQuestionnaireResponseRules",
        }    "urn:fhir:extension:SDCQuestionnaireResponseScores"
  }      }]
    ]},
    "linkIdbasedOn": [
"69725-0"    },    {
     "text": "Not being able to stop or control worrying","reference": "ServiceRequest/a445a8da-df43-4910-8ecb-6c3cca4cee9e"
    "answer": [   }
  {  ],
    "valuequestionnaire": {
  "http://fhir.patientsknowbest.com/questionnaire/gad7|1.0",
    "status": "completed",
    "Codingsubject": {
        "codereference": "LA6570-1",Patient/f7b7efbe-dc8b-4ca1-b589-f80d96785416"
    },
    "scoreauthored": 2,
  "2024-06-14T17:50:19.048249Z",
     "systemauthor": "http://loinc.org",{
        "displayreference": "More than half the days"
  Organization/dc67926b-4545-44b1-ab95-e487c6ab431b"
    },
    "source": {
}      }  "reference": "Patient/f7b7efbe-dc8b-4ca1-b589-f80d96785416"
    ]},
    "linkIditem": "68509-9"[
    },    {
    "text": "Worrying too much about different things",     "answerlinkId": ["69725-0",
     {       "valuetext": {"Feeling nervous, anxious, or on edge",
  "Coding": {         "codeanswer": "LA6571-9",[
        "score": 3,       {
 "system": "http://loinc.org",         "display": "Nearly every day"      "valueCoding": {
}        }      }     ],     "linkIdextension": "69733-4"
[
  },    {     "text": "Trouble relaxing",     "answer": [      {   {
   "value": {        "Coding": {         "code": "LA6570-1",         "scoreurl": 2,"urn:fhir:extension:sdc-questionnaire-score",
        "system": "http://loinc.org",         "display": "More than half the days"        } "valueInteger": 1
    }      }     ],     "linkId": "69734-2"    },   }
{     "text": "Being so restless that it is hard to sit still",     "answer": [      { ],
     "value": {        "Coding": {         "codesystem": "LA6568-5http://loinc.org",
         "score": 0,           "system    "code": "http://loinc.org",LA6569-3",
                        "display": "NotSeveral at alldays"
       }       }      }
    ],       "linkId": "69735-9"    },
   {     "text": "Becoming easily annoyed or irritable",    ]
       "answer": [ },
     {   {
   "value": {        "CodinglinkId": { "68509-9",
            "codetext": "LA6570-1",Not being able to stop or control   "score": 2worrying",
            "systemanswer": "http://loinc.org", [
             "display": "More than half{
the days"        }       }    "valueCoding": {
}     ],     "linkId": "69689-8"    },    {     "textextension": "Feeling afraid, as if something awful might happen",[
             "answer": [      {       "value": {
       "Coding": {               "code": "LA6569-3",         "scoreurl": 1"urn:fhir:extension:sdc-questionnaire-score",
        "system": "http://loinc.org",            "display": "Several days"        }  "valueInteger": 1
   }      }     ],     "linkId": "69736-7"    },    {}
    "text": "GAD-7 Anxiety Severity Score",     "answer": [           ],
                 {       "system"value: "http: {
       "integer": 11
      }
     }
    ],
    "linkId": "/70274-6",
    "rule-description": "A + B + C + D + E + F + G\n\nWhere:\n* A = Feeling nervous, anxious, or on edge\n* B = Not being able to stop or control worrying\n* C = Worrying too much about different things\n* D = Trouble relaxing\n* E = Being so restless that it is hard to sit still\n* F = Becoming easily annoyed or irritable\n* G = Feeling afraid, as if something awful might happen"
   }
  ],
  "resourceType": "QuestionnaireResponse",
  "status": "completed",
  "id": "a009317f-741f-4cfe-817b-c8d56a6db7aa",
  "authored": "2023-08-22T11:38:09.425887Z",
  "basedOn": {
    "id": "12345",
    "resourceType": "ServiceRequest"
  },
  "subject": {
   "id": "morgan",
   "resourceType": "Patient"
  }
//loinc.org",
                        "code": "LA6569-3",
                        "display": "Several days"
                    }
                }
            ]
        },
        {
            "linkId": "69733-4",
            "text": "Worrying too much about different things",
            "answer": [
                {
                    "valueCoding": {
                        "extension": [
                            {
                                "url": "urn:fhir:extension:sdc-questionnaire-score",
                                "valueInteger": 2
                            }
                        ],
                        "system": "http://loinc.org",
                        "code": "LA6570-1",
                        "display": "More than half the days"
                    }
                }
            ]
        },
        {
            "linkId": "69734-2",
            "text": "Trouble relaxing",
            "answer": [
                {
                    "valueCoding": {
                        "extension": [
                            {
                                "url": "urn:fhir:extension:sdc-questionnaire-score",
                                "valueInteger": 0
                            }
                        ],
                        "system": "http://loinc.org",
                        "code": "LA6568-5",
                        "display": "Not at all"
                    }
                }
            ]
        },
        {
            "linkId": "69735-9",
            "text": "Being so restless that it is hard to sit still",
            "answer": [
                {
                    "valueCoding": {
                        "extension": [
                            {
                                "url": "urn:fhir:extension:sdc-questionnaire-score",
                                "valueInteger": 3
                            }
                        ],
                        "system": "http://loinc.org",
                        "code": "LA6571-9",
                        "display": "Nearly every day"
                    }
                }
            ]
        },
        {
            "linkId": "69689-8",
            "text": "Becoming easily annoyed or irritable",
            "answer": [
                {
                    "valueCoding": {
                        "extension": [
                            {
                                "url": "urn:fhir:extension:sdc-questionnaire-score",
                                "valueInteger": 2
                            }
                        ],
                        "system": "http://loinc.org",
                        "code": "LA6570-1",
                        "display": "More than half the days"
                    }
                }
            ]
        },
        {
            "linkId": "69736-7",
            "text": "Feeling afraid, as if something awful might happen",
            "answer": [
                {
                    "valueCoding": {
                        "extension": [
                            {
                                "url": "urn:fhir:extension:sdc-questionnaire-score",
                                "valueInteger": 0
                            }
                        ],
                        "system": "http://loinc.org",
                        "code": "LA6568-5",
                        "display": "Not at all"
                    }
                }
            ]
        },
        {
            "extension": [
                {
                    "url": "urn:fhir:extension:sdc-questionnaire-ruleDescription",
                    "valueMarkdown": "A + B + C + D + E + F + G\n\nWhere:\n* A = Feeling nervous, anxious, or on edge\n* B = Not being able to stop or control worrying\n* C = Worrying too much about different things\n* D = Trouble relaxing\n* E = Being so restless that it is hard to sit still\n* F = Becoming easily annoyed or irritable\n* G = Feeling afraid, as if something awful might happen"
                }
            ],
            "linkId": "/70274-6",
            "text": "GAD-7 Anxiety Severity Score",
            "answer": [
                {
                    "valueInteger": 9
                }
            ]
        }
    ]
}

How to read this QuestionnaireResponse resource

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:

em

Description

Where is this defined?

questionnaire

A ID referring to the associated Questionnaire resource, in the format:

<questionnaire_id>|<version>

Created from the URL and version fields of the associated Questionnaire resource

item

The answers provided by the patient to the questions they answered

Created based on the patient’s answers. linkId links the answers to the questions on the Questionnaire resource

rule-description

A formula detailing how a score was calculated

This is set by PKB when the questionnaire is built

status

The status of the QuestionnaireResponse resource

This changes depending on whether the patient has submitted their questionnaire or whether it is in draft

basedOn

A reference to the ServiceRequest generated when the questionnaire request is sent

Generated when the ServiceRequest is created.

subject

A reference to the Patient resource of the patient answering the questionnaire

Generated based on the patient that the questionnaire was sent to