Versions Compared

Old Version 20

changes.mady.by.user Pauline C

Saved on

compared with

New Version Current

changes.mady.by.user Amos Folarin

Saved on

Key

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

...

jsrepeatQuestionnaire min "unitsFromZero[
elementpurpose
version
increment this if either the version of the protocol changes or if the questionnaires change
schemaVersionthe version of the AVRO schema being used to post to the backend and Kafka
healthIssuesthe class of health area the protocol applies to
"repository": "https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/"the github repository holding the versions of the questionnaires
"startText": language variants for the start text
estimatedCompletionTimesuggested completion time shown for the aRMT


Code Block
"protocol": {
        "repeatProtocol": {
          "unit": "day",
          "amount": 14
        },
        "repeatQuestionnaire": {
          "unit": "min",
          "unitsFromZero": [
            540
          ]
        },
        "reminders": {
          "unit": "day",
          "amount": 4,
          "repeat": 1
        }
      }
    }


The protocol block is the most important part of the configuration, it controls the regimen. The block consists of 3 main components the the  "repeatQuestionnairerepeatProtcol", "repeatProtcolrepeatQuestionnaire", "reminders", ; and an optional clinicalProtocols component in this block.

e.g. repeat the repeatQuestionnaire regimen every 1 day

Code Block
language
"
repeatProtocol": {
"unit": "day",
"amount": 1
}

e.g. repeat the repeatQuestionnaire regimen every 14 days

Code Block
"repeatProtocol": {

"unit": "
day",

"amount": 
14

}


The frequency at which to repeat the "repeatQuestionnaire" regimen is provided by 

repeatProtocol: 

unit: unit of time e.g. day

amount: how often to repeat the whole repeatQuestionnaire block

e.g. schedule the questionnaire after 480 mins from midnight

Code Block
languagejs
"repeatQuestionnaire": {
480 
    "unit": "min",
]
  "unitsFromZero": [
}
       480
          ]
        }


e.g. set of

offests

offsets at these

minuites

minutes past midnight of the set day:

Code Block
languagejs
 "repeatQuestionnaire": {
          "unit": "min",
          "unitsFromZero": [
            480,
            540,
            600,
            660,
            720,
            780,
            840,
            900,
            960,
            1020,
            1080,
            1140,
            1200
          ]
        },

This is important as it controls the schedule of the particular questionnaire , the number of minutes from midnight from which toand subsequent push notifications 

i) schedule the questionnaire on the app and

ii) schedule the notifications 

sets of offsets can provided for a repeating regimen for example with ESM is delivered at several timepoints offsets are in the given units and start from midnight of the protocol repeating i.e. repeatProtocol e.g. above would be every 14 days, and 480th minute from the start of that 14 day period. 

Arrays of offsets can provided for a repeating regimen for example with ESM is delivered at several time points withing the repeatProtocol period.

480,
540,
600,
660,
720,
780,
840,
900,
960,
1020,
1080,
1140,
1200 

It is set from the Enrolment Date on the Management Portal,

the given units are configurable.

repeatQuestionnaire:

unit: the unit of time e.g. minuite

unitsFromZero: set of offsets to repeat the questionnaire

e.g. repeat the repeatQuestionnaire regimen every 1 day

Code Block
"repeatProtocol": {
"unit": "day",
"amount": 1
}

e.g. repeat the repeatQuestionnaire regimen every 14 day

Code Block
"repeatProtocol": {
"unit": "day",
"amount": 14
}

The frequency at which to repeat the "repeatQuestionnaire" regimen

repeatProtocol: 

unit:

It is set from the Enrolment Date on the Management Portal,

the given units are configurable.

repeatQuestionnaire:

unit: the unit of time e.g. dayminuite

amount: how often unitsFromZero: set of offsets to repeat the whole repeatQuestionnaire blockquestionnaire





Code Block
languagejs
"reminders": {
          "unit": "day",
          "amount": 4,
          "repeat": 1
        }


The numbers of reminder notifications to issue for that questionnaire

unit: of time the amount is measured in e.g day

amount: ???   the number of unit time over which "repeat" number of reminders are delivered ???

repeat: ???   the number of times to repeat the reminder ???reminder 




Code Block
"clinicalProtocol": {
                    "requiresInClinicCompletion": true,
                    "repeatAfterClinicVisit": {
                        "unit": "min",
                        "unitsFromZero": [
                            10080
                        ]
                    }
                }


This is a special case implemented for the Multiple Sclerosis walking and balance tests which require to be repeated 1 week after the initial test in the clinic. in clinic test is selected by clicking on the  icon in the app 

requiresInClinicCompletion: flag set by the clinician in the app

repeatAfterClinicVisit:

unit: e.g. min

unitsFromZero: the offset time after the in-clinic test

completionWindow

Code Block
"completionWindow": {
          "unit": "min",
          "amount": 5
        }


The amount of time the questionnaire is available for completion after it's scheduled time. If this block is not specified in the protocol, then the default completion window in the app is 15 mins for ESM and 1 Day for all other tasks.

It is recommended to specify this block in the protocol.


unit: unit of time e.g. day

amount: The time for which the questionnaire is available for completion.





...