Amazon HealthLake System API - Implementation Template
home
This API implementation template is a shared component of MuleSoft Accelerators, which accelerate the implementation of essential integration use cases.
The solution includes pre-built APIs, connectors, and integration templates that help unlock business-critical data from external systems and guide you in adopting best practices synthesized from thousands of customer implementations. Use these assets as is or extend them to meet your company’s unique needs.
Overview
This asset provides the implementation template for the Amazon HealthLake System API specification.
Getting started
|
The Getting Started with MuleSoft Accelerators guide provides general information on getting started with the accelerator components. This includes instructions on setting up your local workstation for configuring and deploying the applications. |
Once your workstation has been set up and the application template imported into Anypoint Studio, proceed with the Prerequisites section.
Prerequisites
This implementation template does not have any prerequisites.
Deployment
Each Accelerator implementation template in Exchange includes Bash and Windows scripts for building and deploying the APIs to CloudHub. These scripts depend on repositories, global settings, deployment profiles, and associated properties configured in the Maven settings.xml file. In particular, make sure the common properties for your environment have been provided in the CloudHub-DEV profile (e.g., Anypoint Platform client ID and secret).
For additional details, please refer to the Application Deployment section of the Getting Started Guide.
Required property overrides
Many templates can also be run from Anypoint Studio without having to customize the Run/Debug profiles. However, some templates make use of hidden deployment properties to protect sensitive information (e.g., passwords and secret keys). These properties must be supplied to the runtime by updating the configuration profile and adding them as VM arguments. At a minimum, the following properties must be customized to reflect the target deployment environment.
At a minimum, the following properties must be customized to reflect the target deployment environment.
| Property Name | Description |
|---|---|
| api.autodiscoveryID | Required if using API Manager to secure this API |
| https.host | sets the service host interface. It should be configured in config-<mule.env>.yaml file. (Defaults to 0.0.0.0 for all interfaces) |
| https.port | sets the service port number. It should be configured in config-<mule.env>.yaml file. (Default 8082) |
| keystore.alias | sets the alias to the keystore. It should be configured in config-<mule.env>.yaml file |
| keystore.path | sets the path to the key file. Key should be available in /src/main/resources/keystore. It should be configured in config-<mule.env>.yaml file |
| keystore.keypass | sets keystore keypass to support HTTPS operation. It should be encrypted and configured in config-secured-<mule.env>.yaml file |
| keystore.password | sets keystore password to support HTTPS operation. It should be encrypted and configured in config-secured-<mule.env>.yaml file |
| aws.accessKey | sets the Amazon HealthLake accessKey. It should be encrypted and configured in config-secured-.yaml file |
| aws.secretKey | sets the Amazon HealthLake secretKey. It should be encrypted and configured in config-secured-.yaml file |
| healthlake.batchSize | ssets the max number of entries to send to Amazon HealthLake. Currently the limit HealthLake supports is 160. The app appends the Patient to each batch though so the recommended max batch size is 159 |
Tested and verified
This solution was developed and tested on Anypoint Studio 7.15 and Mule Runtime 4.4.0.
Testing
Use Advanced Rest Client or Postman to send a request over HTTPS. The template includes a Postman collection in the src/test/resources folder. Update the collection variable(s) after successful import.
Additional resources
- Please refer to the attached [link](https://docs.mulesoft.com/mule-runtime/4.4/tls-configuration) on how to generate the Keystore.- Please refer to the attached link on how to secure the configuration properties.
- The Developer guide tab provides information generated from the DataWeave scripts included in the project.
- Refer to the Accelerators documentation home for more information about the MuleSoft Accelerators.