Welcome to

Epic’s App Orchard

June 22, 2020

Epic | 1979 Milky Way | Verona WI 53593 | Voice: 608.271.9000 | Fax: 608.271.7237 | www.epic.com
Table of Contents
 Getting Started........................................................................................................................................3
Support .............................................................................................................................................. 3
Project Kickoff ................................................................................................................................... 3
 Using the App Orchard Website ........................................................................................................4
Login Menu ....................................................................................................................................... 4
Building Apps ................................................................................................................................... 4
 Testing .......................................................................................................................................................5
Sandbox Details ................................................................................................................................ 5
Special Integration Methods ........................................................................................................... 6
Client ID Updates ............................................................................................................................. 6
 Path to the Gallery .................................................................................................................................6
Submitting Your App ...................................................................................................................... 6
Insurance ........................................................................................................................................... 7
Interested Organizations ................................................................................................................. 7
 Managing Implementations ...................................................................................................................7
Kicking Off an Install ....................................................................................................................... 7
Resources ........................................................................................................................................... 7
 Upcoming Classes and Conferences ..................................................................................................8
 Summary of Recent Changes ...............................................................................................................9
June 17, 2020 ...................................................................................................................................... 9
June 9, 2020 ........................................................................................................................................ 9
February 3, 2020................................................................................................................................ 9
December 20, 2019 ............................................................................................................................ 9
July 26, 2019....................................................................................................................................... 9

App Orchard Welcome Packet 2

 Getting Started
Welcome to App Orchard, Epic’s developer program and app gallery. We are excited to work with you to help
our mutual customers by integrating your software solutions with the Epic infrastructure. Your membership
in App Orchard provides a number of resources to make your app and business successful, including:
 Our library of web services, FHIR APIs, the Kit data model, and web integration.
 Testing harnesses, sandboxes, and testing data.
 Design and technical support.
 Advertising in our app gallery.

For complete program benefit details, refer to the App Orchard Program Details document.
The information below outlines our recommended approach for getting your app ready for the gallery.

Support
App Orchard membership includes support from our knowledgeable Technical Services (TS) team. Our team
is available to answer questions about the App Orchard site, help with integration design, aid in testing and
troubleshooting, and help with customer implementations after your app is approved for distribution. The
support time from App Orchard TS is billable, however the App Orchard Terrace and Garden memberships
include several hours of support services each membership year at no additional fee. We recommend talking
with your App Orchard TS early in your integration design process so we can help you avoid potential pitfalls
early.
An App Orchard TS will be assigned to you about a week after your App Orchard welcome call. If you are
unsure who your App Orchard TS is, reach out to AppOrchardTS@epic.com with a brief description of your
integration and the questions that you have. We’ll connect you to your App Orchard TS or begin assigning an
App Orchard TS as your primary App Orchard contact if one is not yet assigned.
For more information about App Orchard support, refer to the App Orchard Support Guidelines document.
If you have questions or concerns about App Orchard support, please contact Chris Cameron and Matt Ollila.

Project Kickoff
We recommend that you kick off your project by scheduling a free call to share information about your app.
We can help guide you to use the most appropriate APIs to integrate with Epic workflows. Topics to discuss
generally include:
 What does your app do?
 Who are the end users of your app?
 What data do you need to read from or write to the Epic system?
 How will users access your app?
 What integration strategies and technologies will your app employ?

Please do not share sensitive information or any information that you might consider a trade secret with Epic.
The goal of this initial call is to recognize the integration needs and guide you to the right methods to be
successful and get your solution to market quickly. Additionally, we use what we learn in the kickoff call to
choose the most appropriate App Orchard TS for you and usually introduce them to you in the week following
the kickoff call.
App Orchard Welcome Packet 3
 Using the App Orchard Website
Login Menu
Use the App Orchard login menu to navigate to important tools and locations on the App Orchard site, such
as the Developer Forum, Sherlock, or your account management page.

Administrators can use the Organization Details menu to:

 Update your organization address, website, and product listing.
 Manage user accounts.
 Access the Epic sandbox user ID and password.
o These credentials are used for basic authentication web service testing against the sandbox from
outside of the App Orchard test harness.
 Change profile photo.
The What’s New option provides information on recent changes and upcoming events relevant to the App
Orchard community.

Building Apps

App Orchard Welcome Packet 4

 The App Orchard site includes a Documentation section describing the steps to publish an app in the gallery,
how to build on the Epic platform, and how to embed your app. There are also tutorials and test harnesses
available for FHIR, OAuth2, Clinical Decision Support, and Kit.
You register your app on the My Apps page. Registering your app creates a record of the app within the App
Orchard database that we use to define and manage your app’s status in the program and interactions with
Epic systems. When you initially create it, the app record contains information on the name, version, and
description of your app, as well as Client IDs for the app. As you continue to work on your draft, you’ll specify
the APIs and services that your app will use.
On the APIs page, you can search our list of public APIs. For each API, you can get information about the first
available Epic version and namespace, a description of the service and its parameters, and an example request
and response. The Try It button takes you to our testing tool, where you can call the API against our sandbox
environments for each applicable version and authentication method. You can add an API to your app directly
from the API page using the Use in App button. Note, some APIs that are used less frequently may be missing
things such as a Try It button. Let your App Orchard TS know if there are APIs that you would like us to
prioritize. If you need it by a certain date, that support is generally billable. Along with the public APIs, there
are some private APIs that will not be visible to you automatically. In order to ensure that you have access to
the correct APIs, please discuss what you need with your App Orchard TS. They will be able to give you access
to the necessary private APIs.

 Testing
Sandbox Details
You should plan to test your app using the relevant APIs in the App Orchard sandbox from outside the App
Orchard test harness. Our sandbox includes various versions of Epic: Epic 2018, Epic May 2019, and Epic’s
current version. Our web services are secured with one of two security policies. The first security policy uses
OAuth 2.0, which is available if you have a login context (either for a MyChart patient or an Epic user)
associated with the web service calls. The second security policy requires a username and password to be sent
with each web service request. This second approach is used if you do not have an Epic login context associated
with the web service call and you instead use a username and password provided to you. Your administrator
can access your App Orchard sandbox username and password from the Organization Details menu.
 OAuth2 Authentication Base URLs:
o Current: https://apporchard.epic.com/interconnect-aocurprd-oauth
o Epic May 2019: https://apporchard.epic.com/interconnect-aomay19prd-oauth
o Epic 2018: https://apporchard.epic.com/interconnect-aofeb18prd-oauth
 Username Authentication Base URLs:
o Current: https://apporchard.epic.com/interconnect-aocurprd-username
o Epic May 2019: https://apporchard.epic.com/interconnect-aomay19prd-username
o Epic 2018: https://apporchard.epic.com/interconnect-aofeb18prd-username

Make sure to use your app’s client ID when testing the various web services. The client ID will need to be
included when calling web services.
To make use of the Kit database sandbox:

App Orchard Welcome Packet 5

  Create a Sherlock and provide your assigned App Orchard TS with the IP address that your
organization’s internet traffic is routed from.
 After the IP address is added to the whitelist, we will provide you with a login and password.
 Use SQL Server Management Studio to connect to kit-current.epic.com with the provided credentials.
Change your password when prompted.
 The Caboodle database contains the Kit views and Kit synonyms for procedures to check database or
extract status.
 Test your Kit queries from either SSMS or embed the connection information in your application to test.

Special Integration Methods

Some integrations require additional setup in the sandbox to make them available to you for testing. If you are
looking to use any of the integration strategies noted below, contact Epic with your interest so we can work
with you on integrating your application in the App Orchard sandbox.
 HL7 interfaces
 Personnel management web services
 Scheduling web services
 Epic Chronicles imports
 MyChart external payment integration
 Rover/Haiku/Canto/MyChart Mobile SMART on FHIR launch

Client ID Updates
App configuration changes are not immediately reflected in the App Orchard sandbox. It can take up to
approximately 12 hours for the changes to take place. This is important when first creating an app and trying
to use its client ID in a Smart on FHIR workflow or when trying to call a web service that has been recently
added to the app definition. Additionally, it may take up to 30 minutes for changes to draft apps to be reflected
in the App Orchard sandbox.

 Path to the Gallery

Submitting Your App
There are two primary tasks that you need to complete when you submit your app to the gallery: an App
Listing Review and a Technical Review. For the App Listing Review, Epic reviews all of the fields contained
within your app in the App Orchard website for accuracy and completeness. This information appears in the
gallery listing, so it is your opportunity to tailor your marketing message. For additional tips and guidelines
about creating your app listing, refer to the Curating Your App Submission document.
The Technical Review involves a high-level review with your TS expert of your app’s adherence to the App
Requirements, especially the Qualities of Well-Behaved Apps in the Program Details. The Technical Review
happens in the form of a questionnaire that is linked from your app listing. Your questionnaire responses will
be available to the App Orchard point person at each customer with hopes that answering these common
questions up front will streamline the app selection and purchasing processes. In addition to the questionnaire,
the app will also be reviewed at a high level by a subject matter expert (SME) to ensure that your app is being
integrated properly with Epic and that all APIs are being used appropriately.

App Orchard Welcome Packet 6

 For more detailed information about the review process for new app submissions, refer to the App Submission
Review Process document.

Insurance
As part of the contributor agreement between you and Epic, you must have a valid certificate of insurance on
file with Epic before publishing an app to the gallery. More information regarding this can be found in section
25 of the contributor agreement, listed under Build Apps > Resources on the App Orchard website.

Interested Organizations
After your app is on the gallery, customers will be able to view your listing and request your application by
clicking on the appropriate button. You will then receive an email notification and the customer will appear
on the Interested Organizations page. After you’ve completed a license agreement for your app with the
customer, you can issue keys to that customer by selecting Enable Keys on the Interested Organizations page
for that customer and app. It can take up to 12 hours before the keys are present in the customer system.
Prospective customers might reach out to you directly rather than through the App Orchard website. During
your demo and sales process, tell these customers to express interest through the App Orchard website. This
process ensures that the prospective customer appears on your Interested Organizations page so you can issue
keys to the customer. For an overview, review the App Request Process document on the App Orchard
website.

 Managing Implementations
Kicking Off an Install
When an Epic community member has committed to moving forward with an app listed in App Orchard, you
or the Epic community member should organize a kickoff call to align key stakeholders on the goals, scope,
processes, milestones, and timeline of the project. Key stakeholders include representatives from all three
organizations: you, the Epic community member (e.g., operational sponsor, project manager, analyst, ECSA,
network engineer), and Epic (e.g., the customer’s technical coordinator, TS who support affected applications,
your App Orchard TS, and, if applicable, the EDI representative). Your App Orchard TS will help ensure the
right Epic support are on the call. Including the right stakeholders from each organization at the start of the
project enhances communication, provides an opportunity to set the right expectations upfront, and helps
identify and avoid potential issues before they impact the success of the project.

Resources
Your App Orchard TS will be able to draft an implementation guide for you and the customer to use starting
with your first install. In addition to supporting you and the Epic customer through this initial implementation,
we will also be documenting any additional considerations with the intent to provide you and the Epic
community with a comprehensive document that captures the required resources and steps to integrate with
your app. We will maintain the implementation guide over time and it is included with your App Orchard
membership. You are welcome to draft, distribute, and maintain additional resources of your own to help
customers with their integration and use of your app.

App Orchard Welcome Packet 7

 Upcoming Classes and Conferences
 Current App Orchard Conference Details
 Updates such as Classes and Training Details are posted on What’s New

App Orchard Welcome Packet 8

 Summary of Recent Changes
The following is a general summary of recent changes.

June 22, 2020

 Updated the Support section, where the majority of the content has been moved to a separate document
in App Orchard name App Orchard Support Guidelines.
 Updated the Sandbox Details section, which now has guidance to work with the assigned App Orchard
TS to help with getting access to the Kit sandbox.

June 9, 2020
 Added the Managing Implementations section, which provides considerations for kicking off installs
with Epic customers.

February 3, 2020
 Added a link to the App Submission Review Process document, which describes the review process that
new apps are subject to.

December 20, 2019

 Added a link to the Curating Your App Submission document, which provides more guidance about
creating and maintaining your app listing.

July 26, 2019

 Added information about the Developer Forum and the Subject Matter Expert Review. Added
reminder of insurance requirement and link to the contributor agreement. Updated login menu
information, Sandbox Details, and information about accessing APIs. Added details to Interested
Organizations section.

© 2020 Epic Systems Corporation. All rights reserved. PROPRIETARY INFORMATION - This item and its contents may not be accessed, used, 9
modified, reproduced, performed, displayed, distributed or disclosed unless and only to the extent expressly authorized by an agreement with
Epic. This item is a Commercial Item, as that term is defined at 48 C.F.R. Sec. 2.101. It contains trade secrets and commercial information that
are confidential, privileged and exempt from disclosure under the Freedom of Information Act and prohibited from disclosure under the Trade
Secrets Act. After Visit Summary, Analyst, App Orchard, ASAP, Beacon, Beaker, BedTime, Bones, Break-the-Glass, Bugsy, Caboodle, Cadence,
Canto, Care Everywhere, Charge Router, Chronicles, Clarity, Cogito ergo sum, Cohort, Colleague, Comfort, Community Connect, Cosmos,
Cupid, Epic, EpicCare, EpicCare Link, Epicenter, Epic Earth, EpicLink, EpicWeb, Garden Plot, Good Better Best, Grand Central, Haiku, Happy
Together, Healthy Planet, Hyperspace, Kaleidoscope, Kit, Limerick, Lucy, Lumens, MyChart, OpTime, OutReach, Patients Like Mine, Phoenix,
Powered by Epic, Prelude, Radar, Radiant, Resolute, Revenue Guardian, Rover, Share Everywhere, SmartForms, Sonnet, Stork, System Pulse,
Tapestry, Trove, Welcome, Willow, Wisdom, With the Patient at Heart, and WorldWise are registered trademarks, trademarks, or service
marks of Epic Systems Corporation in the United States of America and/or other countries. Other company, product, and service names
referenced herein may be trademarks or service marks of their respective owners. Patents Notice: www.epic.com/patents.