Tags

Getting Started with VX's REST API

Introduction

The VistA Exchange (VX) Application Program Interface (API) is a rich API that provides interconnections to the VistA medical record system.

Getting Started


Authentication - Logging On

The first step to being able to use and exercise the variety of REST messages available via the VX-API is to authenticate to the system. This authentication is passed through the API to VistA, validated, then the response is generated back to the caller.

The first step is usually to authenticate to the system with one of the Test User Accounts. This creates a user session. See POST - authentication-authentication to understand how the login system works for VX and explore it interactively. The ability to ask VX for a list of hospital sites or basically list of VistA servers is GET - authentication/list - list VistA servers aka hospitals and requires no credentials.


User - Who's Who and What

Now that you have logged into the system, it can be handy to know what the user account has access to in the system and at a per-patient basis. Can the logged-in user read and write lab data or only read it (roles)? Who else has an account and what are their roles?

See User to experiment with and understand the role of user roles and various user information in the VistA system.


Related





Comments

/groups/vx/search/index.rss?sort=modifiedDate&sortDirection=reverse&tag=codelist/groups/vx/search/?sort=modifiedDate&sortDirection=reverse&tag=codeSource Code SamplesCustomTagSidebarCustomTagSidebar?sort=modifiedDate&sortDirection=reverse&tag=code0/groups/vx/sidebar/CustomTagSidebarmodifiedDate5CustomTagSidebarreversecodeSource Code Samplescustom/groups/vx/search/index.rss?tag=hotlist/groups/vx/search/?tag=hotWhat’s HotHotListHot!?tag=hot2/groups/vx/sidebar/HotListAdded tag - apivaphscernibBill Cerniuk2016-07-15 19:52:19+00:002016-07-15 19:52:19addTag43vaphscernibBill Cerniuk2016-07-15 19:49:38+00:002016-07-15 19:49:38updated42vaphscernibBill Cerniuk2016-07-15 19:47:10+00:002016-07-15 19:47:10updated41vaphscernibBill Cerniuk2016-07-09 15:52:05+00:002016-07-09 15:52:05updated40vaphscernibBill Cerniuk2016-07-08 22:32:33+00:002016-07-08 22:32:33updated39updated ObjC code samplemadminmadmin2016-05-18 13:55:04+00:002016-05-18 13:55:04updated38madminmadmin2016-05-18 13:54:00+00:002016-05-18 13:54:00updated37updated the swift codemadminmadmin2016-05-18 13:51:41+00:002016-05-18 13:51:41updated36madminmadmin2016-04-28 20:00:36+00:002016-04-28 20:00:36updated35vaphscernibBill Cerniuk2016-02-27 02:12:04+00:002016-02-27 02:12:04updated34vaphscernibBill Cerniuk2016-02-27 02:10:35+00:002016-02-27 02:10:35updated33vaphscernibBill Cerniuk2016-02-27 02:01:46+00:002016-02-27 02:01:46updated32vaphscernibBill Cerniuk2016-02-27 01:53:55+00:002016-02-27 01:53:55updated31vaphscernibBill Cerniuk2016-02-27 01:46:46+00:002016-02-27 01:46:46updated30vaphscernibBill Cerniuk2016-02-27 01:41:47+00:002016-02-27 01:41:47updated29vaphscernibBill Cerniuk2016-02-27 01:41:27+00:002016-02-27 01:41:27updated28vaphscernibBill Cerniuk2016-02-27 01:41:09+00:002016-02-27 01:41:09updated27Added tag - operationvaphscernibBill Cerniuk2016-02-27 01:39:41+00:002016-02-27 01:39:41addTag26vaphscernibBill Cerniuk2016-02-27 01:07:12+00:002016-02-27 01:07:12updated25vaphscernibBill Cerniuk2016-02-27 01:06:41+00:002016-02-27 01:06:41updated24vaphscernibBill Cerniuk2016-02-27 01:05:47+00:002016-02-27 01:05:47updated23Added tag - authenticationvaphscernibBill Cerniuk2016-02-27 01:03:46+00:002016-02-27 01:03:46addTag22vaphscernibBill Cerniuk2016-02-27 01:03:23+00:002016-02-27 01:03:23updated21Added tag - hotvaphscernibBill Cerniuk2016-02-27 00:59:44+00:002016-02-27 00:59:44addTag20vaphscernibBill Cerniuk2016-02-22 13:40:25+00:002016-02-22 13:40:25updated19vaphscernibBill Cerniuk2016-02-22 13:39:54+00:002016-02-22 13:39:54updated18vaphscernibBill Cerniuk2016-02-22 13:39:36+00:002016-02-22 13:39:36updated17vaphscernibBill Cerniuk2016-02-22 13:11:54+00:002016-02-22 13:11:54updated16vaphscernibBill Cerniuk2016-02-22 02:55:45+00:002016-02-22 02:55:45updated15vaphscernibBill Cerniuk2016-02-22 02:55:37+00:002016-02-22 02:55:37updated14vaphscernibBill Cerniuk2016-02-22 02:55:08+00:002016-02-22 02:55:08updated13vaphscernibBill Cerniuk2016-02-22 02:53:51+00:002016-02-22 02:53:51updated12vaphscernibBill Cerniuk2016-02-22 02:50:32+00:002016-02-22 02:50:32updated11vaphscernibBill Cerniuk2016-02-22 02:43:28+00:002016-02-22 02:43:28updated10vaphscernibBill Cerniuk2016-02-22 02:43:03+00:002016-02-22 02:43:03updated9vaphscernibBill Cerniuk2016-02-22 02:42:15+00:002016-02-22 02:42:15updated8vaphscernibBill Cerniuk2016-02-22 02:32:40+00:002016-02-22 02:32:40updated7vaphscernibBill Cerniuk2016-02-22 02:30:41+00:002016-02-22 02:30:41updated6madminmadmin2016-01-23 12:27:25+00:002016-01-23 12:27:25updated5madminmadmin2016-01-23 12:21:15+00:002016-01-23 12:21:15updated4madminmadmin2016-01-13 19:14:14+00:002016-01-13 19:14:14updated3madminmadmin2016-01-13 18:59:22+00:002016-01-13 18:59:22updated2First createdmadminmadmin2016-01-13 18:59:09+00:002016-01-13 18:59:09created1wiki2016-07-15T19:49:38+00:00groups/vx/wiki/37ac2FalsePOST - authentication - authentication/groups/vx/wiki/37ac2/POST__authentication__authentication.htmlBill Cerniuk43 updatesPOST - authentication - authentication Description The Authenticate message creates a user session which opens access to the VistA system for the permissions associated...Falsevaphscernib2016-07-15T19:49:38+00:00madminmadmin2016-04-28 20:09:41+00:002016-04-28 20:09:41updated11vaphscernibBill Cerniuk2016-02-27 01:56:16+00:002016-02-27 01:56:16updated10vaphscernibBill Cerniuk2016-02-27 01:55:24+00:002016-02-27 01:55:24updated9Added tag - hotmadminmadmin2016-02-27 00:59:34+00:002016-02-27 00:59:34addTag8madminmadmin2016-01-13 19:18:04+00:002016-01-13 19:18:04updated7madminmadmin2016-01-13 15:48:16+00:002016-01-13 15:48:16updated6madminmadmin2016-01-11 22:23:11+00:002016-01-11 22:23:11updated5madminmadmin2016-01-11 22:21:23+00:002016-01-11 22:21:23updated4madminmadmin2016-01-11 22:21:01+00:002016-01-11 22:21:01updated3madminmadmin2016-01-11 22:20:31+00:002016-01-11 22:20:31updated2First createdmadminmadmin2016-01-11 21:56:40+00:002016-01-11 21:56:40created1wiki2016-04-28T20:09:41+00:00groups/vx/wiki/0dd9cFalseGetting Started with VX's REST API/groups/vx/wiki/0dd9c/Getting_Started_with_VXs_REST_API.htmlmadmin11 updatesGetting Started with VX's REST API Introduction The VistA Exchange (VX) Application Program Interface (API) is a rich API that provides interconnections to the VistA medical ...Falsemadmin2016-04-28T20:09:41+00:00hot/groups/vx/search/index.rss?sort=modifiedDate&kind=all&sortDirection=reverse&excludePages=wiki/welcomelist/groups/vx/search/?sort=modifiedDate&kind=all&sortDirection=reverse&excludePages=wiki/welcomeRecent ChangesRecentChangesListUpdates?sort=modifiedDate&kind=all&sortDirection=reverse&excludePages=wiki/welcome0/groups/vx/sidebar/RecentChangesListmodifiedDateallRecent ChangesRecentChangesListUpdateswiki/welcomeNo recent changes.reverse5search