Gocodo YourChart Client Documentation

Gocodo YourChart ClientDocumentation

Release 0.1

Gocodo

October 28, 2014

Contents

1 Overview 31.1 Hospitals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.2 Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81.3 API Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

2 Getting Started 112.1 Node.js . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112.2 Objective-C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122.3 .Net . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132.4 Reporting Bugs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

3 Calls 153.1 Authenticate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153.2 AcceptTermsConditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153.3 GetAccountDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153.4 GetBillsAndStatements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153.5 GetEncounter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163.6 GetMessageDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163.7 GetTermsConditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163.8 GetTestDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163.9 ListAlerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163.10 ListAllergies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163.11 ListCurrentHealthIssues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173.12 ListFutureAppointments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173.13 ListHealthAdvisory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173.14 ListImmunizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173.15 ListInbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173.16 ListMedications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173.17 ListMessageRecipients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183.18 ListPatientAccesses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183.19 ListPastAppointments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183.20 ListTestResults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183.21 LogAudit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

4 Models 214.1 Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214.2 AccountDemographics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214.3 Alert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

i

4.4 Allergy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224.5 Appointment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224.6 AppointmentListResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224.7 AttachementSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234.8 AuditLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234.9 Authenticate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234.10 AuthenticateResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234.11 BillSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244.12 BillingAccountDetailsRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244.13 BillingAccountDetailsResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254.14 BillsAndStatementsSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254.15 Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254.16 CurrentHealthIssue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254.17 Diagnosis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264.18 Encounter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264.19 FeatureInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264.20 From . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274.21 HealthAdvisory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274.22 Immunization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274.23 MedicalAdviceSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274.24 Medication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284.25 Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284.26 MessageDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294.27 MessageListResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294.28 MessageViewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304.29 Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304.30 PatientAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304.31 Pharmacy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304.32 Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314.33 RecentPayment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314.34 Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314.35 TestDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324.36 TestListResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324.37 To . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334.38 Vitals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334.39 WPLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334.40 WPMessageRecipient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344.41 WPObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

5 Contribute 355.1 MyChart Test logins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355.2 Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

6 About 376.1 YourChart Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376.2 Gocodo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

7 Indices and tables 39

ii

Gocodo YourChart Client Documentation, Release 0.1

The Gocodo YourChart Client is set of programmatic descriptions and webservice client for Epic’s MyChart Mobileproduct. With this, a programmer can quickly connect to and retrieve the health records on behalf of individuals foruse in applications.

Contents:

Contents 1

https://itunes.apple.com/us/app/mychart/id382952264?mt=8



2 Contents

CHAPTER 1

Overview

The Gocodo YourChart Client is a set of programmatic clients for Epic’s MyChart Mobile product. With this, aprogrammer can quickly connect to and retrieve the health records of an individual. Gocodo YourChart Client currentlysupports connecting to about 250 different hospital systems. A handful of applications that this set of client librariescould be used to create include:

• Creating a Personal Health Record (PHR) application (mobile/ web)

• A Personal Health Record system that aggregates health records across many different hosptial systems

• A way to prove a person is who they say they are and have particular conditions/ go to particular medical systems

• Transfer basic information on individuals going to a new doctor

• Gathering information for a clinical trial

All a developer needs to get started are an individual’s MyChart hosptial location, username, password, and approvalto access their health records.

1.1 Hospitals

The following is a list of health system’s and hospitals that are currently supported by the Gocodo YourChart Client.The main requirement for being supported is that the health system/ hospital has MyChart Mobile enabled for theirdeployment of Epic MyChart.

OrgId Health System/ Hospital Name MyChart Branding412-2 Access Community Health Centers MyChart762 Access Community Health Network myACCESSHEALTH302 Adventist Health MyChart MyHealth691 Akron Children’s MyChart870 Alegent Creighton Health MyChart465 Allina MyChart714 Altru MyHealth688 Anne Arundel MyChart435 Arnett MyChart843 Asante Health System MyChart163 Atrius Health MyHealth443 Austin Regional Clinic MyChart782 Baptist Health MyChart875 Baptist Memorial Health Care Baptist OneCare514-2 Barton Health MyChart

Continued on next page

3



Table 1.1 – continued from previous pageOrgId Health System/ Hospital Name MyChart Branding778 Bassett Healthcare MyBassett Health Connection830-2 The Baton Rouge Clinic MyChart663 Baylor MyChart485 Beaumont myBeaumontChart880 Boston Medical Center BMC MyChart509-3 Broadway MyChart804 Bronson Bronson MyChart883 Brookdale University Hospital and Medical Center MyBrookdale509-2 Buffalo Clinic MyChart317 Buffalo Medical Group MyBMGChart650 Cadence Health MyChart445 Cambridge Health Alliance MyChart600 Carilion MyChart316 Carle MyCarle742 Catholic Health Partners MyChart765-2 GHV-Catskill MyChart612 Cedars-Sinai My CS-Link515 CentraCare MyChart160 Children’s Hospital Colorado MyChart553 Children’s Omaha Children’s Connect815 Children’s Hospital of Wisconsin MyChart871 Children’s Hospital Oakland MyChart655 The Christ Hospital MyChart773 Catholic Health Services of Long Island CHS MyChart565 Cincinnati Children’s MyChart320 Cleveland Clinic MyChart594 Children’s Medical Center Dallas MyChart834 Community Health Network MyChart750 Community Healthcare System MyChart797 Cone Health MyChart Powered by Cone Health578 Cooper MyCooper545 Covenant HealthCare MyChart854 Cheyenne Regional Medical Center MyChart722 Dartmouth myD-H567 Dayton Children’s Hospital MyKidsChart703 Deaconess ViewMyChart.com415-1 Dean Clinic MyChart465-6 District One Hospital MyChart515-2 Douglas County Hospital MyChart342 Dreyer MyChart835 Duke University Health System Duke MyChart206 DuPage Medical Group MyChart265 East Boston Neighborhood Health Center MyChart517-2 East Carolina University Physicians ECU MyChart206-2 Edward Edward MyChart333 Elliot MyEChart343 Essentia Health MyHealth312 Fairview MyChart866 Franciscan Health Services Franciscan MyChart465-1 FirstLight MyChart648 Franciscan Alliance MyChart


4 Chapter 1. Overview


Table 1.1 – continued from previous pageOrgId Health System/ Hospital Name MyChart Branding453 Froedtert MyChart735 Genesis MyChart801 Glens Falls Hospital GFH MyChart465-5 Glencoe Regional Health Services MyChart748 Grady Health System MyChart465-3 Grand Itasca MyChart413 GHC GHCMyChart605 Gundersen Health System MyCare433 Guthrie eGuthrie701 Hackensack UMC MyChart420 HCHD MyHealth795 Hattiesburg Iris471 Hawaii Pacific Health MyHealthAdvantage510 Hennepin MyChart848 Henry Ford Health System Henry Ford MyChart774 Hurley Medical Center MyChart465-4 Hutchinson Health MyChart694 Infirmary MyChart816 Inova Health System MyChart826 John C. Lincoln MyChart842 Johns Hopkins Medicine MyChart789 JPS Health Network JPS MyChart148 Kelsey-Seybold MyKelseyOnline749 Kettering MyChart631 KDMC MyChart569 University of Kansas Hospital MyChart652 Lakeland HealthCare Lakeland Health MyChart538 Lancaster MyLGHealth523 Lee Memorial Health System MyChart671 Legacy Health System MyHealth461 Loyola Medicine MyLoyolaSelect779 LSU MyChart633 MaineHealth MyChart706 Maricopa MyChart786 Martin Memorial MyChart682 Health Ventures MyChart775 MediSys Health Network MediSys MyChart763 Memorial Healthcare System MyChart549 MHS MyChart864 Mercy Medical Center MyChart876 Mercy Health Services MyChart Mercy450 Meriter MyChart530 Metro Health MyChart292 MetroHealth OH MyChart846 Memorial Health MyChart452 Monroe Clinic MyChart850 HCA MyChart658 Mount Sinai Florida MyChart279 MultiCare MyChart824 MUSC Health MyChart456 Aspirus MyAspirus


1.1. Hospitals 5


Table 1.1 – continued from previous pageOrgId Health System/ Hospital Name MyChart Branding306-2 Bellin My Bellin Health590 BonSecours MyBonSecours426 IFH MyChartMyHealth758 Providence Health & Services808 Providence Health & Services802 Providence Health & Services223 Geisinger MyGeisinger343-2 MyHealth Powered by Essentia Health780 Kadlec Kadlec My K-Chart836 Loma Linda My LLU Health498 MemorialCare myChart513 MountSinai My Mount Sinai Chart297 UPenn myPennMedicine791 University of Michigan MyUofMHealth814 UC Health My UC Health525 Nationwide Children’s Hospital MyChart825 The Nebraska Medical Center One Chart | PATIENT321 Nemours MyNemours509 North Memorial MyChart840 North Oaks Health System MyChart431 NorthShore University HealthSystem NorthShoreConnect338 Northwestern Medicine Northwestern Medicine’s MyChart819 Norton Healthcare MyChart798 Novant MyNovant718 NYU Langone MyChart at NYU Langone432 OCHIN MyChart796 Ochsner Health System MyOchsner557 OSU OSUMyChart504 Oregon Health and Science University OHSU MyChart765 GHV-ORMC MyChart596 OSF HealthCare OSF myHealth830-3 Our Lady of the Lake MyChart851 Overlake ONE Chart781 Owensboro MyChart720 Pacific Medical Center MyChart675 Park Nicollet MyChart300 Parkland MyChart838 Parkview Health MyChart853 PeaceHealth PatientConnection425 Ascension - Providence HealthCare Network MyChart839 Piedmont Healthcare MyChart512-2 Polyclinic MyChart494 Premier Health Partners MyChart792 ProHealth Care MyChart805 Provena MyChart637 Rady Children’s MyChart at Rady Children’s844 Reading Health System MyChart511 Reliant Medical Group MyChart514 Renown MyChart787 Resurrection Health Care MyChart515-4 Rice Memorial Hospital MyChart




Table 1.1 – continued from previous pageOrgId Health System/ Hospital Name MyChart Branding771 Riverside Medical Clinic My Healthy Connection436 Riverbend Medical Group MyChart772 Rochester General MyCare756 Rockford Health System RHS MyChart294 Rush University Medical Center MyChart442 TMC Saguaro Physicians MyChart516 Salem MyChart849 Samaritan Health Services MyChart856 Scott & White Healthcare MyChart507 Sanford My Sanford Chart785 Sansum MyChart855 Santa Clara MyHealth Online645 Sisters of Charity of Leavenworth Health System MyChart531 Sentara Sentara MyChart822 Singing River Health System MyChart804-2 South Haven Health System MyChart684 Sparrow Health System MySparrow648-2 Specialty Physicians of Illinois MyChart618-1 SSM Health Care MyChart618 SSM MyChart618-2 St. Anthony MyChart680 St Anthony’s Medical Center MyChart541 Stanford MyHealth857 Stanford Children’s Health MyChart465-7 St. Croix Regional Medical Center MyChart830 St. Elizabeth MyChart712 St. Elizabeth Healthcare MyChart618-3 St. Francis MyChart888 Saint Francis Health System MyChart891 St Joseph’s Hospital Health Center My St. Joseph’s799 St. Luke’s MyChart845 St Luke’s Health System MyChart441 HSHS and Prevea Health MyPrevea768 Stormont Vail Health Care MyChart278 Sutter Health My Health Online512 Swedish MyChart428 Talbert TMG4ME761 Tampa General Hospital MyChart660 TempleHealth myTempleHealth551 Texas Children’s MyChart491 THR MyCare306 Thedacare MyThedaCare410 CHOP MyChart584 The Everett Clinic MyChart759 The Vancouver Clinic MyChart@TVC821 The Portland Clinic MyChart515-3 Tri-County Health Care MyChart319 TriHealth MyChart832 Trinity Mother Frances MyChart865 University of Arkansas for Medical Sciences MyChart451 UC Davis MyChart


1.1. Hospitals 7

mailto:MyChart@TVC


Table 1.1 – continued from previous pageOrgId Health System/ Hospital Name MyChart Branding806 UCLA Medical Center myUCLAhealth502 UCSD MyUCSDChart166 UCSF677 University of Florida MyChart882 UNC Health Care My UNC Chart465-2 United Family Medicine MyChart790 UnityPoint Health MyUnityPoint859 University of Arizona Health Network MyChart755 University of Colorado Hospital My Health Connection810 UHCS UHMyChart779-2 University Health University Health MyChart434 University Hospital MyChart592 UIHC MyChart784 University of Mississippi Medical Center MyChart555 University of Maryland Medical System MyPortfolio747 University of Miami MyUHealthChart303 University of Utah737 University of Virginia MyChart UVA312-2 University of Minnesota MyChart261 UPMC MyUPMC753 SUNY MyChart751 University of Rochester MyChart477 UTMB MyChart582 UT Medicine San Antonio MyChart408 UTSW MyChart412 UW Health MyChart255 UW Medicine eCare817 Valley Medical Center MyChart517 Vidant Health Vidant Health MyChart823 Wake Forest myWakeHealth409 Weill Cornell Weill Cornell Physicians863 WellStar WellStar MyChart879 Wellmont Health System MyWellmont764 Wenatchee Valley MyChart563 West Virginia University MyWVUChart827 Wheaton Franciscan MyChart788 Washington Hospital Health System WmyChart415-2 Wildwood Family Clinic MyChart800 Yale New Haven Health/Yale Medical Group MyChart665 Yuma MyCare

1.2 Data

A wide array of different types of patient data are available through the use of the Gocodo YourChart Client. Forexample:

• Immunization history

• Allergies

• Lab results



• Current medications

• Patient facing notes, orders, diagnosis, and medications from a medical encounter (such as a preventative visit)

• Lab results

• Current problems list

This data is made available by hospitals by the MyChart Mobile webservice. Given a location, a username, and apassword, and a patients permission, a developer can fetch all of the above information. See the Models section for amore complete description of the data made available.

1.3 API Clients

To make it easier for software developers to get quick and secure access to patient records, API clients have beenprovided for use by Gocodo under an MIT license. Please contact Michael Wasser at Gocodo for access to the APIclients. Currently, the API client is written in the following languages:

• Javascript with Node.js

• .Net

• Objective-C

If you would like support for additional languages, please contact Michael Wasser at Gocodo. Writing additionalclients are relatively strait forward and can generally be completed in less than two days.

1.3. API Clients 9

http://about.me/mwasser




CHAPTER 2

Getting Started

To get started, you’ll first need access to the API Client of your choice’s source code. To get access to the source, pleasecontact Michael Wasser at Gocodo. Once you have access, you will be able to use the language specific documentationalong with the documentation in the Calls and Models sections to connect to and interact with patient records.

2.1 Node.js

The Gocodo YourChart Client is available as a Node.js npm package. For access to the source, contact Michael Wasser.

Once installed, the package can be include via

var YourChartClient = require(’yourchart’)

To create a client, use

var client = new YourChartClient(’<Epic MyChart Username>’, ’<Epic MyChart Password>’, ’<Epic-specified Organization ID>’)

To get an organizations id, you can programatically access an array of all known sites usingYourChartClient.sites. Each site will have an orgId which tells the client where to fetch healthrecords from. Each object in the sites array looks like the following example:

{serviceUrl: ’https://mychart.swedish.org/MyChartWeb/Wcf/Epic.MyChartMobile/MyChartMobile.svc/’,name: ’Swedish’,orgId: ’512’,myChartBranding: ’MyChart’,myChartUserLabel: ’Username’,locations: [ ’Washington’ ],timezone: ’America/Los_Angeles’

}

Once a client is initialized, any of the listed Calls can be used to access patient information. In the node.js client, thenames of calls and the properties listed in the resulting Models will be camel-cased versions of themselves. E.g. Thecall documented as ListPastAppointments becomes listPastAppointments in the node.js client. Foreach call, the first paramenter will be a hash of both request parameters (key would be the name of the parameter)as well as the request model (key would be requestModel). The second parameter will be a callback with a firstparameter communicating error conditions if they exist and null otherwise, and a second parameter with the request’sresponse model. For example, a call to getAccountDetails may look as follows:

client.getAccountDetails({request_model: {billingAccountId: "<account id>",

11




billingAccountType: <account type>}

}, function (err, response) {if (err) return console.log(’Something bad happened!’);

if (response.isPaperless) {console.log("User receives paperless statements!");

}});

Calls to authenticate will be automatically made during the first call and its results will be stored inauthenticateResponse on the current instance of the client. Manual calls to authenticate will also authorize theclient/ store the results for future calls.

Putting it all together:

var YourChartClient = require(’yourchart’),orgId, client;

// Fetch the orgId of SwedishorgId = YourChartClient.sites.filter(function (elm) { return elm.name == ’Swedish’; })[0];

// Create a client with a MyChart user’s credentialsclient = new YourChartClient(’<Swedish MyChart username>’, ’<Swedish MyChart password>’, orgId);

// Fetch a list of past appointmentsclient.listPastAppointments({identifier: 0, index: 0}, function (err, data) {

if (err) return console.log(err.stack);

console.log("Past Appointments:");console.log("==================");

// Display results of listing past appointmentsconsole.dir(data);

if (typeof data.appointmentList !== undefined && data.appointmentList.length > 0) {var appointmentID = data.appointmentList[0].dat;

// Get details for a specific appointmentepicClient.getEncounter({identifier: 0, appointment_dat: appointmentID}, function (err, data) {if (err) return console.log(err.stack);

console.log("");console.log("First Past Appointment Details:");console.log("===============================");

// Display specific appointment detailsconsole.dir(data);

});}

});

2.2 Objective-C

TODO: Write

12 Chapter 2. Getting Started


2.3 .Net

TODO: Write

2.4 Reporting Bugs

If you come across a bug in the Gocodo YourChart Client, please report the bug at Gocodo YourChart or submit a pullrequest. If you don’t have access to the project, please contact Michael Wasser.

2.3. .Net 13

https://github.com/gocodo/epic-client-generator/issues

https://about.me/mwasser


14 Chapter 2. Getting Started

CHAPTER 3

Calls

Each call bellow will send a web request to the previously selected hospital system. For more information on creatinga client and using the given calls, see the client specific documentation (e.g. the node.js client).

3.1 Authenticate

TODO: Write this

Request Model: AuthenticateResponse Model: AuthenticateResponse

3.2 AcceptTermsConditions

TODO: Write this

3.3 GetAccountDetails

Used to get an individuals’ billing and demographic information. Data for the request model can be found on one ofthe Account included in the response from GetBillsAndStatements.

Request Model: BillingAccountDetailsRequestResponse Model: BillingAccountDetailsResponse

3.4 GetBillsAndStatements

TODO: Write this

Response Model: BillsAndStatementsSummary

15


3.5 GetEncounter

TODO: Write this

Response Model: Encounter

3.6 GetMessageDetail

TODO: Write this

Response Model: MessageDetail

3.7 GetTermsConditions

TODO: Write this

3.8 GetTestDetail

TODO: Write this

Response Model: TestDetail

3.9 ListAlerts

TODO: Write this

Response Model: Array of Alert

3.10 ListAllergies

TODO: Write this

Response Model: Array of Allergy

16 Chapter 3. Calls


3.11 ListCurrentHealthIssues

TODO: Write this

Response Model: Array of CurrentHealthIssue

3.12 ListFutureAppointments

TODO: Write this

Response Model: AppointmentListResult

3.13 ListHealthAdvisory

TODO: Write this

Response Model: Array of HealthAdvisory

3.14 ListImmunizations

TODO: Write this

Response Model: Array of Immunization

3.15 ListInbox

TODO: Write this

Response Model: MessageListResult

3.16 ListMedications

TODO: Write this

Response Model: Array of Medication

3.11. ListCurrentHealthIssues 17


3.17 ListMessageRecipients

TODO: Write this

Response Model: MedicalAdviceSettings

3.18 ListPatientAccesses

TODO: Write this

Response Model: Array of PatientAccess

3.19 ListPastAppointments

TODO: Write this

Response Model: AppointmentListResult

3.20 ListTestResults

TODO: Write this

Response Model: TestListResult

3.21 LogAudit

TODO: Write this

Request Model: AuditLogResponse Model: Boolean

In addition to the calls listed above, support could be theoretically added for any feature seen in MyChart Mobile.Here’s a list of calls known to exist at some hospitals that are currently unsupported by Gocodo Epic Client:

• Schedule Appointment

• Send Message (to a doctor, nurse, etc)

• Get Imaging Results

• Request Medication Refill

18 Chapter 3. Calls


If are working with a site that supports any of the above features and would like to see support added, please lookhere.

3.21. LogAudit 19


20 Chapter 3. Calls

CHAPTER 4

Models

Each model bellow is used in one or more calls. For more information on how to fetch the models using a specificclient, see the client specific documentation (e.g. the node.js client).

4.1 Account

TOOD: Write description

Property Type DescriptionId String TODO: Write descriptionPatientName String TODO: Write descriptionServiceAreaId String TODO: Write descriptionServiceAreaName String TODO: Write description

Used in models

• BillSummary

4.2 AccountDemographics


Property Type DescriptionPatientName String TODO: Write descriptionAddress Array of String TODO: Write descriptionHomePhone String TODO: Write descriptionWorkPhone String TODO: Write description

Used in models

• BillingAccountDetailsResponse

4.3 Alert


21


Property Type DescriptionCount Integer TODO: Write descriptionKey String TODO: Write descriptionType String TODO: Write description

4.4 Allergy


Property Type DescriptionName String TODO: Write descriptionDate DateTime TODO: Write descriptionReactions Array of String TODO: Write description

4.5 Appointment


Property Type DescriptionCancelDirectAllowed Boolean TODO: Write descriptionCancelRequestAllowed Boolean TODO: Write descriptionCancelRequestSent Boolean TODO: Write descriptionIsTimeNull Boolean TODO: Write descriptionConfirmStatus Integer TODO: Write descriptionDat String TODO: Write descriptionDate DateTime TODO: Write descriptionIsClinicalInformationAvailable Boolean TODO: Write descriptionIsEDVisit Boolean TODO: Write descriptionIsSurgery Boolean TODO: Write descriptionPatientInstruction String TODO: Write descriptionProvider Provider TODO: Write descriptionSurgeryTimeOfDay String TODO: Write descriptionVisitType String TODO: Write description

Used in models

• AppointmentListResult

4.6 AppointmentListResult


Property Type DescriptionAppointmentList Array of Appointment TODO: Write descriptionLoadMoreDAT String TODO: Write description

Used in calls

• ListFutureAppointments

• ListPastAppointments

22 Chapter 4. Models


4.7 AttachementSettings


Property Type DescriptionAllowedImageExtensions Array of String TODO: Write descriptionAllowedVideoExtensions Array of String TODO: Write descriptionMaximumAllowed Integer TODO: Write descriptionMaximumImageSize Integer TODO: Write descriptionMaximumVideoSize Integer TODO: Write description

Used in models

• MedicalAdviceSettings

4.8 AuditLog


Property Type DescriptionLogs Array of WPLog TODO: Write descriptionTimeStamp String TODO: Write description

Used in calls

• LogAudit

4.9 Authenticate


Property Type DescriptionUsername String TODO: Write descriptionPassword String TODO: Write description

Used in calls

• Authenticate

4.10 AuthenticateResponse


4.7. AttachementSettings 23


Property Type DescriptionAccountID String TODO: Write descriptionAvailable2011Features Integer TODO: Write descriptionAvailable2012Features Integer TODO: Write descriptionAvailable2013Features Integer TODO: Write descriptionHomeURL String TODO: Write descriptionDeviceTimeout Integer TODO: Write descriptionFeatureInformation FeatureInformation TODO: Write descriptionIsAdmitted Boolean TODO: Write descriptionIsPatient Boolean TODO: Write descriptionName String TODO: Write descriptionReadOnlyServer Boolean TODO: Write descriptionShowTerms String TODO: Write descriptionStatus String TODO: Write descriptionTermsConditions String TODO: Write descriptionTicket String TODO: Write descriptionTicketTimeout Integer TODO: Write description

Used in calls

• Authenticate

4.11 BillSummary


Property Type DescriptionOutstandingBalance String TODO: Write descriptionAcceptPayment Boolean TODO: Write descriptionBillingAccountType Integer TODO: Write descriptionHasNewInfo Boolean TODO: Write descriptionRecentPayment RecentPayment TODO: Write descriptionAccount Account TODO: Write descriptionPaymentPlan String TODO: Write descriptionRecentStatement String TODO: Write description

Used in models

• BillsAndStatementsSummary

4.12 BillingAccountDetailsRequest


Property Type DescriptionBillingAccountId String TODO: Write descriptionBillingAccountType Integer TODO: Write description

Used in calls

• GetAccountDetails



4.13 BillingAccountDetailsResponse


Property Type DescriptionAccountDemographics AccountDemographics TODO: Write descriptionPaymentPlan String TODO: Write descriptionStatements String TODO: Write descriptionIsPaperless Boolean TODO: Write descriptionRecentPayments String TODO: Write descriptionOutstandingBalance String TODO: Write descriptionRecentStatementsEnabled Boolean TODO: Write descriptionUnviewableStatementsAvailable Boolean TODO: Write description

Used in calls

• GetAccountDetails

4.14 BillsAndStatementsSummary


Property Type DescriptionBills Array of BillSummary TODO: Write descriptionPastStatements String TODO: Write descriptionPaperlessStatus Integer TODO: Write descriptionAllowCancelPaperless Boolean TODO: Write description

Used in calls

• GetBillsAndStatements

4.15 Component


Property Type DescriptionComponentComments String TODO: Write descriptionFlag String TODO: Write descriptionHigh String TODO: Write descriptionLow String TODO: Write descriptionName String TODO: Write descriptionRefRange String TODO: Write descriptionUnit String TODO: Write descriptionValue String TODO: Write description

Used in models

• TestDetail

4.16 CurrentHealthIssue


4.13. BillingAccountDetailsResponse 25


Property Type DescriptionDate DateTime TODO: Write descriptionName String TODO: Write description

4.17 Diagnosis


Property Type DescriptionName String TODO: Write descriptionObjectID String TODO: Write description

Used in models

• Encounter

4.18 Encounter


Property Type DescriptionCancelDirectAllowed Boolean TODO: Write descriptionCancelRequestAllowed Boolean TODO: Write descriptionCancelRequestSent Boolean TODO: Write descriptionConfirmStatus String TODO: Write descriptionDat String TODO: Write descriptionDate DateTime TODO: Write descriptionIsClinicalInformationAvailable Boolean TODO: Write descriptionIsEDVisit Boolean TODO: Write descriptionIsSurgery Boolean TODO: Write descriptionIsTimeNull Boolean TODO: Write descriptionPatientInstruction String TODO: Write descriptionProvider Provider TODO: Write descriptionSurgeryTimeOfDay String TODO: Write descriptionVisitType String TODO: Write descriptionAvs_order String TODO: Write descriptionDiagnoses Array of Diagnosis TODO: Write descriptionFollowUpInstructions String TODO: Write descriptionMedications Array of Medication TODO: Write descriptionOrders Array of Order TODO: Write descriptionReasons Array of String TODO: Write descriptionVitals Vitals TODO: Write description

Used in calls

• GetEncounter

4.19 FeatureInformation




Property Type DescriptionAllowRxRefill Boolean TODO: Write descriptionDisabledFeatures Array of String TODO: Write descriptionEnabledFeatures Array of String TODO: Write description

Used in models

• AuthenticateResponse

• PatientAccess

4.20 From


Property Type DescriptionName String TODO: Write descriptionObjectID String TODO: Write descriptionIsPCP Boolean TODO: Write descriptionOOCEndDate DateTime TODO: Write descriptionPCPType String TODO: Write descriptionRecipTemplate String TODO: Write description

Used in models

• Message

• MessageDetail

4.21 HealthAdvisory


Property Type DescriptionDueDate DateTime TODO: Write descriptionDueDateOverride String TODO: Write descriptionLastDoneDate DateTime TODO: Write descriptionName String TODO: Write descriptionStatus String TODO: Write descriptionStatusText String TODO: Write description

4.22 Immunization


Property Type DescriptionDates Array of DateTime TODO: Write descriptionName String TODO: Write description

4.23 MedicalAdviceSettings


4.20. From 27


Property Type DescriptionAttachementSettings AttachementSettings TODO: Write descriptionPoolList String TODO: Write descriptionProviderList Array of WPMessageRecipient TODO: Write descriptionSubjectList Array of WPObject TODO: Write description

Used in calls

• ListMessageRecipients

4.24 Medication


Property Type DescriptionCanRefill Boolean TODO: Write descriptionCommonBrandName String TODO: Write descriptionDiscontinuedDate DateTime TODO: Write descriptionDosageInfo String TODO: Write descriptionEndDate DateTime TODO: Write descriptionExpiration String TODO: Write descriptionGenericProductIndicator String TODO: Write descriptionHasPendingRefill Boolean TODO: Write descriptionID String TODO: Write descriptionInstructions String TODO: Write descriptionLastUpdateInstant String TODO: Write descriptionName String TODO: Write descriptionNdcCode String TODO: Write descriptionPharmacy Pharmacy TODO: Write descriptionPrescriptionNumber String TODO: Write descriptionProductName String TODO: Write descriptionProvider String TODO: Write descriptionProviderID String TODO: Write descriptionRefillPendingStatus String TODO: Write descriptionRefillsRemaining String TODO: Write descriptionRefillsTotal String TODO: Write descriptionStartDate DateTime TODO: Write description

Used in models

• Encounter

4.25 Message




Property Type DescriptionName String TODO: Write descriptionObjectID String TODO: Write descriptionBody String TODO: Write descriptionDate DateTime TODO: Write descriptionFrom From TODO: Write descriptionHasAttachments Boolean TODO: Write descriptionHasIncompleteTask Boolean TODO: Write descriptionRead Boolean TODO: Write descriptionSubject String TODO: Write descriptionTo To TODO: Write description

Used in models

• MessageListResult

4.26 MessageDetail


Property Type DescriptionName String TODO: Write descriptionObjectID String TODO: Write descriptionBody String TODO: Write descriptionDate DateTime TODO: Write descriptionFrom From TODO: Write descriptionHasAttachments Boolean TODO: Write descriptionHasIncompleteTask Boolean TODO: Write descriptionRead Boolean TODO: Write descriptionSubject String TODO: Write descriptionTo To TODO: Write descriptionAllowAttachmentsForReply Boolean TODO: Write descriptionCanBeReplied Boolean TODO: Write descriptionNote String TODO: Write descriptionTasks String TODO: Write descriptionViewers Array of MessageViewer TODO: Write description

Used in calls

• GetMessageDetail

4.27 MessageListResult


Property Type DescriptionLoadMore Boolean TODO: Write descriptionMessageList Array of Message TODO: Write descriptionPositionInfo String TODO: Write description

Used in calls

• ListInbox

4.26. MessageDetail 29


4.28 MessageViewer


Property Type DescriptionName String TODO: Write descriptionObjectID String TODO: Write descriptionReadDate DateTime TODO: Write description

Used in models

• MessageDetail

4.29 Order


Property Type DescriptionName String TODO: Write descriptionObjectID String TODO: Write descriptionCodeType String TODO: Write descriptionExpectedDate DateTime TODO: Write descriptionExpireDate DateTime TODO: Write descriptionProcedureCode String TODO: Write descriptionType String TODO: Write description

Used in models

• Encounter

4.30 PatientAccess


Property Type DescriptionAccountID String TODO: Write descriptionFeatureInformation FeatureInformation TODO: Write descriptionHomeURL String TODO: Write descriptionIsAdmitted Boolean TODO: Write descriptionName String TODO: Write descriptionNeedsDataFromHomeDeployment Boolean TODO: Write descriptionStatus String TODO: Write descriptionTillDate DateTime TODO: Write description

4.31 Pharmacy




Property Type DescriptionAddress String TODO: Write descriptionHours String TODO: Write descriptionID String TODO: Write descriptionName String TODO: Write descriptionPhone String TODO: Write description

Used in models

• Medication

4.32 Provider


Property Type DescriptionName String TODO: Write descriptionObjectID String TODO: Write descriptionAddress String TODO: Write descriptionDepartmentName String TODO: Write descriptionIsPCP Boolean TODO: Write descriptionOOCEndDate DateTime TODO: Write descriptionPCPType String TODO: Write descriptionPhone String TODO: Write description

Used in models

• Appointment

• Encounter

4.33 RecentPayment


Property Type DescriptionAmount String TODO: Write descriptionDate DateTime TODO: Write descriptionSource String TODO: Write descriptionDescription String TODO: Write descriptionReference String TODO: Write description

Used in models

• BillSummary

4.34 Test


4.32. Provider 31


Property Type DescriptionName String TODO: Write descriptionObjectID String TODO: Write descriptionDAT String TODO: Write descriptionIsAbnormal Boolean TODO: Write descriptionIsResultTimeNull Boolean TODO: Write descriptionOrderedBy String TODO: Write descriptionRead Boolean TODO: Write descriptionResultDate DateTime TODO: Write descriptionStatus String TODO: Write description

Used in models

• TestListResult

4.35 TestDetail


Property Type DescriptionName String TODO: Write descriptionDAT String TODO: Write descriptionObjectID String TODO: Write descriptionIsAbnormal Boolean TODO: Write descriptionIsResultTimeNull Boolean TODO: Write descriptionOrderedBy String TODO: Write descriptionRead Boolean TODO: Write descriptionResultDate DateTime TODO: Write descriptionStatus String TODO: Write descriptionComments String TODO: Write descriptionComponents Array of Component TODO: Write descriptionHasScans Boolean TODO: Write descriptionImpression String TODO: Write descriptionIsECG Boolean TODO: Write descriptionNarrative String TODO: Write descriptionRecipients Array of WPMessageRecipient Details of the provider who received the test resultResultNote String TODO: Write descriptionShowFlag Boolean TODO: Write descriptionTranscriptions String TODO: Write description

Used in calls

• GetTestDetail

4.36 TestListResult


Property Type DescriptionNextLabLink String TODO: Write descriptionResultVisibility Integer TODO: Write descriptionTestList Array of Test TODO: Write description

Used in calls



• ListTestResults

4.37 To



Used in models

• Message

• MessageDetail

4.38 Vitals


Property Type DescriptionBloodPressure String TODO: Write descriptionHeight String TODO: Write descriptionPulse String TODO: Write descriptionResp String TODO: Write descriptionTemperature String TODO: Write descriptionTemperatureSource String TODO: Write descriptionWeight String TODO: Write description

Used in models

• Encounter

4.39 WPLog


Property Type DescriptionAccountID String TODO: Write descriptionTimeStamp String TODO: Write descriptionType String TODO: Write descriptionAction String TODO: Write descriptionComment String TODO: Write description

Used in models

• AuditLog

4.37. To 33


4.40 WPMessageRecipient



Used in models

• TestDetail


4.41 WPObject


Property Type DescriptionName String TODO: Write descriptionObjectID String TODO: Write description

Used in models



CHAPTER 5

Contribute

5.1 MyChart Test logins

We’re always looking for more MyChart logins to test with. The more sample data we have, the more complete theclients will become. If you find a hosptial you are working with has more data or capabilities than is currently availablein the client, let us know. If you are willing to provide a set of MyChart logins to test with, we may be able to quicklyadd more functionality to the client.

5.2 Source

If you’d like to contribute code back to the project, please take a look at the Gocodo YourChart Client codebase. Eachclient library is autogenerated using the code there. To get started, install Node.js version 0.10 or greater and run

npm installnode make

The client libraries will be outputted to ./build. If you think others would benifit from your code, send a pullrequest on github.

35


https://https://github.com/gocodo/yourchart-client-generator


36 Chapter 5. Contribute

CHAPTER 6

About

6.1 YourChart Client

The Gocodo YourChart Client was originally built while working with a Hospital System running Epic MyChart. Theywanted to build a PHR for themselves that was more feature rich and usable than the MyChart Mobile application.The first step was to figure out how we could access patient data in a secure way within our own application at lowcost to the hospital itself. This client library started as a proof of concept with a related mobile application for thathospital system. Since then, Gocodo has decided to open source the client library in an effort to improve healthcare inthe US by enabling application developers to create applications unlike we’ve seen before.

6.2 Gocodo

Gocodo is a collection of open source health IT projects created by Michael Wasser Consulting, LLC. It’s objective isto enable the creation of shockingly simple and secure healthcare applications. It’s founder, Michael Wasser previouslycreated BloomAPI as well as co-founded HealthSherpa.

37

http://www.mikewasser.com

http://www.bloomapi.com/

https://www.healthsherpa.com


38 Chapter 6. About

CHAPTER 7

Indices and tables

• genindex

• modindex

• search

39

Documents

Gocodo YourChart Client Documentation