FHIR Questionnaire API for Health Cloud
Setup
Prerequisites
To use the FHIR Questionnaire app, you must have a MuleSoft license.
Setup
- Log in to Salesforce and navigate to the Setup page.
- Search for the ‘MuleSoft Direct’ page.
- Select the FHIR Questionnaire API for Health Cloud application and click Enable.
- Enter the Display Name, Application Name, Business Group, Environment, and Deployment Target, then click Next.
- Add the configuration properties:
| Key name | Sample value | Description | |
|---|---|---|---|
| 1 | https.configured.port | - | Application port number for FHIR Questionnaire API. Default: 8081 |
- To add an optional configuration, click Add Additional parameters and enter the required details. For configuration details, refer to this table:
| SNo | Application property name(Key name) | Sample value | Description |
|---|---|---|---|
| 1 | sf.apiVersion | 63.0 | Salesforce api version |
| 2 | sf.questionnaireOmniscriptCustomType | - | Questionnaire Omniscript Custom Type Default: Discovery Framework |
| 3 | sf.questionnaireBundleIpName | - | Questionnaire bundle name Default: HlsDTR_RetrieveQuestionnaire |
| 4 | sf.auditEntity.name | - | Salesforce audit entity name Default: ServiceInformationRequest |
| 5 | sf.IPBasepath | - | Salesforce base path for Integration Procedure Default: /services/apexrest/omnistudio/v1/integrationprocedure |
- Click Proceed to deploy the application.
Post-Deployment:
Follow the FHIR Questionnaire API Specification to trigger the MuleSoft endpoints.
Note: The base path for all the endpoints is:
/api/v1/fhir-questionnaire/. For example, the URL for the/QuestionnaireResponseendpoint ishttps://{hostname}/{basePath}/QuestionnaireResponsewhere the base path is/api/v1/fhir-questionnaire/.For outbound deployment, send the org instance and access token for connecting to Salesforce with keys
Instance-Domain-NameandAccess-Token.Note:
- The above mentioned headers are mandatory.
- The value of
Access-Tokenis in the formatBearer sample-access-token.
Security notice: Configure TLS and the keystore for production
This application includes a sample Java KeyStore (fhir-questionnaire-api-impl-keystore.jks) to help you deploy quickly and test locally. Don't use this keystore in production.
You're responsible for provisioning your production keys. Before you send production traffic to the application, replace the sample keystore with your organization's own private key and certificate.
Follow the steps for your deployment model.
If you deploy to CloudHub 2.0 Private Spaces.
You can manage your certificates at the platform level, without changing the application.
1. In Anypoint Platform, go to Runtime Manager > Private Spaces.
2. Select your private space, and then click Domains & TLS tab.
3. In the TLS context configuration, upload your organization's PEM or JKS file.
4. Enter the passwords and aliases that your organization's certificate requires.
For more information, see CloudHub 2.0 Private Space TLS Documentation.
If you deploy to CloudHub 1.0, Runtime Fabric, or a standalone runtime.
Before you deploy, add your own keystore to the application artifact.
1. Generate a new, organization-specific JKS using your own PKI or the Java keytool.
2. Open the application artifact (or import it into Anypoint Studio), and go to src/main/resources/tls/.
3. Delete the default fhir-questionnaire-api-impl-keystore.jks file, and then add your new .jks file.
4. Update the application's configuration properties to match your new keystore. You can do this on the Properties tab in Runtime Manager or in your YAML configuration file.
tls.keyStoreAlias: tls.keyStoreSecret: * tls.keySecret: 5. Deploy the updated application artifact.
For more information, see MuleSoft TLS Configuration Guide.