4241. EPMO Open Source Coordination Office Redaction File Detail Report

Produced by Araxis Merge on 10/5/2018 9:06:44 PM Central 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.

4241.1 Files compared

# Location File Last Modified
1 MHEDP3_VAOS_VATS_SM_Sept2018.zip\VAR 4.5.2 VAR-4.x-SDD.docx Thu Sep 27 18:38:52 2018 UTC
2 MHEDP3_VAOS_VATS_SM_Sept2018.zip\VAR 4.5.2 VAR-4.x-SDD.docx Sat Oct 6 01:27:50 2018 UTC

4241.2 Comparison summary

Description Between
Files 1 and 2
Text Blocks Lines
Unchanged 3 962
Changed 3 7
Inserted 0 0
Removed 0 0

4241.3 Comparison options

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

4241.4 Active regular expressions

No regular expressions were active.

4241.5 Comparison detail

  1   VA Online  Scheduling  (VAOS) We b Applicat ion 4.x SD D
  2  
  3   Mobile App lication S ystem Desi gn Documen t (SDD) Ad dendum
  4   Mobile App lication I nformation
  5   - Overview
  6   - Data Sto rage
  7   - Applicat ion Classi fication
  8   - Supporte d Devices
  9   - Supporte d Browsers
  10   - Capabili ties
  11   Applicatio n Design
  12   - Design P rinciples  and Patter ns
  13   - Conceptu al Perspec tive
  14   - Componen t Overview  - Current  as of Aug ust 15, 20 18
  15   - Componen t Overview  - through  completio n of VAR 4 .x
  16   - High-lev el User In terface Di agram
  17   - Logical  Perspectiv e
  18   - Function al Workflo ws Diagram
  19   - Typical  Request Wo rkflow Dia gram
  20   Physical P erspective
  21   - Deployme nt Diagram s
  22   - Deployme nt Diagram , Current  as of Augu st 15, 201 8
  23   - Deployme nt Diagram , Planned  for 4.x co mpletion ( subject to  change as  requireme nts evolve )
  24   Technology  Stack and  Service D ependencie s
  25   - Technolo gy Stack O verview
  26   - VA Inter faces
  27   - VA Mobil e Infrastr ucture and  Microserv ices
  28   - VAOS Int erfaces
  29   Non-functi onal Requi rements
  30   - Containe r Capacity
  31   - User Vol ume
  32   Developer  and Progra m Manager  (PM) Conta ct Informa tion
  33  
  34  
  35  
  36  
  37   Mobile App lication S ystem Desi gn Documen t (SDD) Ad dendum
  38   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.
  39  
  40  
  41   Mobile App lication I nformation
  42  
  43   - Overview
  44  
  45   Software N ame
  46   VA Online  Scheduling  (VAOS) We b Applicat ion
  47   Project In crement /  Release De signation:
  48   var-web
  49   Product Ve rsion (cur rent)
  50   4.5.2
  51   Source Rep ository
  52   https://co derepo.mob ilehealth. va.gov/pro jects/VAR/ repos/var- web
  53   /browse?at =refs%2Fhe ads%2Frele ase%2F4.5
  54   Enclave(s)
  55  
  56   Veteran Pr ovider
  57  
  58  
  59  
  60   Software T ype
  61  
  62   Service Ap p
  63   Background  Process O ther
  64  
  65  
  66  
  67  
  68  
  69   Veteran
  70   Care Giver
  71   Provider
  72   Public
  73   Help Desk
  74   Intended A udience fo r Mobile A pplication
  75   X
  76  
  77  
  78  
  79  
  80  
  81  
  82   - Data Sto rage
  83  
  84   Question
  85   Yes
  86   No
  87   If Yes, wh at informa tion / dat a
  88   If yes, th en identif y any cons umer or so urce syste m(s) for t he data
  89   Does the u ser enter  informatio n or data  into the m obile appl ication?
  90   X
  91  
  92  
  93   Appointmen t request  informatio n
  94   VistA appo intment in formation  Notificati on prefere nce data
  95  
  96   VARDB
  97   VistA
  98   Does Mobil e Applicat ion store  informatio n or data  entered by  the User?  If yes, w here is it  stored?
  99   X
  100  
  101  
  102   VARDB Orac le Databas e
  103  
  104   VARDB
  105   Does Mobil e Applicat ion transm it/push da ta entered  outside o f the VAMF  to VA?
  106   X
  107  
  108  
  109   Appointmen t request  informatio n
  110   Appointmen t informat ion
  111  
  112   VARDB
  113   VistA
  114   Does Mobil e Applicat ion pull d ata from a  VA Databa se (extern al to VAMF )?
  115   X
  116  
  117  
  118   Patient In formation  Booked app ointments  Facilities
  119   Providers  and clinic s
  120  
  121   VARDB
  122   VistA CDW
  123   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?
  124   X
  125  
  126  
  127   Patient In formation  Patient pr eference d ata Appoin tment requ est inform ation
  128  
  129   VARDB
  130  
  131  
  132   - Applicat ion Classi fication
  133   This appli cation can  be classi fied as on e of the f ollowing:
  134  
  135   Mobile App lication C lassificat ion (Only  one box ma y be check ed)
  136   Mark with  X
  137   1 – Very L ow: Mobile  Applicati on does no t use VA R esource
  138  
  139   2 – Low: R ead only a ccess to V A Resource (s) (No PI I / PHI)
  140  
  141  
  142  
  143   3 – Medium : Write ac cess to VA  Resource( s)
  144  
  145   4 – High:  Read and/o r Write ac cess of se nsitive da ta to VA R esource(s)  (Includes  PII/PHI/o ther sensi tive)
  146   X
  147  
  148   - Supporte d Devices
  149  
  150   Device OS
  151   Native
  152   Hybrid
  153   Web-Only
  154   OS version  supported
  155   Targeted D evices (iP hone, iPad , Samsung  model...)
  156   Estimated  Storage Re  quired fo r Device
  157   iOS
  158  
  159  
  160   X
  161   iOS 9+
  162   iPhone
  163   n/a
  164   Android
  165  
  166  
  167   X
  168   4.x+ (conf irm)
  169   Tablet - S amsung Gal axy Note
  170   n/a
  171   Windows
  172  
  173  
  174   X
  175   Windows 8  (confirm)
  176   Desktop
  177   n/a
  178  
  179  
  180  
  181   - Supporte d Browsers
  182  
  183   Device
  184   Browser
  185   Version
  186   iOS
  187   Safari
  188  
  189   Android
  190   Chrome
  191  
  192   Windows
  193   Internet E xplorer
  194   10+
  195   Apple OSX
  196   Safari
  197  
  198  
  199   - Capabili ties
  200   The VAOS W eb applica tion provi des the fo llowing fe atures:
  201  
  202   View list  of VistA b ooked appo intments.
  203   Cancel Vis tA booked  appointmen ts.
  204   View list  of appoint ment reque sts made i n VAR.
  205   Cancel app ointment r equests.
  206   Directly b ook a Vist A appointm ent at a c linic.
  207   Request an  appointme nt at a fa cility.
  208   Submit mes sage to cl erk along  with reque st.
  209   Submit an  Express Ca re request .
  210  
  211  
  212   Applicatio n Design
  213  
  214   - Design P rinciples  and Patter ns
  215   VAR follow s the 12 F actor App  Guidelines  https://1 2factor.ne t/
  216   VAR is a V AMF NextGe n Applicat ion and fo llows the  fundamenta ls and req uirements  of the pla tform
  217   Single Pag e Applicat ion - Sing le Page Ap plication  design pat terns will  be levera ged, but,  not strict ly adhered  to. This  includes t he Backbon e.js frame work and t he additio n of mobil e styling  from jQuer y UI.
  218   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. Ea ch REST se rvice endp oint is de fined with  a "title"  and "href ". For con venience,  all the de pendencies  are ident ified in t he VAMF In terfaces s ection.
  219   REST Conve ntions - T he applica tion works  with data  using HTT P verbs. G ET is used  for retri eving data , POST is  used for c reating or  processin g data, PU T is used  for updati ng data an d DELETE i s used for  deleting  data.
  220   Exception  Handling u sing HTTP  standards  - Exceptio n handling  is perfor med based  on HTTP st atus codes . Bad Requ est (statu s code
  221   400) is ha ndled at t he Model o r Resource  level. In ternal Ser ver Error  (status co de 500) is  handled g lobally wi thin the a pplication . Leveragi ng common  VAMF Servi ces such a s User Ser vice and R ight of Ac cess (ROA)  Web/Servi ce.
  222  
  223   - Conceptu al Perspec tive
  224   Component  diagram de picting ho w the VAR  Web Applic ation conn ects acros s software  in the VA OS Schedul ing Suite  is illustr ated below .
  225  
  226   - Componen t Overview  - Current  as of Aug ust 15, 20 18
  227  
  228   VA Online  Scheduling  Web Appli cation (VA R Web) rec eives inpu t from Vet eran Users  and reque sts appoin tments and  other set tings data  through V AOS Shared  Resources . VAR Web  also acces ses MDWS f or EHR and  other Pat ient infor mation, as  well as a ppointment  slots for  booking a ppointment s and serv icing requ ests. Site -specific  settings f or this ap plication  are retrie ved from V AOS Shared  Resources  as config ured throu gh VA Tool  Set.
  229  
  230  
  231  
  232  
  233   - Componen t Overview  - through  completio n of VAR 4 .x
  234  
  235   The follow ing diagra m illustra tes the to -be archit ecture thr ough the c ompletion  of VAR 4.x . The prim ary differ ences here  are the u se of VIA  for EHR an d other Pa tient Info rmation, a nd the use  of VAOS M icrosevice s in place  of Shared  Resources  to retrie ve VAR-cen tric data  and settin gs.
  236  
  237  
  238  
  239  
  240  
  241  
  242  
  243  
  244  
  245   - High-lev el User In terface Di agram
  246   The primar y User Exp erience, n oted as fu nctional r egions and  component s, is depi cted in th e diagram  below.
  247  
  248  
  249  
  250  
  251  
  252  
  253  
  254  
  255   - Logical  Perspectiv e
  256  
  257   - Function al Workflo ws Diagram
  258   VAR logica l function s are depi cted below . The two  main funct ional area s are Appo intment Re quests and  Direct Bo oking. Onl y patients  meeting t he eligibi lity crite ria are al lowed to a ccess the  main funct ions opera ting on a  Facility r egistered  as a Site  supporting  VAR. Subs equent act ions in ea ch functio nal area a re as illu strated.
  259  
  260  
  261  
  262  
  263   - Typical  Request Wo rkflow Dia gram
  264  
  265   Below depi cts an all -encompass ing boiler plate inte raction be tween the  VAOS Web A pplication  and its a ttached re sources. R equests fr om the cli ent will a lways pass  through t he API Gat eway where  an author ization ch eck will t ake place.  Upon succ essful aut horization , proper h eaders and  session c ookies wil l be injec ted into t he request  and then  handed off  to the ap propriate  resource.
  266  
  267  
  268  
  269  
  270  
  271   Physical P erspective
  272  
  273   - Deployme nt Diagram s
  274   This secti on highlig hts a comp lete list  of the dep loyment di agrams, in  order of  completion  and deliv ery of the  software.  The first  set is ba sed on inc remental r eleases. T he last is  the ideal  planned a rchitectur e based on  evolving  requiremen ts and tar geted reso lution of  technical  debt.
  275  
  276   3.1.1 - De ployment D iagram, Cu rrent as o f August 1 5, 2018
  277   Summary:
  278  
  279   Deployment  of the VA OS Web app lication i s depicted  in the di agram belo w. VAOS We b is inten ded for de ployment i n the VAMF  NextGen e nvironment , and as s uch, all c ontainers  listed in  the diagra m are run  in both a  Docker Com pose envir onment and  Docker Sw arm enviro nment, dep ending on  the deploy ment stage  to produc tion. The  VAOS Web ( VAOS UI) p ortion is  deployed t o a CentOS  7 NginX s erver in a  Docker co ntainer. P lease refe r to the o ther VAMF  Shared Ser vices SRVD Ds for add itional in formation  and compon ent depend encies rel ated to th ose servic es indepen dently, bu t not list ed in this  diagram.
  280  
  281  
  282  
  283  
  284   Footnotes:
  285  
  286   The direct  use of MV I is techn ical debt  that is ac counted fo r, and sco ped for a  future rel ease (prio rity not y et given).  The use i s around l egacy EDIP I correlat ion to acc ount for p re-existin g data des ign in pro duction, a s well as  proper col lection of  DFNs. Thi s will be  resolved w ith the mo st up to d ate correl ation patt ern using  ICN and a  production -level dat a migratio n.
  287  
  288  
  289  
  290   3.1.2 - De ployment D iagram, Pl anned for  4.x comple tion (subj ect to cha nge as req uirements  evolve)
  291   Summary:
  292  
  293  
  294  
  295  
  296  
  297  
  298   Technology  Stack and  Service D ependencie s
  299  
  300   - Technolo gy Stack O verview
  301   The follow ing is a r unning lis t of all m ajor techn ologies ch osen to bu ild out th e VAR Web  Applicatio n.
  302  
  303   Technologi es, Librar ies, and T ools Used  in the App
  304   Version
  305   On the TRM ? (If not,  provide a  link to t he waiver)
  306   HTML5
  307   5
  308   Yes
  309   CSS
  310   3
  311   Yes
  312   BackboneJS
  313   1.1.2
  314   Yes
  315   Marionette
  316   2.4.4
  317   Yes
  318   jQuery
  319   2.1.4
  320   Yes
  321  
  322  
  323   jQuery Mob ile
  324   1.4.5
  325   Yes
  326   Lo-Dash
  327   2.4.2
  328   Yes
  329   Moment
  330   2.7.0
  331   Yes
  332   Moment Tim ezone
  333   0.5.13
  334   Yes
  335   Font Face  Observer
  336   1.7.1
  337   No
  338   RequireJS
  339   2.1.14
  340   Yes
  341   Applicare
  342   7.3.8.4
  343   Yes
  344   Google Ana lytics
  345   7.x
  346   Yes
  347  
  348  
  349  
  350   - VA Inter faces
  351  
  352   4.2.1 - VA  Mobile In frastructu re and Mic roservices
  353  
  354   The VAR We b Applicat ion has di rect depen dencies on  the follo wing VA-pr ovided int erfaces:
  355  
  356   Interface  Name
  357   Version
  358   Domain
  359   Descriptio n of Role
  360   SDD
  361   API Gatewa y
  362   1.x
  363   VAMF NextG en Infrast ructure
  364   Access to  VA domain  services
  365   VDD Link
  366   User Servi ces
  367   1.x
  368   VAMF NextG en Infrast ructure
  369   Login, Ses sion, Pati ent Inform ation
  370   SRVDD Link
  371   Consul (Ha shiCorp)
  372  
  373   VAMF NextG en Infrast ructure
  374   Applicatio n runtime  configurat ion
  375  
  376   Mobile App ointments  Enterprise  Service
  377   1.x
  378   VAMF NextG en Infrast ructure
  379   Centralize d retrieva l of appoi ntments ac ross all e nterprise  types
  380   SRVDD Link
  381   ** VistA D ata Servic es
  382   1.x
  383   VAMF NextG en Infrast ructure
  384  
  385   VistA Data  Services  v1 SRVDD
  386   ** CDW Ser vices
  387   1.x
  388   VAMF NextG en Infrast ructure
  389  
  390   CDW-Servic e - SRVDD  (1.6.0)
  391  
  392  
  393   Footnotes:
  394  
  395   ** - To be  integrate d by the c ompletion  of VAOS We b 4.x
  396  
  397  
  398   4.3 - VAOS  Interface s
  399   The VAR We b Applicat ion has di rect depen dencies on  the follo wing VAOS  interfaces  developed  in line w ith Schedu ling Manag er on the  same contr act:
  400  
  401   Interface  Name
  402   Version
  403   Domain
  404   Descriptio n of Role
  405  
  406   VAR Resour ces
  407   4.2.x
  408   VAOS Servi ces
  409   Business l ogic passt hrough for  access to  underlyin g VAMF Inf rastructur e
  410   SRVDD Link
  411   Facility S ervice
  412   2.x
  413   VAOS Servi ces
  414   Retrieval  of facilit ies suppor ting VAR f unctionali ty
  415   SRVDD Link
  416   ** Communi ty Care Mi croservice
  417   1.x
  418   VAOS Micro services
  419   Requesting  and modif ying pendi ng Communi ty Care Co nsults in  the VAOS s ystem
  420   Community  Care Appoi ntments Mi croservice
  421   1.x - SRVD D
  422  
  423   Footnotes:
  424  
  425   ** - To be  integrate d by the c ompletion  of VAOS We b 4.x
  426  
  427  
  428  
  429  
  430   Non-functi onal Requi rements
  431  
  432   - Containe r Capacity
  433  
  434   Type
  435   Min
  436   Max
  437   CPU
  438   1
  439   2
  440   Memory
  441   512 MB
  442   1024 MB
  443   Storage
  444   1 GB
  445   5 GB
  446  
  447  
  448  
  449   - User Vol ume
  450  
  451   User Categ ory
  452   Total Numb er of User s
  453   Concurrent  Users
  454   Veterans
  455   ~ 5000/wee k
  456   ~ 100
  457  
  458  
  459   Developer  and Progra m Manager  (PM) Conta ct Informa tion
  460  
  461  
  462   Developer  Name/Point  of Contac t (POC)
  463   VA E-Mail  Address
  464   Phone Numb er
  465   Doug Kuruc z
  466   doug.kuruc z@ablevets .com  PII
  467  
  468   Developer  Organizati on/Company
  469   Contract S tart Date
  470   Contract E nd Date
  471   AbleVets
  472   1/27/17
  473   1/26/18
  474   Web and Mo bile Solut ions PM or  POC
  475   VA E-Mail  Address
  476   Phone Numb er
  477   Steve Gree n
  478   PII
  479  
  480   VA Product  Developme nt PM or P OC
  481   VA E-Mail  Address
  482   Phone Numb er
  483   Steve Gree n
  484   PII
        485