Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Note

Please note the order in which questions are asked in a session is controlled by the algorithm.json file, it is not the order in which the questions are listed in the questions.json file.

Info

DEFINITIONS & TERMINOLOGIES

Options: (Answers) A list of possible answers options the client can pick from for their to answer to a question.

...

Please note, C4C is built using POEditor which facilities language translations, this is required even if you do not use

...

this option, to learn more about the C4C multilingual feature, click here.

...

File Structure - questions.json

All questions are stored in the questions.json file, each question is made up of two parts;

  • Question

  • Options

Each question is defined by a keyword in double quotes and can have one or more options. As in the example below, the question "factor1" (a key-value pair, the question (shown in ”red“) is the reference key, in the example below the key is factor1.

The options are also key-value pairs, in the example below the keys are Effectiveness, Privacy and FewSideEffects.

"factor1": {

"options": {

"Effectiveness": "",

"Privacy": "",

"FewSideEffects": ""

}

}

In the example below, the key used for the question is "factor1" the value is the text that will appear as the question.

KEY

VALUE

factor1

I'll give you some options to choose from. Tell me which one is most important to you when considering contraception.

...

has 3 options: "Effectiveness" (Efficient method), "Privacy" (Discrete method), and "FewSideEffects" (Method with few side effects).

The file is written using JSON notation. To learn more about the basic notation used in JSON, click here.

"factor1": {

"options": {

"Effectiveness": "",

"Privacy": "",

"FewSideEffects": ""

}

}

The following tables present the terms (keywords) available for the algorithm file:

Questions

Keyword

Translation

gender

How do you identify yourself? It helps me to better meet your needs.

futurePregnancy

Do you want to be pregnant in the future?

breastFeeding

Are you breastfeeding a baby less than 6 months old?

age

How old are you?

factor1

I'll give you some options to choose from. Tell me which one is most important to you when considering contraception.

factor2

And which of the following three options is the most important to you?

factors2vs1

Compared to '{{FACTOR_1}}', how important is '{{FACTOR_2}}'?

factor3

Finally, which of the following three options is most important to you?

factors3vs12

Compared to '{{FACTOR_1}}' AND '{{FACTOR_2}}', how important is '{{FACTOR_3}}'?

...

Options

Methods

Keyword

Translation

Sterilization

Sterilization

IUD

IUD

IUD

IUD

Implant

Implant

Injectables

Injectables

POP

Progesterone Pills

COP

Combined Pills

EC

EC

Condoms

Condoms

Cyclebeads

Cyclebeads

Factor 1

Keyword

Translation

Effectiveness

Efficient method

Privacy

Discrete method

FewSideEffects

Method with few side effects

...