redcap_fhir_ontology_provider/config.json at main · aehrc/redcap_fhir_ontology_provider · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
{
  "name": "Fhir Ontology Autocomplete Module",
  "namespace": "AEHRC\\FhirOntologyAutocompleteExternalModule",
  "description": "This module provides support for referencing an external Fhir based ontology server to lookup values.",
  "framework-version": 1,
  "authors": [
    {
      "name": "David Conlan",
      "email": "david.conlan@csiro.au",
      "institution": "Commonwealth Science & Industrial Research Organisation"
    }
  ],
  "permissions": [
    "redcap_every_page_before_render",
    "redcap_data_entry_form",
    "redcap_survey_page"
  ],
  "system-settings": [
    {
      "key": "fhir_api_url",
      "name": "FHIR API URL",
      "type": "text",
      "required": true
    },
    {
      "key": "fhir_api_url_info",
      "name": "The FHIR server url to use. eg. https://tx.ontoserver.csiro.au/fhir or https://snowstorm-fhir.snomedtools.org/fhir. Don't leave a trailing slash.",
      "type": "descriptive"
    },
    {
      "key": "snomed_support_info",
      "name": "Does the FHIR server support implicit SNOMEDCT valuesets?",
      "type": "descriptive"
    },
    {
      "key": "snomed_support",
      "name": "SNOMEDCT Support",
      "type": "checkbox",
      "required": true
    },
    {
      "key": "loinc_support_info",
      "name": "Does the FHIR server support implicit LOINC valuesets?",
      "type": "descriptive"
    },
    {
      "key": "loinc_support",
      "name": "LOINC Support",
      "type": "dropdown",
      "required": true,
      "choices": [
        {
          "value": "none",
          "name": "LOINC not available"
        },
        {
          "value": "ontoserver",
          "name": "Ontoserver LL parent concept"
        },
        {
          "value": "filter",
          "name": "Filter LLxxxxx concepts from expand"
        }
      ]
    },
    {
      "key": "add_value_tooltip",
      "name": "Add value tooltip",
      "type": "checkbox"
    },
    {
      "key": "return_no_result",
      "name": "Return 'No Results Found'",
      "type": "checkbox"
    },
    {
      "key": "no_result_label",
      "name": "No Results Label",
      "type": "text",
      "default": "No Results Found",
      "branchingLogic": {
        "field": "return_no_result",
        "value": "true"
      }
    },
    {
      "key": "no_result_code",
      "name": "No Results Code",
      "type": "text",
      "default": "_NRF_",
      "branchingLogic": {
        "field": "return_no_result",
        "value": "true"
      }
    },
    {
      "key": "fhir_api_auth_info",
      "name": "The fhir server may require some form of authentication, currently OAuth2 Client Credentials and Basic Auth is supported. Communication with the FHIR server is made by the redcap server, not the users browser.",
      "type": "descriptive"
    },
    {
      "key": "authentication_type",
      "name": "Authentication Type",
      "required": true,
      "type": "dropdown",
      "choices": [
        {
          "value": "none",
          "name": "No Authentication Required"
        },
        {
          "value": "cc",
          "name": "OAuth2 Client Credentials"
        },
        {
          "value": "basic",
          "name": "Basic Auth"
        }
      ]
    },
    {
      "key": "cc_token_endpoint",
      "name": "OAuth2 token endpoint",
      "type": "text",
      "branchingLogic": {
        "field": "authentication_type",
        "value": "cc"
      }
    },
    {
      "key": "cc_client_id",
      "name": "Client Id",
      "type": "text",
      "branchingLogic": {
        "field": "authentication_type",
        "value": "cc"
      }
    },
    {
      "key": "cc_client_secret",
      "name": "Client Secret",
      "type": "text",
      "branchingLogic": {
        "field": "authentication_type",
        "value": "cc"
      }
    },
    {
      "key": "basic_user_id",
      "name": "Basic Auth User Id",
      "type": "text",
      "branchingLogic": {
        "field": "authentication_type",
        "value": "basic"
      }
    },
    {
      "key": "basic_user_password",
      "name": "Basic Auth User Password",
      "type": "text",
      "branchingLogic": {
        "field": "authentication_type",
        "value": "basic"
      }
    }
  ],
  "no-auth-pages": [
    "FindValueSetService"
  ],
  "compatibility": {
    "php-version-min": "5.4.0",
    "redcap-version-min": "8.8.1"
  }
}