.forms

JSON Forms: Instructions and schema for defining JSON forms used for handling reports from SMS and external tools

JSON Forms are used for parsing reports from formatted SMS, SIM applications, and Medic Collect. JSON form definitions are also used for interoperability with third-party systems. Each form is defined as an JSON form object according to the following schema.

app_settings.json .forms[]

propertytypedescriptionrequired
metaobjectInformation about the report.yes
meta.codestringThe unique form identifier, which will be sent with all reports of this form. Must be the same as the form’s key.yes
meta.iconstringName of the icon resource shown in the app.no
meta.translation_keystringName of the form shown in the app.no
meta.subject_keystringA translation key to display in the report list instead of the subject name (default). The translation is provided with a summary of the report which can be used for evaluation, eg: Case registration {{case_id}}. Useful properties available in the summary include: from (the phone number of the sender), phone (the phone number of the report contact), form (the form code), subject.name (the name of the subject), and case_id (the generated case id). Added in 3.9.0no
fieldsobjectCollection of field objects included in the form.yes
fields.${field}objectField that is part of the form.yes
fields.${field}.typestringData type of field:
- "integer": a whole number
- "string": any collection of characters
- "date": a date in the format YYYY-mm-dd, for example “2019-01-28"
- "boolean": true or false, represented by the digit 1 and 0 respectively (native JSON booleans are also supported if sending via JSON)
- "custom": Only possible for JSON forms that are passed as actual JSON (not an SMS that gets parsed into JSON). Effectively any non-specific data structure, which will be taken without validation.
yes
fields.${field}.labelsobjectno
fields.${field}.labels.shortstring, object with translation_key field, or translation objectLabel shown for field in the app, seen when report is viewed in Reports tab. If missing, label will default to a translation key of report.${form_name}.${field_name} (eg report.f.patient_id) which can be translated in the app languages.no
fields.${field}.labels.tinystringUnique identifier within the form for this field. Used in form submission to bind values to fields. Not required for all submission formats.no
fields.${field}.positionintegerZero based order of this field for incoming reports.no
fields.${field}.flagsobjectAdditional instructions that could be used by form renderers. For instance { "input_digits_only": true } indicated to SIM applications to show the number keyboard. Obsolete.no
fields.${field}.lengtharray with two integersInclusive range accepted for length of the field.no
fields.${field}.requiredbooleanDetermines if a report without this field is considered valid.no
public_formbooleanDetermines if reports will be accepted from phone numbers not associated to a contact. Set to false if you want to reject reports from unknown senders. Default: true.no
facility_referencestringThe form field whose value is to be used to match the incoming report to a contact’s rc_code. Useful when reports are sent on behalf of a facility by unknown or various phone numbers. Requires the update_clinics transition.no

Code Sample

The following form has two fields, one for the patient ID, another for notes.

app_settings.json

  "forms": [
    {
      "F": {
        "meta": {
          "code": "F",
          "icon": "risk",
          "translation_key": "form.flag.title" // displayed in the webapp
        },
        "fields": {
          "patient_id": { // this is used for the property name when the report doc is created
            "labels": {
              "short": { "translation_key": "form.flag.patient_id.short" }, // displayed in the webapp
              "tiny": "pid" // used in form submission to bind values to fields - not required for all submission formats
            },
            "position": 0, // specifies where in the SMS this value should be
            "type": "string",
            "length": [ 5, 13 ],
            "required": true
          },
          "notes": {
            "labels": {
              "short": { "translation_key": "form.flag.notes.short" },
              "tiny": "form.flag.notes.tiny"
            },
            "position": 1,
            "type": "string",
            "length": [ 1, 100 ],
            "required": false
          }
        },
        "public_form": true
      }
    }
  ]