64. EPMO Open Source Coordination Office Redaction File Detail Report

Produced by Araxis Merge on 11/8/2016 5:25:08 PM Eastern Standard 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.

64.1 Files compared

# Location File Last Modified
1 rxrefill-v2.0.0 P2.zip Medication+Image+Library+(MIL)+Service+Interface+Control+Document+(ICD).docx Fri Nov 4 21:48:43 2016 UTC
2 rxrefill-v2.0.0 P2.zip Medication+Image+Library+(MIL)+Service+Interface+Control+Document+(ICD).docx Sun Nov 6 22:42:56 2016 UTC

64.2 Comparison summary

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

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

64.4 Active regular expressions

No regular expressions were active.

64.5 Comparison detail

  1   Medication  Image Lib rary (MIL)  Service I nterface C ontrol Doc ument (ICD )
  2   1.           Introduc tion
  3   The VA Mob ile Framew ork (VAMF)  Prescript ion (Rx) R efill appl ication re quires a w eb service  that will  provide a  medicatio n image be ing provid ed from th e Medicati on Image L ibrary (MI L) Schema  within the  Corporate  Data Ware house (CDW ).  This i mage will  allow a Ve teran to a ccurately  match the  medication  being sen t to them  via Mail O rder with  that being  delivered  in hand v ia the del ivery serv ice (Unite d States P ostal Serv ice (USPS) ), FedEx a nd United  Parcel Ser vice. This  service c reated, VA MF Medicat ion Image  Library Se rvice, wil l support  patient sa fety by en suring the  Veteran i s taking t he correct  received  medication  with thei r prescrib ed medicat ion using  the VAMF R xRefill Ap plication.  The VAMF  Architectu re team al so directe d that the  VAMF MIL  Service be  a common  service as  it provid es data th at could b e used by  all applic ations wit hin the VA MF.
  4   2.           Identifi cation of  Interfacin g Systems/ Sub-system s
  5   The follow ing archit ectural di agram is p rovided as  a referen ce so that  the proce eding subs ections ca n be easil y interpre ted. This  document w ill only f ocus on th e VAMF Med ication Im age Librar y (MIL) Se rvice swim lane of th e diagram.   The othe r swimlane s are prov ided to he lp the rea der unders tand how t he service  sits with in the ent erprise.  
  6  
  7   Figure 1:  VAMF Medic ation Imag e Library  Resource F low
  8   2.1.         Medicati on Image L ibrary (MI L) Image M etadata
  9   2.1.1.         Interf ace Descri ption
  10   This RESTf ul interfa ce provide s an endpo int within  the VAMF  for retrie ving Accep tedImageMe tadata fro m the Medi cation Ima ge Library  (MIL) Sch ema within  the Corpo rate Data  Warehouse  (CDW) by p roviding a  National  Drug Code  (NDC) to t he endpoin t. The end point will  handle al l business  logic and  exception  handling  including  calls to C DW and tra nsformatio n of MIL D ata into J SON object s.  If the  service a ll encount ers an err or an exce ption will  be create d and a Fa ult will b e return t o the end  user. All  VAMF MIL R esource Se rvices are  protected  by VAMF s ecurity in  the form  of an oAut h token so  that it c an only be  called by  VAMF auth entication  users.
  11    
  12  
  13   Figure 2:  VAMF MIL I mage Metad ata Sequen ce Flow
  14   2.1.2.         Specif ication fo r Informat ion to be  Exchanged 
  15   URI
  16   HTTP Metho d
  17   Produces
  18   Source of  Data
  19   /medicatio n-image-li brary/{ndc }
  20   GET
  21   applicatio n/json
  22   Corporate  Data Wareh ouse (CDW)  MIL Schem a
  23   Table 1: M IL Image M etadata -  Specificat ion for In formation  to be Exch anged
  24   2.1.2.1.            R equest
  25   Header
  26    
  27    
  28   Content-ty pe
  29   Required
  30   applicatio n/json
  31   Accept
  32   Required
  33   applicatio n/json
  34   Authorizat ion
  35   Required
  36   Value is B earer <spa ce> “VAMF  oAuth Toke n” (Key:Au thorizatio n Value:Be arer “toke n”)
  37    
  38    
  39    
  40   Parameters
  41    
  42    
  43   ndc
  44   Required
  45   National D rug Code ( NDC) of th e medicati on
  46    
  47    
  48    
  49     Body
  50    
  51    
  52   None
  53    
  54    
  55    
  56    
  57    
  58    
  59    
  60    
  61    
  62   2.1.2.2.            R esponse
  63   Header
  64    
  65    
  66   None
  67    
  68    
  69    
  70    
  71    
  72   Body
  73    
  74    
  75   AcceptedIm ageMetadat a
  76   Required
  77   (See A.1 –  AcceptedI mageMetada ta)
  78   Fault
  79   On Error
  80   (See A.4 –  Fault)
  81    
  82    
  83    
  84   Codes
  85    
  86    
  87   200
  88    
  89   Successful  retrieval  of Accept ed Image M etadata
  90   400
  91    
  92   150 - Unau thorized a ccess
  93   151- Missi ng VAMF to ken
  94   152 - Inva lid VAMF t oken
  95   153 - Expi red VAMF t oken
  96   160 - Miss ing NDC Co de
  97   161 – NDC  Code not f ound
  98    
  99   117 – Data  Integrity  Error
  100   99 – Unkno wn Applica tion Error
  101    
  102    
  103    
  104    
  105    
  106    2.1.3.         Timin g and Sequ encing Con straints
  107   All VAMF M IL Resourc e Services  are prote cted by VA MF securit y in the f orm of an  oAuth toke n so that  it can onl y be calle d by VAMF  authentica tion users . A token  must be pr esent in o rder to ma ke calls t o this end point.
  108   2.2.         Medicati on Image L ibrary (MI L) Image
  109   2.2.1.         Interf ace Descri ption
  110   This RESTf ul interfa ce provide s an endpo int within  the VAMF  for retrie ving a JPE G from the  Medicatio n Image Li brary (MIL ) Schema w ithin the  Corporate  Data Wareh ouse (CDW)  by provid ing an ima geId to th e endpoint . The endp oint will  handle all  business  logic and  exception  handling i ncluding c alls to CD W and tran sformation  of MIL bi nary data  into a JPE G.  If the  service a ll encount ers an err or an exce ption will  be create d and a Fa ult will b e return t o the end  user. All  VAMF MIL R esource Se rvices are  protected  by VAMF s ecurity in  the form  of an oAut h token so  that it c an only be  called by  VAMF auth entication  users.
  111    
  112   Figure 3:  VAMF MIL I mage Seque nce Flow
  113   2.2.2.         Specif ication fo r Informat ion be to  Exchanged
  114   URI
  115   HTTP Metho d
  116   Produces
  117   Source of  Data
  118   /medicatio n-image-li brary/imag e/{imageId }
  119   GET
  120   image/jpeg
  121   Corporate  Data Wareh ouse (CDW)  MIL Schem a
  122   Table 2: M IL Image -  Specifica tion for I nformation  to be Exc hanged
  123   2.2.2.1.            R equest
  124   Header
  125    
  126    
  127   Content-ty pe
  128   Required
  129   applicatio n/json
  130   Accept
  131   Required
  132   image/jpeg
  133   Authorizat ion
  134   Required
  135   Value is B earer <spa ce> “VAMF  oAuth Toke n” (Key:Au thorizatio n Value:Be arer “toke n”)
  136   mobile-ima ge
  137   Optional
  138   Optional b oolean fla g to repre sent if th e caller w ants an im age optimi zed for mo bile (max  of 320px w idth). If  true resiz ed image w ill be ret urned if n ot provide d or false  the origi nal image  is returne d.
  139    
  140    
  141    
  142   Parameters
  143    
  144    
  145   imageId
  146   Required
  147   The ImageI d within t he CDW MIL  AcceptedI mage View
  148    
  149    
  150    
  151     Body
  152    
  153    
  154   None
  155    
  156    
  157    
  158    
  159    
  160    
  161    
  162    
  163    
  164   2.2.2.2.            R esponse
  165   Header
  166    
  167    
  168    
  169    
  170    
  171    
  172    
  173    
  174   Body
  175    
  176    
  177   JPEG
  178   Required
  179   JPEG of im age select ed
  180   Fault
  181   On Error
  182   (See A.4 –  Fault)
  183    
  184    
  185    
  186   Codes
  187    
  188    
  189   200
  190    
  191   Successful  retrieval  of medica tion image
  192   400
  193    
  194   150 - Unau thorized a ccess
  195   151- Missi ng VAMF to ken
  196   152 - Inva lid VAMF t oken
  197   153 - Expi red VAMF t oken
  198   160 - Miss ing image  id
  199   161 – Imag e Id not f ound
  200   162 – No i mage exist s for Imag eId xxx
  201    
  202   117 – Data  Integrity  Error
  203   99 – Unkno wn Applica tion Error
  204    
  205    
  206    
  207    
  208    
  209   2.2.3.         Timing  and Seque ncing Cons traints
  210   All VAMF M IL Resourc e Services  are prote cted by VA MF securit y in the f orm of an  oAuth toke n so that  it can onl y be calle d by VAMF  authentica tion users . A token  must be pr esent in o rder to ma ke calls t o this end point.
  211   2.3.         Medicati on Image L ibrary (MI L) Images
  212   2.3.1.         Interf ace Descri ption
  213   This RESTf ul interfa ce provide s an endpo int within  the VAMF  for retrie ving Accep tedImages  from the M edication  Image Libr ary (MIL)  Schema wit hin the Co rporate Da ta Warehou se (CDW) b y providin g a Nation al Drug Co de (NDC) t o the endp oint.  The  endpoint  will handl e all busi ness logic  and excep tion handl ing includ ing calls  to CDW and  transform ation of M IL Data in to JSON ob jects.  If  the servi ce all enc ounters an  error an  exception  will be cr eated and  a Fault wi ll be retu rn to the  end user.  All VAMF M IL Resourc e Services  are prote cted by VA MF securit y in the f orm of an  oAuth toke n so that  it can onl y be calle d by VAMF  authentica tion users .
  214    
  215   Figure 4:  VAMF MIL I mages Sequ ence Flow
  216   2.3.2.         Specif ication fo r Informat ion to be  Exchanged
  217   URI
  218   HTTP Metho d
  219   Produces
  220   Source of  Data
  221   /medicatio n-image-li brary/imag es/{ndc}
  222   GET
  223   applicatio n/json
  224   Corporate  Data Wareh ouse (CDW)  MIL Schem a
  225   Table 3: M IL Images  - Specific ation for  Informatio n to be Ex changed
  226   2.3.2.1.            R equest
  227   Header
  228    
  229    
  230   Content-ty pe
  231   Required
  232   applicatio n/json
  233   Accept
  234   Required
  235   applicatio n/json
  236   Authorizat ion
  237   Required
  238   Value is B earer <spa ce> “VAMF  oAuth Toke n” (Key:Au thorizatio n Value:Be arer “toke n”)
  239    
  240    
  241    
  242   Parameters
  243    
  244    
  245   ndc
  246   Required
  247   National D rug Code ( NDC) of th e medicati on
  248    
  249    
  250    
  251     Body
  252    
  253    
  254   None
  255    
  256    
  257    
  258    
  259    
  260    
  261    
  262    
  263    
  264    
  265   2.3.2.2.            R esponse
  266   Header
  267    
  268    
  269   None
  270    
  271    
  272    
  273    
  274    
  275   Body
  276    
  277    
  278   AcceptedIm ages
  279   Required
  280   (See A.2 –  AcceptedI mages)
  281   Fault
  282   On Error
  283   (See A.4 –  Fault)
  284    
  285    
  286    
  287   Codes
  288    
  289    
  290   200
  291    
  292   Successful  retrieval  of Accept edImages ( List<Accep tedImage>)
  293   400
  294    
  295   150 - Unau thorized a ccess
  296   151- Missi ng VAMF to ken
  297   152 - Inva lid VAMF t oken
  298   153 - Expi red VAMF t oken
  299   160 - Miss ing NDC Co de
  300   161 – NDC  Code not f ound
  301    
  302   117 – Data  Integrity  Error
  303   99 – Unkno wn Applica tion Error
  304    
  305    
  306    
  307    
  308    
  309    
  310    
  311   2.3.3.         Timing  and Seque ncing Cons traints
  312   All VAMF M IL Resourc e Services  are prote cted by VA MF securit y in the f orm of an  oAuth toke n so that  it can onl y be calle d by VAMF  authentica tion users . A token  must be pr esent in o rder to ma ke calls t o this end point.
  313   2.4.         Medicati on Image L ibrary (MI L) Image P roperties
  314   2.4.1.         Interf ace Descri ption
  315   This RESTf ul interfa ce provide s an endpo int within  the VAMF  for retrie ving Accep tedImageMe tadata fro m the Medi cation Ima ge Library  (MIL) Sch ema within  the Corpo rate Data  Warehouse  (CDW) by p roviding a n imageId  to the end point. The  endpoint  will handl e all busi ness logic  and excep tion handl ing includ ing calls  to CDW and  transform ation of M IL Data in  JSON obje cts.  If t he service  all encou nters an e rror an ex ception wi ll be crea ted and a  Fault will  be return  to the en d user. Al l VAMF MIL  Resource  Services a re protect ed by VAMF  security  in the for m of an oA uth token  so that it  can only  be called  by VAMF au thenticati on users.
  316    
  317   Figure 5:  VAMF MIL I mage Prope rties Sequ ence Flow
  318   2.4.2.         Specif ication fo r Informat ion to be  Exchanged
  319   URI
  320   HTTP Metho d
  321   Produces
  322   Source of  Data
  323   /medicatio n-image-li brary/imag e/{imageId }/properti es
  324   GET
  325   applicatio n/json
  326   Corporate  Data Wareh ouse (CDW)  MIL Schem a
  327   Table 4: M IL Image P roperties  - Specific ation for  Informatio n to be Ex changed
  328   2.4.2.1.            R equest
  329   Header
  330    
  331    
  332   Content-ty pe
  333   Required
  334   applicatio n/json
  335   Accept
  336   Required
  337   applicatio n/json
  338   Authorizat ion
  339   Required
  340   Value is B earer <spa ce> “VAMF  oAuth Toke n” (Key:Au thorizatio n Value:Be arer “toke n”)
  341    
  342    
  343    
  344   Parameters
  345    
  346    
  347   imageId
  348   Required
  349   The ImageI d within t he CDW MIL  AcceptedI mage View
  350    
  351    
  352    
  353     Body
  354    
  355    
  356   None
  357    
  358    
  359    
  360    
  361    
  362    
  363    
  364    
  365    
  366    
  367   2.4.2.2.            R esponse
  368   Header
  369    
  370    
  371   None
  372    
  373    
  374    
  375    
  376    
  377   Body
  378    
  379    
  380   AcceptedIm age
  381   Required
  382   (See A.3 –  AcceptedI mage)
  383   Fault
  384   On Error
  385   (See A.4 –  Fault)
  386    
  387    
  388    
  389   Codes
  390    
  391    
  392   200
  393    
  394   Successful  retrieval  of an Acc eptedImage
  395   400
  396    
  397   150 - Unau thorized a ccess
  398   151- Missi ng VAMF to ken
  399   152 - Inva lid VAMF t oken
  400   153 - Expi red VAMF t oken
  401   160 - Miss ing image  id
  402   161 – Imag e id not f ound
  403    
  404   117 – Data  Integrity  Error
  405   99 – Unkno wn Applica tion Error
  406    
  407    
  408    
  409    
  410    
  411    
  412   2.4.3.         Timing  and Seque ncing Cons traints
  413   All VAMF M IL Resourc e Services  are prote cted by VA MF securit y in the f orm of an  oAuth toke n so that  it can onl y be calle d by VAMF  authentica tion users . A token  must be pr esent in o rder to ma ke calls t o this end point.
  414   3.           Capacity  and Perfo rmance Req uirements
  415   The servic e will lev erage My H ealtheVet  statistics  for capac ity planni ng.  Metri cs show on  average o ne million  prescript ion refill s using th e Enterpri se RxRefil l and Trac king servi ce.  This  would requ ire simila r capacity  planning  due to Vet erans need ing to vie w a medica tion durin g the trac king of th eir prescr iption act ivity.
  416   4.           Requirem ents for C ommunicati on Protoco l Standard s Complian ce
  417   Clients wi ll exchang e informat ion with t he VAMF Rx Refill Res ources ser vice via R EST.  All  endpoints  will  be a ble to tra nsmit/rece ive JSON o bjects. Er ror recove ry and gua ranteed de livery are  not part  of the pro tocol. Any  unexpecte d errors m ust be com municated  using REST /HTTP Erro r codes an d are defi ned within  the Respo nse Segmen ts for eac h endpoint .  HTTP ca n provide  compressio n of the i nformation  exchanged . HTTPS, o r more pre cisely Sec ure Socket  Layer (SS L)/ Transp ort Securi ty Layer ( TSL), shal l be used  to provide  encryptio n of the i nformation  exchanged . HTTPS is  used betw een the en d-user’s b rowser and  the web s erver. The  following  communica tion stand ards will  be used: R EST, JSON,  WADL, SSL  3.0, and  TLS 1.1.
  418   Appendix A . Data Ele ments
  419   A.1.        AcceptedI mageMetada ta
  420   Field
  421   Type
  422   acceptedIm ageMetadat aSID
  423   Integer
  424   NDC
  425   String
  426   drugStyleC hange
  427   Integer
  428   NDC9Digit
  429   String
  430   NDC10
  431   String
  432   LBLCode
  433   String
  434   prodCode
  435   String
  436   PKGCode
  437   String
  438   VAProductI D
  439   String
  440   packSize
  441   String
  442   packType
  443   String
  444   manufactur er
  445   String
  446   tradeName
  447   String
  448   VAProductN ame
  449   String
  450   VAGenericN ame
  451   String
  452   VAPrintNam e
  453   String
  454   nationalFo rmularyInd icator
  455   Boolean
  456   nationalFo rmularyNam e
  457   String
  458   drugClassi ficationCo de
  459   String
  460   drugClassi fication
  461   String
  462   strength
  463   String
  464   unit
  465   String
  466   DosageForm
  467   String
  468   rx_OTC
  469   String
  470   shape
  471   String
  472   color
  473   String
  474   imprintTyp e
  475   String
  476   frontImpri nt
  477   String
  478   backImprin t
  479   String
  480   score
  481   String
  482   coating
  483   String
  484   VADispense Unit
  485   String
  486   lastModifi edDT
  487   RFC1123 Da te
  488   lastModifi edUser
  489   String
  490   initialAdd DT
  491   RFC1123 Da te
  492   inNDF
  493   Boolean
  494   inFDA
  495   Boolean
  496   inFDB
  497   Boolean
  498   listingSEQ NO
  499   String
  500   GCNSeqNO
  501   String
  502   VUID
  503   String
  504   IEN
  505   String
  506   UPN
  507   String
  508   inactivati onDate
  509   String
  510   CSFederalS chedule
  511   String
  512   imageID
  513   Integer
  514   medImageID
  515   Integer
  516   packImageI D
  517   Integer
  518   imageStatu s
  519   Integer
  520   reviewDate Time
  521   RFC1123 Da te
  522   verifiedDa teTime
  523   RFC1123 Da te
  524   Notes
  525   String
  526   verificati onReason
  527   String
  528   drugID
  529   String
  530   newStyle
  531   Boolean
  532   unitofUse
  533   Boolean
  534   imageRef
  535   String
  536   medImageRe f
  537   String
  538   packImageR ef
  539   String
  540    
  541   A.2.        AcceptedI mages
  542   Field
  543   Type
  544   acceptedIm ageList
  545   List<Accep tedImage>
  546    
  547   A.3.        AcceptedI mage
  548   Field
  549   Type
  550   acceptedIm ageID
  551   Integer
  552   imageID
  553   Integer
  554   sourceID
  555   String
  556   NDC
  557   String
  558   drugImage
  559   JPEG (byte [ ])
  560   acceptance
  561   String
  562   reviewDate Time
  563   RFC1123 Da te
  564   verifiedDa teTime
  565   RFC1123 Da te
  566   imageRef
  567   String
  568    
  569   A.4.        Fault
  570   Field
  571   Type
  572   developerM essage
  573   String
  574   errorCode
  575   Integer
  576   message
  577   String
  578    
  579