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 their deployment of Epic MyChart.

Data¶

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

• 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 a password, and a patients permission, a developer can fetch all of the above information. See the Models section for a more complete description of the data made available.

API Clients¶

To make it easier for software developers to get quick and secure access to patient records, API clients have been provided for use by Gocodo under an MIT license. Please contact Michael Wasser at Gocodo for access to the API clients. 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 additional clients are relatively strait forward and can generally be completed in less than two days.

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 using YourChartClient.sites. Each site will have an orgId which tells the client where to fetch health records 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, the names of calls and the properties listed in the resulting Models will be camel-cased versions of themselves. E.g. The call documented as ListPastAppointments becomes listPastAppointments in the node.js client. For each 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 first parameter communicating error conditions if they exist and null otherwise, and a second parameter with the request’s response model. For example, a call to getAccountDetails may look as follows:

client.getAccountDetails({
  request_model: {
    billingAccountId: "<account id>",
    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 in authenticateResponse on the current instance of the client. Manual calls to authenticate will also authorize the client/ store the results for future calls.

Putting it all together:

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

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

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

// Fetch a list of past appointments
client.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 appointments
  console.dir(data);

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

    // Get details for a specific appointment
    epicClient.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 details
      console.dir(data);
    });
  }
});

Objective-C¶

TODO: Write

.Net¶

TODO: Write

Reporting Bugs¶

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

Authenticate¶

TODO: Write this

AcceptTermsConditions¶

TODO: Write this

GetAccountDetails¶

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

GetBillsAndStatements¶

TODO: Write this

GetEncounter¶

TODO: Write this

GetMessageDetail¶

TODO: Write this

GetTermsConditions¶

TODO: Write this

GetTestDetail¶

TODO: Write this

ListAlerts¶

TODO: Write this

ListAllergies¶

TODO: Write this

ListCurrentHealthIssues¶

TODO: Write this

ListFutureAppointments¶

TODO: Write this

ListHealthAdvisory¶

TODO: Write this

ListImmunizations¶

TODO: Write this

ListInbox¶

TODO: Write this

ListMedications¶

TODO: Write this

ListMessageRecipients¶

TODO: Write this

ListPatientAccesses¶

TODO: Write this

ListPastAppointments¶

TODO: Write this

ListTestResults¶

TODO: Write this

LogAudit¶

TODO: Write this

Account¶

TOOD: Write description

Used in models

• BillSummary

AccountDemographics¶

TOOD: Write description

Used in models

• BillingAccountDetailsResponse

Alert¶

TOOD: Write description

Allergy¶

TOOD: Write description

Appointment¶

TOOD: Write description

Used in models

• AppointmentListResult

AppointmentListResult¶

TOOD: Write description

Used in calls

• ListFutureAppointments
• ListPastAppointments

AttachementSettings¶

TOOD: Write description

Used in models

• MedicalAdviceSettings

AuditLog¶

TOOD: Write description

Used in calls

• LogAudit

Authenticate¶

TOOD: Write description

Used in calls

• Authenticate

AuthenticateResponse¶

TOOD: Write description

Used in calls

• Authenticate

BillSummary¶

TOOD: Write description

Used in models

• BillsAndStatementsSummary

BillingAccountDetailsRequest¶

TOOD: Write description

Used in calls

• GetAccountDetails

BillingAccountDetailsResponse¶

TOOD: Write description

Used in calls

• GetAccountDetails

BillsAndStatementsSummary¶

TOOD: Write description

Used in calls

• GetBillsAndStatements

Component¶

TOOD: Write description

Used in models

• TestDetail

CurrentHealthIssue¶

TOOD: Write description

Diagnosis¶

TOOD: Write description

Used in models

• Encounter

Encounter¶

TOOD: Write description

Used in calls

• GetEncounter

FeatureInformation¶

TOOD: Write description

Used in models

• AuthenticateResponse
• PatientAccess

From¶

TOOD: Write description

Used in models

• Message
• MessageDetail

HealthAdvisory¶

TOOD: Write description

Immunization¶

TOOD: Write description

MedicalAdviceSettings¶

TOOD: Write description

Used in calls

• ListMessageRecipients

Medication¶

TOOD: Write description

Used in models

• Encounter

Message¶

TOOD: Write description

Used in models

• MessageListResult

MessageDetail¶

TOOD: Write description

Used in calls

• GetMessageDetail

MessageListResult¶

TOOD: Write description

Used in calls

• ListInbox

MessageViewer¶

TOOD: Write description

Used in models

• MessageDetail

Order¶

TOOD: Write description

Used in models

• Encounter

PatientAccess¶

TOOD: Write description

Pharmacy¶

TOOD: Write description

Used in models

• Medication

Provider¶

TOOD: Write description

Used in models

• Appointment
• Encounter

RecentPayment¶

TOOD: Write description

Used in models

• BillSummary

Test¶

TOOD: Write description

Used in models

• TestListResult

TestDetail¶

TOOD: Write description

Used in calls

• GetTestDetail

TestListResult¶

TOOD: Write description

Used in calls

• ListTestResults

To¶

TOOD: Write description

Used in models

• Message
• MessageDetail

Vitals¶

TOOD: Write description

Used in models

• Encounter

WPLog¶

TOOD: Write description

Used in models

• AuditLog

WPMessageRecipient¶

TOOD: Write description

Used in models

• TestDetail
• MedicalAdviceSettings

WPObject¶

TOOD: Write description

Used in models

• MedicalAdviceSettings