Versions Compared

Key

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

This page contains example JSON for a Questionnaire resource of a GAD7, generated from the advanced questionnaires feature. This is the format you will receive the Questionnaire in when you retrieve it from the Questionnaire endpoint.

JSON

Code Block
{
 "description": "Blood Pressure Questionnaire",
 "meta": {
  "lastUpdated": "2024-01-16T11:39:05.405410Z",
  "versionId": "6",
  "extension": [
   {
    "url": "ex:createdAt",
    "valueInstant": "2024-01-16T11:39:05.405410Z"
   }
  ]
 },
 "name": "pkb.forms-sandbox/BloodPressureQuestionnaireForm",
 "item": [
  {
   "code": [
    {
     "code": "8480-6",
     "system": "http://loinc.org"
    }
   ],
   "text": "What is your systolic blood pressure?",
   "type": "decimal",
   "linkId": "05b61fc8-cf69-4d2d-9cd8-74ed0c9234c7"
  },
  {
   "code": [
    {
     "code": "8462-4",
     "system": "http://loinc.org"
    }
   ],
   "text": "What is your diastolic blood pressure?",
   "type": "decimal",
   "linkId": "9633cf18-3dc1-4995-a84d-aa6f8d5fa8b1"
  }
 ],
 "resourceType": "Questionnaire",
 "title": "Blood Pressure Questionnaire",
 "status": "active",
 "id": "5f227a54-570f-470f-9150-ce7e8321c1b1",
 "version": "1.0.0"
}

How to read this Questionnaire resource

The above Questionnaire resource is in JSON format and adheres to the FHIR R4 standard. The FHIR Questionnaire resource spec can be found here. Key information it contains includes:

Item

Description

Where is this defined?

description

A textual description of the questionnaire.

This is set by PKB when the questionnaire is built.

item

The questions in the questionnaire, linkId to link to the answers in the QuestionnaireResponse and, where they exist, multiple choice answer options.

This is set by PKB when the questionnaire is built.

status

Whether the questionnaire is actively in use

This is set by PKB when the questionnaire is built.

url

A canonical URL for the questionnaire. This is used to link the QuestionnaireResponse to the relevant version of the Questionnaire resource.

This is set by PKB when the questionnaire is built.

version

The business version of the Questionnaire.

This is set by PKB when the questionnaire is built.