Questions

A question is a field in a Form. It consists of a label, an associated input, and a set of answers.

Below is an example of a question that seeks to establish the patient's Current HIV status:

{
  "questions": [
    {
      "label": "Current HIV status",
      "type": "obs",
      "id": "hivStatus",
      "questionOptions": {
        "rendering": "select",
        "concept": "9e4d6436-4040-46a3-a0ae-6dbc0acfe593",
        "answers": [
          {
            "concept": "a896f3a6-1350-11df-a1f1-0026b9348838",
            "label": "HIV positive"
          },
          {
            "concept": "a896d2cc-1350-11df-a1f1-0026b9348838",
            "label": "HIV negative"
          },
          {
            "concept": "a899b50a-1350-11df-a1f1-0026b9348838",
            "label": "Unknown"
          }
        ]
      },
      "validators": []
    }
  ]
}

Defining a Question

Here's a reference of the various properties you can specify in a question definition:

• label: The actual content of the question. This label is what gets rendered as the question label.

• id: An ID unique to that question. Used when validating the field input. It's recommended to use camel-case for your ID names.

• type: Provides information that the processor uses to render a field. An obs field, for example, will be rendered differently than an encounterLocation field. Currently supported types include: obs, obsGroup, testOrder, control, complex-obs, encounterDatetime, encounterLocation, encounterProvider, personAttribute.

• questionOptions: An object containing the following properties:

  • rendering: The field type of the question. The most commonly used field types are text (for text inputs), select (for select fields) and date (for date fields). See the Field types reference for a full list of rendering types.

  • concept: The concept UUID of the backing concept for this field. You can get this concept UUID from searching in the Concept Dictionary.

  • answers: An array of answers scoped to a question. An answer definition consists of a concept UUID and label pair. Below is an example of answers to a Current HIV status question:

    {
      "answers": [
        {
          "concept": "a896f3a6-1350-11df-a1f1-0026b9348838",
          "label": "HIV positive"
        },
        {
          "concept": "a896d2cc-1350-11df-a1f1-0026b9348838",
          "label": "HIV negative"
        },
        {
          "concept": "a899b50a-1350-11df-a1f1-0026b9348838",
          "label": "Unknown"
        }
      ]
    }

  • calculate: An object where you can specify calculateExpressions. These are predefined expression helpers that take inputs and return numeric values. Read more about calculateExpressions in the Performing Calculations guide.

    {
      "label": "BMI (Kg/M2):",
      "questionInfo": "",
      "id": "bmi",
      "questionOptions": {
        "rendering": "number",
        "concept": "a89c60c0-1350-11df-a1f1-0026b9348838",
        "max": "100",
        "min": "0",
        "calculate": {
          "calculateExpression": "calcBMI(height,weight)"
        }
      },
      "type": "obs",
      "validators": []
    }

• required: If set to true, that form field is considered a required field. Defaults to false.

• validators: An array in which you provide validation logic for the specific question. Read more about validation in the Validation guide.

• historicalExpression: This allows you to hook your input up to the HistoricalEncounterDataService. This service 'remembers' the last value entered in the input from the last encounter and offers the user the option to reuse that value. Read more about historicalExpressions in the Historical expressions guide.

  

• hide: You can use this to define logic for hiding a question based on certain conditions. To do so, you provide a JavaScript expression that evaluates to a boolean value. Read more about hiding fields in the Hiding fields guide.

  {
    "hide": {
      "hideWhenExpression": "onArt!== 'a899b35c-1350-11df-a1f1-0026b9348838'"
    }
   
    // This logic hides the question with the `onArt` id if the value of its
    // concept does not match the supplied value
  }

• questionInfo: You can specify helper text for the question here. When specified, a question mark icon gets displayed to the right of the question label. When you hover over it, the information you entered gets displayed as a tooltip.

  

  The code for this is as follows:

  {
    "label": "Person Collecting Medication",
    "questions": [
      {
        "label": "Visited by:",
        "id": "visitBy",
        "questionInfo": "Record the person that came for the clinic today, whether it is the patient or the treatment supporter.",
        "questionOptions": {
          "rendering": "select",
          "concept": "a89cd410-1350-11df-a1f1-0026b9348838",
          "answers": [
            {
              "concept": "a898c6f4-1350-11df-a1f1-0026b9348838",
              "label": "Self"
            },
            {
              "concept": "01b957da-23bb-4862-819d-036364fe3faf",
              "label": "Treatment supporter"
            }
          ]
        },
        "type": "obs",
        "validators": []
      }
    ]
  }