Produced by Araxis Merge on 11/8/2016 5:25:16 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.
| # | Location | File | Last Modified |
|---|---|---|---|
| 1 | rxrefill-v2.0.0 P2.zip | Rx+Refill+(RXR)+Service+Interface+Control+Document+(ICD).docx | Fri Nov 4 21:50:01 2016 UTC |
| 2 | rxrefill-v2.0.0 P2.zip | Rx+Refill+(RXR)+Service+Interface+Control+Document+(ICD).docx | Mon Nov 7 00:10:35 2016 UTC |
| Description | Between Files 1 and 2 |
|
|---|---|---|
| Text Blocks | Lines | |
| Unchanged | 1 | 2798 |
| Changed | 0 | 0 |
| 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 | Rx Refill (RXR) Serv ice Interf ace Contro l Document (ICD) | |
| 2 | Department of Vetera ns Affairs Mobile Ap plications (Apps) Ph ase Two (M AP2)Rx Ref ill - Pres cription R efill Inte rface Cont rol Docume nt Novembe r 2015 Sof tware Vers ion 2.0 | |
| 3 | Introducti on | |
| 4 | The VA Mob ile Framew ork (VAMF) Prescript ion (Rx) R efill appl ication re quires a w eb service created i n order to fulfill t he require ments of d isplaying the status of the Ve teran's Rx Medicatio n, expecte d delivery date, and relevant mail track ing inform ation with links to the delive ry service (United S tates Post al Service (USPS)), FedEx and United Par cel Servic e. This se rvice will help supp ort the ap plication and allow the Vetera n to obtai n all the necessary informatio n about th eir prescr iption wit hout havin g to phone a VAMC di rectly. Th is service will not only provi de an inte rface for data neede d for the VAMF Rx Re fill appli cation it will also make use o f a newly created En terprise R x Refill a nd Trackin g Service being prov ided by th e My Healt heVet Prod uct Develo pment team . The VAMF Rx Refill Service w ill integr ate into t he VAMF's security i nfrastruct ure and pr ovide an a dapter and session m anagement administra tion with the Enterp rise servi ce. A very important considera tion for t he need an d use of t his servic e was also to levera ge the Ent erprise Rx Refill an d Tracking service s o that all data rela ting to Pr escription s and Trac king infor mation is consistent for Veter an Facing Applicatio ns. | |
| 5 | Identifica tion of In terfacing Systems/Su b-systems | |
| 6 | 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 Rx Refill Ser vice swim lane of th e diagram. The other swim lane s are prov ided to he lp the rea der unders tand how t he service sits with in the ent erprise. T he diagram below als o provides backgroun d into how session m anagement is handled with the Enterprise Rx Refill and Track ing servic e. Figure 1: VAMF Rx Refill Se rvice Flow | |
| 7 | Enterprise Session | |
| 8 | Interface Descriptio n | |
| 9 | This RESTf ul interfa ce provide s an endpo int within the VAMF for initia ting a ses sion with the Enterp rise Rx Re fill and T racking Se rvice curr ently bein g provided by the My HealtheVe t Product Developmen t team. Th e enterpri se token t hat is ret urned is s tored with in the VAM F client f or subsequ ent calls to the Ent erprise Rx Refill an d Tracking Service. Each subse quent call to a VAMF endpoint for Rx Ref ill servic es must pr ovide the valid ente rprise tok en. Figure 2: VAMF S ession Seq uence Flow | |
| 10 | Specificat ion for In formation to be Exch anged | |
| 11 | Request | |
| 12 | Header | |
| 13 | ||
| 14 | ||
| 15 | ||
| 16 | ||
| 17 | ||
| 18 | ||
| 19 | ||
| 20 | ||
| 21 | ||
| 22 | Content-ty pe | |
| 23 | ||
| 24 | ||
| 25 | Required | |
| 26 | ||
| 27 | ||
| 28 | ||
| 29 | applicatio n/json | |
| 30 | ||
| 31 | ||
| 32 | Accept | |
| 33 | ||
| 34 | ||
| 35 | Required | |
| 36 | ||
| 37 | ||
| 38 | ||
| 39 | applicatio n/json | |
| 40 | ||
| 41 | ||
| 42 | ||
| 43 | ||
| 44 | ||
| 45 | ||
| 46 | ||
| 47 | ||
| 48 | ||
| 49 | ||
| 50 | ||
| 51 | ||
| 52 | Parameters | |
| 53 | ||
| 54 | ||
| 55 | ||
| 56 | ||
| 57 | ||
| 58 | ||
| 59 | ||
| 60 | ||
| 61 | ||
| 62 | assigning- authority | |
| 63 | ||
| 64 | ||
| 65 | Required | |
| 66 | ||
| 67 | ||
| 68 | ||
| 69 | Logged in user's ass igning aut hority | |
| 70 | ||
| 71 | ||
| 72 | patient-id | |
| 73 | ||
| 74 | ||
| 75 | Required | |
| 76 | ||
| 77 | ||
| 78 | ||
| 79 | Logged in user's pat ient id | |
| 80 | ||
| 81 | ||
| 82 | ||
| 83 | ||
| 84 | ||
| 85 | ||
| 86 | ||
| 87 | ||
| 88 | ||
| 89 | ||
| 90 | ||
| 91 | ||
| 92 | Body | |
| 93 | ||
| 94 | ||
| 95 | ||
| 96 | ||
| 97 | ||
| 98 | ||
| 99 | ||
| 100 | ||
| 101 | ||
| 102 | None | |
| 103 | ||
| 104 | ||
| 105 | ||
| 106 | ||
| 107 | ||
| 108 | ||
| 109 | ||
| 110 | ||
| 111 | ||
| 112 | Response | |
| 113 | Header | |
| 114 | ||
| 115 | ||
| 116 | ||
| 117 | ||
| 118 | None | |
| 119 | ||
| 120 | ||
| 121 | ||
| 122 | ||
| 123 | ||
| 124 | ||
| 125 | ||
| 126 | ||
| 127 | ||
| 128 | Body | |
| 129 | ||
| 130 | ||
| 131 | ||
| 132 | ||
| 133 | Enterprise SessionMgm tTO | |
| 134 | Required | |
| 135 | ||
| 136 | ||
| 137 | (See A.9 – Enterpris eSessionMg mtTO) | |
| 138 | Fault | |
| 139 | On error | |
| 140 | ||
| 141 | ||
| 142 | (See A.6 – Fault) | |
| 143 | ||
| 144 | ||
| 145 | ||
| 146 | ||
| 147 | ||
| 148 | Codes | |
| 149 | ||
| 150 | ||
| 151 | ||
| 152 | ||
| 153 | ||
| 154 | ||
| 155 | ||
| 156 | ||
| 157 | ||
| 158 | 200 | |
| 159 | ||
| 160 | ||
| 161 | ||
| 162 | Successful creation of a token and expir ation time stamp | |
| 163 | 400 | |
| 164 | ||
| 165 | ||
| 166 | ||
| 167 | Fault code s and mess ages: 101 - Applicat ion authen tication f ailed 102 - Applicat ion author ization fa iled 103 - Invalid U ser Creden tials 104 - Missing User Crede ntials 105 - User wa s not foun d 106 - Us er is not eligible b ecause the y are bloc ked 107 - System una ble to cre ate token 132 - Miss ing applic ation toke n 135 - Us er is not eligible b ecause the y have not accepted terms and conditions or opted- in 901 - A uthenticat ion Servic e Error | |
| 168 | ||
| 169 | Timing and Sequencin g Constrai nts | |
| 170 | This inter face is ca lled from a VAMF cli ent that w ishes to m ake subseq uent calls to any VA MF Rx Refi ll Service s that act as adapte rs to the Enterprise Rx Refill and Track ing Servic e. This in terface is only call ed if an e nterprise session to ken either does not exist or h as expired . | |
| 171 | Active Pre scriptions (Rx) | |
| 172 | Interface Descriptio n | |
| 173 | This RESTf ul interfa ce provide s an endpo int within the VAMF for retrie ving activ e prescrip tions from the Enter prise Rx R efill and Tracking S ervice cur rently bei ng provide d by the M y HealtheV et Product Developme nt team. T he endpoin t provides an adapte r to the E nterprise service. T he endpoin t expects an enterpr ise token from the c lient in o rder to ma ke a succe ssful call to the En terprise R x Refill a nd Trackin g Service. All VAMF Rx Refill 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. Figure 3: VAMF Rx Re fill Activ e Prescrip tions Sequ ence Flow | |
| 174 | Specificat ion for In formation to be Exch anged | |
| 175 | URI | |
| 176 | HTTP Metho d | |
| 177 | Produces | |
| 178 | Source of Data | |
| 179 | /v2/patien t/prescrip tion/activ e | |
| 180 | GET | |
| 181 | applicatio n/json | |
| 182 | Enterprise Rx Refill and Track ing Servic e | |
| 183 | Table 1: A ctive Pres criptions - Specific ation for Informatio n to be Ex changed | |
| 184 | Request | |
| 185 | Header | |
| 186 | ||
| 187 | ||
| 188 | ||
| 189 | ||
| 190 | ||
| 191 | ||
| 192 | Content-ty pe | |
| 193 | ||
| 194 | Required | |
| 195 | ||
| 196 | ||
| 197 | ||
| 198 | applicatio n/json | |
| 199 | Accept | |
| 200 | ||
| 201 | Required | |
| 202 | ||
| 203 | ||
| 204 | ||
| 205 | applicatio n/json | |
| 206 | Authorizat ion | |
| 207 | ||
| 208 | Required | |
| 209 | ||
| 210 | ||
| 211 | ||
| 212 | Value is B earer <spa ce> "VAMF oAuth Toke n" (Key:Au thorizatio n Value:Be arer "toke n") | |
| 213 | Token | |
| 214 | ||
| 215 | Required | |
| 216 | ||
| 217 | ||
| 218 | ||
| 219 | Enterprise Session T oken | |
| 220 | ||
| 221 | ||
| 222 | ||
| 223 | ||
| 224 | ||
| 225 | ||
| 226 | ||
| 227 | Parameters | |
| 228 | ||
| 229 | ||
| 230 | ||
| 231 | ||
| 232 | ||
| 233 | ||
| 234 | None | |
| 235 | ||
| 236 | ||
| 237 | ||
| 238 | ||
| 239 | ||
| 240 | ||
| 241 | ||
| 242 | ||
| 243 | ||
| 244 | ||
| 245 | ||
| 246 | ||
| 247 | ||
| 248 | Body | |
| 249 | ||
| 250 | ||
| 251 | ||
| 252 | ||
| 253 | ||
| 254 | ||
| 255 | None | |
| 256 | ||
| 257 | ||
| 258 | ||
| 259 | ||
| 260 | ||
| 261 | ||
| 262 | Response | |
| 263 | Header | |
| 264 | ||
| 265 | ||
| 266 | ||
| 267 | None | |
| 268 | ||
| 269 | ||
| 270 | ||
| 271 | ||
| 272 | ||
| 273 | ||
| 274 | ||
| 275 | Body | |
| 276 | ||
| 277 | ||
| 278 | ||
| 279 | Prescripti onsTO Pres criptionTO | |
| 280 | Required R equired | |
| 281 | ||
| 282 | (See A.1 – Prescript ionsTO) (S ee A.2 – P rescriptio nTO) | |
| 283 | Fault | |
| 284 | On error | |
| 285 | ||
| 286 | (See A.6 – Fault) | |
| 287 | Codes | |
| 288 | ||
| 289 | ||
| 290 | ||
| 291 | 200 | |
| 292 | ||
| 293 | ||
| 294 | Successful retrieval of Prescr iptions | |
| 295 | 400 | |
| 296 | ||
| 297 | ||
| 298 | Fault code s and mess ages: 102 - Applicat ion author ization fa iled 108 - Missing s ession tok en 109 - I nvalid ses sion token 110 - Exp ired sessi on token 1 11 - Inval id user pe rmissions 901 – Auth entication Service E rror 135 – Rx Agreem ent Not Ac cepted Err or 117 – D ata Integr ity Error 99 – Unkno wn Applica tion Error | |
| 299 | Timing and Sequencin g Constrai nts | |
| 300 | An enterpr ise sessio n token mu st exist w ithin the VAMF for t he client. If a toke n does not exist or has expire d the busi ness logic within th e Rx Refil l client w ill make a call to i nitiate a new sessio n and stor e both the enterpris e token an d expirati on timesta mp within the client session. See Enterp rise Sessi on. | |
| 301 | Refillable Prescript ions (Rx) | |
| 302 | Interface Descriptio n | |
| 303 | This RESTf ul interfa ce provide s an endpo int within the VAMF for retrie ving refil lable pres criptions from the E nterprise Rx Refill and Tracki ng Service currently being pro vided by t he My Heal theVet Pro duct Devel opment tea m. The end point prov ides an ad apter to t he Enterpr ise servic e. The end point expe cts an ent erprise to ken from t he client in order t o make a s uccessful call to th e Enterpri se Rx Refi ll and Tra cking Serv ice. All V AMF Rx Ref ill Servic es are pro tected by VAMF secur ity in the form of a n oAuth to ken so tha t it can o nly be cal led by VAM F authenti cation use rs. Figure 4: VAMF R x Refill R efillable Prescripti ons Sequen ce Flow | |
| 304 | Specificat ion for In formation to be Exch anged | |
| 305 | URI | |
| 306 | HTTP Metho d | |
| 307 | Produces | |
| 308 | Source of Data | |
| 309 | /v2/patien t/prescrip tion/refil lable | |
| 310 | GET | |
| 311 | applicatio n/json | |
| 312 | Enterprise Rx Refill and Track ing Servic e | |
| 313 | Table 2: R efillable Prescripti ons - Spec ification for Inform ation to b e Exchange d | |
| 314 | Request | |
| 315 | Header | |
| 316 | ||
| 317 | ||
| 318 | ||
| 319 | ||
| 320 | ||
| 321 | ||
| 322 | Content-ty pe | |
| 323 | ||
| 324 | Required | |
| 325 | ||
| 326 | ||
| 327 | ||
| 328 | applicatio n/json | |
| 329 | Accept | |
| 330 | ||
| 331 | Required | |
| 332 | ||
| 333 | ||
| 334 | ||
| 335 | applicatio n/json | |
| 336 | Authorizat ion | |
| 337 | ||
| 338 | Required | |
| 339 | ||
| 340 | ||
| 341 | ||
| 342 | Value is B earer <spa ce> "VAMF oAuth Toke n" (Key:Au thorizatio n Value:Be arer "toke n") | |
| 343 | Token | |
| 344 | ||
| 345 | Required | |
| 346 | ||
| 347 | ||
| 348 | ||
| 349 | Enterprise Session T oken | |
| 350 | ||
| 351 | ||
| 352 | ||
| 353 | ||
| 354 | ||
| 355 | ||
| 356 | ||
| 357 | Parameters | |
| 358 | ||
| 359 | ||
| 360 | ||
| 361 | ||
| 362 | ||
| 363 | ||
| 364 | None | |
| 365 | ||
| 366 | ||
| 367 | ||
| 368 | ||
| 369 | ||
| 370 | ||
| 371 | ||
| 372 | ||
| 373 | ||
| 374 | ||
| 375 | ||
| 376 | ||
| 377 | ||
| 378 | Body | |
| 379 | ||
| 380 | ||
| 381 | ||
| 382 | ||
| 383 | ||
| 384 | ||
| 385 | None | |
| 386 | ||
| 387 | ||
| 388 | ||
| 389 | ||
| 390 | ||
| 391 | ||
| 392 | Response | |
| 393 | Header | |
| 394 | ||
| 395 | ||
| 396 | ||
| 397 | None | |
| 398 | ||
| 399 | ||
| 400 | ||
| 401 | ||
| 402 | ||
| 403 | ||
| 404 | ||
| 405 | Body | |
| 406 | ||
| 407 | ||
| 408 | ||
| 409 | Prescripti onsTO Pres criptionTO | |
| 410 | Required R equired | |
| 411 | ||
| 412 | (See A.1 – Prescript ionsTO) (S ee A.2 – P rescriptio nTO) | |
| 413 | Fault | |
| 414 | On error | |
| 415 | ||
| 416 | (See A.6 – Fault) | |
| 417 | Codes | |
| 418 | ||
| 419 | ||
| 420 | ||
| 421 | 200 | |
| 422 | ||
| 423 | ||
| 424 | Successful retrieval of Prescr iptions | |
| 425 | 400 | |
| 426 | ||
| 427 | ||
| 428 | Fault code s and mess ages: 102 - Applicat ion author ization fa iled 108 - Missing s ession tok en 109 - I nvalid ses sion token 110 - Exp ired sessi on token 1 11 - Inval id user pe rmissions 901 – Auth entication Service E rror 135 – Rx Agreem ent Not Ac cepted Err or 117 – D ata Integr ity Error 99 – Unkno wn Applica tion Error | |
| 429 | Timing and Sequencin g Constrai nts | |
| 430 | An enterpr ise sessio n token mu st exist w ithin the VAMF for t he client. If a toke n does not exist or has expire d the busi ness logic within th e Rx Refil l client w ill make a call to i nitiate a new sessio n and stor e both the enterpris e token an d expirati on timesta mp within the client session. See Enterp rise Sessi on. | |
| 431 | Refill Pre scription (Rx) | |
| 432 | Interface Descriptio n | |
| 433 | This RESTf ul interfa ce provide s an endpo int within the VAMF for refill ing a pres cription f rom the En terprise R x Refill a nd Trackin g Service currently being prov ided by th e My Healt heVet Prod uct Develo pment team . The endp oint provi des an ada pter to th e Enterpri se service . The endp oint expec ts an ente rprise tok en from th e client i n order to make a su ccessful c all to the Enterpris e Rx Refil l and Trac king Servi ce. All VA MF Rx Refi ll Service s are prot ected by V AMF securi ty in the form of an oAuth tok en so that it can on ly be call ed by VAMF authentic ation user s. Figure 4: VAMF R x Refill S equence Fl ow | |
| 434 | Specificat ion for In formation to be Exch anged | |
| 435 | URI | |
| 436 | HTTP Metho d | |
| 437 | Produces | |
| 438 | Source of Data | |
| 439 | /v2/patien t/{assigni ng-authori ty}/{patie nt-id}/pre scription/ {rxId}{?ap pSource=rx r} | |
| 440 | POST | |
| 441 | applicatio n/json | |
| 442 | Enterprise Rx Refill and Track ing Servic e | |
| 443 | Table 3: R efill Pres cription - Specifica tion for I nformation to be Exc hanged | |
| 444 | Request | |
| 445 | Header | |
| 446 | ||
| 447 | ||
| 448 | ||
| 449 | ||
| 450 | ||
| 451 | ||
| 452 | Content-ty pe | |
| 453 | ||
| 454 | Required | |
| 455 | ||
| 456 | ||
| 457 | ||
| 458 | applicatio n/json | |
| 459 | Accept | |
| 460 | ||
| 461 | Required | |
| 462 | ||
| 463 | ||
| 464 | ||
| 465 | applicatio n/json | |
| 466 | Authorizat ion | |
| 467 | ||
| 468 | Required | |
| 469 | ||
| 470 | ||
| 471 | ||
| 472 | Value is B earer <spa ce> "VAMF oAuth Toke n" (Key:Au thorizatio n Value:Be arer "toke n") | |
| 473 | Token | |
| 474 | ||
| 475 | Required | |
| 476 | ||
| 477 | ||
| 478 | ||
| 479 | Enterprise Session T oken | |
| 480 | ||
| 481 | ||
| 482 | ||
| 483 | ||
| 484 | ||
| 485 | ||
| 486 | ||
| 487 | Parameters | |
| 488 | ||
| 489 | ||
| 490 | ||
| 491 | ||
| 492 | ||
| 493 | ||
| 494 | rxId | |
| 495 | ||
| 496 | Required | |
| 497 | ||
| 498 | ||
| 499 | ||
| 500 | Prescripti on Id to b e refilled | |
| 501 | appSource | |
| 502 | ||
| 503 | Required | |
| 504 | ||
| 505 | ||
| 506 | ||
| 507 | Applicatio n Source m aking this request | |
| 508 | ||
| 509 | ||
| 510 | ||
| 511 | ||
| 512 | ||
| 513 | ||
| 514 | ||
| 515 | Body | |
| 516 | ||
| 517 | ||
| 518 | ||
| 519 | ||
| 520 | ||
| 521 | ||
| 522 | None | |
| 523 | ||
| 524 | ||
| 525 | ||
| 526 | ||
| 527 | ||
| 528 | ||
| 529 | Response | |
| 530 | Header | |
| 531 | ||
| 532 | ||
| 533 | ||
| 534 | None | |
| 535 | ||
| 536 | ||
| 537 | ||
| 538 | ||
| 539 | ||
| 540 | ||
| 541 | ||
| 542 | Body | |
| 543 | ||
| 544 | ||
| 545 | ||
| 546 | Fault | |
| 547 | On error | |
| 548 | ||
| 549 | (See A.6 – Fault) | |
| 550 | ||
| 551 | ||
| 552 | ||
| 553 | ||
| 554 | Codes | |
| 555 | ||
| 556 | ||
| 557 | ||
| 558 | 200 | |
| 559 | ||
| 560 | ||
| 561 | Successful refill of prescript ion | |
| 562 | 400 | |
| 563 | ||
| 564 | ||
| 565 | Fault code s and mess ages: 102 - Applicat ion author ization fa iled 108 - Missing s ession tok en 109 - I nvalid ses sion token 110 - Exp ired sessi on token 1 11 - Inval id user pe rmissions 901 – Auth entication Service E rror 135 – Rx Agreem ent Not Ac cepted Err or 136 – T he User is not the o wner of th e prescrip tion 137 – when rxId parameter is empty 138 – Pres cription N ot Found 1 17 – Data Integrity Error 99 – Unknown A pplication Error 139 –Prescrip tion is no t refillab le 140 – P rescriptio n Refill w as unsucce ssful. Ple ase try ag ain later | |
| 566 | Timing and Sequencin g Constrai nts | |
| 567 | An enterpr ise sessio n token mu st exist w ithin the VAMF for t he client. If a toke n does not exist or has expire d the busi ness logic within th e Rx Refil l client w ill make a call to i nitiate a new sessio n and stor e both the enterpris e token an d expirati on timesta mp within the client session. See Enterp rise Sessi on. | |
| 568 | Historical Prescript ions (Rx) | |
| 569 | Interface Descriptio n | |
| 570 | This RESTf ul interfa ce provide s an endpo int within the VAMF for retrie ving histo ric prescr iptions fr om the Ent erprise Rx Refill an d Tracking Service c urrently b eing provi ded by the My Health eVet Produ ct Develop ment team. The endpo int provid es an adap ter to the Enterpris e service. The endpo int expect s an enter prise toke n from the client in order to make a suc cessful ca ll to the Enterprise Rx Refill and Track ing Servic e. All VAM F Rx Refil l Service endpoints are protec ted by VAM F security in the fo rm of an o Auth token so that i t can only be called by VAMF a uthenticat ion users. Figure 6: VAMF Rx R efill Hist orical Pre scriptions Sequence Flow | |
| 571 | Specificat ion for In formation to be Exch anged | |
| 572 | URI | |
| 573 | HTTP Metho d | |
| 574 | Produces | |
| 575 | Source of Data | |
| 576 | /v2/patien t/prescrip tion/histo ric | |
| 577 | GET | |
| 578 | applicatio n/json | |
| 579 | Enterprise Rx Refill and Track ing Servic e | |
| 580 | Table 4: H istorical Prescripti ons - Spec ification for Inform ation to b e Exchange d | |
| 581 | Request | |
| 582 | Header | |
| 583 | ||
| 584 | ||
| 585 | ||
| 586 | ||
| 587 | ||
| 588 | ||
| 589 | Content-ty pe | |
| 590 | ||
| 591 | Required | |
| 592 | ||
| 593 | ||
| 594 | ||
| 595 | applicatio n/json | |
| 596 | Accept | |
| 597 | ||
| 598 | Required | |
| 599 | ||
| 600 | ||
| 601 | ||
| 602 | applicatio n/json | |
| 603 | Authorizat ion | |
| 604 | ||
| 605 | Required | |
| 606 | ||
| 607 | ||
| 608 | ||
| 609 | Value is B earer <spa ce> "VAMF oAuth Toke n" (Key:Au thorizatio n Value:Be arer "toke n") | |
| 610 | Token | |
| 611 | ||
| 612 | Required | |
| 613 | ||
| 614 | ||
| 615 | ||
| 616 | Enterprise Session T oken | |
| 617 | ||
| 618 | ||
| 619 | ||
| 620 | ||
| 621 | ||
| 622 | ||
| 623 | ||
| 624 | Parameters | |
| 625 | ||
| 626 | ||
| 627 | ||
| 628 | ||
| 629 | ||
| 630 | ||
| 631 | None | |
| 632 | ||
| 633 | ||
| 634 | ||
| 635 | ||
| 636 | ||
| 637 | ||
| 638 | ||
| 639 | ||
| 640 | ||
| 641 | ||
| 642 | ||
| 643 | ||
| 644 | ||
| 645 | Body | |
| 646 | ||
| 647 | ||
| 648 | ||
| 649 | ||
| 650 | ||
| 651 | ||
| 652 | None | |
| 653 | ||
| 654 | ||
| 655 | ||
| 656 | ||
| 657 | ||
| 658 | ||
| 659 | Response | |
| 660 | Header | |
| 661 | ||
| 662 | ||
| 663 | ||
| 664 | None | |
| 665 | ||
| 666 | ||
| 667 | ||
| 668 | ||
| 669 | ||
| 670 | ||
| 671 | ||
| 672 | Body | |
| 673 | ||
| 674 | ||
| 675 | ||
| 676 | Prescripti onsTO Pres criptionTO | |
| 677 | Required R equired | |
| 678 | ||
| 679 | (See A.1 – Prescript ionsTO) (S ee A.2 – P rescriptio nTO) | |
| 680 | Fault | |
| 681 | On error | |
| 682 | ||
| 683 | (See A.6 – Fault) | |
| 684 | Codes | |
| 685 | ||
| 686 | ||
| 687 | ||
| 688 | 200 | |
| 689 | ||
| 690 | ||
| 691 | Successful retrieval of Histor ical Presc riptions | |
| 692 | 400 | |
| 693 | ||
| 694 | ||
| 695 | Fault code s and mess ages: 102 - Applicat ion author ization fa iled 108 - Missing s ession tok en 109 - I nvalid ses sion token 110 - Exp ired sessi on token 1 11 - Inval id user pe rmissions 901 – Auth entication Service E rror 135 – Rx Agreem ent Not Ac cepted Err or 117 – D ata Integr ity Error 99 – Unkno wn Applica tion Error | |
| 696 | Timing and Sequencin g Constrai nts | |
| 697 | An enterpr ise sessio n token mu st exist w ithin the VAMF for t he client. If a toke n does not exist or has expire d the busi ness logic within th e Rx Refil l client w ill make a call to i nitiate a new sessio n and stor e both the enterpris e token an d expirati on timesta mp within the client session. See Enterp rise Sessi on. | |
| 698 | Prescripti on (Rx) Tr acking | |
| 699 | Interface Descriptio n | |
| 700 | This RESTf ul interfa ce provide s an endpo int within the VAMF for retrie ving a lis t of presc riptions t hat can be tracked f rom the En terprise R x Refill a nd Trackin g Service currently being prov ided by th e My Healt heVet Prod uct Develo pment team . The endp oint provi des an ada pter to th e Enterpri se service . The endp oint expec ts an ente rprise tok en from th e client i n order to make a su ccessful c all to the Enterpris e Rx Refil l and Trac king Servi ce. All VA MF Rx Refi ll Service endpoints 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 . This end point call s the Ente rprise RxR efill and Tracking S ervice get historyrx endpoint a nd filters the respo nse to onl y include data where isTrackab le = true and refill Date <= 45 days. Figu re 7: VAMF Rx Refill Trackable Prescript ions Seque nce Flow | |
| 701 | Specificat ion for In formation to be Exch anged | |
| 702 | URI | |
| 703 | HTTP Metho d | |
| 704 | Produces | |
| 705 | Source of Data | |
| 706 | /v2/patien t/prescrip tion/track ing | |
| 707 | GET | |
| 708 | applicatio n/json | |
| 709 | Enterprise Rx Refill and Track ing Servic e | |
| 710 | Table 5: H istorical Prescripti ons - Spec ification for Inform ation to b e Exchange d | |
| 711 | Request | |
| 712 | Header | |
| 713 | ||
| 714 | ||
| 715 | ||
| 716 | ||
| 717 | ||
| 718 | ||
| 719 | Content-ty pe | |
| 720 | ||
| 721 | Required | |
| 722 | ||
| 723 | ||
| 724 | ||
| 725 | applicatio n/json | |
| 726 | Accept | |
| 727 | ||
| 728 | Required | |
| 729 | ||
| 730 | ||
| 731 | ||
| 732 | applicatio n/json | |
| 733 | Authorizat ion | |
| 734 | ||
| 735 | Required | |
| 736 | ||
| 737 | ||
| 738 | ||
| 739 | Value is B earer <spa ce> "VAMF oAuth Toke n" (Key:Au thorizatio n Value:Be arer "toke n") | |
| 740 | Token | |
| 741 | ||
| 742 | Required | |
| 743 | ||
| 744 | ||
| 745 | ||
| 746 | Enterprise Session T oken | |
| 747 | ||
| 748 | ||
| 749 | ||
| 750 | ||
| 751 | ||
| 752 | ||
| 753 | ||
| 754 | Parameters | |
| 755 | ||
| 756 | ||
| 757 | ||
| 758 | ||
| 759 | ||
| 760 | ||
| 761 | None | |
| 762 | ||
| 763 | ||
| 764 | ||
| 765 | ||
| 766 | ||
| 767 | ||
| 768 | ||
| 769 | ||
| 770 | ||
| 771 | ||
| 772 | ||
| 773 | ||
| 774 | ||
| 775 | Body | |
| 776 | ||
| 777 | ||
| 778 | ||
| 779 | ||
| 780 | ||
| 781 | ||
| 782 | None | |
| 783 | ||
| 784 | ||
| 785 | ||
| 786 | ||
| 787 | ||
| 788 | ||
| 789 | Response | |
| 790 | Header | |
| 791 | ||
| 792 | ||
| 793 | ||
| 794 | None | |
| 795 | ||
| 796 | ||
| 797 | ||
| 798 | ||
| 799 | ||
| 800 | ||
| 801 | ||
| 802 | Body | |
| 803 | ||
| 804 | ||
| 805 | ||
| 806 | Prescripti onsTO Pres criptionTO | |
| 807 | Required R equired | |
| 808 | ||
| 809 | (See A.1 – Prescript ionsTO) (S ee A.2 – P rescriptio nTO) | |
| 810 | Fault | |
| 811 | On error | |
| 812 | ||
| 813 | (See A.6 – Fault) | |
| 814 | Codes | |
| 815 | ||
| 816 | ||
| 817 | ||
| 818 | 200 | |
| 819 | ||
| 820 | ||
| 821 | Successful retrieval of Tracka ble Prescr iptions | |
| 822 | 400 | |
| 823 | ||
| 824 | ||
| 825 | Fault code s and mess ages: 102 - Applicat ion author ization fa iled 108 - Missing s ession tok en 109 - I nvalid ses sion token 110 - Exp ired sessi on token 1 11 - Inval id user pe rmissions 901 – Auth entication Service E rror 135 – Rx Agreem ent Not Ac cepted Err or 117 – D ata Integr ity Error 99 – Unkno wn Applica tion Error | |
| 826 | Timing and Sequencin g Constrai nts | |
| 827 | An enterpr ise sessio n token mu st exist w ithin the VAMF for t he client. If a toke n does not exist or has expire d the busi ness logic within th e Rx Refil l client w ill make a call to i nitiate a new sessio n and stor e both the enterpris e token an d expirati on timesta mp within the client session. See Enterp rise Sessi on. | |
| 828 | Prescripti on (Rx) Tr acking Det ail | |
| 829 | Interface Descriptio n | |
| 830 | This RESTf ul interfa ce provide s an endpo int within the VAMF for retrie ving presc ription tr acking det ail from t he Enterpr ise Rx Ref ill and Tr acking Ser vice curre ntly being provided by the My HealtheVet Product D evelopment team. The endpoint provides a n adapter to the Ent erprise se rvice. The endpoint expects an enterpris e token fr om the cli ent in ord er to make a success ful call t o the Ente rprise Rx Refill and Tracking Service. A ll VAMF Rx Refill Se rvice endp oints are protected by VAMF se curity in the form o f an oAuth token so that it ca n only be called by VAMF authe ntication users. Fig ure 7: VAM F Rx Refil l Prescrip tion Track ing Detail Sequence Flow | |
| 831 | Specificat ion for In formation to be Exch anged | |
| 832 | URI | |
| 833 | HTTP Metho d | |
| 834 | Produces | |
| 835 | Source of Data | |
| 836 | /v2/patien t/prescrip tion/track ing/{rxId} | |
| 837 | GET | |
| 838 | applicatio n/json | |
| 839 | Enterprise Rx Refill and Track ing Servic e | |
| 840 | Table 6: P rescriptio n Tracking Detail- S pecificati on for Inf ormation t o be Excha nged | |
| 841 | Request | |
| 842 | Header | |
| 843 | ||
| 844 | ||
| 845 | ||
| 846 | ||
| 847 | ||
| 848 | ||
| 849 | Content-ty pe | |
| 850 | ||
| 851 | Required | |
| 852 | ||
| 853 | ||
| 854 | ||
| 855 | applicatio n/json | |
| 856 | Accept | |
| 857 | ||
| 858 | Required | |
| 859 | ||
| 860 | ||
| 861 | ||
| 862 | applicatio n/json | |
| 863 | Authorizat ion | |
| 864 | ||
| 865 | Required | |
| 866 | ||
| 867 | ||
| 868 | ||
| 869 | Value is B earer <spa ce> "VAMF oAuth Toke n" (Key:Au thorizatio n Value:Be arer "toke n") | |
| 870 | Token | |
| 871 | ||
| 872 | Required | |
| 873 | ||
| 874 | ||
| 875 | ||
| 876 | Enterprise Session T oken | |
| 877 | ||
| 878 | ||
| 879 | ||
| 880 | ||
| 881 | ||
| 882 | ||
| 883 | ||
| 884 | Parameters | |
| 885 | ||
| 886 | ||
| 887 | ||
| 888 | ||
| 889 | ||
| 890 | ||
| 891 | rxId | |
| 892 | ||
| 893 | Required | |
| 894 | ||
| 895 | ||
| 896 | ||
| 897 | Prescripti on Id to b e used to return tra cking info rmation | |
| 898 | ||
| 899 | ||
| 900 | ||
| 901 | ||
| 902 | ||
| 903 | ||
| 904 | ||
| 905 | Body | |
| 906 | ||
| 907 | ||
| 908 | ||
| 909 | ||
| 910 | ||
| 911 | ||
| 912 | None | |
| 913 | ||
| 914 | ||
| 915 | ||
| 916 | ||
| 917 | ||
| 918 | ||
| 919 | Response | |
| 920 | Header | |
| 921 | ||
| 922 | ||
| 923 | ||
| 924 | None | |
| 925 | ||
| 926 | ||
| 927 | ||
| 928 | ||
| 929 | ||
| 930 | ||
| 931 | ||
| 932 | Body | |
| 933 | ||
| 934 | ||
| 935 | ||
| 936 | TrackingIn foDetailsT O Tracking InfoTO Oth erPrescrip tionsInclu ded Fault | |
| 937 | Required R equired Re quiredOn E rror | |
| 938 | ||
| 939 | (See A.3. – Tracking InfoDetail sTO) (See A.4. – Tra ckingInfoT O) (See A. 5. – Presc riptionLit eTO) (See A.6. – Fau lt) | |
| 940 | ||
| 941 | ||
| 942 | ||
| 943 | ||
| 944 | Codes | |
| 945 | ||
| 946 | ||
| 947 | ||
| 948 | 200 | |
| 949 | ||
| 950 | ||
| 951 | Successful retrieval of Tracki ng Informa tion | |
| 952 | 400 | |
| 953 | ||
| 954 | ||
| 955 | Fault code s and mess ages: 102 - Applicat ion author ization fa iled 108 - Missing s ession tok en 109 - I nvalid ses sion token 110 - Exp ired sessi on token 1 11 - Inval id user pe rmissions 901 – Auth entication Service E rror 136 – The User is not the owner of the prescr iption 138 – Prescri ption Not Found 99 – Unknown A pplication Error | |
| 956 | Timing and Sequencin g Constrai nts | |
| 957 | An enterpr ise sessio n token mu st exist w ithin the VAMF for t he client. If a toke n does not exist or has expire d the busi ness logic within th e Rx Refil l client w ill make a call to i nitiate a new sessio n and stor e both the enterpris e token an d expirati on timesta mp within the client session. See Enterp rise Sessi on. | |
| 958 | Medication Refill Re quest | |
| 959 | Interface Descriptio n | |
| 960 | This RESTf ul interfa ce provide s an endpo int within the VAMF for retrie ving succe ssful Medi cation Ref ill reques ts from wi thin the V AMF. This endpoint w ill provid e metrics for the nu mber of su ccessful r equests re turned and metadata relating t o criteria sent to t he service via HTTP Headers to help refi ne the dat a. All VAM F Rx Refil l Service endpoints are protec ted by VAM F security in the fo rm of an o Auth token so that i t can only be called by VAMF a uthenticat ion users. Figure 9 : VAMF Rx Refill Med ication Re fill Reque st Sequenc e Flow | |
| 961 | Specificat ion for In formation to be Exch anged | |
| 962 | URI | |
| 963 | HTTP Metho d | |
| 964 | Produces | |
| 965 | Source of Data | |
| 966 | /v2/patien t/prescrip tion/refil lrequests | |
| 967 | GET | |
| 968 | applicatio n/json | |
| 969 | VAMF Medic ation Refi ll Request Datastore | |
| 970 | Table 7: M edication Refill Req uest Track ing - Spec ification for Inform ation to b e Exchange d | |
| 971 | Request | |
| 972 | Header | |
| 973 | ||
| 974 | ||
| 975 | ||
| 976 | ||
| 977 | ||
| 978 | ||
| 979 | Content-ty pe | |
| 980 | ||
| 981 | Required | |
| 982 | ||
| 983 | ||
| 984 | ||
| 985 | applicatio n/json | |
| 986 | Accept | |
| 987 | ||
| 988 | Required | |
| 989 | ||
| 990 | ||
| 991 | ||
| 992 | applicatio n/json | |
| 993 | Authorizat ion | |
| 994 | ||
| 995 | Required | |
| 996 | ||
| 997 | ||
| 998 | ||
| 999 | Value is B earer <spa ce> "VAMF oAuth Toke n" (Key:Au thorizatio n Value:Be arer "toke n") | |
| 1000 | patientId | |
| 1001 | ||
| 1002 | Optional | |
| 1003 | ||
| 1004 | ||
| 1005 | ||
| 1006 | String, re flecting t he patient Id that th e data sho uld be fil tered by. | |
| 1007 | assigningA uthority | |
| 1008 | ||
| 1009 | Optional | |
| 1010 | ||
| 1011 | ||
| 1012 | ||
| 1013 | String, re flecting t he assigni ngAuthorit y that the data shou ld be filt ered by. | |
| 1014 | startDate | |
| 1015 | ||
| 1016 | Optional | |
| 1017 | ||
| 1018 | ||
| 1019 | ||
| 1020 | String in the form o f a RFC112 3 Date, re flecting t he startDa te that th e data sho uld be fil tered by. | |
| 1021 | endDate | |
| 1022 | ||
| 1023 | Optional | |
| 1024 | ||
| 1025 | ||
| 1026 | ||
| 1027 | String in the form o f a RFC112 3 Date, re flecting t he endDate that the data shoul d be filte red by. | |
| 1028 | count | |
| 1029 | ||
| 1030 | Optional | |
| 1031 | ||
| 1032 | ||
| 1033 | ||
| 1034 | Boolean, r eflecting if the dat a being re turned sho uld be cou nted to re turn a tot al of reco rds based on the fil tering cri teria. | |
| 1035 | ||
| 1036 | ||
| 1037 | ||
| 1038 | ||
| 1039 | ||
| 1040 | ||
| 1041 | ||
| 1042 | Parameters | |
| 1043 | ||
| 1044 | ||
| 1045 | ||
| 1046 | ||
| 1047 | ||
| 1048 | ||
| 1049 | None | |
| 1050 | ||
| 1051 | ||
| 1052 | ||
| 1053 | ||
| 1054 | ||
| 1055 | ||
| 1056 | ||
| 1057 | ||
| 1058 | ||
| 1059 | ||
| 1060 | ||
| 1061 | ||
| 1062 | ||
| 1063 | Body | |
| 1064 | ||
| 1065 | ||
| 1066 | ||
| 1067 | ||
| 1068 | ||
| 1069 | ||
| 1070 | None | |
| 1071 | ||
| 1072 | ||
| 1073 | ||
| 1074 | ||
| 1075 | ||
| 1076 | ||
| 1077 | Response | |
| 1078 | Header | |
| 1079 | ||
| 1080 | ||
| 1081 | ||
| 1082 | None | |
| 1083 | ||
| 1084 | ||
| 1085 | ||
| 1086 | ||
| 1087 | ||
| 1088 | ||
| 1089 | ||
| 1090 | Body | |
| 1091 | ||
| 1092 | ||
| 1093 | ||
| 1094 | Medication RefillRequ est | |
| 1095 | Optional | |
| 1096 | ||
| 1097 | (See A.7. – Medicati onRefillRe quest) | |
| 1098 | Medication Refills | |
| 1099 | Optional | |
| 1100 | ||
| 1101 | (See A.8. – Medicati onRefills) | |
| 1102 | Count | |
| 1103 | Optional | |
| 1104 | ||
| 1105 | Integer re presenting the count of the nu mber of su ccessful r efill requ ests compl eted withi n the VAMF applicati on given a ny filteri ng criteri a (patient Id,startDa te, or end Date) | |
| 1106 | Fault | |
| 1107 | On Error | |
| 1108 | ||
| 1109 | (See A.6. – Fault) | |
| 1110 | ||
| 1111 | ||
| 1112 | ||
| 1113 | ||
| 1114 | Codes | |
| 1115 | ||
| 1116 | ||
| 1117 | ||
| 1118 | 200 | |
| 1119 | ||
| 1120 | ||
| 1121 | Successful return of a count, Medication Refills, o r Medicati onRefillRe quest | |
| 1122 | 400 | |
| 1123 | ||
| 1124 | ||
| 1125 | Fault code s and mess ages: 102 - Applicat ion author ization fa iled 108 - Missing s ession tok en 109 - I nvalid ses sion token 110 - Exp ired sessi on token 1 11 - Inval id user pe rmissions 901 – Auth entication Service E rror 136 – The User is not the owner of the prescr iption 138 – Prescri ption Not Found 99 – Unknown A pplication Error | |
| 1126 | Timing and Sequencin g Constrai nts | |
| 1127 | The endpoi nt is prot ected by V AMF securi ty in the form of an oAuth tok en so that it can on ly be call ed by VAMF authentic ation user s. A token must be p resent in order to m ake calls to this en dpoint. | |
| 1128 | Rx Refill Directory Resources | |
| 1129 | Interface Descriptio n | |
| 1130 | This RESTf ul interfa ce provide s an endpo int within the VAMF for retrie ving a lis t of avail able endpo ints withi n the Rx R efill grou p of web s ervice res ources. A list of At om-standar d links wi ll be retu rned. All VAMF Rx Re fill Resou rce Servic es are pro tected by VAMF secur ity in the form of a n oAuth to ken so tha t it can o nly be cal led by VAM F authenti cation use rs. | |
| 1131 | Specificat ion for In formation to be Exch anged | |
| 1132 | URI | |
| 1133 | HTTP Metho d | |
| 1134 | Produces | |
| 1135 | Source of Data | |
| 1136 | /v2/public /resource- directory | |
| 1137 | GET | |
| 1138 | applicatio n/json | |
| 1139 | VAMF Rx Re fill web s ervice | |
| 1140 | Table 8: R x Refill D irectory R esources - Specifica tion for I nformation to be Exc hanged | |
| 1141 | Request | |
| 1142 | Header | |
| 1143 | ||
| 1144 | ||
| 1145 | ||
| 1146 | ||
| 1147 | ||
| 1148 | ||
| 1149 | Content-ty pe | |
| 1150 | ||
| 1151 | Required | |
| 1152 | ||
| 1153 | ||
| 1154 | ||
| 1155 | applicatio n/json | |
| 1156 | Accept | |
| 1157 | ||
| 1158 | Required | |
| 1159 | ||
| 1160 | ||
| 1161 | ||
| 1162 | applicatio n/json | |
| 1163 | Authorizat ion | |
| 1164 | ||
| 1165 | Required | |
| 1166 | ||
| 1167 | ||
| 1168 | ||
| 1169 | Value is B earer <spa ce> "VAMF oAuth Toke n" (Key:Au thorizatio n Value:Be arer "toke n") | |
| 1170 | ||
| 1171 | ||
| 1172 | ||
| 1173 | ||
| 1174 | ||
| 1175 | ||
| 1176 | ||
| 1177 | Parameters | |
| 1178 | ||
| 1179 | ||
| 1180 | ||
| 1181 | ||
| 1182 | ||
| 1183 | ||
| 1184 | None | |
| 1185 | ||
| 1186 | ||
| 1187 | ||
| 1188 | ||
| 1189 | ||
| 1190 | ||
| 1191 | ||
| 1192 | ||
| 1193 | ||
| 1194 | ||
| 1195 | ||
| 1196 | ||
| 1197 | ||
| 1198 | Body | |
| 1199 | ||
| 1200 | ||
| 1201 | ||
| 1202 | ||
| 1203 | ||
| 1204 | ||
| 1205 | None | |
| 1206 | ||
| 1207 | ||
| 1208 | ||
| 1209 | ||
| 1210 | ||
| 1211 | ||
| 1212 | Response | |
| 1213 | Header | |
| 1214 | ||
| 1215 | ||
| 1216 | ||
| 1217 | None | |
| 1218 | ||
| 1219 | ||
| 1220 | ||
| 1221 | ||
| 1222 | ||
| 1223 | ||
| 1224 | ||
| 1225 | Body | |
| 1226 | ||
| 1227 | ||
| 1228 | ||
| 1229 | Links | |
| 1230 | Required | |
| 1231 | ||
| 1232 | (See A.11 – Links) | |
| 1233 | ||
| 1234 | ||
| 1235 | ||
| 1236 | ||
| 1237 | Codes | |
| 1238 | ||
| 1239 | ||
| 1240 | ||
| 1241 | 200 | |
| 1242 | ||
| 1243 | ||
| 1244 | Successful retrieval of Links | |
| 1245 | Timing and Sequencin g Constrai nts | |
| 1246 | All VAMF R x Refill 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. A token must be presen t in order to make c alls to th is endpoin t. | |
| 1247 | Capacity a nd Perform ance Requi rements | |
| 1248 | Since this service i s an adapt er that in tegrates e ndpoints b eing provi ded by the Enterpris e Rx Refil l and Trac king Servi ce it was deemed tha t Capacity and Perfo rmance Req uirements would foll ow those p rovided fo r within t he Enterpr ise Rx Ref ill and Tr acking Ser vice Inter face Contr ol Documen t. | |
| 1249 | Requiremen ts for Com munication Protocol Standards Compliance | |
| 1250 | Clients wi ll exchang e informat ion with t he VAMF Rx Refill Se rvice via REST. All endpoints will be ab le to tran smit/recei ve JSON ob jects. Err or recover y and guar anteed del ivery are not part o f the prot ocol. Any unexpected errors mu st be comm unicated u sing REST/ HTTP Error codes and are defin ed within the Respon se Segment s for each endpoint. HTTP can provide co mpression of the inf ormation e xchanged. HTTPS, or more preci sely Secur e Socket L ayer (SSL) / Transpor t Security Layer (TS L), shall be used to provide e ncryption of the inf ormation e xchanged. HTTPS is u sed betwee n the end- user's bro wser and t he web ser ver. The f ollowing c ommunicati on standar ds will be used: RES T, JSON, W ADL, SSL 3 .0, and TL S 1.1. | |
| 1251 | Appendix A - Data El ements | |
| 1252 | Prescripti onsTO | |
| 1253 | Field | |
| 1254 | Type | |
| 1255 | prescripti onList | |
| 1256 | List<Presc riptionTO> | |
| 1257 | failedStat ionList | |
| 1258 | String | |
| 1259 | lastUpdate dTime | |
| 1260 | RFC1123 Da te | |
| 1261 | Prescripti onTO | |
| 1262 | Field | |
| 1263 | Type | |
| 1264 | refillStat us | |
| 1265 | String | |
| 1266 | refillSubm itDate | |
| 1267 | RFC1123 Da te | |
| 1268 | refillDate | |
| 1269 | RFC1123 Da te | |
| 1270 | refillRema ining | |
| 1271 | Integer | |
| 1272 | facilityNa me | |
| 1273 | String | |
| 1274 | isRefillab le | |
| 1275 | Boolean | |
| 1276 | isTrackabl e | |
| 1277 | Boolean | |
| 1278 | prescripti onId | |
| 1279 | Long | |
| 1280 | orderedDat e | |
| 1281 | RFC1123 Da te | |
| 1282 | Quantity | |
| 1283 | Integer | |
| 1284 | expiration Date | |
| 1285 | RFC1123 Da te | |
| 1286 | prescripti onNumber | |
| 1287 | String | |
| 1288 | prescripti onName | |
| 1289 | String | |
| 1290 | dispensedD ate | |
| 1291 | RFC1123 Da te | |
| 1292 | stationNum ber | |
| 1293 | String | |
| 1294 | Notes:refi llStatus: | |
| 1295 | active, de leted, dis continued, discontin uedByProvi der, disco ntinuedEdi t, expired , hold, no nVerified, providerH old, refil linprocess , submitte d, suspend ed, unknow n | |
| 1296 | prescripti onId: | |
| 1297 | MHV RX Id | |
| 1298 | prescripti onNumber: | |
| 1299 | VistA RX N umber | |
| 1300 | ||
| 1301 | ||
| 1302 | TrackingIn foDetailsT O | |
| 1303 | Field | |
| 1304 | Type | |
| 1305 | prescripti onName | |
| 1306 | String | |
| 1307 | prescripti onNumber | |
| 1308 | String | |
| 1309 | facilityNa me | |
| 1310 | String | |
| 1311 | rxInfoPhon eNumber | |
| 1312 | String | |
| 1313 | ndcNumber | |
| 1314 | String | |
| 1315 | lastUpdate dtime | |
| 1316 | RFC1123 Da te | |
| 1317 | trackingIn fo | |
| 1318 | List<Track ingInfoTO> | |
| 1319 | Notes:refi llStatus: | |
| 1320 | VistA RX N umber | |
| 1321 | ||
| 1322 | TrackingIn foTO | |
| 1323 | Field | |
| 1324 | Type | |
| 1325 | shippedDat e | |
| 1326 | RFC1123 Da te | |
| 1327 | deliverySe rvice | |
| 1328 | String | |
| 1329 | trackingNu mber | |
| 1330 | String | |
| 1331 | OtherPresc riptionsIn cluded | |
| 1332 | List<Presc riptionLit eTO> | |
| 1333 | Prescripti onLiteTO | |
| 1334 | Field | |
| 1335 | Type | |
| 1336 | prescripti onName | |
| 1337 | String | |
| 1338 | prescripti onNumber | |
| 1339 | String | |
| 1340 | ndcNumber | |
| 1341 | String | |
| 1342 | stationNum ber | |
| 1343 | String | |
| 1344 | Notes:pres criptionNu mber: | |
| 1345 | VistA RX N umber | |
| 1346 | ||
| 1347 | Fault | |
| 1348 | Field | |
| 1349 | Type | |
| 1350 | developerM essage | |
| 1351 | String | |
| 1352 | errorCode | |
| 1353 | Integer | |
| 1354 | message | |
| 1355 | String | |
| 1356 | Medication RefillRequ est | |
| 1357 | Field | |
| 1358 | Type | |
| 1359 | patientId | |
| 1360 | String | |
| 1361 | assigningA uthority | |
| 1362 | String | |
| 1363 | prescripti onId† | |
| 1364 | String | |
| 1365 | requestDat e | |
| 1366 | RFC1123 Da te | |
| 1367 | appSource | |
| 1368 | String | |
| 1369 | docCreated Date | |
| 1370 | RFC1123 Da te | |
| 1371 | docUpdated Date | |
| 1372 | RFC1123 Da te | |
| 1373 | †prescript ionId from which the prescript ion was su bmitted to be refill ed using t he Enterpr ise RxRefi ll and Tra cking API. | |
| 1374 | ||
| 1375 | Medication Refills | |
| 1376 | Field | |
| 1377 | Type | |
| 1378 | medication Refills | |
| 1379 | List<Medic ationRefil lRequest> | |
| 1380 | Enterprise SessionMgm tTO | |
| 1381 | Field | |
| 1382 | Type | |
| 1383 | token | |
| 1384 | String | |
| 1385 | expiresDat e | |
| 1386 | RFC1123 Da te | |
| 1387 | Link | |
| 1388 | Field | |
| 1389 | Type | |
| 1390 | rel | |
| 1391 | String | |
| 1392 | href | |
| 1393 | String | |
| 1394 | Links | |
| 1395 | Field | |
| 1396 | Type | |
| 1397 | Links | |
| 1398 | List<Link> | |
| 1399 |
Araxis Merge (but not the data content of this report) is Copyright © 1993-2016 Araxis Ltd (www.araxis.com). All rights reserved.