Skip to content
This repository has been archived by the owner on Jan 19, 2024. It is now read-only.


Repository files navigation

Template Healthcare EHR System API

Underlying all IT architectures are core systems of records that are often not readily available due to their complexity and connectivity concerns. System APIs provide a means of hiding that complexity from the user while exposing data and providing downstream insulation from any interface changes or rationalization of those systems. This API provides an implementation best practice to expose EHR data from systems like Epic via a set of RESTful FHIR services in RAML 1.0, making it easy to consume within an enterprise.

Healthcare Accelerator

This EHR Implementation is one of many components included in Accelerator for Healthcare. This API provides organizations with connectivity assets that accelerate project delivery in healthcare, including pre-built API designs and implementations that support core healthcare business processes. Contact for more information.

License Agreement

This template is subject to the conditions of the MuleSoft License Agreement. Review the terms of the license before downloading and using this template. You can use this template for free with the Mule Enterprise Edition, CloudHub, or as a trial in Anypoint Studio.

Use Case

As a user of Healthcare API-led connectivity web portal, I want a microservice to act as a system API to provide services to upper layers of the architecture. This includes creation, modification, and retrieval of medical data from an EHR system.

EHR System API is part of the Healthcare Templates Solution and uses the standardized FHIR structures version 3.0.1 STU3.

The API is defined using RAML 1.0 to provide type information for validation of requests and to help with the data transformation during development by providing useful metadata.

The following FHIR objects and operations are implemented in this API:

  • AllergyIntolerance - search, update, create
  • Appointment - search, create
  • Condition - search, update, create
  • Patient - search, read, update, create
  • Practitioner - search, read, update, create
  • Schedule - search, create
  • Slot - search, read, update, create


To run this template, there are certain preconditions that must be considered. Failing to do so can lead to unexpected behavior of the template.

This template uses SOAP services defined by WSDL files located in the src/main/resources/wsdl folder.

Run it!

Simple steps to get Healthcare EHR System API running.

Where to Download Anypoint Studio and the Mule Runtime

If you are new to Mule, download this software:

Note: Anypoint Studio requires JDK 8.

Import into Studio

In Studio, click the Exchange X icon in the upper left of the taskbar, log in with your Anypoint Platform credentials, search for the template, and click Open.

Run on Studio

After you import your template into Anypoint Studio, follow these steps to run it:

  1. Locate the properties file, in src/main/resources.
  2. Complete all the properties required per the examples in the "Properties to Configure" section.
  3. Right click the template project folder.
  4. Hover your mouse over Run as.
  5. Click Mule Application (configure).
  6. Inside the dialog, select Environment and set the variable mule.env to the value dev.
  7. Click Run.

Run on Stand Alone

Fill in all the properties in one of the property files, for example in and run your app with the corresponding environment variable to use it. To follow the example, use mule.env=prod.

Run on CloudHub

When creating your application in CloudHub, go to Manage Application > Properties to set all environment variables detailed in "Properties to Configure".

Deploy on CloudHub

In Studio, right click your project name in Package Explorer and select Anypoint Platform > Deploy on CloudHub.

Properties to Configure

To use this template, you need to configure properties either in a properties file or in CloudHub as Environment Variables.

Application Properties

  • http.port 8081

  • allergyintolerance.service AllergyService

  • allergyintolerance.port AllergyServicePort

  • allergyintolerance.address

  • appointment.service AppointmentService

  • appointment.port AppointmentServicePort

  • appointment.address

  • condition.service ConditionService

  • condition.port ConditionServicePort

  • condition.address

  • patient.service PatientService

  • patient.port PatientServicePort

  • patient.address

  • practitioner.service PractitionerService

  • practitioner.port PractitionerServicePort

  • practitioner.address

  • schedule.service ScheduleService

  • schedule.port ScheduleServicePort

  • schedule.address

  • slot.service SlotService

  • slot.port SlotServicePort

  • slot.address


Template implementation of API-led System API for accessing EHR information using the FHIR standard






No packages published