Examples

Search for a questionnaire

This example demonstrates how to find a questionnaire based on a given external identifier.
  1. Generate an access token by following the OAuth2 walkthrough
    1. The example below assumes you have been granted an access token of: aaaaa-bbbbb
  2. Confirm the identifier that you assigned to the questionnaire
    1. The example below assumes an identifier of: id-123
  3. Make the call as detailed below, replacing the access token and search parameters with your own values
  4. The matching Questionnaire resources will be returned

Example Request

This example is written for sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.

ExampleDetails
Absolute URLhttps://sandbox.patientsknowbest.com/fhir/Questionnaire?identifier=id-123
curlcurl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" "https://sandbox.patientsknowbest.com/fhir/Questionnaire?identifier=id-123"

Example Response

Note: whilst every effort has been made to ensure that the examples are correct and useful, they do not form part of the official specification.

{
  "resourceType": "Bundle",
  "id": "06197768-3adc-4cb6-b64c-7a0f9cd2fbf2",
  "meta": {
    "lastUpdated": "2019-08-27T10:48:35.114+00:00"
  },
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "/Questionnaire?identifier=id-123"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://sandbox.patientsknowbest.com/fhir/Questionnaire/f1a841f1-6f3a-43fc-830f-e1417b4ff13d",
      "resource": {
        "resourceType": "Questionnaire",
        "id": "f1a841f1-6f3a-43fc-830f-e1417b4ff13d",
        "meta": {
          "lastUpdated": "2019-06-08T19:21:59.797Z",
          "security": [
            {
              "system": "http://fhir.patientsknowbest.com/codesystem/privacy-label",
              "code": "GENERAL_HEALTH"
            }
          ]
        },
        "identifier": [
          {
            "value": "id-123",
            "assigner": {
              "reference": "Organization/dbec9e64-1731-4ec0-ab57-552cb214127a",
              "display": "Example NHS Trust"
            }
          }
        ],
        "title": "IBD Control PROM",
        "status": "active",
        "date": "2019-06-07T19:29:42Z",
        "item": [
          {
            "linkId": "1",
            "text": "1. Do you believe that:",
            "type": "display"
          },
          {
            "linkId": "2",
            "text": "a. Your IBD has been well controlled in the past two weeks?",
            "type": "choice",
            "option": [
              {
                "valueString": "Yes"
              },
              {
                "valueString": "No"
              },
              {
                "valueString": "Not sure"
              }
            ]
          },
          {
            "linkId": "3",
            "text": "b. Your current treatment is useful in controlling your IBD?",
            "type": "choice",
            "option": [
              {
                "valueString": "Yes"
              },
              {
                "valueString": "No"
              },
              {
                "valueString": "Not sure"
              }
            ]
          },
          {
            "linkId": "4",
            "text": "(if you are not taking any treatment, please tick this box)",
            "type": "choice",
            "repeats": true,
            "option": [
              {
                "valueString": "Not taking any treatment"
              }
            ]
          },
          {
            "linkId": "5",
            "text": "2. Over the past 2 weeks, have your bowel symptoms been getting worse, getting better or not changed?",
            "type": "choice",
            "option": [
              {
                "valueString": "Better"
              },
              {
                "valueString": "No change"
              },
              {
                "valueString": "Worse"
              }
            ]
          },
          {
            "linkId": "6",
            "text": "3 In the past 2 weeks, did you:",
            "type": "display"
          },
          {
            "linkId": "7",
            "text": "a. Miss any planned activities because of IBD? (e.g. attending school/college, going to work or a social event)",
            "type": "choice",
            "option": [
              {
                "valueString": "Yes"
              },
              {
                "valueString": "No"
              },
              {
                "valueString": "Not sure"
                    }
            ]
          },
          {
            "linkId": "8",
            "text": "b. Wake up at night because of symptoms of IBD?",
            "type": "choice",
            "option": [
              {
                "valueString": "Yes"
              },
              {
                "valueString": "No"
              },
              {
                "valueString": "Not sure"
              }
            ]
          },
          {
            "linkId": "9",
            "text": "c. Suffer from significant pain or discomfort?",
            "type": "choice",
            "option": [
              {
                "valueString": "Yes"
              },
              {
                "valueString": "No"
              },
              {
                "valueString": "Not sure"
              }
            ]
          },
          {
            "linkId": "10",
            "text": "d. Often feel lacking in energy (fatigued) (by ‘often’ we mean more than half of the time)",
            "type": "choice",
            "option": [
              {
                "valueString": "Yes"
              },
              {
                "valueString": "No"
              },
              {
                "valueString": "Not sure"
              }
            ]
          },
          {
            "linkId": "11",
            "text": "e. Feel anxious or depressed because of your IBD?",
            "type": "choice",
            "option": [
              {
                "valueString": "Yes"
              },
              {
                "valueString": "No"
              },
              {
                "valueString": "Not sure"
              }
            ]
          },
          {
            "linkId": "12",
            "text": "f. Think you needed a change to your treatment?",
            "type": "choice",
            "option": [
              {
                "valueString": "Yes"
              },
              {
                "valueString": "No"
              },
              {
                "valueString": "Not sure"
              }
            ]
          },
          {
            "linkId": "13",
            "text": "4 At your next clinic visit, would you like to discuss:",
            "type": "display"
          },
          {
            "linkId": "14",
            "text": "a. Alternative types of drug for controlling IBD",
            "type": "choice",
            "option": [
              {
                "valueString": "Yes"
              },
              {
                "valueString": "No"
              },
              {
                "valueString": "Not sure"
              }
            ]
          },
          {
            "linkId": "15",
            "text": "b. Ways to adjust your own treatment",
            "type": "choice",
            "option": [
              {
                "valueString": "Yes"
              },
              {
                "valueString": "No"
              },
              {
                "valueString": "Not sure"
              }
            ]
          },
          {
            "linkId": "16",
            "text": "c. Side effects or difficulties with using your medicines",
            "type": "choice",
            "option": [
              {
                "valueString": "Yes"
              },
              {
                "valueString": "No"
              },
              {
                "valueString": "Not sure"
              }
            ]
          },
          {
            "linkId": "17",
            "text": "d. New symptoms that have developed since your last visit",
            "type": "choice",
            "option": [
              {
                "valueString": "Yes"
              },
              {
                "valueString": "No"
              },
              {
                "valueString": "Not sure"
              }
            ]
          },
          {
            "linkId": "18",
            "text": "5 How would you rate the OVERALL control of your IBD in the past two weeks?",
            "type": "choice",
            "option": [
              {
                "valueString": "0- Worst possible control"
              },
              {
                "valueString": "1"
              },
              {
                "valueString": "2"
              },
              {
                "valueString": "3"
              },
              {
                "valueString": "4"
              },
              {
                "valueString": "5"
              },
              {
                "valueString": "6"
              },
              {
                "valueString": "7"
              },
              {
                "valueString": "8"
              },
              {
                "valueString": "9"
              },
              {
                "valueString": "10- Best possible control"
              }
            ]
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}
Comments