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/QuestionnaireResponse
endpoint ishttps://{hostname}/{basePath}/QuestionnaireResponse
where 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-Name
andAccess-Token
.Note:
- The above mentioned headers are mandatory.
- The value of
Access-Token
is in the formatBearer sample-access-token
.