Produced by Araxis Merge on 5/8/2017 10:03:24 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.1.0+-+System+Design+Document+(SDD)+Addendum.docx | Mon May 8 15:46:21 2017 UTC |
| 2 | var-utility-web-Release-1.0.0-Branch.zip\MHED_VAR_DOCS | VAR+Utility+v1.1.0+-+System+Design+Document+(SDD)+Addendum.docx | Tue May 9 01:19:37 2017 UTC |
| Description | Between Files 1 and 2 |
|
|---|---|---|
| Text Blocks | Lines | |
| Unchanged | 2 | 1150 |
| Changed | 1 | 2 |
| 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.1.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 | ||
| 13 | Physical P erspective | |
| 14 | Deployment Diagram | |
| 15 | VAR Utilit y Modules | |
| 16 | Sites (Fac ilities) S upporting VAR | |
| 17 | Clinical S ervices | |
| 18 | Direct Boo king Eligi bility Cri teria | |
| 19 | Request El igibility Criteria | |
| 20 | Custom Mes sage | |
| 21 | Data Archi tecture/Di ctionary | |
| 22 | Supported Devices | |
| 23 | Technology Stack (Fr ont-End) | |
| 24 | Technology Stack (Ba ck-End) | |
| 25 | VA Interfa ces - Exis ting | |
| 26 | Authorizat ion Servic es 4.3.x | |
| 27 | Interfaces – New | |
| 28 | DirectBook ingEligibi lityCriter iaResource | |
| 29 | Responses | |
| 30 | RequestEli gibilityCr iteriaReso urce | |
| 31 | Responses | |
| 32 | CustomMess ageResourc e | |
| 33 | Responses | |
| 34 | ||
| 35 | Non-Functi onal Requi rements | |
| 36 | Security | |
| 37 | Capacity R equirement s | |
| 38 | Mobile App lication S ystem Desi gn Documen t (SDD) Ad dendum | |
| 39 | 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. | |
| 40 | Mobile App lication I nformation | |
| 41 | Project In crement / Release De signation: VAR Utili ty Applica tion | |
| 42 | Product Ve rsion: 1. 1.0 | |
| 43 | ||
| 44 | ||
| 45 | Veteran | |
| 46 | Care Giver | |
| 47 | Provider | |
| 48 | Public | |
| 49 | Intended A udience fo r Mobile A pplication | |
| 50 | ||
| 51 | ||
| 52 | X (Schedul ing Clerks ) | |
| 53 | ||
| 54 | ||
| 55 | Question | |
| 56 | Yes | |
| 57 | No | |
| 58 | If Yes, wh at informa tion / dat a | |
| 59 | If yes, th en identif y any cons umer or so urce syste m(s) for t he data | |
| 60 | Does the u ser enter informatio n or data into the m obile appl ication? | |
| 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 store informatio n or data entered by the User? If yes, w here is it stored? | |
| 66 | X | |
| 67 | ||
| 68 | Custom Mes sages, Req uest and D irect Sche duling Eli gibility C riteria | |
| 69 | VAR Utilit y Services (MongoDB) | |
| 70 | Does Mobil e Applicat ion transm it/push da ta entered outside o f the VAMF to VA? | |
| 71 | ||
| 72 | X | |
| 73 | ||
| 74 | ||
| 75 | Does Mobil e Applicat ion pull d ata from a VA Databa se (extern al to VAMF )? | |
| 76 | ||
| 77 | X | |
| 78 | ||
| 79 | ||
| 80 | 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? | |
| 81 | ||
| 82 | X | |
| 83 | ||
| 84 | ||
| 85 | ||
| 86 | This appli cation can be classi fied as on e of the f ollowing: | |
| 87 | Mobile App lication C lassificat ion (Only one box ma y be check ed) | |
| 88 | Mark with X | |
| 89 | 1 – Very Low: Mobil e Applicat ion does n ot use VA Resource | |
| 90 | ||
| 91 | 2 – Low: Read only access to VA Resourc e(s) (No P II / PHI) | |
| 92 | ||
| 93 | 3 – Mediu m: Write a ccess to V A Resource (s) | |
| 94 | X | |
| 95 | 4 – High: Read and/ or Write a ccess of s ensitive d ata to VA Resource(s ) (Include s PII/PHI/ other sens itive) | |
| 96 | ||
| 97 | Applicatio n Design | |
| 98 | Design Pri nciples an d Patterns | |
| 99 | Single Pag e Applicat ion - Sing le Page Ap plication design pat tern will be leverag ed. | |
| 100 | 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. | |
| 101 | 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. | |
| 102 | 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. | |
| 103 | Leveraging common VA MF Service s such as Authorizat ion Servic es and Met ric Servic es. | |
| 104 | Veteran Ap pointment Requests ( VAR) Utili ty Applica tion | |
| 105 | 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. | |
| 106 | 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. | |
| 107 | Request El igibility Criteria: configure s the crit eria gover ning the e ligibility of vetera ns to requ est an app ointment. | |
| 108 | Conceptual Perspecti ve | |
| 109 | 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. | |
| 110 | Component Diagram | |
| 111 | ||
| 112 | ServletCon tainer | |
| 113 | ServletCon tainer pro vides the runtime fo r the Jers ey Servlet acting as the entry point for HTTP requ ests. | |
| 114 | CorsHttpRe sponseFilt er | |
| 115 | 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. | |
| 116 | ExceptionF ilter | |
| 117 | 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. | |
| 118 | SpringSecu rityFilter | |
| 119 | SpringSecu rityFilter (Delegati ngFilterPr oxy) is us ed for rol e-based ac cess contr ol and aut horization . | |
| 120 | jersey.ser vlet.Servl etContaine r | |
| 121 | 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. | |
| 122 | XSSRequest Filter | |
| 123 | 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. | |
| 124 | Metrics As pect | |
| 125 | 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. | |
| 126 | Applicatio n Resource s | |
| 127 | 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. | |
| 128 | Applicatio n Services | |
| 129 | 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. | |
| 130 | Applicatio n Reposito ries | |
| 131 | Applicatio n Reposito ries provi de the abs traction t o the pers istence da ta stored in MongoDB . | |
| 132 | ||
| 133 | The Class diagram be low provid es a high- level clas sification of object s used in the VAR Ut ility appl ication. The three main objec ts are the DirectBoo kingEligib ilityCrite ria, Reque stEligibil ityCriteri a and Cust omMessage which enco mpass the main objec tive of th e applicat ion. | |
| 134 | Class Diag ram | |
| 135 | ||
| 136 | Logical Pe rspective | |
| 137 | Generic Se quence dia grams for REST calls are depic ted below for each R EST operat ion. Only GET, POST, and PUT operat ions are i mplemented . DELETE ope ration is not used i n this app lication. The accomp anying tab le below t hat provid e s details o n each cal l. | |
| 138 | Sequence D iagram | |
| 139 | ||
| 140 | REST Metho d | |
| 141 | Applicatio n Resource | |
| 142 | Applicatio n Service | |
| 143 | Applicatio n Reposito ry | |
| 144 | Retrieve S ervice | |
| 145 | Retrieve D atalayer | |
| 146 | GET | |
| 147 | DirectBook ingEligibi lityCriter iaResource | |
| 148 | DirectBook ingEligibi lityCriter iaService | |
| 149 | DirectBook ingEligibi lityCriter iaReposito ry | |
| 150 | fetchDirec tBookingEl igibiltyCr iteria() | |
| 151 | directBook ingEligibi lityCriter iaReposito ry.findByI d() | |
| 152 | GET | |
| 153 | RequestEli gibilityCr iteriaReso urce | |
| 154 | RequestEli gibilityCr iteriaServ ice | |
| 155 | RequestEli gibilityCr iteriaRepo sitory | |
| 156 | fetchReque stEligibil tyCriteria () | |
| 157 | requestEli gibilityCr iteriaRepo sitory.fin dById() | |
| 158 | GET | |
| 159 | CustomMess ageResourc e | |
| 160 | CustomMess ageService | |
| 161 | CustomMess ageReposit ory | |
| 162 | fetchCusto mMessagesB ySiteCode( ) | |
| 163 | customMess ageReposit ory.findBy SiteCode() | |
| 164 | GET | |
| 165 | CustomMess ageResourc e | |
| 166 | CustomMess ageService | |
| 167 | CustomMess ageReposit ory | |
| 168 | fetchCusto mMessgeByS iteCodeAnd MessageId( ) | |
| 169 | customMess ageReposit ory.findBy SiteCodeAn dMessageId () | |
| 170 | REST Metho d | |
| 171 | Applicatio n Resource | |
| 172 | Applicatio n Service | |
| 173 | Applicatio n Validato r | |
| 174 | Applicatio n Reposito ry | |
| 175 | Save Servi ce | |
| 176 | Validate D ata | |
| 177 | Save Datal ayer | |
| 178 | POST | |
| 179 | DirectBook ingEligibi lityCriter iaResource | |
| 180 | DirectBook ingEligibi lityCriter iaService | |
| 181 | CoreSettin gs | |
| 182 | DirectBook ingEligibi lityCriter iaReposito ry | |
| 183 | save() | |
| 184 | CoreSettin gs.validat e() | |
| 185 | directBook ingEligibi lityCriter iaReposito ry.save() | |
| 186 | POST | |
| 187 | DirectBook ingEligibi lityCriter iaResource | |
| 188 | DirectBook ingEligibi lityCriter iaService | |
| 189 | CoreSettin gs | |
| 190 | RequestEli gibilityCr iteriaRepo sitory | |
| 191 | save() | |
| 192 | CoreSettin gs.validat e() | |
| 193 | requestEli gibilityCr iteriaRepo sitory.sav e() | |
| 194 | ||
| 195 | REST Metho d | |
| 196 | Applicatio n Resource | |
| 197 | Applicatio n Service | |
| 198 | Applicatio n Validato r | |
| 199 | Applicatio n Reposito ry | |
| 200 | Save Servi ce | |
| 201 | Validate D ata | |
| 202 | Save Datal ayer | |
| 203 | PUT | |
| 204 | DirectBook ingEligibi lityCriter iaResource | |
| 205 | DirectBook ingEligibi lityCriter iaService | |
| 206 | CoreSettin gs | |
| 207 | DirectBook ingEligibi lityCriter iaReposito ry | |
| 208 | save() | |
| 209 | CoreSettin gs.validat e() | |
| 210 | directBook ingEligibi lityCriter iaReposito ry.save() | |
| 211 | PUT | |
| 212 | DirectBook ingEligibi lityCriter iaResource | |
| 213 | DirectBook ingEligibi lityCriter iaService | |
| 214 | CoreSettin gs | |
| 215 | RequestEli gibilityCr iteriaRepo sitory | |
| 216 | save() | |
| 217 | CoreSettin gs.validat e() | |
| 218 | requestEli gibilityCr iteriaRepo sitory.sav e() | |
| 219 | PUT | |
| 220 | CustomMess ageResourc e | |
| 221 | CustomMess ageService | |
| 222 | ||
| 223 | CustomMess ageReposit ory | |
| 224 | saveCustom Message() | |
| 225 | ||
| 226 | customMess ageReposit ory.save() | |
| 227 | REST Metho d | |
| 228 | Applicatio n Resource | |
| 229 | Applicatio n Service | |
| 230 | Applicatio n Validato r | |
| 231 | Applicatio n Reposito ry | |
| 232 | Delete Ser vice | |
| 233 | Validate D ata | |
| 234 | Delete Dat alayer | |
| 235 | DELETE | |
| 236 | CustomMess ageResourc e | |
| 237 | CustomMess ageService | |
| 238 | ||
| 239 | CustomMess ageReposit ory | |
| 240 | deleteCust omMessages BySiteCode | |
| 241 | ||
| 242 | customMess ageReposit ory.delete BySiteCode () | |
| 243 | ||
| 244 | Physical P erspective | |
| 245 | 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. | |
| 246 | Deployment Diagram | |
| 247 | ||
| 248 | VAR Utilit y Modules | |
| 249 | 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. | |
| 250 | Sites (Fac ilities) S upporting VAR | |
| 251 | 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. | |
| 252 | SiteSuppor tingVAR | |
| 253 | { | |
| 254 | _id: Sit e (Facilit y) ID Prim ary Key | |
| 255 | name: Sit e name | |
| 256 | } | |
| 257 | Clinical S ervices | |
| 258 | 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. | |
| 259 | Clinical S ervices Co llection | |
| 260 | { | |
| 261 | _id: Clin ical Servi ce ID Prim ary Key | |
| 262 | name: Clin ical Servi ce Name | |
| 263 | stopCodes: [ | |
| 264 | { | |
| 265 | primary: Primary S top Code | |
| 266 | secondary: Secondary Stop Code | |
| 267 | }, | |
| 268 | ... | |
| 269 | ... | |
| 270 | ] | |
| 271 | submittedR equestLimi t: Submit ted Reques t Limit | |
| 272 | } | |
| 273 | Direct Boo king Eligi bility Cri teria | |
| 274 | 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. | |
| 275 | Direct Boo king Eligi bility Cri teria | |
| 276 | { | |
| 277 | _id: Site ID. The Facility ( Site) ID i s used as Primary Ke y | |
| 278 | coreSettin gs: [ | |
| 279 | { | |
| 280 | id: Cli nical Serv ice (Type of Care) I D, | |
| 281 | typeOfCa re: Clinic al Service Name, | |
| 282 | 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. | |
| 283 | patientH istoryDura tion: Inte ger - Numb er of days | |
| 284 | }, | |
| 285 | ... | |
| 286 | ... | |
| 287 | ] | |
| 288 | lastModifi edDate: D ate of las t modifica tion | |
| 289 | modifiedBy : Modific ation User | |
| 290 | } | |
| 291 | Request El igibility Criteria | |
| 292 | 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. | |
| 293 | Request El igibility Criteria | |
| 294 | { | |
| 295 | _id: Site ID. The Facility ( Site) ID i s used as Primary Ke y | |
| 296 | requestSet tings: [ | |
| 297 | { | |
| 298 | id: Cli nical Serv ice (Type of Care) I D, | |
| 299 | typeOfCa re: Clinic al Service Name, | |
| 300 | 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. | |
| 301 | patientH istoryDura tion: Inte ger - Numb er of days | |
| 302 | }, | |
| 303 | ... | |
| 304 | ... | |
| 305 | ] | |
| 306 | lastModifi edDate: D ate of las t modifica tion | |
| 307 | modifiedBy : Modific ation User | |
| 308 | } | |
| 309 | Custom Mes sage | |
| 310 | Custom mes sage provi des inform ation that is specif ic to divi sions with VA using the VAR ap p. Custom message i s stored i n the cust om-message s collecti on in Mong oDB. The custom-me ssages col lection da ta structu re is illu strated be low. | |
| 311 | Custom Mes sage | |
| 312 | { | |
| 313 | "siteC ode" : Sit e ID. The Facility (Site) ID is used as part of t he compoun d unique k ey. | |
| 314 | "messageId " : Messag e ID. The ID for the message t ext as par t of the c ompound un ique key. | |
| 315 | "messa geText" : Custom mes sage text that is sp ecific to divisions. | |
| 316 | "lastM odifiedDat e" Custom message te xt date of last modi fication. | |
| 317 | } | |
| 318 | Data Archi tecture/Di ctionary | |
| 319 | 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. | |
| 320 | # | |
| 321 | NoSQL Coll ection | |
| 322 | Descriptio n of data collection | |
| 323 | Source of data | |
| 324 | Structure | |
| 325 | Max capaci ty for ent ire collec tion | |
| 326 | 1 | |
| 327 | var-utilit y.siteSupp ortingVAR | |
| 328 | Sites allo wed for VA R applicat ion | |
| 329 | Pre-define d and impo rted using mongoimpo rt utility | |
| 330 | sites-supp orting-var .json | |
| 331 | < 100KB | |
| 332 | 2 | |
| 333 | var-utilit y.clinical -services | |
| 334 | Clinical S ervices su pported by VAR appli cation | |
| 335 | Pre-define d and impo rted using mongoimpo rt utility | |
| 336 | clinical-s ervices.js on | |
| 337 | < 100 KB | |
| 338 | 3 | |
| 339 | var-utilit y.directBo okingEligi bilityCrit eria | |
| 340 | Criteria f or definin g direct b ooking eli gibility r ules | |
| 341 | Scheduler entry thro ugh VAR Ut ility app | |
| 342 | direct-boo king-eligi bility-cri teria.json | |
| 343 | not more t han 1 MB | |
| 344 | 4 | |
| 345 | var-utilit y.requestE ligibility Criteria | |
| 346 | Criteria f or definin g request eligibilit y rules | |
| 347 | Scheduler entry thro ugh VAR Ut ility app | |
| 348 | request-el igibility- criteria.j son | |
| 349 | not more t han 1 MB | |
| 350 | 5 | |
| 351 | var-utilit y.custom-m essages | |
| 352 | Custom mes sage speci fic to div ision. | |
| 353 | Scheduler entry thro ugh VAR Ut ility app | |
| 354 | custom-mes sage.json | |
| 355 | not more t han 1 MB | |
| 356 | Supported Devices | |
| 357 | Device's O S | |
| 358 | Native | |
| 359 | Hybrid | |
| 360 | Web-Only | |
| 361 | OS version supported | |
| 362 | Targeted d evices (iP hone, iPad , Samsung model...) | |
| 363 | Estimated Storage Re quired for Device | |
| 364 | Windows | |
| 365 | ||
| 366 | ||
| 367 | X | |
| 368 | Windows 8 | |
| 369 | IE 11 | |
| 370 | ||
| 371 | Technology Stack (Fr ont-End) | |
| 372 | Technologi es, Librar ies and To ols Used i n the Appl ication | |
| 373 | Version | |
| 374 | On the TRM ? (If not, provide a link to t he waiver) | |
| 375 | HTML5 | |
| 376 | 5 | |
| 377 | Yes | |
| 378 | CSS | |
| 379 | 3 | |
| 380 | Yes | |
| 381 | Angular | |
| 382 | 1.3.5 | |
| 383 | Yes | |
| 384 | AngularUI (ui-router ) | |
| 385 | 0.2.15 | |
| 386 | Yes | |
| 387 | UI-Bootstr ap | |
| 388 | 0.12.1 | |
| 389 | No (pendin g decision from VA P M, as issu es were fo und in upg rading to 0.13.0) | |
| 390 | jQuery | |
| 391 | 1.11.1 | |
| 392 | Yes | |
| 393 | Lo-Dash | |
| 394 | 2.4.2 | |
| 395 | Yes | |
| 396 | Moment | |
| 397 | 2.10.6 | |
| 398 | Yes | |
| 399 | RequireJS | |
| 400 | 2.1.14 | |
| 401 | Yes | |
| 402 | Technology Stack (Ba ck-End) | |
| 403 | Technologi es, Librar ies and To ols Used i n the Appl ication | |
| 404 | Version | |
| 405 | On the TRM ? (If not, provide a link to t he waiver) | |
| 406 | Java | |
| 407 | 7 | |
| 408 | Yes | |
| 409 | Spring Fra mework | |
| 410 | 4.2.5 | |
| 411 | Yes | |
| 412 | Jersey | |
| 413 | 2.22.2 | |
| 414 | Yes | |
| 415 | Mongo | |
| 416 | 3.x | |
| 417 | Yes | |
| 418 | VA Interfa ces - Exis ting | |
| 419 | Authorizat ion Servic es 4.3.x | |
| 420 | Interface Name (incl . version number) | |
| 421 | Data Used by Mobile App | |
| 422 | Source of Data | |
| 423 | Data Retri eved - pro vide speci fic data e lements us ed by this app | |
| 424 | Title (res ource-dire ctory) | |
| 425 | Endpoint | |
| 426 | Notes/Refe rences | |
| 427 | OAuth Toke n - Author ization Se rvices v4. 3.x | |
| 428 | OAuth Toke n | |
| 429 | Authorizat ion Servic es | |
| 430 | oauth-toke n.json | |
| 431 | oauth-toke n | |
| 432 | /Authoriza tionServic es/oauth/t oken | |
| 433 | ||
| 434 | Resource L ast Access ed Time - Authorizat ion Servic es v4.3.x | |
| 435 | Resource L ast Access ed Time | |
| 436 | Authorizat ion Servic es | |
| 437 | resource-l ast-access -time.json | |
| 438 | resource-l ast-access ed-time | |
| 439 | /Authoriza tionServic es/rest/re sourceLast AccessedTi me | |
| 440 | ||
| 441 | Interfaces – New | |
| 442 | The follow ing REST S ervices wi ll be crea ted to sup port VAR U tility app . | |
| 443 | DirectBook ingEligibi lityCriter iaResource | |
| 444 | 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. | |
| 445 | Method | |
| 446 | End Point | |
| 447 | Sample Dat a | |
| 448 | Sample Pay load | |
| 449 | GET | |
| 450 | /VarUtilit yServices/ v1/rest/di rect-booki ng-eligibi lity-crite ria/site/{ site-code} | |
| 451 | direct-boo king-eligi bility-cri teria.json | |
| 452 | ||
| 453 | POST | |
| 454 | /VarUtilit yServices/ v1/rest/di rect-booki ng-eligibi lity-crite ria/site/{ site-code} | |
| 455 | ||
| 456 | direct-boo king-eligi bility-cri teria-payl oad.json | |
| 457 | PUT | |
| 458 | /VarUtilit yServices/ v1/rest/di rect-booki ng-eligibi lity-crite ria/site/{ site-code} /id/{id} | |
| 459 | ||
| 460 | direct-boo king-eligi bility-cri teria-payl oad.json | |
| 461 | Parameters | |
| 462 | Parameter | |
| 463 | Descriptio n | |
| 464 | Parameter Type | |
| 465 | Data Type | |
| 466 | Valid Valu es | |
| 467 | site-code | |
| 468 | VistA Site Code | |
| 469 | Path | |
| 470 | 3-digit Fa cility ID or Site Co de | |
| 471 | This shoul d match Si te Code of the logge d in user | |
| 472 | id | |
| 473 | The Clinic al Service ID | |
| 474 | Path | |
| 475 | 3-digit Cl inical Ser vice ID | |
| 476 | Valid Clin ical Servi ces ID | |
| 477 | Responses | |
| 478 | HTTP Statu s Code | |
| 479 | Descriptio n | |
| 480 | 200 | |
| 481 | Success | |
| 482 | 403 | |
| 483 | Access Den ied | |
| 484 | 503 | |
| 485 | Service Un available | |
| 486 | RequestEli gibilityCr iteriaReso urce | |
| 487 | 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. | |
| 488 | Method | |
| 489 | End Point | |
| 490 | Sample Dat a | |
| 491 | Sample Pay load | |
| 492 | GET | |
| 493 | /VarUtilit yServices/ v1/rest/re quest-elig ibility-cr iteria/sit e/{site-co de} | |
| 494 | request-el igibility- criteria.j son | |
| 495 | ||
| 496 | POST | |
| 497 | /VarUtilit yServices/ v1/rest/re quest-elig ibility-cr iteria/sit e/{site-co de} | |
| 498 | ||
| 499 | request-el igibility- criteria-p ayload.jso n | |
| 500 | PUT | |
| 501 | /VarUtilit yServices/ v1/rest/re quest-elig ibility-cr iteria/sit e/{site-co de}/id/{id } | |
| 502 | ||
| 503 | request-el igibility- criteria-p ayload.jso n | |
| 504 | Parameters | |
| 505 | Parameter | |
| 506 | Descriptio n | |
| 507 | Parameter Type | |
| 508 | Data Type | |
| 509 | Valid Valu es | |
| 510 | site-code | |
| 511 | VistA Site Code | |
| 512 | Path | |
| 513 | 3-digit Fa cility ID or Site Co de | |
| 514 | This shoul d match Si te Code of the logge d in user | |
| 515 | id | |
| 516 | The Clinic al Service ID | |
| 517 | Path | |
| 518 | 3-digit Cl inical Ser vice ID | |
| 519 | Valid Clin ical Servi ces ID | |
| 520 | Responses | |
| 521 | HTTP Statu s Code | |
| 522 | Descriptio n | |
| 523 | 200 | |
| 524 | Success | |
| 525 | 403 | |
| 526 | Access Den ied | |
| 527 | 503 | |
| 528 | Service Un available | |
| 529 | CustomMess ageResourc e | |
| 530 | CustomMess ageResourc e exposes REST endpo ints to ha ndle custo m messages for the F acility. | |
| 531 | Method | |
| 532 | End Point | |
| 533 | Sample Dat a | |
| 534 | Sample Pay load | |
| 535 | GET | |
| 536 | /VarUtilit yServices/ v1/rest/cu stom-messa ges/site/{ site-code} | |
| 537 | custom-mes sage.json | |
| 538 | ||
| 539 | PUT | |
| 540 | /VarUtilit yServices/ v1/rest/cu stom-messa ges/site/{ site-code} | |
| 541 | ||
| 542 | custom-mes sage-paylo ad.json | |
| 543 | DELETE | |
| 544 | /VarUtilit yServices/ v1/rest/cu stom-messa ges/site/{ site-code} | |
| 545 | custom-mes sage.json | |
| 546 | ||
| 547 | Parameters | |
| 548 | Parameter | |
| 549 | Descriptio n | |
| 550 | Parameter Type | |
| 551 | Data Type | |
| 552 | Valid Valu es | |
| 553 | site-code | |
| 554 | VistA Site Code | |
| 555 | Path | |
| 556 | 3-digit Fa cility ID or Site Co de | |
| 557 | This shoul d match Si te Code of the logge d in user | |
| 558 | Responses | |
| 559 | HTTP Statu s Code | |
| 560 | Descriptio n | |
| 561 | 200 | |
| 562 | Success | |
| 563 | 403 | |
| 564 | Access Den ied | |
| 565 | 503 | |
| 566 | Service Un available | |
| 567 | ||
| 568 | Non-Functi onal Requi rements | |
| 569 | Security | |
| 570 | 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. | |
| 571 | Capacity R equirement s | |
| 572 | Expected c oncurrent and maximu m size of the user b ase | |
| 573 | User Categ ory | |
| 574 | Concurrent Requests | |
| 575 | Scheduling Clerks | |
| 576 | 50 |
Araxis Merge (but not the data content of this report) is Copyright © 1993-2016 Araxis Ltd (www.araxis.com). All rights reserved.