4242. EPMO Open Source Coordination Office Redaction File Detail Report

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

4242.1 Files compared

#	Location	File	Last Modified
1	MHEDP3_VAOS_VATS_SM_Sept2018.zip\VAR 4.5.2	VAR-4.x-SRVDD.docx	Thu Sep 27 18:39:54 2018 UTC
2	MHEDP3_VAOS_VATS_SM_Sept2018.zip\VAR 4.5.2	VAR-4.x-SRVDD.docx	Sat Oct 6 01:26:10 2018 UTC

4242.2 Comparison summary

Description	Between Files 1 and 2
Description	Text Blocks	Lines
Unchanged	1	3968
Changed	0	0
Inserted	1	1
Removed	0	0

4242.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

4242.4 Active regular expressions

No regular expressions were active.

4242.5 Comparison detail

1	VA Online Scheduling (VAOS) Se rvice 4.x SRVDD
2
3	VA Online Scheduling (VAOS) Se rvice Desi gn Documen t (SRVDD)
4
5	- General Informatio n
6	- Data Sto rage and C lassificat ion
7	- Design P rinciples and Patter ns
8	- Conceptu al Overvie w
9	- High-Lev el Compone nt Diagram - Current as of Aug ust 15, 20 18**
10	- Componen t Overview - through completio n of VAR 4 .x
11	- Detailed Service-O riented Co mponent Di agram
12	2.2.3 - Pl anned Deco mposition of Veteran Appointme nt Request Service ( this appli cation)
13	- Logical Design Ove rview
14	- REST End point Brea kdown
15	- Deployme nt Archite cture
16	- Deployme nt Diagram s
17	3.2.1 - De ployment D iagram, Cu rrent as o f March 28 , 2018
18	- Technolo gy Stack O verview
19	- VA Inter faces
20	- MDWS 3.2 .8 - Sched uling Serv ice
21	- CDW
22	- VA Mobil e Infrastr ucture and Microserv ices JWT E ndpoints
23	User Sessi on Endpoin ts
24	- VAMF Sha red Servic es
25	- VAOS Int erfaces
26	Oracle Dat a Architec ture
27	MongoDB Da ta Archite cture
28	- Security
29	- Service Configurat ion
30	- Applicat ion Capaci ty Plan Us er Volume
31	- Containe r Capacity
32	Project Da tabase Cap acity
33
34
35
36
37
38	The Servic e Design D ocument (S RVDD) prov ides three chief des ign perspe ctives: Co nceptual, Logical, a nd Physica l for proc esses and data. This document will be up dated duri ng the imp lementatio n life cyc le.
39
40
41
42
43	Mobile Ser vice Infor mation
44
45	- General Informatio n
46
47	Software N ame
48	VA Online Scheduling (VAOS) Se rvice
49	Project In crement / Release De signation:
50	var-resour ces
51	Product Ve rsion
52	4.5.2
53	Source Rep ository
54	https://co derepo.mob ilehealth. va.gov/pro jects/VAR/ repos/var- resources /browse?at =refs%2Fhe ads%2Frele ase%2F4.5
55	Enclave(s)
56
57	Veteran Pr ovider
58
59
60
61	Software T ype
62
63	Service Ap p
64	Background Process O ther
65
66
67
68	- Data Sto rage and C lassificat ion
69
70	Question
71	Response
72	Persists d ata in VAM F?
73
74	Yes No
75	Database T ype
76
77	Mongo Orac le Other
78	Type of Da ta in VAMF
79
80	Applicatio n-Specific PGD
81	Other Shar ed Data
82	Reads/Writ es data fr om VA Ente rprise sou rce direct ly? (examp le VistA, ADR, HDR, etc.)
83
84	This relat es to this service d irectly, n ot through another s hared serv ice.
85
86	Reads - Li st sources : CDW Writ es - List sources:
87	Both - Lis t sources: VistA Typ e of Data:
88	PII SPI
89	Non-sensit ive
90
91
92	Applicatio n Design P erspective
93
94	- Design P rinciples and Patter ns
95	Single Pag e Applicat ion - The Single Pag e Applicat ion design pattern w ill be lev eraged, so web page content wi ll not be routed thr ough these web servi ces
96	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.
97	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.
98	Exception Handling u sing HTTP standards - Exceptio n handling is perfor med based on HTTP st atus codes . Bad Requ est (statu s code
99	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 Share d Services such as A PI Gateway , User Ser vices, and MDWS2VIA.
100
101	- Conceptu al Overvie w
102	Major comp onents of the VAR Re sources ap plication are implem ented as R EST servic es and are depicted in the fol lowing Com ponent Dia grams. Des cription o f how this exists in the appli cation arc hitecture and relate d workflow s are also depicted.
103
104	- High-Lev el Compone nt Diagram - Current as of Aug ust 15, 20 18**
105	Summary:
106
107	Component diagram de picting ho w the VA O nline Sche duling Ser vice (VAR Resources) connects across sof tware in t he VAOS Sc heduling S uite is il lustrated below. VAR Web Appli cation rec eives inpu t from Vet eran Users and reque sts appoin tments and other set tings data through V AOS Share d Resource s to inclu de VAR Res ources (th is applica tion). VAO S Web Appl ication al so accesse s MDWS for EHR and o ther 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.
108
109
110
111
112
113	Footnotes:
114
115	** - VAOS Resources will be de composed i nto micros ervices by the compl etion of 4 .x. For mo re informa tion on th e proposed component s and diag rams, plea se refer t o the VAR Web 4.x SD D. Further SRVDDs wi ll be comp leted as t he design is solidif ied and th e work pri oritized.
116
117	- Componen t Overview - through completio n of VAR 4 .x
118
119	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.
120
121
122
123
124	- Detailed Service-O riented Co mponent Di agram
125
126	Summary: V AR Resourc es accepts requests for resour ces in the the domai ns on the left side of the dia gram. Data points to satisfy r eads and w rites to e ach domain are detai led on the right sid e. VAR Res ources pul ls facilit y informat ion from F acility Se rvice, ret rieves boo king and patient in formation from VistA as a data source th rough MDWS , and also queries f or patient identifie r correlat ion using MVI, and c onnects to CDW
127	. VAOS Res ources mai ntains req uest infor mation and other set tings thro ugh Mongo and Oracle .
128
129
130
131	2.2.3 - Pl anned Deco mposition of Veteran Appointme nt Request Service ( this appli cation)
132	By the con clusion of 3.x, Sche duling Man ager Servi ce will be rearchite cted into a series o f microser vices to m eet modern ization re quirements outlined by the VAM F Architec ture Board , and the overall vi sion of a scalable a rchitectur e. A summa ry of the services i s outlined below. Al l domains in the Vet eran Appoi ntment Req uest Servi ce have be en covered in this d ecompositi on and wil l also com plement do mains in t he VAR Mic roservices decomposi tion plan.
133
134	VAOS Clini cal Servic es Microse rvice - al l operatio ns related to clinic settings and inform ation
135	VAOS Appoi ntments Mi croservice - all ope rations re lated to v iewing boo ked appoin tments and direct sc heduling
136	VAOS Reque sts Micros ervice - a ll operati ons specif ic to crea ting, upda ting, and cancelling appointme nt request s
137	VAOS Notif ications M icroservic e - all no tification -related s ettings an d preferen ces for ve terans
138	VAOS Messa ges MIcros ervice - a ll operati ons relate d to creat ing messag es to and from veter ans and pr oviders in appointme nt request s
139	VAOS Expre ss Care Mi croservice - all aux illary ope rations re lated to i nterfacing express c are reques ts and det ails
140	VAOS Site Settings M icroservic e - all op erations f or viewing and updat ing site-s pecific se ttings for VAR
141
142
143
144
145	2.3 - Logi cal Design Overview
146
147	2.3.1 - RE ST Endpoin t Breakdow n
148
149
150	Appointmen ts
151
152
153	GET
154	/v4/direct -schedulin g/site/{si te-code}/p atient/
155	{assigning -authority }/{patient -id}/avail able- appo intment-sl ots
156
157
158	POST
159	/v4/direct -schedulin g/site/{si te-code}/p atient/
160	{assigning -authority }/{patient -id}/booke d- appoint ments
161
162
163	GET
164	/v4/direct -schedulin g/site/{si te-code}/p atient/
165	{assigning -authority }/{patient -id}/booke d- appoint ments
166
167
168	GET
169	/v4/direct -schedulin g/patient/ {assigning - authorit y}/{patien t-id}/book ed-cc-appo intments
170
171
172	GET
173	/v4/direct -schedulin g/site/{si te-code}/p atient/
174	{assigning -authority }/{patient -id}/cance l-reasons- list
175
176
177	PUT
178	/v4/direct -schedulin g/site/{si te-code}/p atient/
179	{assigning -authority }/{patient -id}/cance l- appoint ment
180
181
182	GET
183	/v4/direct -schedulin g/site/{si te-code}/l ogout
184
185
186	GET
187	/v4/direct -schedulin g/institut ions
188
189
190	GET
191	/v4/direct -schedulin g/site/{si te-code}/p atient/
192	{assigning -authority }/{patient -id}/direc t-eligibil ity
193	/visited-i n-past-mon ths
194
195
196	GET
197	/v4/direct -schedulin g/site/{si te-code}/p atient/
198	{assigning -authority }/{patient -id}/reque st- eligib ility/visi ted-in-pas t-months
199
200
201	GET
202	/v4/direct -schedulin g/patient/ {assigning - authorit y}/{patien t-id}/pact -team
203
204
205	GET
206	/v4/direct -schedulin g/patient/ {assigning - authorit y}/{patien t-id}/requ est-limit
207
208
209	GET
210	/v4/direct -schedulin g/parent-s ites
211
212
213
214
215
216	Facilities
217	GET
218	/v4/clinic -service/p atient/{as signing-au thority}/
219	{patient-i d}/site/{s ite-code}/ clinic-pro file/{clin ic-id}
220	GET
221	/v4/clinic al-service s/types-of -care
222	GET
223	/v4/clinic al-service s/patient/ {assigning -authority }/
224	{patient-i d}/clinics
225
226	Requests
227
228
229	GET
230	/v4/appoin tment-serv ice/patien t/{assigni ng- author ity}/{pati ent-id}/ap pointments
231
232
233	POST
234	/v4/appoin tment-serv ice/patien t/{assigni ng- author ity}/{pati ent-id}/ap pointments
235
236
237	GET
238	/v4/appoin tment-serv ice/patien t/{assigni ng- author ity}/{pati ent-id}/ap pointment- requests
239	/system/{s ystem-id}/ id/{appoin tment-requ est-id}
240	/messages
241
242
243	POST
244	/v4/appoin tment-serv ice/patien t/{assigni ng- author ity}/{pati ent-id}/ap pointment- requests
245	/system/{s ystem-id}/ id/{appoin tment-requ est-id}
246	/messages
247
248
249	POST
250	/v4/appoin tment-serv ice/patien t/{assigni ng- author ity}/{pati ent-id}/ap pointment- requests
251	/system/{s ystem-id}/ id/{appoin tment-requ est-id}
252	/messages/ read
253
254
255	GET
256	/v4/appoin tment-serv ice/patien t/{assigni ng- author ity}/{pati ent-id}/ap pointments /system/
257	{system-id }/id/{appo intment-re quest-id}
258
259
260	PUT
261	/v4/appoin tment-serv ice/patien t/{assigni ng- author ity}/{pati ent-id}/ap pointments /system/
262	{system-id }/id/{appo intment-re quest-id}
263
264
265	POST
266	/v4/appoin tment-serv ice/patien t/{assigni ng- author ity}/{pati ent-id}/co mmunity-ca re- appoin tment
267
268
269
270	Clinics
271
272
273
274
275	GET
276	/v4/facili ty-service /facilitie s
277	GET
278	/v4/facili ty-service /supported -facilitie s
279
280
281	Notificati ons
282
283
284	GET
285	/v4/patien t/{assigni ng-authori ty}/{patie nt-id}
286	/preferenc e
287
288
289	PUT
290	/v4/patien t/{assigni ng-authori ty}/{patie nt-id}
291	/preferenc e
292
293
294	GET
295	/v4/notifi cation-ser vice/patie nt/{assign ing- autho rity}/{pat ient-id}/n otificatio ns
296
297
298	PUT
299	/v4/notifi cation-ser vice/patie nt/{assign ing- autho rity}/{pat ient-id}/n otificatio ns/{notifi cation-id}
300	/read
301
302
303	DELETE
304	/v4/notifi cation-ser vice/patie nt/{assign ing- autho rity}/{pat ient-id}/n otificatio ns/{notifi cation-id}
305
306
307
308	Feedback
309
310	POST/v4/ap pointment- service/fe edback
311
312
313
314	GET
315	/v4/api-ke ys
316	GET
317	/v4/commun ity-care-s ervices/ty pe-of-care s
318	GET
319	/v4/custom -messages
320	GET
321	/v4/disabl ed-feature s
322	GET
323	/v4/expres s-care-ser vice/reaso ns
324
325
326
327
328
329	Applicatio n Settings Physical P erspective
330	This secti on calls f or informa tion gathe red at the last deve lopment sp rint. This design vi ew describ es how and where a s ervice is deployed t o one or m ore enviro nments, su ch as test , dev-int, productio n, etc. Th e physical view shou ld illustr ate how th e deployed entity is packaged, with whic h entities it is int egrated an d exchange s messages , and the physical e nvironment in which the implem entation i s installe d and conf igured.
331
332	- Deployme nt Archite cture
333	Applicatio n app.yml - https:// coderepo.m obilehealt h.va.gov/p rojects/VA R/repos/va r-resource s/browse/a pp.yml?at= refs%2Fhea ds%2Frelea se% 2F4.2
334
335	Applicatio n Dockerfi le - https ://coderep o.mobilehe alth.va.go v/projects /VAR/repos /var-resou rces/brows e/Dockerfi le?at=rele ase/4.2
336
337
338	- Deployme nt Diagram s
339	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.
340
341	- Deployme nt Diagram , Current as of Marc h 28, 2018
342	Summary:
343
344
345
346
347
348	Technology Stack and Service D ependencie s
349
350	- Technolo gy Stack O verview
351	The follow ing is a r unning lis t of all m ajor techn ologies ch osen to bu ild out th e Scheduli ng Manager Service a pplication .
352
353
354	Technologi es, Librar ies, and T ools Used in the App
355	Version
356	On the TRM ? (If not, provide a link to t he waiver)
357	Java Runti me Environ ment
358	8
359	Yes
360	Spring Fra mework
361	4.2.5
362	Yes
363	Jersey
364	2.22.2
365	Yes
366	Hibernate
367	3.x
368	Yes
369	MongoDB
370	3.0.x
371	Yes
372	Docker
373	17.09.1-ce
374	Yes
375	Tomcat
376	8.0.56
377	Yes
378
379	- VA Inter faces
380	The VAR Re sources ap plication has depend encies on the follow ing existi ng VA inte rfaces:
381
382
383	SOAP
384	MDWS 3.2.8 - MDWS 3.2 .8 - Sched uling Serv ice
385
386
387
388
389
390
391	Interface Name
392	HTTP
393	Method
394	Scheduling Svc.asmx
395	Make Appoi ntment
396	POST
397	/Schedulin gSvc/makeA ppointment
398	Cancel App ointment
399	POST
400	/Schedulin gSvc/cance lAppointme nt
401	Get Booked Appointme nts
402	POST
403	/Schedulin gSvc/getAp pointments BookingNot es
404	Get Availa ble Slots
405	POST
406	/Schedulin gSvc
407	/getClinic Scheduling DetailsByD ateRange
408	Get Cancel Reason Li st
409	POST
410	/Schedulin gSvc/getCa ncellation Reasons
411
412
413
414	- CDW
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454	CDW (MS SQ L DB)
455
456
457	Interface Name
458	Object Typ e
459	Data Used by Mobile App
460	Data Retri eved - pro vide speci fic data e lements us ed by this app
461	Notes/Refe rences
462
463
464	OIA_Mobile Healt h.Ap p. ap_GetA ctiveCli n ics_v2
465	Procedure
466	Active Cli nics
467	Clinics lo cation, pr imary and secondary stop codes .
468
469
470
471	OIA_Mobile Healt h.Ap p. ap_GetP tActiveT e amsMembers _v4
472	Procedure
473	PACT Team Members
474	Primary Ca re PACT Te am provide rs data.
475
476
477
478	OIA_Mobile Healt h.Ap p. ap_GetP tActiveT e amsClinics _v4
479	Procedure
480	PACT Team Clinics
481	Primary Ca re PACT Te am clinics data.
482
483
484
485	OIA_Mobile Healt h.Ap p. fn_VAR_ BuildSto p codeTable
486	Function
487	None.
488	None.
489	This is a utility fu nction use d internal ly in CDW by the oth er stored procedures .
490
491
492	OIA_Mobile Healt h.Ap p. ap_Appt RecallRe m indersByDa te_v1
493	Procedure
494	Recall Rem inders
495	Data for g enerating recall app ointment r eminders.
496	Functional ity delive red since VAR Resour ces 3.1.0
497
498
499	OIA_Mobile Health. Ap p. ap_GetC hildFacili ti es_v2
500	Procedure
501	Child Faci lities
502	Data for C hild facil ities
503
504
505
506
507	2.3 - VA M obile Infr astructure and Micro services
508
509	VAR Resour ces applic ation has direct dep endencies on the fol lowing VA Mobile exi sting inte rfaces:
510	4.
511
512	The
513
514
515
516
517	Dependency
518	Version
519	Domain
520	Descriptio n
521	SDD
522	API Gatewa y
523	1.x
524	VAMF NextG en Infrast ructure
525	Access to VA domain services
526	VDD Link
527	Consul (Ha shiCorp)
528
529	VAMF NextG en Infrast ructure
530	Configurat ion data f or environ ment (data base conne ction info rmation, e tc)
531
532	User Servi ces
533	1.7.x
534	VAMF NextG en Infrast ructure
535	Login, Ses sion, Pati ent Inform ation
536	SRVDD Link
537	MDWS to VI A Adapter
538	1.x
539	VAMF NextG en Infrast ructure
540	Access to VIA Servic es
541	SRVDD Link
542
543
544
545
546
547	Interface Name
548	Method
549	Endpoint
550	jwt
551	GET
552	/jwt/
553
554
555
556
557
558	Interface Name
559	Method
560	Endpoint
561	Login
562	GET
563	/users/v1/ login
564	Logout
565	GET
566	/users/v1/ logout
567	MHP User
568	GET
569	/users/v1/ session/mh puser
570	Session
571	GET
572	/users/v1/ session
573	Patient Id entifiers
574	GET
575	/users/v1/ session/id entifiers. json
576	Token
577	GET
578	/users/v1/ session/jw t
579
580
581
582
583	REST Endpo ints
584	JWT Endpoi nts
585
586
587
588
589
590
591	User Sessi on Endpoin ts- VAMF S hared Serv ices
592	The Vetera n Appointm ent Reques t Service has direct dependenc ies on the following VAMF Shar ed Service s develope d in line with Sched uling Mana ger on the same cont ract:
593
594	Interface Name
595	Version
596	Domain
597	Descriptio n of Role
598	SDD
599	Veteran Vi deo Connec t Service
600	3.x
601	VAMF Share d Services
602	Connector to Video V isits Serv ice
603	SDD Missin g or Outda ted
604	Video Visi ts Service
605	3.x
606	VAMF Share d Services
607	Booking of Express C are Appoin tments
608	SDD Missin g or Outda ted
609
610	- VAOS Int erfaces
611	The Vetera n Appointm ent Reques t Service has direct dependenc ies on the following VAOS inte rfaces dev eloped in line with Scheduling Manager o n the same contract:
612
613	Interface Name
614	Version
615	Domain
616	Descriptio n of Role
617	SDD
618	VAR Messag ing Micros ervice
619	2.x
620	VAOS Servi ces
621	Applicatio n notifica tions and recall rem inders
622	SRVDD Link
623	Facility S ervice
624	2.x
625	VAOS Servi ces
626	Retrieval of facilit ies suppor ting VAR f unctionali ty
627	SRVDD Link
628
629
630
631	Data Model
632	Data model s for Orac le and Mon goDB are d escribed b elow.
633
634	Oracle Dat a Architec ture
635	Scheduling Manager S ervice ope rates on t he Oracle database s chema VARD B which is connected to the Ve teran Appo intment Re quest (VAR ) applicat ion. The E ntity Rela tionship D iagram is shown belo w. Details of each O racle tabl e in the d atabase ar e provided in the fo llowing ta bles.
636
637
638
639
640
641
642
643
644
645
646	Oracle
647	APPOINTMEN T_REQUEST
648
649	COLUMN_NAM E
650	DATA_TYPE
651	NULLAB LE
652	DATA_DEFA ULT
653	COLUMN
654	_ID
655	PK?
656	COMMEN TS
657
658
659	APPOINTMEN T_REQUEST_ ID
660	VARCHAR2(3 2 BYTE)
661	No
662
663	1
664	Y
665
666
667
668
669
670	PATIENT_ID
671	VARCHAR2(2 55 BYTE)
672	No
673
674	2
675
676
677
678
679	LAST_UPDAT ED_DATE
680	TIMESTAMP( 6)
681	No
682
683	3
684
685
686
687
688	CREATED_DA TE
689	TIMESTAMP( 6)
690	No
691
692	4
693
694
695
696
697	DELETED_DA TE
698	TIMESTAMP( 6)
699	Yes
700
701	5
702
703
704
705
706	ACTIVE
707	NUMBER(1,0 )
708	No
709
710	6
711
712
713
714
715	SECOND_REQ UEST
716	NUMBER(1,0 )
717	No
718
719	7
720
721
722
723
724	APPOINTMEN T_DATE
725	VARCHAR2(5 0 BYTE)
726	Yes
727
728	8
729
730
731
732
733	APPOINTMEN T_TIME
734	VARCHAR2(5 0 BYTE)
735	Yes
736
737	9
738
739
740
741
742	OPTION_DAT E_1
743	VARCHAR2(5 0 BYTE)
744	No
745
746	10
747
748
749
750
751	OPTION_TIM E_1
752	VARCHAR2(5 0 BYTE)
753	No
754
755	11
756
757
758
759
760	OPTION_DAT E_2
761	VARCHAR2(5 0 BYTE)
762	No
763
764	12
765
766
767
768
769	OPTION_TIM E_2
770	VARCHAR2(5 0 BYTE)
771	No
772
773	13
774
775
776
777
778	OPTION_DAT E_3
779	VARCHAR2(5 0 BYTE)
780	No
781
782	14
783
784
785
786
787	OPTION_TIM E_3
788	VARCHAR2(5 0 BYTE)
789	No
790
791	15
792
793
794
795
796	STATUS
797	VARCHAR2(2 55 BYTE)
798	No
799
800	16
801
802
803
804
805	APPOINTMEN T_TYPE
806	VARCHAR2(2 55 BYTE)
807	No
808
809	17
810
811
812
813
814	FACILITY_C ODE
815	VARCHAR2(1 00 BYTE)
816	No
817
818	18
819
820
821
822
823	EMAIL
824	VARCHAR2(2 55 BYTE)
825	Yes
826
827	19
828
829
830
831
832	PHONE_NUMB ER
833	VARCHAR2(2 55 BYTE)
834	No
835
836	20
837
838
839
840
841	TEXT_MESSA GING_ALLOW ED
842	NUMBER(1,0 )
843	No
844
845	21
846
847
848
849
850	TEXT_MESSA GING_PHONE _N UMBER
851	VARCHAR2(2 55 BYTE)
852	Yes
853
854	22
855
856
857
858
859	PURPOSE_OF _VISIT
860	VARCHAR2(2 55 BYTE)
861	Yes
862
863	23
864
865
866
867
868	OTHER_PURP OSE_OF_VIS IT
869	VARCHAR2(1 00 BYTE)
870	Yes
871
872	24
873
874
875
876
877	VISIT_TYPE
878	VARCHAR2(4 0 BYTE)
879	Yes
880
881	25
882
883
884
885
886	PROVIDER_I D
887	VARCHAR2(2 55 BYTE)
888	Yes
889
890	26
891
892
893
894
895
896
897	COLUMN_NAM E
898	DATA_TYPE
899	NULLAB LE
900	DATA_DEFAU LT
901	COLUMN_ ID
902	PK?
903	COMMEN TS
904	ID
905	VARCHAR2(3 2 BYTE)
906	No
907
908	1
909	Y
910
911	APPOINTMEN T_REQUES T _ID
912	VARCHAR2(3 2 BYTE)
913	No
914
915	2
916
917
918	SENDER_ID
919	VARCHAR2(2 55 BYTE)
920	No
921
922	3
923
924
925	MESSAGE_TE XT
926	VARCHAR2(2 55 BYTE)
927	No
928
929	4
930
931
932	MESSAGE_DA TE_TIME
933	TIMESTAMP( 6)
934	No
935
936	5
937
938
939	MESSAGE_TY PE
940	VARCHAR2(3 2 BYTE)
941
942
943
944
945
946
947
948	PROVIDER_N AME
949	VARCHAR2(2 55 BYTE)
950	Yes
951
952	27
953
954
955
956
957	PROVIDER_P ERSON_CLAS S
958	VARCHAR2(2 55 BYTE)
959	Yes
960
961	28
962
963
964
965
966	PROVIDER_O PTION
967	VARCHAR2(1 00 BYTE)
968	Yes
969
970	29
971
972
973
974
975	SECOND_REQ UEST_SUBMI TT ED
976	NUMBER(1,0 )
977	No
978
979	30
980
981
982
983
984	PARENT_REQ UEST_ID
985	VARCHAR2(3 2 BYTE)
986	Yes
987
988	31
989
990
991
992
993	HAS_VETERA N_NEW_MESS A GE
994	NUMBER(1,0 )
995	Yes
996	0
997	32
998
999
1000
1001
1002	HAS_PROVID ER_NEW_MES SA GE
1003	NUMBER(1,0 )
1004	Yes
1005	0
1006	33
1007
1008
1009
1010
1011	PROVIDER_S EEN_APPT_R EQ
1012	NUMBER(1,0 )
1013	Yes
1014	0
1015	34
1016
1017
1018
1019
1020	REQUESTED_ PHONE_CALL
1021	NUMBER(1,0 )
1022	Yes
1023	0
1024	35
1025
1026
1027
1028
1029	TYPE_OF_CA RE_ID
1030	VARCHAR2(5 0 BYTE)
1031	Yes
1032
1033	36
1034
1035
1036
1037
1038	REASON_FOR _VISIT
1039	VARCHAR2 ( 50 BYTE)
1040	Yes
1041
1042	37
1043
1044
1045
1046
1047	OTHER_REAS ON_FOR_VIS IT
1048	VARCHAR2 ( 255 BYTE)
1049	Yes
1050
1051	38
1052
1053
1054
1055
1056	ADDITIONAL _INFORMATI ON
1057	VARCHAR2 ( 255 BYTE)
1058	Yes
1059
1060	39
1061
1062
1063
1064
1065	BOOKED_APP T_DATETIME
1066	TIMESTAMP( 6)
1067	Yes
1068
1069	40
1070
1071
1072
1073
1074	FRIENDLY_N AME
1075	VARCHAR2 ( 255 BYTE)
1076	Yes
1077
1078	41
1079
1080
1081
1082
1083
1084
1085	APPOINTMEN T_REQUEST_ MESSAGE
1086
1087
1088	APPT_REQ_I NPROCESS
1089
1090	Used for l ocking an appointmen t while so meone is w orking on a particul ar request . Used in SCV.
1091
1092	COLUMN_NAM E
1093	DATA_TYPE
1094	NULLABLE
1095	DATA_DEFAU LT
1096	COLUMN_ID
1097	PK?
1098	COMMENTS
1099	APPT_REQ_I D
1100	VARCHAR2(3 2 BYTE)
1101	No
1102
1103	1
1104	Y
1105
1106	USER_ID
1107	VARCHAR2(2 55 BYTE)
1108	No
1109
1110	2
1111
1112
1113	FIRST_NAME
1114	VARCHAR2(2 55 BYTE)
1115	No
1116
1117	3
1118
1119
1120	LAST_NAME
1121	VARCHAR2(2 55 BYTE)
1122	No
1123
1124	4
1125
1126
1127
1128
1129	AR_DETAIL_ CODE
1130
1131	COLUMN_NAM E
1132	DATA_TYPE
1133	NULLAB LE
1134	DATA_DEFAU LT
1135	COLUMN_ ID
1136	PK?
1137	COMMEN TS
1138	AR_DETAIL_ CODE_ID
1139	VARCHAR2(3 2 BYTE)
1140	No
1141
1142	1
1143	Y
1144
1145	DETAIL_COD E_ID
1146	VARCHAR2(3 2 BYTE)
1147	No
1148
1149	2
1150
1151
1152	APPOINTMEN T_REQUES T _ID
1153	VARCHAR2(3 2 BYTE)
1154	No
1155
1156	3
1157
1158
1159	CREATED_DA TE
1160	TIMESTAMP( 6)
1161	No
1162
1163	4
1164
1165
1166	USER_ID
1167	VARCHAR2(2 55 BYTE)
1168	No
1169
1170	5
1171
1172
1173
1174
1175	BEST_TIME_ TO_CALL
1176
1177	COLUMN_NAM E
1178	DATA_TYPE
1179	NULLAB LE
1180	DATA_DEFAU LT
1181	COLUMN_ ID
1182	PK?
1183	COMMEN TS
1184	APPOINTMEN T_REQUES T _ID
1185	VARCHAR2(3 2 BYTE)
1186	No
1187
1188	1
1189	Y
1190
1191	BEST_TIME
1192	VARCHAR2(4 0 BYTE)
1193	No
1194
1195	2
1196
1197
1198
1199
1200	CC_APPOINT MENT_REQUE ST
1201
1202
1203	COLUMN_NAM E
1204	DATA_TYPE
1205	NULLAB LE
1206	DATA_DEFA ULT
1207	COLUMN
1208	_ID
1209	PK?
1210	COMMEN TS
1211	CC_APPOINT MENT_REQUE ST_ID
1212	VARCHAR2(3 2 BYTE)
1213	No
1214
1215	1
1216	Y
1217
1218	APPOINTMEN T_REQUEST_ ID
1219	VARCHAR2(4 0 BYTE)
1220	No
1221
1222	2
1223
1224	Foreign Ke y
1225	TRAVEL_BUR DEN
1226	NUMBER
1227	No
1228
1229	3
1230
1231
1232	UNUSUAL_TR AVEL_BURDE N
1233	NUMBER
1234	Yes
1235
1236	4
1237
1238
1239	DISTANCE_W ILLING_TO_ TR AVEL
1240	NUMBER
1241	No
1242
1243	5
1244
1245
1246	ADDRESS
1247	VARCHAR2(1 00 BYTE)
1248	Yes
1249
1250	6
1251
1252
1253	CITY
1254	VARCHAR2(5 0 BYTE)
1255	Yes
1256
1257	7
1258
1259
1260	STATE
1261	VARCHAR2(2 BYTE)
1262	Yes
1263
1264	8
1265
1266
1267	ZIPCODE
1268	VARCHAR2(5 BYTE)
1269	Yes
1270
1271	9
1272
1273
1274	DISTANCE_E LIGIBLE
1275	NUMBER
1276	Yes
1277
1278	10
1279
1280
1281	PREFERRED_ CITY
1282	VARCHAR2(5 0 BYTE)
1283	Yes
1284	''
1285	11
1286
1287
1288	PREFERRED_ STATE
1289	VARCHAR2(2 BYTE)
1290	Yes
1291	''
1292	12
1293
1294
1295	PREFERRED_ ZIPCODE
1296	VARCHAR2(1 0 BYTE)
1297	Yes
1298
1299	13
1300
1301
1302	PREFERRED_ LANGUAGE
1303	VARCHAR2(1 00 BYTE)
1304	Yes
1305	'English'
1306	14
1307
1308
1309
1310
1311	DETAIL_COD E
1312
1313	COLUMN_NAM E
1314	DATA_TYPE
1315	NULLABLE
1316	DATA_DEFAU LT
1317	COLUMN_ID
1318	PK?
1319	COMMENTS
1320	DETAIL_COD E_ID
1321	VARCHAR2(3 2 BYTE)
1322	No
1323
1324	1
1325	Y
1326
1327	PROVIDER_M ESSA GE
1328	VARCHAR2(2 000 BYTE)
1329	No
1330
1331	2
1332
1333
1334	VETERAN_ME SSAGE
1335	VARCHAR2(2 000 BYTE)
1336	No
1337
1338	3
1339
1340
1341
1342
1343	FACILITY
1344
1345
1346	COLUMN_NAM E
1347	DATA_TYPE
1348	NULLABLE
1349	DATA_DEFAU LT
1350	COLUMN_ID
1351	PK?
1352	COMMENTS
1353	NAME
1354	VARCHAR2(1 00 BYTE)
1355	No
1356
1357	1
1358
1359
1360	TYPE
1361	VARCHAR2(1 00 BYTE)
1362	Yes
1363
1364	2
1365
1366
1367	FACILITY_C ODE
1368	VARCHAR2(1 00 BYTE)
1369	No
1370
1371	3
1372	Y
1373
1374	STATE
1375	VARCHAR2(5 0 BYTE)
1376	Yes
1377
1378	4
1379
1380
1381	CITY
1382	VARCHAR2(5 0 BYTE)
1383	Yes
1384
1385	5
1386
1387
1388	ADDRESS
1389	VARCHAR2(1 00 BYTE)
1390	Yes
1391
1392	6
1393
1394
1395	PARENT_SIT E_CODE
1396	VARCHAR2(1 00 BYTE)
1397	No
1398
1399	7
1400
1401
1402
1403
1404	NOTIFICATI ON_PREFERE NCE
1405
1406	Preference s for a Ve teran to b e notified
1407
1408	COLUMN_NAM E
1409	DATA_TYPE
1410	NULLAB LE
1411	DATA_DEFA ULT
1412	COLUMN
1413	_ID
1414	PK?
1415	COMMEN TS
1416	PATIENT_ID
1417	VARCHAR2(2 55 BYTE)
1418	No
1419
1420	1
1421	Y
1422
1423	NOTIFICATI ON_FREQUEN CY
1424	VARCHAR2(2 55 BYTE)
1425	Yes
1426
1427	2
1428
1429
1430	EMAIL_ALLO WED
1431	NUMBER(1,0 )
1432	No
1433
1434	3
1435
1436
1437	EMAIL_ADDR ESS
1438	VARCHAR2(2 55 BYTE)
1439	Yes
1440
1441	4
1442
1443
1444	TEXT_MESSA GING_ALLOW ED
1445	NUMBER(1,0 )
1446	No
1447
1448	5
1449
1450
1451	TEXT_MESSA GING_PHONE _N UMBER
1452	VARCHAR2(2 55 BYTE)
1453	Yes
1454
1455	6
1456
1457
1458
1459
1460	OFFICE_HOU RS
1461
1462	COLUMN_NAM E
1463	DATA_TYPE
1464	NULLAB LE
1465	DATA_DEFA ULT
1466	COLUMN_ ID
1467	PK?
1468	COMMEN TS
1469	CC_APPOINT MENT_REQUE ST_ID
1470	VARCHAR2(3 2 BYTE)
1471	Yes
1472
1473	1
1474
1475	Foreign Ke y
1476	OFFICE_TIM E
1477	VARCHAR2(4 0 BYTE)
1478	Yes
1479
1480	2
1481
1482
1483
1484
1485	PATIENT
1486
1487
1488	COLUMN_NAM E
1489	DATA_TYPE
1490	NULLAB LE
1491	DATA_DEFA ULT
1492	COLUMN
1493	_ID
1494	PK?
1495	COMMEN TS
1496	PATIENT_ID
1497	VARCHAR2(2 55 BYTE)
1498	No
1499
1500	1
1501	Y
1502
1503	FIRST_NAME
1504	VARCHAR2(1 00 BYTE)
1505	No
1506
1507	2
1508
1509
1510	LAST_NAME
1511	VARCHAR2(1 00 BYTE)
1512	No
1513
1514	3
1515
1516
1517	SSN
1518	VARCHAR2(2 0 BYTE)
1519	No
1520
1521	4
1522
1523
1524	DATE_OF_BI RTH
1525	TIMESTAMP( 6)
1526	No
1527
1528	5
1529
1530
1531	TEXT_MESSA GING_ALLOW ED
1532	NUMBER(1,0 )
1533	No
1534
1535	6
1536
1537
1538	TEXT_MESSA GING_PHONE _N UMBER
1539	VARCHAR2(2 55 BYTE)
1540	Yes
1541
1542	7
1543
1544
1545
1546
1547	PATIENT_ME TADATA
1548
1549	COLUMN_NAM E
1550	DATA_TYPE
1551	NULLAB LE
1552	DATA_DEFA ULT
1553	COLUMN
1554	_ID
1555	PK?
1556	COMMEN TS
1557	PATIENT_ID
1558	VARCHAR2(2 55 BYTE)
1559	No
1560
1561	1
1562	Y
1563
1564	LAST_APPT_ REQ_ACCESS _ DATE
1565	TIMESTAMP( 6)
1566	Yes
1567
1568	2
1569
1570
1571
1572
1573	PREFERRED_ PROVIDER
1574
1575
1576	COLUMN_NAM E
1577	DATA_TYPE
1578	NULLAB LE
1579	DATA_DEFA ULT
1580	COLUMN
1581	_ID
1582	PK?
1583	COMMEN TS
1584	PREFERRED_ PROVIDER_I D
1585	VARCHAR2(3 2 BYTE)
1586	No
1587
1588	1
1589	Y
1590
1591	CC_APPOINT MENT_REQUE ST_ID
1592	VARCHAR2(3 2 BYTE)
1593	Yes
1594
1595	2
1596
1597	Foreign Ke y
1598	FIRST_NAME
1599	VARCHAR2(1 00 BYTE)
1600	Yes
1601
1602	3
1603
1604
1605	LAST_NAME
1606	VARCHAR2(1 00 BYTE)
1607	Yes
1608
1609	4
1610
1611
1612	PRACTICE_N AME
1613	VARCHAR2(1 00 BYTE)
1614	Yes
1615
1616	5
1617
1618
1619	PROVIDER_S TREET
1620	VARCHAR2(1 00 BYTE)
1621	Yes
1622
1623	6
1624
1625
1626	PROVIDER_C ITY
1627	VARCHAR2(1 00 BYTE)
1628	Yes
1629
1630	7
1631
1632
1633	PROVIDER_S TATE
1634	VARCHAR2(2 BYTE)
1635	Yes
1636
1637	8
1638
1639
1640	PROVIDER_Z IPCODE
1641	VARCHAR2(5 BYTE)
1642	Yes
1643
1644	9
1645
1646
1647	PREFERRED_ ORDER
1648	NUMBER
1649	No
1650
1651	10
1652
1653
1654
1655
1656	USER_FEEDB ACK
1657
1658	COLUMN_NAM E
1659	DATA_TYPE
1660	NULLABLE
1661	DATA_DEFAU LT
1662	COLUMN_I
1663	D PK?
1664	COMMEN TS
1665	USER_FEEDB ACK_ID
1666	VARCHAR2(3 2 BYTE)
1667	No
1668
1669	1
1670	Y
1671
1672	RATING
1673	NUMBER(3,0 )
1674	No
1675
1676	2
1677
1678
1679	APPT_PROCE SSED_TIM E LY
1680	VARCHAR2(3 2 BYTE)
1681	No
1682
1683	3
1684
1685
1686	COMMENTS
1687	CLOB
1688	Yes
1689
1690	4
1691
1692
1693	CREATED_DA TE
1694	TIMESTAMP( 6)
1695	No
1696
1697	5
1698
1699
1700
1701
1702	USER_HISTO RY
1703
1704
1705	COLUMN_NAM E
1706	DATA_TYPE
1707	NULLABLE
1708	DATA_DEFAU LT
1709	COLUMN_ID
1710	PK?
1711	COMMENTS
1712	ID
1713	RAW
1714	No
1715
1716	1
1717	Y
1718
1719	USER_ID
1720	VARCHAR2(2 55 BYTE)
1721	Yes
1722
1723	2
1724
1725
1726	TABLE_NAME
1727	VARCHAR2(2 55 BYTE)
1728	Yes
1729
1730	3
1731
1732
1733	ROW_ID
1734	RAW
1735	Yes
1736
1737	4
1738
1739
1740	OPERATION
1741	VARCHAR2(2 55 BYTE)
1742	Yes
1743
1744	5
1745
1746
1747	ACTION_DAT E
1748	TIMESTAMP( 6)
1749	Yes
1750
1751	6
1752
1753
1754	DATA
1755	CLOB
1756	Yes
1757
1758	7
1759
1760
1761
1762
1763
1764
1765
1766
1767	MongoDB Da ta Archite cture
1768
1769
1770	MongoDB
1771
1772
1773	Ref #
1774	NoSQL Coll ection
1775	Descriptio n of Data
1776	Source of Data
1777	Sample
1778
1779
1780	1
1781	var-utilit y. bookedC CAppointm ents
1782	List of al l booked a ppointment data crea ted by Sch eduli ng M anager
1783	Staff entr y through Scheduling Manager a pp
1784	bookedCCAp pointm ent s.json
1785
1786
1787	2
1788	var-utilit y.clinical - services
1789	List of al l clinical services supported by VAR and Schedulin g Manager.
1790	Pre-define d and impo rted using mongoimpo rt utility
1791	clinical- services.j son
1792
1793
1794	3
1795	var-utilit y. communi tyCareTyp eOfCares
1796	List of al l types of care supp orted by C ommunity C are appoin tments in the VAOS a pplication
1797	Pre-define d and impo rted using mon goimp ort utilit y
1798	communityC areTyp eOf Cares.json
1799
1800
1801	4
1802	var-utilit y.custom- friendly-t ext
1803	List of Si tes (Facil ities) and their Fri endly Name
1804	Staff entr y through VA Tool Se t app
1805	custom-fri endly-text . json
1806
1807
1808	5
1809	var-utilit y.custom- messages
1810	Facility c ustom text s displaye d on the V AR applica tion input screen fo r specific input fie lds
1811	Staff entr y through VA Tool Se t app
1812	custom- me ssages.jso n
1813
1814
1815	6
1816	var-utilit y. directB ookingElig ibili tyCr iteria
1817	List of Si tes (Facil ities) tha t allow ve terans to directly b ook to the ir site co de
1818	Pre-define d and impo rted using mongoimpo rt utility
1819	directBook ingEligibi li tyCrite ria.json
1820
1821
1822	7
1823	var-utilit y. express CareReason
1824	List of re asons a ve teran can choose fro m when cho osing expr ess care a s their ty pe of care
1825	Pre-define d and impo rted using mon goimp ort utilit y
1826	expressCar eReason
1827	.json
1828
1829
1830	8
1831	var-utilit y. request Eligibilit yCrit eria
1832	List of Si tes (Facil ities) and their con figuration that allo w veterans to create requests
1833	Staff entr y through VA Tool Se t app
1834	requestEli gibilityCr it eria.js on
1835
1836
1837	9
1838	var-utilit y. siteSup portingVAR
1839	List of Si tes (Facil ities) sup porting th e VAR appl ication
1840	Pre-define d and impo rted using mongoimpo rt utility
1841	sites- sup porting-va r. json
1842
1843
1844
1845	Non-functi onal Requi rements
1846
1847	- Security
1848
1849	This servi ce protect ed by JWT Authentica tion, it s upports bo th staff a nd veteran roles.
1850
1851
1852	- Service Configurat ion
1853	The applic ation expe cts to loa d configur ation para meters fro m environm ent variab les loads from consu l server:
1854
1855	//TODO: Ad d required Consul co nfiguratio n variable s
1856
1857
1858	- Applicat ion Capaci ty Plan
1859
1860	User Volum e
1861
1862	User Categ ory
1863	Total Numb er of User s
1864	Concurrent Users
1865	Veterans
1866	5000 per w eek
1867	100
1868
1869	- Containe r Capacity
1870
1871	Type
1872	Min
1873	Max
1874	CPU
1875	1
1876	2
1877	Memory
1878	512 MB
1879	1024 MB
1880	Storage
1881	1 GB
1882	5 GB
1883
1884
1885	Project Da tabase Cap acity
1886	These numb ers are po ssible whe n fully Na tionally R eleased af ter a grow ing user b ase period , possibly 6 months after NR.
1887
1888	Table or C ollection
1889	Number of Rows / Ent ries (per month)
1890	Estimated Size per E ntry
1891	Total Disk (minus ov erhead for indexes, etc)
1892
1893	(per month )
1894	APPOINTMEN T_METRICS
1895	100
1896	109MB
1897	10K (total , not per month)
1898	APPOINTMEN T_REQUEST
1899	180,000
1900	est 3.1MB per entry
1901	.56GB
1902	APPOINTMEN T_REQUEST_ MESS AGE
1903	360,000
1904	580B
1905	.02GB
1906	APPT_REQ_I NPROCESS
1907	360,000
1908	574B
1909	.02GB
1910	AR_DETAIL_ CODE
1911
1912	357B
1913
1914	BEST_TIME_ TO_CALL
1915	180,000
1916	72B
1917	.01GB
1918	CC_APPOINT MENT_REQUE ST
1919	180,000
1920	468B
1921	.08GB
1922	DETAIL_COD E
1923	360,000
1924	4KB
1925	1.4GB
1926	FACILITY
1927	150 (not m onthly)
1928	700B
1929	<1GB total
1930	NOTIFICATI ON_PREFERE NCE
1931	50,000
1932	1022B
1933	.10GB
1934	OFFICE_HOU RS
1935	360,000
1936	72B
1937	.02GB
1938	PATIENT
1939	50,000 (ju st new peo ple)
1940	737B
1941	.07GB
1942	PATIENT_ME TADATA
1943	180,000
1944	261B
1945	.04GB
1946	PREFERRED_ PROVIDER
1947	360,000
1948	591B
1949	.2GB
1950	USER_FEEDB ACK
1951	1000
1952	est 1KB pe r entry
1953	<1GB
1954	USER_HISTO RY
1955	200,000
1956	est 1KB pe r entry
1957	.19GB
1958
1959	Developer & PM Conta ct Informa tion
1960
1961
1962	Developer Name/Point of Contac t (POC)
1963	VA E-Mail Address
1964	Phone Numb er
1965	Doug Kuruc z
1966	doug.kuruc z@ablevets .com
1967
1968	Developer Organizati on/Company
1969	Contract S tart Date
1970	Contract E nd Date
1971	AbleVets
1972	1/27/18
1973	1/26/19
1974	Web and Mo bile Solut ions PM or POC
1975	VA E-Mail Address
1976	Phone Numb er
1977
1978
1979
1980	VA Product Developme nt PM or P OC
1981	VA E-Mail Address
1982	Phone Numb er
1983
1984
		1985