2244. EPMO Open Source Coordination Office Redaction File Detail Report

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

2244.1 Files compared

#	Location	File	Last Modified
1	MHEDP3_VAOS_VATS_SM_Sept2018.zip\SM 2.4.0	SCV-SchedulingManagerService2.4.x-SRVDD.docx	Thu Sep 27 17:25:32 2018 UTC
2	MHEDP3_VAOS_VATS_SM_Sept2018.zip\SM 2.4.0	SCV-SchedulingManagerService2.4.x-SRVDD.docx	Sat Oct 6 01:36:32 2018 UTC

2244.2 Comparison summary

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

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

2244.4 Active regular expressions

No regular expressions were active.

2244.5 Comparison detail

1	Scheduling Manager S ervice 2.4 .x - SRVDD
2
3	Summary of Service
4	Data Stora ge and Cla ssificatio n Scheduli ng Manager Applicati on
5	Applicatio n Design P erspective
6	- Design P rinciples and Patter ns
7	- Conceptu al Overvie w
8	1.2.1 - Hi gh-Level C omponent D iagram
9	Logical Pe rspective 2.1 - REST Endpoint Breakdown (Swagger d efinition to be adde d in versi on 3.x)
10	2.2 - Sequ ence Diagr ams
11	The follow ing diagra ms illustr ate a gene ral workfl ow and the Schedulin g Manager Services a pplication 's role in endpoint operations
12	HTTP GET O perations HTTP PUT O perations HTTP POST Operations HTTP DELE TE Operati ons
13	Physical P erspective
14	Deployment Diagram ( Platform S tabilizati on Environ ment)
15	Dependenci es Summary
16	- VA Inter faces
17	MDWS 3.2.8 - SOAP En dpoints
18	- VAMF Sha red Servic es Authori zation Ser vice v4.3. x Patient Viewer Ser vice v2.3. 4 User Con text Servi ce v1.0.1 Patient Pr ofile Serv ice v1.0.0
19	Staff Vide o Connect Service v1 .0.0 Task Service v1 .0.0
20	- Technolo gy Stack S ummary
21	Data Model
22	Oracle Dat a Architec ture
23	Entity Rel ationship Diagram AP POINTMENT_ REQUEST AP POINTMENT_ REQUEST_ME SSAGE APPT _REQ_INPRO CESS AR_DE TAIL_CODE BEST_TIME_ TO_CALL
24	DETAIL_COD E FACILITY
25	NOTIFICATI ON_PREFERE NCE PATIEN T PATIENT_ METADATA U SER_FEEDBA CK USER_HI STORY
26	MongoDB Da ta Archite cture Clin ical Servi ces Collec tion
27	Non-Functi onal Requi rements
28	Security
29	Capacity R equirement s
30	Projected Database c apacity
31	Developer and Progra m Manager (PM) Conta ct Informa tion
32
33
34	Summary of Service
35	The System Design Do cument (SR VDD) is a dual-use d ocument th at provide s the conc eptual des ign as wel l as the a s-built de sign. This document is updated as develo pment prog resses to reflect th e as-built implement ation.
36
37	Software N ame
38	Scheduling Manager S ervice
39	Product Ve rsion
40	2.4.0
41	Source Rep ository
42
43
44
45	Enclave(s)
46
47	Veteran Pr ovider
48	Software T ype
49
50	Service Ap p
51	Background Process O ther
52
53	Data Stora ge and Cla ssificatio n
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	Veteran ap pointment info, prov ider messa ges to vet erans
64	Oracle dat abase, Mon goDB datab ase
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	Veteran ap pointment info, prov ider messa ges to vet erans
69	Oracle dat abase, Mon goDB datab ase
70	Does Mobil e Applicat ion transm it/push da ta entered outside o f the VAMF to VA?
71	X
72
73	Veteran ap pointment info
74	VistA
75	Does Mobil e Applicat ion pull d ata from a VA Databa se (extern al to VAMF )?
76	X
77
78	Veteran ap pointment info
79	VistA
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
87	This appli cation can be classi fied as on e of the f ollowing:
88
89	Mobile App lication C lassificat ion (Only one box ma y be check ed)
90	Mark with X
91	1 – Very L ow: Mobile Applicati on does no t use VA R esource
92
93	2 – Low: R ead only a ccess to V A Resource (s) (No PI I / PHI)
94
95	3 – Medium : Write ac cess to VA Resource( s)
96
97	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)
98	X
99
100
101	Scheduling Manager A pplication
102	The Schedu ling Manag er applica tion provi des schedu ling clerk s the foll owing capa bilities:
103
104	Process ve teran appo intment re quests sub mitted via the Veter an Appoint ment Reque st (VAR) a pplication .
105	Process Ex press Care requests submitted via the VA R applicat ion.
106	Book or ca ncel VistA appointme nts for ve terans.
107	Schedule a dhoc video visit app ointments for vetera ns.
108
109	Applicatio n Design P erspective
110
111	- Design P rinciples and Patter ns
112	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
113	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.
114	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.
115	Exception Handling u sing HTTP standards - Exceptio n handling is perfor med based on HTTP st atus codes . Bad Requ est (statu s code
116	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 Authoriz ation Serv ices and M etric Serv ices.
117
118
119	- Conceptu al Overvie w
120	Summary:
121
122	The Schedu ling Manag er Applica tion is th e receiver of Vetera n Appointm ent Reques ts in the VAOS (VA O nline Sche duling) su ite of app lications. The prima ry users a re Provide rs/Staff i n the VA. Scheduling Manager o perates ag ainst the Scheduling Manager S ervice (th is applica tion) that interface with the VAR DB as well as se ttings man aged from the VA Too l Set appl ication. W orkflows i n Scheduli ng Manager Applicati on direct appointmen t bookings through V IA (former ly MDWS) t o update d ata in Vis tA systems .
123
124	1.2.1 - Hi gh-Level C omponent D iagram
125
126
127
128	Logical Pe rspective
129	- REST End point Brea kdown (Swa gger defin ition to b e added in version 3 .x)
130
131	Interface Name
132	Method
133	Endpoint ( Prefix: /S chedulingM anager Ser vice/v2/re st)
134	Get Resour ce Directo ry
135	GET
136	/location- service/si te/{facili ty-code}/r esource- d irectory
137	Get Specia lties
138	GET
139	/location- service/si te/{facili ty-code}
140	/specialti es
141	Get Locati ons
142	GET
143	/location- service/si te/{facili ty-code}/l ocations
144	Get Appoin tments Met data
145	GET
146	/appointme nt-service /metadata
147	Get Appoin tment Requ ests
148	GET
149	/appointme nt-service /appointme nt-request s
150	Get Appoin tment Requ est Messag es
151	GET
152	/appointme nt-service /patient/{ assigning- authority }/{patient -id}/appoi ntment-req uests
153	/system/{s ystem-id}/ id/{appoin tment-requ est- id}/m essages
154	Create App ointment R equest Mes sage
155	POST
156	/appointme nt-service /patient/{ assigning- authority }/{patient -id}/appoi ntment-req uests
157	/system/{s ystem-id}/ id/{appoin tment-requ est- id}/m essages
158	Mark Appoi ntment Req uest Messa ge as Read
159	POST
160	/appointme nt-service /patient/{ assigning- authority }/{patient -id}/appoi ntment-req uests
161	/system/{s ystem-id}/ id/{appoin tment-requ est- id}/m essages/re ad
162	Get Appoin tment Requ est Messag e
163	GET
164	/appointme nt-service /patient/{ assigning- authority }/{patient -id}/appoi ntments/sy stem/
165	{system-id }/id/{appo intment-re quest-id}
166	Update App ointment R equest Mes sage
167	PUT
168	/appointme nt-service /patient/{ assigning- authority }/{patient -id}/appoi ntments/sy stem/
169	{system-id }/id/{appo intment-re quest-id}
170	Set Appoin tment Requ est In Pro cess
171	POST
172	/appointme nt-service /patient/{ assigning- authority }/{patient -id}/appoi ntments/sy stem/
173	{system-id }/id/{appo intment-re quest-id}
174	/inprocess
175	Unset Appo intment Re quest In P rocess
176	DELETE
177	/appointme nt-service /patient/{ assigning- authority }/{patient -id}/appoi ntments/sy stem/
178	{system-id }/id/{appo intment-re quest-id}
179	/inprocess
180	Set an App ointment R equest "Re ad" flag
181	PUT
182	/appointme nt-service /patient/{ assigning- authority }/{patient -id}/appoi ntment-req uests
183	/system/{s ystem-id}/ id/{appoin tment-requ est- id}/a ppointment /provider- read
184	Get Patien t DFN
185	GET
186	/appointme nt-service /patient/{ assigning- authority }/{patient -id}
187	Get Patien t Preferen ce
188	GET
189	/patient/{ assigning- authority} /{patient- id}
190	/preferenc e
191	Update Pat ient Prefe rence
192	PUT
193	/patient/{ assigning- authority} /{patient- id}
194	/preferenc e
195	Get Resour ce Diretor y
196	GET
197	/schedulin g-service/ site/{site -code}/res ource- dir ectory
198	Get Appoin tment Slot s
199	GET
200	/schedulin g-service/ site/{site -code}/ava ilable- ap pointment- slots/clin ic/{clinic -id}
201
202
203	Get Booked Appointme nts
204	GET
205	/schedulin g-service/ site/{site -code}/pat ient/
206	{assigning -authority }/{patient -id}/booke d- appoint ments
207	Create a B ooked Appo intment
208	POST
209	/schedulin g-service/ site/{site -code}/pat ient/
210	{assigning -authority }/{patient -id}/book- appointme nt
211	Create a C ommunity C are Appoin tment
212	POST
213	/schedulin g-service/ site/{site -code}/pat ient/
214	{assigning -authority }/{patient -id}/sched ule- new-c c-request
215	Get Appoin tment Type s
216	GET
217	/schedulin g-service/ site/{site -code}/pur pose- list
218	Get Cancel ation Reas ons
219	GET
220	/schedulin g-service/ site/{site -code}/can cel- reaso ns-list
221	Cancel App ointment
222	PUT
223	/schedulin g-service/ site/{site -code}/pat ient/
224	{assigning -authority }/{patient -id}/cance l- appoint ment
225	Get Clinic al Service s
226	GET
227	/clinical- service
228	Get Disabl ed Feature s
229	GET
230	/disabled- features
231
232	- Sequence Diagrams
233
234	The follow ing diagra ms illustr ate a gene ral workfl ow and the Schedulin g Manager Services a pplication 's role in endpoint operations
235
236	HTTP GET O perations
237
238
239
240
241
242	HTTP PUT O perations
243
244
245
246	HTTP POST Operations
247
248
249
250
251	HTTP DELET E Operatio ns
252
253
254
255
256	Physical P erspective
257	Deployment of the en tirety of the Schedu ling Manag er applica tion is de picted in the diagra m below. T he diagram highlight s several key high- level inte ractions b etween the various c omponents supporting the softw are. The S cheduling Manager We b (UI) app lication i s deployed to Apache . The Sche duling Man ager Servi ce applica tion is de ployed to the WebLog ic cluster alongside its depen dent share d services . Scheduli ng Manage r 2.x is i ntended fo r deployme nt in Plat form Stabi lization. Scheduling Manager S ervice lev erages MDW S to make requests t o VistA fo r EHR data including demograph ics and ap pointments . Scheduli ng Manager Service m akes direc t requests to CDW, A DR, and MV I for pati ent inform ation and correlatio n data, an d accesses the VAR M ongo DB an d VAR Orac le DB for appointmen t informat ion. Both Scheduling Manager S ervice and Video Vis it Service connect t o an exter nal SMTP S erver serv er to comp lete workf lows relev ant to thi s
258	applicatio n. Please refer to t he Video V isit Servi ce SRVDD f or additio nal inform ation and component dependenci es not lis ted in thi s diagram. Please al so refer t o the othe r VAMF Sha red Servic es SRVDDs for additi onal infor mation and component dependenc ies relate d to those services independen tly, but n ot listed in this di agram.
259
260	Deployment Diagram ( Platform S tabilizati on Environ ment)
261
262
263
264
265
266	Dependenci es Summary
267	The Schedu ling Manag er Service applicati on has dep endencies on the fol lowing exi sting VA i nterfaces:
268
269	- VA Inter faces
270
271	MDWS 3.2.8 - SOAP En dpoints
272
273	Interface Name
274	HTTP Metho d
275	Scheduling Svc.asmx
276	Make Appoi ntment
277	POST
278	/Schedulin gSvc/makeA ppointment
279	Cancel App ointment
280	POST
281	/Schedulin gSvc/cance lAppointme nt
282	Get Booked Appointme nts
283	POST
284	/Schedulin gSvc/getAp pointments BookingNot es
285	Get Availa ble Slots
286	POST
287	/Schedulin gSvc/getCl inicSchedu lingDetail sByDateRan ge
288	Get Cancel Reason Li st
289	POST
290	/Schedulin gSvc/getCa ncellation Reasons
291
292
293	Get Appoin tment Type s
294	POST
295	/Schedulin gSvc/getAp pointmentT ypes
296	Get Clinic s with Spe cialties
297	POST
298	/Schedulin gSvc/getCl inicsWithS pecialties
299	Get Patien ts by Clin ic
300	POST
301	/Schedulin gSvc/getPa tientsByCl inic
302	Select Pat ient
303	POST
304	/Schedulin gSvc/selec t
305
306	Interface Name
307	HTTP Metho d
308	EmrSvc.asm x
309	Login
310	POST
311	/EmrSvc/lo gin
312	Get User S ecurity Ke ys
313	POST
314	/EmrSvc/ge tUserSecur ityKeys
315	Get Specia lties
316	POST
317	/EmrSvc/ge tSpecialti es
318
319	Interface Name
320	HTTP Metho d
321	QuerySvc.a smx
322	Get Clinic s with Spe cialties
323	POST
324	/QuerySvc/ ddrLister
325
326
327
328	- VAMF Sha red Servic es
329
330	Authorizat ion Servic e v4.3.x
331
332	Interface Name
333	Method
334	REST Endpo int
335	OAuth Toke n
336	GET
337	/Authoriza tionServic es/oauth
338	/token
339	Resource L ast Access ed Time
340	GET
341	/Authoriza tionServic es/rest
342	/resourceL astAccesse dTime
343	Login
344	GET
345	/Authoriza tionServic es/login
346	Provider A uthorize
347	GET
348	/Authoriza tionServic es/provide r
349	/authorize
350	Security C heck
351	POST
352	/Authoriza tionServic es/provide r
353	/security_ check
354
355	Patient Vi ewer Servi ce v2.3.4
356
357	Interface Name
358	Method
359	REST Endpo int
360	Resource D irectory
361	GET
362	/PatientVi ewerServic es/rest
363	/public/re source-dir ectory
364	User Sessi on
365	GET
366	/PatientVi ewerServic es/rest
367	/public/us er-session
368	MHP User
369	GET
370	/PatientVi ewerServic es/rest
371	/mhpuser
372	Patient
373	GET
374	/PatientVi ewerServic es/rest
375	/patient/{ assigning- authority} /
376	{unique-id }
377	Patient Id entifiers
378	GET
379	/PatientVi ewerServic es/rest
380	/patient/{ assigning- authority} /
381	{unique-id }/identifi ers
382
383	User Conte xt Service v1.0.1
384
385
386	Interface Name
387	Method
388	REST Endpo int
389	User Conte xt
390	GET
391	/UserConte xt/rest/co ntext/user /system/{s ite-code}} /id/{user- id}
392
393	Patient Pr ofile Serv ice v1.0.0
394
395	Interface Name
396	Method
397	REST Endpo int
398	Contacts
399	GET
400	/PatientPr ofileServi ces/rest/v 1
401	/patient/{ assigning- authority} /
402	{unique-id }/contacts
403	Demographi cs
404	GET
405	/PatientPr ofileServi ces/rest/v 1
406	/patient/{ assigning- authority} /
407	{unique-id }/demograp hics
408
409	Staff Vide o Connect Service v1 .0.0
410
411	Interface Name
412	Method
413	REST Endpo int
414	Appointmen ts
415	GET
416	/staff-vid eoconnect- resources/ v1
417	/provider/ {facility- code}/{sta ff- id}/pa tient/{ass igning-aut hority}
418	/{patient- id}/appoin tments
419	Book Appoi ntment
420	POST
421	/staff-vid eoconnect- resources/ v1
422	/provider/ {facility- code}/{sta ff- id}/pa tient/{ass igning-aut hority}
423	/{patient- id}/appoin tment
424
425	Task Servi ce v1.0.0
426
427	The Schedu ling Manag er Service s applicat ion has an indirect dependency on Task S ervice as Patient Vi ewer Servi ce depends on it.
428
429	- Technolo gy Stack S ummary
430
431	Technologi es, Librar ies, and T ools Used in the App
432	Version
433	On the TRM ? (If not, provide a link to t he waiver)
434	JRE
435	7
436	Yes
437	Spring Fra mework
438	4.2.5
439	Yes
440	Jersey
441	2.22.2
442	Yes
443	MongoDB
444	3.0.x
445	Yes
446	Oracle
447	11g
448	Yes
449
450
451	Data Model
452	Data model s for Orac le and Mon goDB are d escribed b elow.
453
454
455	Oracle Dat a Architec ture
456	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.
457
458	TODO: add informatio n for LOCA TION
459
460	Entity Rel ationship Diagram
461
462
463
464
465
466	APPOINTMEN T_REQUEST
467
468	COLUMN_NAM E
469	DATA_TYPE
470	NULLABLE
471	DATA_DEFAU LT
472	COLUMN_ID
473	PK?
474	COMMENTS
475	APPOINTMEN T_REQUEST_ ID
476	VARCHAR2(3 2 BYTE)
477	No
478
479	1
480	Y
481
482	PATIENT_ID
483	VARCHAR2(2 55 BYTE)
484	No
485
486	2
487
488
489	LAST_UPDAT ED_DATE
490	TIMESTAMP( 6)
491	No
492
493	3
494
495
496	CREATED_DA TE
497	TIMESTAMP( 6)
498	No
499
500	4
501
502
503	DELETED_DA TE
504	TIMESTAMP( 6)
505	Yes
506
507	5
508
509
510	ACTIVE
511	NUMBER(1,0 )
512	No
513
514	6
515
516
517	SECOND_REQ UEST
518	NUMBER(1,0 )
519	No
520
521	7
522
523
524	APPOINTMEN T_DATE
525	VARCHAR2(5 0 BYTE)
526	Yes
527
528	8
529
530
531	APPOINTMEN T_TIME
532	VARCHAR2(5 0 BYTE)
533	Yes
534
535	9
536
537
538	OPTION_DAT E_1
539	VARCHAR2(5 0 BYTE)
540	No
541
542	10
543
544
545	OPTION_TIM E_1
546	VARCHAR2(5 0 BYTE)
547	No
548
549	11
550
551
552	OPTION_DAT E_2
553	VARCHAR2(5 0 BYTE)
554	No
555
556	12
557
558
559	OPTION_TIM E_2
560	VARCHAR2(5 0 BYTE)
561	No
562
563	13
564
565
566	OPTION_DAT E_3
567	VARCHAR2(5 0 BYTE)
568	No
569
570	14
571
572
573	OPTION_TIM E_3
574	VARCHAR2(5 0 BYTE)
575	No
576
577	15
578
579
580	STATUS
581	VARCHAR2(2 55 BYTE)
582	No
583
584	16
585
586
587	APPOINTMEN T_TYPE
588	VARCHAR2(2 55 BYTE)
589	No
590
591	17
592
593
594	FACILITY_C ODE
595	VARCHAR2(1 00 BYTE)
596	No
597
598	18
599
600
601	EMAIL
602	VARCHAR2(2 55 BYTE)
603	Yes
604
605	19
606
607
608
609
610	PHONE_NUMB ER
611	VARCHAR2(2 55 BYTE)
612	No
613
614	20
615
616
617	TEXT_MESSA GING_ALLOW ED
618	NUMBER(1,0 )
619	No
620
621	21
622
623
624	TEXT_MESSA GING_PHONE _NUMBER
625	VARCHAR2(2 55 BYTE)
626	Yes
627
628	22
629
630
631	PURPOSE_OF _VISIT
632	VARCHAR2(2 55 BYTE)
633	Yes
634
635	23
636
637
638	OTHER_PURP OSE_OF_VIS IT
639	VARCHAR2(1 00 BYTE)
640	Yes
641
642	24
643
644
645	VISIT_TYPE
646	VARCHAR2(4 0 BYTE)
647	Yes
648
649	25
650
651
652	PROVIDER_I D
653	VARCHAR2(2 55 BYTE)
654	Yes
655
656	26
657
658
659	PROVIDER_N AME
660	VARCHAR2(2 55 BYTE)
661	Yes
662
663	27
664
665
666	PROVIDER_P ERSON_CLAS S
667	VARCHAR2(2 55 BYTE)
668	Yes
669
670	28
671
672
673	PROVIDER_O PTION
674	VARCHAR2(1 00 BYTE)
675	Yes
676
677	29
678
679
680	SECOND_REQ UEST_SUBMI TTED
681	NUMBER(1,0 )
682	No
683
684	30
685
686
687	PARENT_REQ UEST_ID
688	VARCHAR2(3 2 BYTE)
689	Yes
690
691	31
692
693
694	HAS_VETERA N_NEW_MESS AGE
695	NUMBER(1,0 )
696	Yes
697	0
698	32
699
700
701	HAS_PROVID ER_NEW_MES SAGE
702	NUMBER(1,0 )
703	Yes
704	0
705	33
706
707
708	PROVIDER_S EEN_APPT_R EQ
709	NUMBER(1,0 )
710	Yes
711	0
712	34
713
714
715	REQUESTED_ PHONE_CALL
716	NUMBER(1,0 )
717	Yes
718	0
719	35
720
721
722	TYPE_OF_CA RE_ID
723	VARCHAR2(5 0)
724	Yes
725
726	36
727
728
729	BOOKED_APP T_DATETIME
730	TIMESTAMP( 6)
731	Yes
732
733	37
734
735
736	REASON_FOR _VISIT
737	VARCHAR2(5 0)
738	Yes
739
740	38
741
742
743	OTHER_REAS ON_FOR_VIS IT
744	VARCHAR2(2 55)
745	Yes
746
747	39
748
749
750	ADDITIONAL _INFORMATI ON
751	VARCHAR2(2 55)
752	Yes
753
754	40
755
756
757	FRIENDLY_N AME
758	VARCHAR2(2 55)
759	Yes
760
761	41
762
763
764
765	APPOINTMEN T_REQUEST_ MESSAGE
766
767	COLUMN_NAM E
768	DATA_TYPE
769	NULLABLE
770	DATA_DEFAU LT
771	COLUMN_ID
772	PK?
773	COMMENTS
774	ID
775	VARCHAR2(3 2 BYTE)
776	No
777
778	1
779	Y
780
781	APPOINTMEN T_REQUEST_ ID
782	VARCHAR2(3 2 BYTE)
783	No
784
785	2
786
787
788	SENDER_ID
789	VARCHAR2(2 55 BYTE)
790	No
791
792	3
793
794
795	MESSAGE_TE XT
796	VARCHAR2(2 55 BYTE)
797	No
798
799	4
800
801
802	MESSAGE_DA TE_TIME
803	TIMESTAMP( 6)
804	No
805
806	5
807
808
809
810	APPT_REQ_I NPROCESS
811	Used for l ocking an appointmen t while so meone is w orking on a particul ar request
812
813	COLUMN_NAM E
814	DATA_TYPE
815	NULLABLE
816	DATA_DEFAU LT
817	COLUMN_ID
818	PK?
819	COMMENTS
820	APPT_REQ_I D
821	VARCHAR2(3 2 BYTE)
822	No
823
824	1
825	Y
826
827	USER_ID
828	VARCHAR2(2 55 BYTE)
829	No
830
831	2
832
833
834	FIRST_NAME
835	VARCHAR2(2 55 BYTE)
836	No
837
838	3
839
840
841	LAST_NAME
842	VARCHAR2(2 55 BYTE)
843	No
844
845	4
846
847
848
849	AR_DETAIL_ CODE
850
851	COLUMN_NAM E
852	DATA_TYPE
853	NULLABLE
854	DATA_DEFAU LT
855	COLUMN_ID
856	PK?
857	COMMENTS
858	AR_DETAIL_ CODE_ID
859	VARCHAR2(3 2 BYTE)
860	No
861
862	1
863	Y
864
865	DETAIL_COD E_ID
866	VARCHAR2(3 2 BYTE)
867	No
868
869	2
870
871
872
873
874	APPOINTMEN T_REQUEST_ ID
875	VARCHAR2(3 2 BYTE)
876	No
877
878	3
879
880
881	CREATED_DA TE
882	TIMESTAMP( 6)
883	No
884
885	4
886
887
888	USER_ID
889	VARCHAR2(2 55 BYTE)
890	No
891
892	5
893
894
895	REASON
896	NVARCHAR2( 100)
897	Yes
898
899	6
900
901
902
903	BEST_TIME_ TO_CALL
904
905	COLUMN_NAM E
906	DATA_TYPE
907	NULLABLE
908	DATA_DEFAU LT
909	COLUMN_ID
910	PK?
911	COMMENTS
912	APPOINTMEN T_REQUEST_ ID
913	VARCHAR2(3 2 BYTE)
914	No
915
916	1
917	Y
918
919	BEST_TIME
920	VARCHAR2(4 0 BYTE)
921	No
922
923	2
924
925
926
927	DETAIL_COD E
928
929	COLUMN_NAM E
930	DATA_TYPE
931	NULLABLE
932	DATA_DEFAU LT
933	COLUMN_ID
934	PK?
935	COMMENTS
936	DETAIL_COD E_ID
937	VARCHAR2(3 2 BYTE)
938	No
939
940	1
941	Y
942
943	PROVIDER_M ESSAGE
944	VARCHAR2(2 000 BYTE)
945	No
946
947	2
948
949
950	VETERAN_ME SSAGE
951	VARCHAR2(2 000 BYTE)
952	No
953
954	3
955
956
957
958	FACILITY
959
960	COLUMN_NAM E
961	DATA_TYPE
962	NULLABLE
963	DATA_DEFAU LT
964	COLUMN_ID
965	PK?
966	COMMENTS
967	NAME
968	VARCHAR2(1 00 BYTE)
969	No
970
971	1
972
973
974	TYPE
975	VARCHAR2(1 00 BYTE)
976	Yes
977
978	2
979
980
981	FACILITY_C ODE
982	VARCHAR2(1 00 BYTE)
983	No
984
985	3
986	Y
987
988	STATE
989	VARCHAR2(5 0 BYTE)
990	Yes
991
992	4
993
994
995	CITY
996	VARCHAR2(5 0 BYTE)
997	Yes
998
999	5
1000
1001
1002	ADDRESS
1003	VARCHAR2(1 00 BYTE)
1004	Yes
1005
1006	6
1007
1008
1009	PARENT_SIT E_CODE
1010	VARCHAR2(1 00 BYTE)
1011	No
1012
1013	7
1014
1015
1016
1017	NOTIFICATI ON_PREFERE NCE
1018	Preference s for a Ve teran to b e notified
1019
1020	COLUMN_NAM E
1021	DATA_TYPE
1022	NULLABLE
1023	DATA_DEFAU LT
1024	COLUMN_ID
1025	PK?
1026	COMMENTS
1027	PATIENT_ID
1028	VARCHAR2(2 55 BYTE)
1029	No
1030
1031	1
1032	Y
1033
1034	NOTIFICATI ON_FREQUEN CY
1035	VARCHAR2(2 55 BYTE)
1036	Yes
1037
1038	2
1039
1040
1041	EMAIL_ALLO WED
1042	NUMBER(1,0 )
1043	No
1044
1045	3
1046
1047
1048	EMAIL_ADDR ESS
1049	VARCHAR2(2 55 BYTE)
1050	Yes
1051
1052	4
1053
1054
1055	TEXT_MESSA GING_ALLOW ED
1056	NUMBER(1,0 )
1057	No
1058
1059	5
1060
1061
1062	TEXT_MESSA GING_PHONE _NUMBER
1063	VARCHAR2(2 55 BYTE)
1064	Yes
1065
1066	6
1067
1068
1069
1070	PATIENT
1071
1072	COLUMN_NAM E
1073	DATA_TYPE
1074	NULLABLE
1075	DATA_DEFAU LT
1076	COLUMN_ID
1077	PK?
1078	COMMENTS
1079	PATIENT_ID
1080	VARCHAR2(2 55 BYTE)
1081	No
1082
1083	1
1084	Y
1085
1086	FIRST_NAME
1087	VARCHAR2(1 00 BYTE)
1088	No
1089
1090	2
1091
1092
1093	LAST_NAME
1094	VARCHAR2(1 00 BYTE)
1095	No
1096
1097	3
1098
1099
1100	SSN
1101	VARCHAR2(2 0 BYTE)
1102	No
1103
1104	4
1105
1106
1107
1108
1109	DATE_OF_BI RTH
1110	TIMESTAMP( 6)
1111	No
1112
1113	5
1114
1115
1116	TEXT_MESSA GING_ALLOW ED
1117	NUMBER(1,0 )
1118	No
1119
1120	6
1121
1122
1123	TEXT_MESSA GING_PHONE _NUMBER
1124	VARCHAR2(2 55 BYTE)
1125	Yes
1126
1127	7
1128
1129
1130
1131	PATIENT_ME TADATA
1132
1133	COLUMN_NAM E
1134	DATA_TYPE
1135	NULLABLE
1136	DATA_DEFAU LT
1137	COLUMN_ID
1138	PK?
1139	COMMENTS
1140	PATIENT_ID
1141	VARCHAR2(2 55 BYTE)
1142	No
1143
1144	1
1145	Y
1146
1147	LAST_APPT_ REQ_ACCESS _DATE
1148	TIMESTAMP( 6)
1149	Yes
1150
1151	2
1152
1153
1154
1155	USER_FEEDB ACK
1156
1157	COLUMN_NAM E
1158	DATA_TYPE
1159	NULLABLE
1160	DATA_DEFAU LT
1161	COLUMN_ID
1162	PK?
1163	COMMENTS
1164	USER_FEEDB ACK_ID
1165	VARCHAR2(3 2 BYTE)
1166	No
1167
1168	1
1169	Y
1170
1171	RATING
1172	NUMBER(3,0 )
1173	No
1174
1175	2
1176
1177
1178	APPT_PROCE SSED_TIMEL Y
1179	VARCHAR2(3 2 BYTE)
1180	No
1181
1182	3
1183
1184
1185	COMMENTS
1186	CLOB
1187	Yes
1188
1189	4
1190
1191
1192	CREATED_DA TE
1193	TIMESTAMP( 6)
1194	No
1195
1196	5
1197
1198
1199
1200	USER_HISTO RY
1201
1202	COLUMN_NAM E
1203	DATA_TYPE
1204	NULLABLE
1205	DATA_DEFAU LT
1206	COLUMN_ID
1207	PK?
1208	COMMENTS
1209	ID
1210	RAW
1211	No
1212
1213	1
1214	Y
1215
1216	USER_ID
1217	VARCHAR2(2 55 BYTE)
1218	Yes
1219
1220	2
1221
1222
1223	TABLE_NAME
1224	VARCHAR2(2 55 BYTE)
1225	Yes
1226
1227	3
1228
1229
1230	ROW_ID
1231	RAW
1232	Yes
1233
1234	4
1235
1236
1237	OPERATION
1238	VARCHAR2(2 55 BYTE)
1239	Yes
1240
1241	5
1242
1243
1244	ACTION_DAT E
1245	TIMESTAMP( 6)
1246	Yes
1247
1248	6
1249
1250
1251	DATA
1252	CLOB
1253	Yes
1254
1255	7
1256
1257
1258
1259
1260
1261	MongoDB Da ta Archite cture
1262
1263	Ref #
1264	NoSQL Coll ection
1265	Descriptio n of Data
1266	Source of Data
1267	Structure
1268	1
1269	var-utilit y.clinical -services
1270	List of al l clinical services supported by VAR and Schedulin g Manager.
1271	VA clinica l service offerings
1272	clinical-s ervices. j son
1273
1274	Clinical S ervices Co llection
1275
1276	Clinical s ervices ar e stored i n the clin ical-servi ces collec tion in Mo ngoDB. Cur rently thi s collecti on is popu lated and maintained by import ing a json document into Mongo DB. No UI component is impleme nted. The clinical-s ervices co llection d ata struct ure is ill ustrated b elow. The clinical
1277	-services collection stores th e lexicon definition of clinic services. No growth is antici pated.
1278
1279	Clinical S ervices Co llection S tructure
1280
1281
1282
1283
1284	{
1285	_id:Clinic al Service ID Primar y Key (Str ing) name: Clinical Service Na me (String ) stopCode s: [
1286	{
1287	primary:Pr imary Stop Code (Str ing) secon dary: Seco ndary Stop Code (Str ing)
1288	},
1289	...
1290	...
1291	]
1292	submittedR equestLimi t:Max numb er of Requ ests in Su bmitted st atus (Inte ger)
1293	}
1294
1295
1296
1297	Non-Functi onal Requi rements
1298
1299	Security
1300	Patient sp ecific RES T endpoint s are secu red and en forced usi ng Spring Security. Access to REST servi ces is gra nted to ca lls that c ontain the correct O Auth2.0 Ac cess Token in the Au thorizatio n Header. User roles are check ed against the confi gured role s using Ac cess Decis ion Manage rs.
1301
1302
1303	Capacity R equirement s
1304	Expected c oncurrent and maximu m size of the user b ase
1305
1306	User Categ ory
1307	Concurrent Requests
1308	Veterans/P atients
1309	1000
1310
1311	Projected Database c apacity
1312	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.
1313
1314	Table or C ollection
1315	Number of Rows / Ent ries (per month)
1316	Estimated Size per E ntry
1317	Total Disk (minus ov erhead for indexes, etc)
1318
1319	(per month )
1320	APPOINTMEN T_REQUEST
1321	180,000
1322	est 3.1MB per entry
1323	.56GB
1324	APPOINTMEN T_REQUEST_ MESS AGE
1325	360,000
1326	580B
1327	.02GB
1328	APPT_REQ_I NPROCESS
1329	360,000
1330	574B
1331	.02GB
1332	AR_DETAIL_ CODE
1333
1334	357B
1335
1336	BEST_TIME_ TO_CALL
1337	180,000
1338	72B
1339	.01GB
1340	DETAIL_COD E
1341	360,000
1342	4KB
1343	1.4GB
1344	FACILITY
1345	150 (not m onthly)
1346	700B
1347	<1GB total
1348
1349
1350	NOTIFICATI ON_PREFERE NCE
1351	50,000
1352	1022B
1353	.10GB
1354	PATIENT
1355	50,000 (ju st new peo ple)
1356	737B
1357	.07GB
1358	PATIENT_ME TADATA
1359	180,000
1360	261B
1361	.04GB
1362	USER_FEEDB ACK
1363	1000
1364	est 1KB pe r entry
1365	<1GB
1366	USER_HISTO RY
1367	200,000
1368	est 1KB pe r entry
1369	.19GB
1370
1371
1372
1373	Developer and Progra m Manager (PM) Conta ct Informa tion
1374
1375	Developer Name/Point of Contac t (POC)
1376	VA E-Mail Address
1377	Phone Numb er
1378	Doug Kuruc z
1379	PII
1380	PII
1381	Developer Organizati on/Company
1382	Contract S tart Date
1383	Contract E nd Date
1384	AbleVets, LLC
1385
1386
1387	Web and Mo bile Solut ions PM or POC
1388	VA E-Mail Address
1389	Phone Numb er
1390
1391
1392
1393	VA Product Developme nt PM or P OC
1394	VA E-Mail Address
1395	Phone Numb er
1396
1397
		1398