Microsoft.HealthcareApis workspaces/fhirservices 2025-03-01-preview

Bicep resource definition

The workspaces/fhirservices resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.HealthcareApis/workspaces/fhirservices resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.HealthcareApis/workspaces/fhirservices@2025-03-01-preview' = {
  parent: resourceSymbolicName
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    acrConfiguration: {
      loginServers: [
        'string'
      ]
      ociArtifacts: [
        {
          digest: 'string'
          imageName: 'string'
          loginServer: 'string'
        }
      ]
    }
    authenticationConfiguration: {
      audience: 'string'
      authority: 'string'
      smartIdentityProviders: [
        {
          applications: [
            {
              allowedDataActions: [
                'string'
              ]
              audience: 'string'
              clientId: 'string'
            }
          ]
          authority: 'string'
        }
      ]
      smartProxyEnabled: bool
    }
    corsConfiguration: {
      allowCredentials: bool
      headers: [
        'string'
      ]
      maxAge: int
      methods: [
        'string'
      ]
      origins: [
        'string'
      ]
    }
    encryption: {
      customerManagedKeyEncryption: {
        keyEncryptionKeyUrl: 'string'
      }
    }
    exportConfiguration: {
      storageAccountName: 'string'
    }
    implementationGuidesConfiguration: {
      usCoreMissingData: bool
    }
    importConfiguration: {
      enabled: bool
      initialImportMode: bool
      integrationDataStore: 'string'
    }
    publicNetworkAccess: 'string'
    resourceVersionPolicyConfiguration: {
      default: 'string'
      resourceTypeOverrides: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.HealthcareApis/workspaces/fhirservices

Encryption

EncryptionCustomerManagedKeyEncryption

FhirServiceAcrConfiguration

FhirServiceAuthenticationConfiguration

FhirServiceCorsConfiguration

FhirServiceExportConfiguration

FhirServiceImportConfiguration

FhirServiceProperties

ImplementationGuidesConfiguration

ResourceTags

ResourceVersionPolicyConfiguration

ResourceVersionPolicyConfigurationResourceTypeOverrides

ServiceManagedIdentityIdentity

ServiceOciArtifactEntry

SmartIdentityProviderApplication

SmartIdentityProviderConfiguration

UserAssignedIdentities

UserAssignedIdentity

Usage Examples

Bicep Samples

A basic example of deploying Healthcare FHIR (Fast Healthcare Interoperability Resources) Service.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource workspace 'Microsoft.HealthcareApis/workspaces@2022-12-01' = {
  name: resourceName
  location: location
}

resource fhirService 'Microsoft.HealthcareApis/workspaces/fhirServices@2022-12-01' = {
  parent: workspace
  name: resourceName
  location: location
  kind: 'fhir-R4'
  properties: {
    acrConfiguration: {}
    authenticationConfiguration: {
      audience: 'https://acctestfhir.fhir.azurehealthcareapis.com'
      authority: 'https://login.microsoftonline.com/deployer().tenantId'
      smartProxyEnabled: false
    }
    corsConfiguration: {
      allowCredentials: false
      headers: []
      methods: []
      origins: []
    }
  }
}

resource fhirService2 'Microsoft.HealthcareApis/workspaces/fhirServices@2022-12-01' = {
  parent: workspace
  name: resourceName
  location: location
  kind: 'fhir-R4'
  properties: {
    acrConfiguration: {}
    authenticationConfiguration: {
      audience: fhirService.properties.authenticationConfiguration.audience
      authority: fhirService.properties.authenticationConfiguration.authority
      smartProxyEnabled: false
    }
    corsConfiguration: {
      allowCredentials: false
      headers: []
      methods: []
      origins: []
    }
  }
}

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

ARM template resource definition

The workspaces/fhirservices resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.HealthcareApis/workspaces/fhirservices resource, add the following JSON to your template.

{
  "type": "Microsoft.HealthcareApis/workspaces/fhirservices",
  "apiVersion": "2025-03-01-preview",
  "name": "string",
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "acrConfiguration": {
      "loginServers": [ "string" ],
      "ociArtifacts": [
        {
          "digest": "string",
          "imageName": "string",
          "loginServer": "string"
        }
      ]
    },
    "authenticationConfiguration": {
      "audience": "string",
      "authority": "string",
      "smartIdentityProviders": [
        {
          "applications": [
            {
              "allowedDataActions": [ "string" ],
              "audience": "string",
              "clientId": "string"
            }
          ],
          "authority": "string"
        }
      ],
      "smartProxyEnabled": "bool"
    },
    "corsConfiguration": {
      "allowCredentials": "bool",
      "headers": [ "string" ],
      "maxAge": "int",
      "methods": [ "string" ],
      "origins": [ "string" ]
    },
    "encryption": {
      "customerManagedKeyEncryption": {
        "keyEncryptionKeyUrl": "string"
      }
    },
    "exportConfiguration": {
      "storageAccountName": "string"
    },
    "implementationGuidesConfiguration": {
      "usCoreMissingData": "bool"
    },
    "importConfiguration": {
      "enabled": "bool",
      "initialImportMode": "bool",
      "integrationDataStore": "string"
    },
    "publicNetworkAccess": "string",
    "resourceVersionPolicyConfiguration": {
      "default": "string",
      "resourceTypeOverrides": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.HealthcareApis/workspaces/fhirservices

Encryption

EncryptionCustomerManagedKeyEncryption

FhirServiceAcrConfiguration

FhirServiceAuthenticationConfiguration

FhirServiceCorsConfiguration

FhirServiceExportConfiguration

FhirServiceImportConfiguration

FhirServiceProperties

ImplementationGuidesConfiguration

ResourceTags

ResourceVersionPolicyConfiguration

ResourceVersionPolicyConfigurationResourceTypeOverrides

ServiceManagedIdentityIdentity

ServiceOciArtifactEntry

SmartIdentityProviderApplication

SmartIdentityProviderConfiguration

UserAssignedIdentities

UserAssignedIdentity

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
Configure FHIR service to enable $import	This template provisions FHIR service to enable $import for initial data loading
Deploy the MedTech service	The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service.
Deploy the MedTech service including an Azure IoT Hub	The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service.

Terraform (AzAPI provider) resource definition

The workspaces/fhirservices resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.HealthcareApis/workspaces/fhirservices resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HealthcareApis/workspaces/fhirservices@2025-03-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    etag = "string"
    kind = "string"
    properties = {
      acrConfiguration = {
        loginServers = [
          "string"
        ]
        ociArtifacts = [
          {
            digest = "string"
            imageName = "string"
            loginServer = "string"
          }
        ]
      }
      authenticationConfiguration = {
        audience = "string"
        authority = "string"
        smartIdentityProviders = [
          {
            applications = [
              {
                allowedDataActions = [
                  "string"
                ]
                audience = "string"
                clientId = "string"
              }
            ]
            authority = "string"
          }
        ]
        smartProxyEnabled = bool
      }
      corsConfiguration = {
        allowCredentials = bool
        headers = [
          "string"
        ]
        maxAge = int
        methods = [
          "string"
        ]
        origins = [
          "string"
        ]
      }
      encryption = {
        customerManagedKeyEncryption = {
          keyEncryptionKeyUrl = "string"
        }
      }
      exportConfiguration = {
        storageAccountName = "string"
      }
      implementationGuidesConfiguration = {
        usCoreMissingData = bool
      }
      importConfiguration = {
        enabled = bool
        initialImportMode = bool
        integrationDataStore = "string"
      }
      publicNetworkAccess = "string"
      resourceVersionPolicyConfiguration = {
        default = "string"
        resourceTypeOverrides = {
          {customized property} = "string"
        }
      }
    }
  }
}

Property Values

Microsoft.HealthcareApis/workspaces/fhirservices

Encryption

EncryptionCustomerManagedKeyEncryption

FhirServiceAcrConfiguration

FhirServiceAuthenticationConfiguration

FhirServiceCorsConfiguration

FhirServiceExportConfiguration

FhirServiceImportConfiguration

FhirServiceProperties

ImplementationGuidesConfiguration

ResourceTags

ResourceVersionPolicyConfiguration

ResourceVersionPolicyConfigurationResourceTypeOverrides

ServiceManagedIdentityIdentity

ServiceOciArtifactEntry

SmartIdentityProviderApplication

SmartIdentityProviderConfiguration

UserAssignedIdentities

UserAssignedIdentity

Usage Examples

Terraform Samples

A basic example of deploying Healthcare FHIR (Fast Healthcare Interoperability Resources) Service.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
    azurerm = {
      source = "hashicorp/azurerm"
    }
  }
}

provider "azurerm" {
  features {
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

data "azurerm_client_config" "current" {
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "workspace" {
  type                      = "Microsoft.HealthcareApis/workspaces@2022-12-01"
  parent_id                 = azapi_resource.resourceGroup.id
  name                      = var.resource_name
  location                  = var.location
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "fhirService" {
  type      = "Microsoft.HealthcareApis/workspaces/fhirServices@2022-12-01"
  parent_id = azapi_resource.workspace.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "fhir-R4"
    properties = {
      acrConfiguration = {
      }
      authenticationConfiguration = {
        audience          = "https://acctestfhir.fhir.azurehealthcareapis.com"
        authority         = "https://login.microsoftonline.com/${data.azurerm_client_config.current.tenant_id}"
        smartProxyEnabled = false
      }
      corsConfiguration = {
        allowCredentials = false
        headers = [
        ]
        methods = [
        ]
        origins = [
        ]
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "fhirService2" {
  type      = "Microsoft.HealthcareApis/workspaces/fhirServices@2022-12-01"
  parent_id = azapi_resource.workspace.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "fhir-R4"
    properties = {
      acrConfiguration = {
      }
      authenticationConfiguration = {
        audience          = azapi_resource.fhirService.output.properties.authenticationConfiguration.audience
        authority         = azapi_resource.fhirService.output.properties.authenticationConfiguration.authority
        smartProxyEnabled = false
      }
      corsConfiguration = {
        allowCredentials = false
        headers = [
        ]
        methods = [
        ]
        origins = [
        ]
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}