Produced by Araxis Merge on 4/5/2017 4:21:49 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.
| # | Location | File | Last Modified |
|---|---|---|---|
| 1 | C:\working_scrub\Unredacted\eHX Code Base\eHX_Bld2_Source Code_CIF_2017-02-14\NHIN_adapter\Docs | PDFlow.doc | Fri Feb 10 15:41:44 2017 UTC |
| 2 | eHX-CIF.zip\eHX-CIF\eHX Code Base\eHX_Bld2_Source Code_CIF_2017-02-14\NHIN_adapter\Docs | PDFlow.doc | Mon Apr 3 14:36:35 2017 UTC |
| Description | Between Files 1 and 2 |
|
|---|---|---|
| Text Blocks | Lines | |
| Unchanged | 2 | 256 |
| 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 | Adapter 5. 0 Pre-Prod uction Ins tallation GuideNatio nwide Heal th Informa tion Netwo rk | |
| 2 | eHealthExc hange (eHe x) Version 6.1.0 | |
| 3 | ||
| 4 | Patient Di scovery(PD ) Interfac e | |
| 5 | Created No vember 201 4 | |
| 6 | Department of Vetera ns Affairs | |
| 7 | Office of Informatio n and Tech nology | |
| 8 | Product De velopment | |
| 9 | Revision H istory | |
| 10 | DateVersio nDescripti on of Chan geAuthor03 Nov20141.0 Initial Dr aftSRATabl e of Conte nts | |
| 11 | 51 | |
| 12 | Introducti on | |
| 13 | ||
| 14 | ||
| 15 | 51.1 Audie nce | |
| 16 | ||
| 17 | ||
| 18 | 51.2 Scope | |
| 19 | ||
| 20 | ||
| 21 | 62 | |
| 22 | PD Inbound | |
| 23 | ||
| 24 | ||
| 25 | 62.1 Inbou nd Request Parameter s | |
| 26 | ||
| 27 | ||
| 28 | 72.2 Inbo und Reques t Process Flow | |
| 29 | ||
| 30 | ||
| 31 | 72.3 Inbo und Reques t Match An d Response Flow | |
| 32 | ||
| 33 | ||
| 34 | 83 | |
| 35 | PD Outboun d | |
| 36 | ||
| 37 | ||
| 38 | 93.1 Outbo und Reques t Paramete rs | |
| 39 | ||
| 40 | ||
| 41 | 103.2 Outb ound Reque st Process Flow | |
| 42 | ||
| 43 | ||
| 44 | 103.3 Out bound Requ est Match And Respon se Flow | |
| 45 | ||
| 46 | ||
| 47 | 124 | |
| 48 | Gaps | |
| 49 | ||
| 50 | ||
| 51 | ||
| 52 | ||
| 53 | Introducti on | |
| 54 | Welcome to the Depar tment of V eterans Af fairs (VA) eHealth E xchange (e Hex) Patie nt discove ry Descri ptions. Th e VA eHeal th Exchang e (eHex) i mplements the action s necessar y to excha nge electr onic healt h records (EHRs) gen erated fro m the VA a nd receive d from aut horized eH ealth Exch ange Healt h Informat ion Exchan ge (HIEs) partners. | |
| 55 | The eHex u ses a serv ice-orient ed archite cture (SOA ) to share patient h ealth data and to co mmunicate between sy stems. The eHex soft ware inter faces with the VA cu stom Adapt er. The Fe deral eHea lth Exchan ge CONNECT Gateway 4 .2.2.2 is the produc t delivera ble of the Federal H ealth Arch itecture ( FHA) under the Depar tment of H ealth and Human Serv ices (HSS) . This pro duct is th e result o f the coll aboration and shared developme nt cost of a group o f more tha n twenty g overnment agencies k nown as th e Federal Consortium . The VA h as been ex changing m edical inf ormation w ith the De partment o f Defense (DoD) for several ye ars. By us ing the D A
|
|
| 56 | This docum ent detail s high lev el functio ning of Pa tient Disc overy inte rface. | |
| 57 | 1.1 Audien ce | |
| 58 | This docum ent has be en prepare d for deve lopers, ad ministrato rs and arc hitects of eHealth s ystem that need to u nderstand how Patien t Discover y interfac e function s within A dapter. | |
| 59 | 1.2 Scope | |
| 60 | This docum ent will c over both inbound an d outbound PD flow. Within ea ch request there wil l be refer ences to l og and res ponse mess ages. Tho se message s can be f ound in th e appendic es. | |
| 61 | PD Inbound | |
| 62 | An inbound Patient D iscovery r equest is initiated by externa l trusted partner. P artners se nd 201305 request an d receive 201306 res ponse. Bel ow is the high level flow diag ram depict ing reques t/response process f low | |
| 63 | ||
| 64 | Following are the hi gh level f unctionali ty describ ed in deta il | |
| 65 | 2.1 Inboun d Request Parameters | |
| 66 | Following are some o f the prim ary but no t limited PD inbound request p arameters | |
| 67 | Sender Hom e Communit y ID - req uired | |
| 68 | Sender Fac ility Numb er – requi red | |
| 69 | Following primary pa tient deta ils | |
| 70 | Gender - R equired | |
| 71 | Birth time - Require d | |
| 72 | Name – Giv en + Famil y - Requir ed | |
| 73 | ICN - Opti onal | |
| 74 | SSN - Opti onal | |
| 75 | Mother mai den name – Optional | |
| 76 | Place of B irth City – Optional | |
| 77 | Place of B irth State – Optiona l | |
| 78 | Middle Nam e/Initial - Optional | |
| 79 | Address - Optional | |
| 80 | Telephone number - O ptional | |
| 81 | 2.2 Inbou nd Request Process F low | |
| 82 | Before fin ding any p ossible ma tches, req uest proce ss runs th rough poli cy and oth er require d check po ints to en sure resu lt deliver y only to entrusted and intend ed partner s. | |
| 83 | Following are VAPS c hecks ran before the request i s processe d | |
| 84 | Sender Hom e Communit y ID check - In this step, sys tem invoke s policy c heck on VA P system t o ensure s ender home community ID is a r egistered facility | |
| 85 | Authorized sender PD request – Invoke VA P call to ensure re questor is authorize d to make inbound PD request | |
| 86 | Community authorized for patie nt request – Call VA P to check if reques ting commu nity is au thorized t o request patient de tails with provided patient in formation | |
| 87 | If either of the che cks fail, no patient found res ponse is s ent back. | |
| 88 | 2.3 Inbou nd Request Match And Response Flow | |
| 89 | Following are the fu rther requ est proces sing steps | |
| 90 | Find Match in MVI - Invoke app ropriate M VI interfa ce calls t o find mat ching pati ent with p rovided re quest para meters. Ma tch thresh old is set on the re quest to i ndicate MV I system t he minimum matching threshold. | |
| 91 | Assign Cor relation – If reques t contains remote pa rtner Id f or patient and a mat ch occurs then we ad d correlat ion. Also add assign ing author ity to fac ility, if it doesn’t exist. Re turn the m atch in th e response to the ca ller. | |
| 92 | Error Cond ition – In case of a ny process ing error while perf orming abo ve steps, the servic e responds with an e rror respo nse indica ting exact nature of error. | |
| 93 | PD Outboun d | |
| 94 | An outboun d patient discovery is execute d via SOAP request b y trusted external p artners. The patien t discover y SOAP req uest is pa ssed to VA adapter g ateway whi ch in turn orchestra tes the ca ll to unde rlying sub system to render res ponse. Th e adapter will then loop throu gh each of the facil ities regi stered in the databa se and fir es off par allel proc essing on each facil ity. | |
| 95 | Below is t he high le vel flow d iagram | |
| 96 | ||
| 97 | Below is h igh level functional ity proces s details that occur s on each connection process | |
| 98 | 3.1 Outbou nd Request Parameter s | |
| 99 | Following are some o f the prim ary but no t limited to PD outb ound reque st paramet ers sent b y the requ estor | |
| 100 | Requestor home commu nity ID | |
| 101 | Patient ID | |
| 102 | Requesting user | |
| 103 | Purpose of use | |
| 104 | User role | |
| 105 | 3.2 Outbou nd Request Process F low | |
| 106 | Before exe cuting the request, adapter ru ns few che cks on par tner home community ID to ensu re partner is truste d and auth orized to execute op eration. | |
| 107 | Below are the VAP pr e-processi ng policy checks | |
| 108 | Sender Hom e Communit y ID check - In this step, sys tem checks if the se nder home community ID is a re gistered f acility | |
| 109 | Authorize sender PD outbound r equest - S ystem runs a check t o ensure requestor has approp riate auth orization to make in bound PD r equest | |
| 110 | If either of the che cks fail, partner re ceives mes sage stati ng that it is not au thorized t o perform PD outboun d. | |
| 111 | 3.3 Outbo und Reques t Match An d Response Flow | |
| 112 | Once polic y check an d authoriz ation step s are pass ed, adapte r loops th rough all the remote facilitie s listed o n database and fires off paral lel reques t/response processin g. Below s teps are p erformed o n each rem ote commun ity to gen erate resp onse. | |
| 113 | Note: At a ny point o n the belo w top thre e steps re sults in f ailure, an appropria te error m essage is sent to th e requesto r. | |
| 114 | Community ID check - In this s tep, syste m checks a gainst VAP system if the remot e communit y ID is a registered facility | |
| 115 | Authorize community PD outboun d request - System r uns a chec k against VAP system to ensure remote co mmunity ha s appropri ate author ization to make outb ound PD re quest | |
| 116 | Community authorized for PD ou tbound on patient – Invoke cal l on VAP s ystem to c heck if th e authoriz ed remote community is allowed to make a PD outbou nd request on a give patient | |
| 117 | Request se nd process – Only af ter all th e above th ree checks result in success t hen the ac tual reque st is sent to MVI sy stem to fi nd matchin g patient | |
| 118 | Process re sponse – A ll request sent are synchronou s in natur e hence PD outbound waits to r eceive res ponse. Onc e response received, it is app ended to a single SO AP respons e | |
| 119 | Return res ponse – Af ter all re sponses ar e aggregat ed on SOAP response, it is ret urned back to the re questor | |
| 120 | Error Cond ition – An y error oc curred dur ing reques t/response processin g is duly logged and appropria te error m essage is sent back to the req uestor | |
| 121 | Gaps | |
| 122 | There are possibilit ies that t he respons e process could be i nterrupted in which case servi ce may ret urn with a n incomple te respons e(Not all the respon ses from p artners ex ecuting in parallel) to the re questor. | |
| 123 | ii | |
| 124 | EHealth Ex change Ada pter v3.1 Installati on Guide J uly 2011 | |
| 125 | Patient Di scovery | |
| 126 | ||
| 127 | ||
| 128 | November 3 , 2014 | |
| 129 | _147722510 5.vsd_1477 294032.vsd |
Araxis Merge (but not the data content of this report) is Copyright © 1993-2016 Araxis Ltd (www.araxis.com). All rights reserved.