Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

Commit

Permalink
Fix README urls
Browse files Browse the repository at this point in the history
  • Loading branch information
syoung-smallwisdom committed Sep 28, 2023
1 parent 6947764 commit fbdc98a
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
# mobile-client-json

[1]: <https://github.com/BridgeDigitalHealth/AssessmentModelKMM> "AssessmentModelKMM"
[2]: <https://www.figma.com/file/edCHqzwDQLgnBUXj7KoNl3/Surveys_ResearcherUI> "Surveys_ResearcherUI"
[3]: <https://developer.sagebridge.org/model-browser.html#AssessmentConfig> "AssessmentConfig"

Json Schema Draft 7 documentation for the JSON model objects used to build the iOS and Android
Assessment Models. The [AssessmentModel][1] library used by all internally developed assessments
considers an assessment to be any measurement, including surveys, that can be run on a mobile
device, provided that the library dependencies for a given app are set up to include it.
This repoitory includes the schemas used to define:

- [Result Archives](#result-archives): The output files for a single run of an assessment.
- [Building a Survey](#building-a-survey): The [AssessmentConfig][2] for describing all the questions and branching logic for running a survey.

[1]: <https://github.com/BridgeDigitalHealth/AssessmentModelKMM> "AssessmentModelKMM"
[2]: <https://developer.sagebridge.org/model-browser.html#AssessmentConfig> "AssessmentConfig"
- [Building a Survey](#building-a-survey): The [AssessmentConfig][3] for describing all the questions and branching logic for running a survey.

## Result Archives

Expand Down Expand Up @@ -62,8 +63,6 @@ Each element in the survey is a `Node` where the root-level `Node` must also be
The [AssessmentModel][1] library has only one "type" key defined for an `Assessment`, but this key must be
included in the JSON or the serialization will fail.

[1]: <https://github.com/BridgeDigitalHealth/AssessmentModelKMM> "AssessmentModelKMM"

- Note: The terms "node" and "step" are used interchangably within this document and essentially mean
the same thing. This is for historical reasons wherein assessments are designed to conform to both the
language/syntax used by older frameworks (namely ResearchKit and ResearchStack) and the concept of a
Expand Down Expand Up @@ -250,8 +249,6 @@ Currently, instruction steps can be:
- [Permission Steps](#permission-steps)
- [Completion Step](#completion-step)

[2]: <https://www.figma.com/file/edCHqzwDQLgnBUXj7KoNl3/Surveys_ResearcherUI> "Surveys_ResearcherUI"

#### Overview Step

In the [survey builder designs][2] this is referred to as the "Title Page". This step
Expand Down

0 comments on commit fbdc98a

Please sign in to comment.