This how-to-guide explains how to configure settings for the FHIR converter service, if the default configuration does not suit your requirements.
To ensure restricted access to your FHIR converter APIs, allowing only tokens issued from within your tenant to be able to interact with the APIs, the FHIR converter service can be configured with authentication settings enabled. Refer Enable Authentication for detailed instructions on configuring your FHIR converter service with authentication settings.
The following are sample deployment commands for configuring authentication, using deployment option 2 or 3 (as described in Deployment options to set up FHIR converter service in Azure):
Option 2 (bicep):
az deployment sub create --location <Location> --name <A custom name for your deployment> --template-file FhirConverter-SingleAzureDeploy.bicep --parameters securityEnabled=true securityAuthenticationAudiences="['<Audience1>','<Audience2>','<etc...>']" securityAuthenticationAuthority="<Authority>"
Option 3 (PowerShell):
./FhirConverter-SingleAzureDeploy.ps1 -securityEnabled $true -securityAuthenticationAudiences @('<Audience1>','<Audience2>','<etc...>') -securityAuthenticationAuthority "<Authority>"The FHIR converter APIs come pre-packaged with default Liquid templates for the supported conversion scenarios.
However, to allow the ability to use custom Liquid templates for custom transformation requirements (see Customize templates to learn more about how to customize templates), your FHIR converter service can be configured to integrate with your template store.
Refer Enable template store integration for detailed instructions on configuring your FHIR converter service with your custom template store.
The following are sample deployment commands for configuring template store integration, using deployment option 2 or 3, as described in Deployment options to set up FHIR converter service in Azure:
Option 2 (bicep):
az deployment sub create --location <Location> --name <A custom name for your deployment> --template-file FhirConverter-SingleAzureDeploy.bicep --parameters templateStoreIntegrationEnabled=true templateStorageAccountName="<Storage_Account_name>" templateStorageAccountContainerName="<Storage_Account_Container_name>"
Option 3 (PowerShell):
./FhirConverter-SingleAzureDeploy.ps1 -templateStoreIntegrationEnabled $true -templateStorageAccountName "<Storage_Account_name>" -templateStorageAccountContainerName "<Storage_Account_Container_name>"The FHIR converter service emits custom logs and metrics to provide information on your service and invocation of the conversion APIs, that could be used for insights or troubleshooting.
These can be viewed using Azure Container App's Azure Monitor Log Analytics. Refer Monitoring for more information on how to view logs and metrics emitted by your FHIR converter service.
Additionally, your FHIR converter service can be configured with an Application Insights resource, which allows you to visualize the custom metrics emitted in graphical format. If you deployed the service using the quickstart deployment options, Application Insights is deployed by default and configured with your FHIR converter service. Alternatively, to provide your own Application Insights resource to collect the telemetry for your service, (TODO instructions).
Refer Application Insights Overview to learn how to customize Application Insights for your requirements.
Application Insights is enabled by default when deploying the FHIR converter using any of the 3 deployment options described in Deployment options to set up FHIR converter service in Azure. The following are sample deployment commands for disabling Application Insights, using deployment option 2 or 3:
Option 2 (bicep):
az deployment sub create --location <Location> --name <A custom name for your deployment> --template-file FhirConverter-SingleAzureDeploy.bicep --parameters applicationInsightsEnabled=false
Option 3 (PowerShell):
./FhirConverter-SingleAzureDeploy.ps1 -applicationInsightsEnabled $falseThe provided deployment options set up the FHIR converter service to run on an Azure Container App, which is configured with basic settings intended for testing. Azure Container Apps offers various configurable options for your app, that you can update to better suit your requirements:
- To manage hardware requirements that meet your workload requirements, refer Workload profiles.
- To manage automatic scaling of your service, refer Scaling & performance.
- To manage ingress of your service and advanced networking configurations, refer Networking, ingress, and network security.
The following are sample deployment commands for customizing your Container App settings, using deployment options 2 and 3, as described in Deployment options to set up FHIR converter service in Azure:
Option 2 (bicep):
az deployment sub create --location <Location> --name <A custom name for your deployment> --template-file FhirConverter-SingleAzureDeploy.bicep --parameters containerAppName="<Custom_Container_App_name>" minReplicas="<min_replicas>" maxReplicas="<max_replicas>" cpuLimit="<cpu_limit>" memoryLimit="memory_unit"
-Container_name>"
Option 3 (PowerShell):
./FhirConverter-SingleAzureDeploy.ps1 -containerAppName "<Custom_Container_App_name>" -minReplicas "<min_replicas>" -maxReplicas "<max_replicas>" -cpuLimit "<cpu_limit>" -memoryLimit "<memory_limit>"In this how-to-guide, you learned how to configure your FHIR converter service in Azure, with your desired settings.
Once the service is set up, you can use the endpoint corresponding to the application url of your Container App running the web service.
To get started using your newly deployed FHIR converter service, refer to the following documents: