Produced by Araxis Merge on 5/8/2017 10:03:23 PM Eastern Daylight Time. See www.araxis.com for information about Merge. This report uses XHTML and CSS2, and is best viewed with a modern standards-compliant browser. For optimum results when printing this report, use landscape orientation and enable printing of background images and colours in your browser.
| # | Location | File | Last Modified |
|---|---|---|---|
| 1 | var-utility-web-Release-1.0.0-Branch.zip\MHED_VAR_DOCS | VAR+Utility+v1.0.0+-+System+Design+Document+(SDD)+Addendum.docx | Mon May 8 15:45:42 2017 UTC |
| 2 | var-utility-web-Release-1.0.0-Branch.zip\MHED_VAR_DOCS | VAR+Utility+v1.0.0+-+System+Design+Document+(SDD)+Addendum.docx | Tue May 9 01:16:48 2017 UTC |
| Description | Between Files 1 and 2 |
|
|---|---|---|
| Text Blocks | Lines | |
| Unchanged | 1 | 960 |
| Changed | 0 | 0 |
| Inserted | 0 | 0 |
| Removed | 0 | 0 |
| Whitespace | |
|---|---|
| Character case | Differences in character case are significant |
| Line endings | Differences in line endings (CR and LF characters) are ignored |
| CR/LF characters | Not shown in the comparison detail |
No regular expressions were active.
| 1 | VAR Utilit y v1.0.0 - System De sign Docum ent (SDD) Addendum | |
| 2 | Mobile App lication S ystem Desi gn Documen t (SDD) Ad dendum | |
| 3 | Mobile App lication I nformation | |
| 4 | Applicatio n Design | |
| 5 | Design Pri nciples an d Patterns | |
| 6 | Veteran Ap pointment Requests ( VAR) Utili ty Applica tion | |
| 7 | Conceptual Perspecti ve | |
| 8 | Component Diagram | |
| 9 | Class Diag ram | |
| 10 | Logical Pe rspective | |
| 11 | Sequence D iagram | |
| 12 | Physical P erspective | |
| 13 | Deployment Diagram | |
| 14 | VAR Utilit y Modules | |
| 15 | Sites (Fac ilities) S upporting VAR | |
| 16 | Clinical S ervices | |
| 17 | Direct Boo king Eligi bility Cri teria | |
| 18 | Request El igibility Criteria | |
| 19 | Data Archi tecture/Di ctionary | |
| 20 | Supported Devices | |
| 21 | Technology Stack (Fr ont-End) | |
| 22 | Technology Stack (Ba ck-End) | |
| 23 | VA Interfa ces - Exis ting | |
| 24 | Authorizat ion Servic es 4.3.x | |
| 25 | Interfaces – New | |
| 26 | DirectBook ingEligibi lityCriter iaResource | |
| 27 | Responses | |
| 28 | RequestEli gibilityCr iteriaReso urce | |
| 29 | Responses | |
| 30 | Non-Functi onal Requi rements | |
| 31 | Security | |
| 32 | Capacity R equirement s | |
| 33 | Mobile App lication S ystem Desi gn Documen t (SDD) Ad dendum | |
| 34 | The System Design Do cument (SD D) is a du al-use doc ument that provides the concep tual desig n as well as the as- built desi gn. This d ocument wi ll be upda ted as the product i s built, t o reflect the as-bui lt product . Per the Project Ma nagement A ccountabil ity System (PMAS) Gu ide, the S DD with co nceptual d esign is r equired pr ior to the Milestone 1 Review. The as-bu ilt for ea ch deliver y must be incorporat ed prior t o the Mile stone 2 Re view. | |
| 35 | Mobile App lication I nformation | |
| 36 | Project In crement / Release De signation: VAR Utili ty Applica tion | |
| 37 | Product Ve rsion: 1. 0.0 | |
| 38 | ||
| 39 | ||
| 40 | Veteran | |
| 41 | Care Giver | |
| 42 | Provider | |
| 43 | Public | |
| 44 | Intended A udience fo r Mobile A pplication | |
| 45 | ||
| 46 | ||
| 47 | X (Schedul ing Clerks ) | |
| 48 | ||
| 49 | ||
| 50 | Question | |
| 51 | Yes | |
| 52 | No | |
| 53 | If Yes, wh at informa tion / dat a | |
| 54 | If yes, th en identif y any cons umer or so urce syste m(s) for t he data | |
| 55 | Does the u ser enter informatio n or data into the m obile appl ication? | |
| 56 | X | |
| 57 | ||
| 58 | Custom Mes sages, Req uest and D irect Sche duling Eli gibility C riteria | |
| 59 | VAR Utilit y Services (MongoDB) | |
| 60 | Does Mobil e Applicat ion store informatio n or data entered by the User? If yes, w here is it stored? | |
| 61 | X | |
| 62 | ||
| 63 | Custom Mes sages, Req uest and D irect Sche duling Eli gibility C riteria | |
| 64 | VAR Utilit y Services (MongoDB) | |
| 65 | Does Mobil e Applicat ion transm it/push da ta entered outside o f the VAMF to VA? | |
| 66 | ||
| 67 | X | |
| 68 | ||
| 69 | ||
| 70 | Does Mobil e Applicat ion pull d ata from a VA Databa se (extern al to VAMF )? | |
| 71 | ||
| 72 | X | |
| 73 | ||
| 74 | ||
| 75 | Does the M obile Appl ication st ore in the VAMF or o n the devi ce data pu lled from a VA Datab ase? | |
| 76 | ||
| 77 | X | |
| 78 | ||
| 79 | ||
| 80 | ||
| 81 | This appli cation can be classi fied as on e of the f ollowing: | |
| 82 | Mobile App lication C lassificat ion (Only one box ma y be check ed) | |
| 83 | Mark with X | |
| 84 | 1 – Very Low: Mobil e Applicat ion does n ot use VA Resource | |
| 85 | ||
| 86 | 2 – Low: Read only access to VA Resourc e(s) (No P II / PHI) | |
| 87 | ||
| 88 | 3 – Mediu m: Write a ccess to V A Resource (s) | |
| 89 | X | |
| 90 | 4 – High: Read and/ or Write a ccess of s ensitive d ata to VA Resource(s ) (Include s PII/PHI/ other sens itive) | |
| 91 | ||
| 92 | Applicatio n Design | |
| 93 | Design Pri nciples an d Patterns | |
| 94 | Single Pag e Applicat ion - Sing le Page Ap plication design pat tern will be leverag ed. | |
| 95 | Applicatio n Specific Dependenc ies - Exte rnal REST service de pendencies are manag ed through applicati on specifi c resource directory (resource -directory .json) pac kaged with the appli cation. E ach REST s ervice end point is d efined wit h a "title " and "hre f". For c onvenience , all the dependenci es are ide ntified in the VAMF Interfaces section. | |
| 96 | REST Conve ntions - T he applica tion works with data using HTT P verbs. GET is use d for retr ieving dat a, POST is used for creating o r processi ng data, P UT is used for updat ing data a nd DELETE is used fo r deleting data. | |
| 97 | Exception Handling u sing HTTP standards - Exceptio n handling is perfor med based on HTTP st atus codes . Bad Req uest (stat us code 40 0) is hand led at the Model or Resource l evel. Int ernal Serv er Error ( status cod e 500) is handled gl obally wit hin the ap plication. | |
| 98 | Leveraging common VA MF Service s such as Authorizat ion Servic es and Met ric Servic es. | |
| 99 | Veteran Ap pointment Requests ( VAR) Utili ty Applica tion | |
| 100 | The VAR Ut ility appl ication pr ovides Fac ility Admi nistrators the abili ty to conf igure the following items for a Facility . Configu rations af fect all s ubdivision s of the F acility. Configurat ion values are store d in the V AR Utility database in MongoDB . In oper ation, the VAR appli cation rea ds the con figured va lues from MongoDB, a nd sets th e veterans eligibili ty accordi ngly. | |
| 101 | Direct Boo king Eligi bility Cri teria: co nfigures t he criteri a governin g the elig ibility of veterans to schedul e an appoi ntment dir ectly. | |
| 102 | Request El igibility Criteria: configure s the crit eria gover ning the e ligibility of vetera ns to requ est an app ointment. | |
| 103 | Conceptual Perspecti ve | |
| 104 | The Compon ent diagra m below de picts the chief comp onents of the VAR Ut ility appl ication. Descriptio n of each component is provide d in the a ccompanyin g table. | |
| 105 | Component Diagram | |
| 106 | ||
| 107 | ServletCon tainer | |
| 108 | ServletCon tainer pro vides the runtime fo r the Jers ey Servlet acting as the entry point for HTTP requ ests. | |
| 109 | CorsHttpRe sponseFilt er | |
| 110 | CORSHttpRe sponseFilt er adds he aders to s upport Cro ss-Origin Resource S haring all owing invo cation of ajax calls from mult iple domai ns. Fully qualified domain wit h scheme w ill be con figured fo r Producti on. | |
| 111 | ExceptionF ilter | |
| 112 | ExceptionF ilter capt ures runti me excepti ons and re turns 500 HTTP respo nses witho ut a Java stack trac e based on WASA reco mmendation s. | |
| 113 | SpringSecu rityFilter | |
| 114 | SpringSecu rityFilter (Delegati ngFilterPr oxy) is us ed for rol e-based ac cess contr ol and aut horization . | |
| 115 | jersey.ser vlet.Servl etContaine r | |
| 116 | jersey.ser vlet.Servl etContaine r is the J ersey Fram ework's se rvlet that provide a framework to expose the REST resources and handle request/r esponse pr ocessing. | |
| 117 | XSSRequest Filter | |
| 118 | XSSRequest Filter che cks for Cr oss Site S cripting i n Query Pa rameters, Headers an d Cookies. It uses J soup libra ry and use s whitelis t mechanis m to ident ify the ma licious co de. | |
| 119 | Metrics As pect | |
| 120 | MetricsAsp ect uses M etrics lib rary to ca pture REST calls met rics and p ublishes m etrics res ults to a Beanstalk message qu eue. | |
| 121 | Applicatio n Resource s | |
| 122 | Applicatio n Resource s implemen t the REST endpoints for the a pplication . Multiple Applicati on Resourc es are imp lemented f or differe nt Domain objects in volved. Ad ditional d etails on each Appli cation Res ource are provided i n the foll owing sect ions. | |
| 123 | Applicatio n Services | |
| 124 | Applicatio n Services implement the Servi ce layer a nd delegat e the pers istence im plementati on to the Applicatio n Reposito ries. Mult iple Appli cation Ser vices are implemente d, one for each Doma in object involved. | |
| 125 | Applicatio n Reposito ries | |
| 126 | Applicatio n Reposito ries provi de the abs traction t o the pers istence da ta stored in MongoDB . | |
| 127 | ||
| 128 | The Class diagram be low provid es a high- level clas sification of object s used in the VAR Ut ility appl ication. The two ma in objects are the D irectBooki ngEligibil ityCriteri a and Requ estEligibi lityCriter ia which e ncompass t he main ob jective of the appli cation. | |
| 129 | Class Diag ram | |
| 130 | ||
| 131 | Logical Pe rspective | |
| 132 | Generic Se quence dia grams for REST calls are depic ted below for each R EST operat ion. Only GET, POST , and PUT operations are imple mented. D ELETE oper ation is n ot used in this appl ication. The accomp anying tab le below t hat provid e details on each ca ll. | |
| 133 | Sequence D iagram | |
| 134 | ||
| 135 | REST Metho d | |
| 136 | Applicatio n Resource | |
| 137 | Applicatio n Service | |
| 138 | Applicatio n Reposito ry | |
| 139 | Retrieve S ervice | |
| 140 | Retrieve D atalayer | |
| 141 | GET | |
| 142 | DirectBook ingEligibi lityCriter iaResource | |
| 143 | DirectBook ingEligibi lityCriter iaService | |
| 144 | DirectBook ingEligibi lityCriter iaReposito ry | |
| 145 | fetchDirec tBookingEl igibiltyCr iteria() | |
| 146 | directBook ingEligibi lityCriter iaReposito ry.findByI d() | |
| 147 | GET | |
| 148 | RequestEli gibilityCr iteriaReso urce | |
| 149 | RequestEli gibilityCr iteriaServ ice | |
| 150 | RequestEli gibilityCr iteriaRepo sitory | |
| 151 | fetchReque stEligibil tyCriteria () | |
| 152 | requestEli gibilityCr iteriaRepo sitory.fin dById() | |
| 153 | REST Metho d | |
| 154 | Applicatio n Resource | |
| 155 | Applicatio n Service | |
| 156 | Applicatio n Validato r | |
| 157 | Applicatio n Reposito ry | |
| 158 | Save Servi ce | |
| 159 | Validate D ata | |
| 160 | Save Datal ayer | |
| 161 | POST | |
| 162 | DirectBook ingEligibi lityCriter iaResource | |
| 163 | DirectBook ingEligibi lityCriter iaService | |
| 164 | CoreSettin gs | |
| 165 | DirectBook ingEligibi lityCriter iaReposito ry | |
| 166 | save() | |
| 167 | CoreSettin gs.validat e() | |
| 168 | directBook ingEligibi lityCriter iaReposito ry.save() | |
| 169 | POST | |
| 170 | DirectBook ingEligibi lityCriter iaResource | |
| 171 | DirectBook ingEligibi lityCriter iaService | |
| 172 | CoreSettin gs | |
| 173 | RequestEli gibilityCr iteriaRepo sitory | |
| 174 | save() | |
| 175 | CoreSettin gs.validat e() | |
| 176 | requestEli gibilityCr iteriaRepo sitory.sav e() | |
| 177 | ||
| 178 | REST Metho d | |
| 179 | Applicatio n Resource | |
| 180 | Applicatio n Service | |
| 181 | Applicatio n Validato r | |
| 182 | Applicatio n Reposito ry | |
| 183 | Save Servi ce | |
| 184 | Validate D ata | |
| 185 | Save Datal ayer | |
| 186 | PUT | |
| 187 | DirectBook ingEligibi lityCriter iaResource | |
| 188 | DirectBook ingEligibi lityCriter iaService | |
| 189 | CoreSettin gs | |
| 190 | DirectBook ingEligibi lityCriter iaReposito ry | |
| 191 | save() | |
| 192 | CoreSettin gs.validat e() | |
| 193 | directBook ingEligibi lityCriter iaReposito ry.save() | |
| 194 | PUT | |
| 195 | DirectBook ingEligibi lityCriter iaResource | |
| 196 | DirectBook ingEligibi lityCriter iaService | |
| 197 | CoreSettin gs | |
| 198 | RequestEli gibilityCr iteriaRepo sitory | |
| 199 | save() | |
| 200 | CoreSettin gs.validat e() | |
| 201 | requestEli gibilityCr iteriaRepo sitory.sav e() | |
| 202 | Physical P erspective | |
| 203 | Deployment of the VA R Utility applicatio n is depic ted in the Deploymen t diagram below. Th e applicat ion front- end code r uns in the client br owser, and the appli cation bac kend code is deploye d into a W eblogic cl uster as d epicted by the multi ple overla pping laye rs. | |
| 204 | Deployment Diagram | |
| 205 | ||
| 206 | VAR Utilit y Modules | |
| 207 | The VAR Ut ility appl ication fe atures are implement ed as modu les. Appl ication mo dules are described below with a high-le vel descri ption. De tailed req uirements are define d in the U ser Storie s. | |
| 208 | Sites (Fac ilities) S upporting VAR | |
| 209 | The siteSu pportingVA R collecti on holds a list of S ites (Faci lities) re gistered a s supporti ng the VAR applicati on. Curre ntly this collection is popula ted and ma intained b y importin g a json d ocument in to MongoDB . No UI c omponent i s implemen ted. The siteSuppor tingVAR co llection d ata struct ure is ill ustrated b elow. A sample sit es-support ing-var.js on file is provided here. | |
| 210 | SiteSuppor tingVAR | |
| 211 | { | |
| 212 | _id: Sit e (Facilit y) ID Prim ary Key | |
| 213 | name: Sit e name | |
| 214 | } | |
| 215 | Clinical S ervices | |
| 216 | This is th e list of all clinic al service s supporte d by VAR. Clinical services a re stored in the cli nical-serv ices colle ction in M ongoDB. C urrently t his collec tion is po pulated an d maintain ed by impo rting a js on documen t into Mon goDB. No UI compone nt is impl emented. T he clinica l-services collectio n data str ucture is illustrate d below. A sample c linical-se rvices.jso n file is provided h ere. | |
| 217 | Clinical S ervices Co llection | |
| 218 | { | |
| 219 | _id: Clin ical Servi ce ID Prim ary Key | |
| 220 | name: Clin ical Servi ce Name | |
| 221 | stopCodes: [ | |
| 222 | { | |
| 223 | primary: Primary S top Code | |
| 224 | secondary: Secondary Stop Code | |
| 225 | }, | |
| 226 | ... | |
| 227 | ... | |
| 228 | ] | |
| 229 | submittedR equestLimi t: Submit ted Reques t Limit | |
| 230 | } | |
| 231 | Direct Boo king Eligi bility Cri teria | |
| 232 | Direct boo king eligi bility cri teria defi nes the co nditions a llowing pa tients to directly b ook appoin tments wit h VA using the VAR a pp. Direc t booking eligibilit y criteria is stored in the di rectBookin gEligibili tyCriteria collectio n in Mongo DB. The directBook ingEligibi lityCriter ia collect ion data s tructure i s illustra ted below. | |
| 233 | Direct Boo king Eligi bility Cri teria | |
| 234 | { | |
| 235 | _id: Site ID. The Facility ( Site) ID i s used as Primary Ke y | |
| 236 | coreSettin gs: [ | |
| 237 | { | |
| 238 | id: Cli nical Serv ice (Type of Care) I D, | |
| 239 | typeOfCa re: Clinic al Service Name, | |
| 240 | patientH istoryRequ ired: "Yes ", "No", " ", or null . NOTE: "" or null means thi s Clinical Service i s not supp orted in t his Facili ty. | |
| 241 | patientH istoryDura tion: Inte ger - Numb er of days | |
| 242 | }, | |
| 243 | ... | |
| 244 | ... | |
| 245 | ] | |
| 246 | lastModifi edDate: D ate of las t modifica tion | |
| 247 | modifiedBy : Modific ation User | |
| 248 | } | |
| 249 | Request El igibility Criteria | |
| 250 | Request el igibility criteria d efines the condition s allowing patients to request appointme nts with V A using th e VAR app. Request eligibilit y criteria is stored in the re questEligi bilityCrit eria colle ction in M ongoDB. The reques tEligibili tyCriteria collectio n data str ucture is illustrate d below. | |
| 251 | Request El igibility Criteria | |
| 252 | { | |
| 253 | _id: Site ID. The Facility ( Site) ID i s used as Primary Ke y | |
| 254 | requestSet tings: [ | |
| 255 | { | |
| 256 | id: Cli nical Serv ice (Type of Care) I D, | |
| 257 | typeOfCa re: Clinic al Service Name, | |
| 258 | patientH istoryRequ ired: "Yes ", "No", " ", or null . NOTE: "" or null means thi s Clinical Service i s not supp orted in t his Facili ty. | |
| 259 | patientH istoryDura tion: Inte ger - Numb er of days | |
| 260 | }, | |
| 261 | ... | |
| 262 | ... | |
| 263 | ] | |
| 264 | lastModifi edDate: D ate of las t modifica tion | |
| 265 | modifiedBy : Modific ation User | |
| 266 | } | |
| 267 | Data Archi tecture/Di ctionary | |
| 268 | Class Diag ram descri bes the ob ject model used by t he NoSQL d atabase. B elow is a listing of the NoSQL data coll ections st ored. | |
| 269 | # | |
| 270 | NoSQL Coll ection | |
| 271 | Descriptio n of data collection | |
| 272 | Source of data | |
| 273 | Structure | |
| 274 | Max capaci ty for ent ire collec tion | |
| 275 | 1 | |
| 276 | var-utilit y.siteSupp ortingVAR | |
| 277 | Sites allo wed for VA R applicat ion | |
| 278 | Pre-define d and impo rted using mongoimpo rt utility | |
| 279 | sites-supp orting-var .json | |
| 280 | < 100KB | |
| 281 | 2 | |
| 282 | var-utilit y.clinical -services | |
| 283 | Clinical S ervices su pported by VAR appli cation | |
| 284 | Pre-define d and impo rted using mongoimpo rt utility | |
| 285 | clinical-s ervices.js on | |
| 286 | < 100 KB | |
| 287 | 3 | |
| 288 | var-utilit y.directBo okingEligi bilityCrit eria | |
| 289 | Criteria f or definin g direct b ooking eli gibility r ules | |
| 290 | Scheduler entry thro ugh VAR Ut ility app | |
| 291 | direct-boo king-eligi bility-cri teria.json | |
| 292 | not more t han 1 MB | |
| 293 | 4 | |
| 294 | var-utilit y.requestE ligibility Criteria | |
| 295 | Criteria f or definin g request eligibilit y rules | |
| 296 | Scheduler entry thro ugh VAR Ut ility app | |
| 297 | request-el igibility- criteria.j son | |
| 298 | not more t han 1 MB | |
| 299 | Supported Devices | |
| 300 | Device's O S | |
| 301 | Native | |
| 302 | Hybrid | |
| 303 | Web-Only | |
| 304 | OS version supported | |
| 305 | Targeted d evices (iP hone, iPad , Samsung model...) | |
| 306 | Estimated Storage Re quired for Device | |
| 307 | Windows | |
| 308 | ||
| 309 | ||
| 310 | X | |
| 311 | Windows 7 | |
| 312 | IE 11 | |
| 313 | ||
| 314 | Technology Stack (Fr ont-End) | |
| 315 | Technologi es, Librar ies and To ols Used i n the Appl ication | |
| 316 | Version | |
| 317 | On the TRM ? (If not, provide a link to t he waiver) | |
| 318 | HTML5 | |
| 319 | 5 | |
| 320 | Yes | |
| 321 | CSS | |
| 322 | 3 | |
| 323 | Yes | |
| 324 | Angular | |
| 325 | 1.3.5 | |
| 326 | Yes | |
| 327 | AngularUI (ui-router ) | |
| 328 | 0.2.15 | |
| 329 | Yes | |
| 330 | UI-Bootstr ap | |
| 331 | 0.12.1 | |
| 332 | No (pendin g decision from VA P M, as issu es were fo und in upg rading to 0.13.0) | |
| 333 | jQuery | |
| 334 | 1.11.1 | |
| 335 | Yes | |
| 336 | Lo-Dash | |
| 337 | 2.4.2 | |
| 338 | Yes | |
| 339 | Moment | |
| 340 | 2.10.6 | |
| 341 | Yes | |
| 342 | RequireJS | |
| 343 | 2.1.14 | |
| 344 | Yes | |
| 345 | Technology Stack (Ba ck-End) | |
| 346 | Technologi es, Librar ies and To ols Used i n the Appl ication | |
| 347 | Version | |
| 348 | On the TRM ? (If not, provide a link to t he waiver) | |
| 349 | Java | |
| 350 | 7 | |
| 351 | Yes | |
| 352 | Spring Fra mework | |
| 353 | 4.2.5 | |
| 354 | Yes | |
| 355 | Jersey | |
| 356 | 2.22.2 | |
| 357 | Yes | |
| 358 | Mongo | |
| 359 | 3.x | |
| 360 | Yes | |
| 361 | VA Interfa ces - Exis ting | |
| 362 | Authorizat ion Servic es 4.3.x | |
| 363 | Interface Name (incl . version number) | |
| 364 | Data Used by Mobile App | |
| 365 | Source of Data | |
| 366 | Data Retri eved - pro vide speci fic data e lements us ed by this app | |
| 367 | Title (res ource-dire ctory) | |
| 368 | Endpoint | |
| 369 | Notes/Refe rences | |
| 370 | OAuth Toke n - Author ization Se rvices v4. 3.x | |
| 371 | OAuth Toke n | |
| 372 | Authorizat ion Servic es | |
| 373 | oauth-toke n.json | |
| 374 | oauth-toke n | |
| 375 | /Authoriza tionServic es/oauth/t oken | |
| 376 | ||
| 377 | Resource L ast Access ed Time - Authorizat ion Servic es v4.3.x | |
| 378 | Resource L ast Access ed Time | |
| 379 | Authorizat ion Servic es | |
| 380 | resource-l ast-access -time.json | |
| 381 | resource-l ast-access ed-time | |
| 382 | /Authoriza tionServic es/rest/re sourceLast AccessedTi me | |
| 383 | ||
| 384 | Interfaces – New | |
| 385 | The follow ing REST S ervices wi ll be crea ted to sup port VAR U tility app . | |
| 386 | DirectBook ingEligibi lityCriter iaResource | |
| 387 | DirectBook ingEligibi lityCriter iaResource exposes R EST endpoi nts to con figure the Direct Bo oking Elig ibility Cr iteria for all Clini cal Servic es support ed at the Facility. | |
| 388 | Method | |
| 389 | End Point | |
| 390 | Sample Dat a | |
| 391 | Sample Pay load | |
| 392 | GET | |
| 393 | /VarUtilit yServices/ v1/rest/di rect-booki ng-eligibi lity-crite ria/site/{ site-code} | |
| 394 | direct-boo king-eligi bility-cri teria.json | |
| 395 | ||
| 396 | POST | |
| 397 | /VarUtilit yServices/ v1/rest/di rect-booki ng-eligibi lity-crite ria/site/{ site-code} | |
| 398 | ||
| 399 | direct-boo king-eligi bility-cri teria-payl oad.json | |
| 400 | PUT | |
| 401 | /VarUtilit yServices/ v1/rest/di rect-booki ng-eligibi lity-crite ria/site/{ site-code} /id/{id} | |
| 402 | ||
| 403 | direct-boo king-eligi bility-cri teria-payl oad.json | |
| 404 | Parameters | |
| 405 | Parameter | |
| 406 | Descriptio n | |
| 407 | Parameter Type | |
| 408 | Data Type | |
| 409 | Valid Valu es | |
| 410 | site-code | |
| 411 | VistA Site Code | |
| 412 | Path | |
| 413 | 3-digit Fa cility ID or Site Co de | |
| 414 | This shoul d match Si te Code of the logge d in user | |
| 415 | id | |
| 416 | The Clinic al Service ID | |
| 417 | Path | |
| 418 | 3-digit Cl inical Ser vice ID | |
| 419 | Valid Clin ical Servi ces ID | |
| 420 | Responses | |
| 421 | HTTP Statu s Code | |
| 422 | Descriptio n | |
| 423 | 200 | |
| 424 | Success | |
| 425 | 403 | |
| 426 | Access Den ied | |
| 427 | 503 | |
| 428 | Service Un available | |
| 429 | RequestEli gibilityCr iteriaReso urce | |
| 430 | RequestEli gibilityCr iteriaReso urce expos es REST en dpoints to configure the Reque st Eligibi lity Crite ria for al l Clinical Services supported at the Fac ility. | |
| 431 | Method | |
| 432 | End Point | |
| 433 | Sample Dat a | |
| 434 | Sample Pay load | |
| 435 | GET | |
| 436 | /VarUtilit yServices/ v1/rest/re quest-elig ibility-cr iteria/sit e/{site-co de} | |
| 437 | request-el igibility- criteria.j son | |
| 438 | ||
| 439 | POST | |
| 440 | /VarUtilit yServices/ v1/rest/re quest-elig ibility-cr iteria/sit e/{site-co de} | |
| 441 | ||
| 442 | request-el igibility- criteria-p ayload.jso n | |
| 443 | PUT | |
| 444 | /VarUtilit yServices/ v1/rest/re quest-elig ibility-cr iteria/sit e/{site-co de}/id/{id } | |
| 445 | ||
| 446 | request-el igibility- criteria-p ayload.jso n | |
| 447 | Parameters | |
| 448 | Parameter | |
| 449 | Descriptio n | |
| 450 | Parameter Type | |
| 451 | Data Type | |
| 452 | Valid Valu es | |
| 453 | site-code | |
| 454 | VistA Site Code | |
| 455 | Path | |
| 456 | 3-digit Fa cility ID or Site Co de | |
| 457 | This shoul d match Si te Code of the logge d in user | |
| 458 | id | |
| 459 | The Clinic al Service ID | |
| 460 | Path | |
| 461 | 3-digit Cl inical Ser vice ID | |
| 462 | Valid Clin ical Servi ces ID | |
| 463 | Responses | |
| 464 | HTTP Statu s Code | |
| 465 | Descriptio n | |
| 466 | 200 | |
| 467 | Success | |
| 468 | 403 | |
| 469 | Access Den ied | |
| 470 | 503 | |
| 471 | Service Un available | |
| 472 | Non-Functi onal Requi rements | |
| 473 | Security | |
| 474 | All the st aff specif ic REST en dpoints ar e secured and it wil l be enfor ced using Spring Sec urity. Acc ess to the services will be gr anted to t he calls t hat contai n OAuth2.0 Access To ken in the Authoriza tion Heade r. User's roles will be checke d against the config ured roles using Acc ess Decisi on Manager s. | |
| 475 | Capacity R equirement s | |
| 476 | Expected c oncurrent and maximu m size of the user b ase | |
| 477 | User Categ ory | |
| 478 | Concurrent Requests | |
| 479 | Scheduling Clerks | |
| 480 | 50 |
Araxis Merge (but not the data content of this report) is Copyright © 1993-2016 Araxis Ltd (www.araxis.com). All rights reserved.