azure-resource-manager-schemas/schemas/2024-03-31/Microsoft.HealthcareApis.json

2181 строка
66 KiB
JSON

{
"id": "https://schema.management.azure.com/schemas/2024-03-31/Microsoft.HealthcareApis.json#",
"title": "Microsoft.HealthcareApis",
"description": "Microsoft HealthcareApis Resource Types",
"$schema": "http://json-schema.org/draft-04/schema#",
"resourceDefinitions": {
"services": {
"description": "Microsoft.HealthcareApis/services",
"properties": {
"apiVersion": {
"enum": [
"2024-03-31"
],
"type": "string"
},
"etag": {
"description": "An etag associated with the resource, used for optimistic concurrency when editing it.",
"type": "string"
},
"identity": {
"description": "Setting indicating whether the service has a managed identity associated with it.",
"oneOf": [
{
"$ref": "#/definitions/ServicesResourceIdentity"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"kind": {
"description": "The kind of the service.",
"oneOf": [
{
"enum": [
"fhir",
"fhir-Stu3",
"fhir-R4"
],
"type": "string"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"location": {
"description": "The resource location.",
"type": "string"
},
"name": {
"description": "The name of the service instance.",
"maxLength": 24,
"minLength": 3,
"type": "string"
},
"properties": {
"description": "The common properties of a service.",
"oneOf": [
{
"$ref": "#/definitions/ServicesProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"resources": {
"items": {
"oneOf": [
{
"$ref": "#/definitions/services_privateEndpointConnections_childResource"
}
]
},
"type": "array"
},
"tags": {
"description": "The resource tags.",
"oneOf": [
{
"additionalProperties": {
"type": "string"
},
"properties": {},
"type": "object"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"type": {
"enum": [
"Microsoft.HealthcareApis/services"
],
"type": "string"
}
},
"required": [
"name",
"properties",
"apiVersion",
"type"
],
"type": "object"
},
"services_privateEndpointConnections": {
"description": "Microsoft.HealthcareApis/services/privateEndpointConnections",
"properties": {
"apiVersion": {
"enum": [
"2024-03-31"
],
"type": "string"
},
"name": {
"description": "The name of the private endpoint connection associated with the Azure resource",
"type": "string"
},
"properties": {
"description": "Resource properties.",
"oneOf": [
{
"$ref": "#/definitions/PrivateEndpointConnectionProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"type": {
"enum": [
"Microsoft.HealthcareApis/services/privateEndpointConnections"
],
"type": "string"
}
},
"required": [
"name",
"properties",
"apiVersion",
"type"
],
"type": "object"
},
"workspaces": {
"description": "Microsoft.HealthcareApis/workspaces",
"properties": {
"apiVersion": {
"enum": [
"2024-03-31"
],
"type": "string"
},
"etag": {
"description": "An etag associated with the resource, used for optimistic concurrency when editing it.",
"type": "string"
},
"location": {
"description": "The resource location.",
"type": "string"
},
"name": {
"description": "The name of workspace resource.",
"maxLength": 24,
"minLength": 3,
"type": "string"
},
"properties": {
"description": "Workspaces resource specific properties.",
"oneOf": [
{
"$ref": "#/definitions/WorkspaceProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"resources": {
"items": {
"oneOf": [
{
"$ref": "#/definitions/workspaces_fhirservices_childResource"
},
{
"$ref": "#/definitions/workspaces_dicomservices_childResource"
},
{
"$ref": "#/definitions/workspaces_iotconnectors_childResource"
},
{
"$ref": "#/definitions/workspaces_privateEndpointConnections_childResource"
}
]
},
"type": "array"
},
"tags": {
"description": "Resource tags.",
"oneOf": [
{
"additionalProperties": {
"type": "string"
},
"properties": {},
"type": "object"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"type": {
"enum": [
"Microsoft.HealthcareApis/workspaces"
],
"type": "string"
}
},
"required": [
"name",
"properties",
"apiVersion",
"type"
],
"type": "object"
},
"workspaces_dicomservices": {
"description": "Microsoft.HealthcareApis/workspaces/dicomservices",
"properties": {
"apiVersion": {
"enum": [
"2024-03-31"
],
"type": "string"
},
"etag": {
"description": "An etag associated with the resource, used for optimistic concurrency when editing it.",
"type": "string"
},
"identity": {
"description": "Setting indicating whether the service has a managed identity associated with it.",
"oneOf": [
{
"$ref": "#/definitions/ServiceManagedIdentityIdentity"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"location": {
"description": "The resource location.",
"type": "string"
},
"name": {
"description": "The name of DICOM Service resource.",
"maxLength": 24,
"minLength": 3,
"type": "string"
},
"properties": {
"description": "Dicom Service configuration.",
"oneOf": [
{
"$ref": "#/definitions/DicomServiceProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"tags": {
"description": "Resource tags.",
"oneOf": [
{
"additionalProperties": {
"type": "string"
},
"properties": {},
"type": "object"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"type": {
"enum": [
"Microsoft.HealthcareApis/workspaces/dicomservices"
],
"type": "string"
}
},
"required": [
"name",
"properties",
"apiVersion",
"type"
],
"type": "object"
},
"workspaces_fhirservices": {
"description": "Microsoft.HealthcareApis/workspaces/fhirservices",
"properties": {
"apiVersion": {
"enum": [
"2024-03-31"
],
"type": "string"
},
"etag": {
"description": "An etag associated with the resource, used for optimistic concurrency when editing it.",
"type": "string"
},
"identity": {
"description": "Setting indicating whether the service has a managed identity associated with it.",
"oneOf": [
{
"$ref": "#/definitions/ServiceManagedIdentityIdentity"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"kind": {
"description": "The kind of the service.",
"oneOf": [
{
"enum": [
"fhir-Stu3",
"fhir-R4"
],
"type": "string"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"location": {
"description": "The resource location.",
"type": "string"
},
"name": {
"description": "The name of FHIR Service resource.",
"maxLength": 24,
"minLength": 3,
"type": "string"
},
"properties": {
"description": "Fhir Service configuration.",
"oneOf": [
{
"$ref": "#/definitions/FhirServiceProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"tags": {
"description": "Resource tags.",
"oneOf": [
{
"additionalProperties": {
"type": "string"
},
"properties": {},
"type": "object"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"type": {
"enum": [
"Microsoft.HealthcareApis/workspaces/fhirservices"
],
"type": "string"
}
},
"required": [
"name",
"properties",
"apiVersion",
"type"
],
"type": "object"
},
"workspaces_iotconnectors": {
"description": "Microsoft.HealthcareApis/workspaces/iotconnectors",
"properties": {
"apiVersion": {
"enum": [
"2024-03-31"
],
"type": "string"
},
"etag": {
"description": "An etag associated with the resource, used for optimistic concurrency when editing it.",
"type": "string"
},
"identity": {
"description": "Setting indicating whether the service has a managed identity associated with it.",
"oneOf": [
{
"$ref": "#/definitions/ServiceManagedIdentityIdentity"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"location": {
"description": "The resource location.",
"type": "string"
},
"name": {
"description": "The name of IoT Connector resource.",
"maxLength": 24,
"minLength": 3,
"type": "string"
},
"properties": {
"description": "IoT Connector configuration.",
"oneOf": [
{
"$ref": "#/definitions/IotConnectorProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"resources": {
"items": {
"oneOf": [
{
"$ref": "#/definitions/workspaces_iotconnectors_fhirdestinations_childResource"
}
]
},
"type": "array"
},
"tags": {
"description": "Resource tags.",
"oneOf": [
{
"additionalProperties": {
"type": "string"
},
"properties": {},
"type": "object"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"type": {
"enum": [
"Microsoft.HealthcareApis/workspaces/iotconnectors"
],
"type": "string"
}
},
"required": [
"name",
"properties",
"apiVersion",
"type"
],
"type": "object"
},
"workspaces_iotconnectors_fhirdestinations": {
"description": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations",
"properties": {
"apiVersion": {
"enum": [
"2024-03-31"
],
"type": "string"
},
"etag": {
"description": "An etag associated with the resource, used for optimistic concurrency when editing it.",
"type": "string"
},
"location": {
"description": "The resource location.",
"type": "string"
},
"name": {
"description": "The name of IoT Connector FHIR destination resource.",
"maxLength": 24,
"minLength": 3,
"type": "string"
},
"properties": {
"description": "IoT FHIR Destination settings.",
"oneOf": [
{
"$ref": "#/definitions/IotFhirDestinationProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"type": {
"enum": [
"Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations"
],
"type": "string"
}
},
"required": [
"name",
"properties",
"apiVersion",
"type"
],
"type": "object"
},
"workspaces_privateEndpointConnections": {
"description": "Microsoft.HealthcareApis/workspaces/privateEndpointConnections",
"properties": {
"apiVersion": {
"enum": [
"2024-03-31"
],
"type": "string"
},
"name": {
"description": "The name of the private endpoint connection associated with the Azure resource",
"type": "string"
},
"properties": {
"description": "Resource properties.",
"oneOf": [
{
"$ref": "#/definitions/PrivateEndpointConnectionProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"type": {
"enum": [
"Microsoft.HealthcareApis/workspaces/privateEndpointConnections"
],
"type": "string"
}
},
"required": [
"name",
"properties",
"apiVersion",
"type"
],
"type": "object"
}
},
"definitions": {
"CorsConfiguration": {
"description": "The settings for the CORS configuration of the service instance.",
"properties": {
"allowCredentials": {
"description": "If credentials are allowed via CORS.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"headers": {
"description": "The headers to be allowed via CORS.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"maxAge": {
"description": "The max age to be allowed via CORS.",
"oneOf": [
{
"maximum": 99999,
"minimum": 0,
"type": "integer"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"methods": {
"description": "The methods to be allowed via CORS.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"origins": {
"description": "The origins to be allowed via CORS.",
"oneOf": [
{
"items": {
"pattern": "^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\\:\\/\\/(?:[a-zA-Z0-9-]+[.]?)+(?:\\:[0-9]{1,5})?|[*]))$",
"type": "string"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"DicomServiceAuthenticationConfiguration": {
"description": "Authentication configuration information",
"properties": {},
"type": "object"
},
"DicomServiceProperties": {
"description": "Dicom Service properties.",
"properties": {
"authenticationConfiguration": {
"description": "Dicom Service authentication configuration.",
"oneOf": [
{
"$ref": "#/definitions/DicomServiceAuthenticationConfiguration"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"corsConfiguration": {
"description": "Dicom Service Cors configuration.",
"oneOf": [
{
"$ref": "#/definitions/CorsConfiguration"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"enableDataPartitions": {
"description": "If data partitions is enabled or not.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"encryption": {
"description": "The encryption settings of the DICOM service",
"oneOf": [
{
"$ref": "#/definitions/Encryption"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"publicNetworkAccess": {
"description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.",
"oneOf": [
{
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"storageConfiguration": {
"description": "The configuration of external storage account",
"oneOf": [
{
"$ref": "#/definitions/StorageConfiguration"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"Encryption": {
"description": "Settings to encrypt a service",
"properties": {
"customerManagedKeyEncryption": {
"description": "The encryption settings for the customer-managed key",
"oneOf": [
{
"$ref": "#/definitions/EncryptionCustomerManagedKeyEncryption"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"EncryptionCustomerManagedKeyEncryption": {
"description": "The encryption settings for the customer-managed key",
"properties": {
"keyEncryptionKeyUrl": {
"description": "The URL of the key to use for encryption",
"type": "string"
}
},
"type": "object"
},
"FhirServiceAcrConfiguration": {
"description": "Azure container registry configuration information",
"properties": {
"loginServers": {
"description": "The list of the Azure container registry login servers.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"ociArtifacts": {
"description": "The list of Open Container Initiative (OCI) artifacts.",
"oneOf": [
{
"items": {
"$ref": "#/definitions/ServiceOciArtifactEntry"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"FhirServiceAuthenticationConfiguration": {
"description": "Authentication configuration information",
"properties": {
"audience": {
"description": "The audience url for the service",
"type": "string"
},
"authority": {
"description": "The authority url for the service",
"type": "string"
},
"smartIdentityProviders": {
"description": "The array of identity provider configurations for SMART on FHIR authentication.",
"oneOf": [
{
"items": {
"$ref": "#/definitions/SmartIdentityProviderConfiguration"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"smartProxyEnabled": {
"description": "If the SMART on FHIR proxy is enabled",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"FhirServiceCorsConfiguration": {
"description": "The settings for the CORS configuration of the service instance.",
"properties": {
"allowCredentials": {
"description": "If credentials are allowed via CORS.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"headers": {
"description": "The headers to be allowed via CORS.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"maxAge": {
"description": "The max age to be allowed via CORS.",
"oneOf": [
{
"maximum": 99999,
"minimum": 0,
"type": "integer"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"methods": {
"description": "The methods to be allowed via CORS.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"origins": {
"description": "The origins to be allowed via CORS.",
"oneOf": [
{
"items": {
"pattern": "^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\\:\\/\\/(?:[a-zA-Z0-9-]+[.]?)+(?:\\:[0-9]{1,5})?|[*]))$",
"type": "string"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"FhirServiceExportConfiguration": {
"description": "Export operation configuration information",
"properties": {
"storageAccountName": {
"description": "The name of the default export storage account.",
"type": "string"
}
},
"type": "object"
},
"FhirServiceImportConfiguration": {
"description": "Import operation configuration information",
"properties": {
"enabled": {
"description": "If the import operation is enabled.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"initialImportMode": {
"description": "If the FHIR service is in InitialImportMode.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"integrationDataStore": {
"description": "The name of the default integration storage account.",
"type": "string"
}
},
"type": "object"
},
"FhirServiceProperties": {
"description": "Fhir Service properties.",
"properties": {
"acrConfiguration": {
"description": "Fhir Service Azure container registry configuration.",
"oneOf": [
{
"$ref": "#/definitions/FhirServiceAcrConfiguration"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"authenticationConfiguration": {
"description": "Fhir Service authentication configuration.",
"oneOf": [
{
"$ref": "#/definitions/FhirServiceAuthenticationConfiguration"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"corsConfiguration": {
"description": "Fhir Service Cors configuration.",
"oneOf": [
{
"$ref": "#/definitions/FhirServiceCorsConfiguration"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"encryption": {
"description": "The encryption settings of the FHIR service",
"oneOf": [
{
"$ref": "#/definitions/Encryption"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"exportConfiguration": {
"description": "Fhir Service export configuration.",
"oneOf": [
{
"$ref": "#/definitions/FhirServiceExportConfiguration"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"implementationGuidesConfiguration": {
"description": "Implementation Guides configuration.",
"oneOf": [
{
"$ref": "#/definitions/ImplementationGuidesConfiguration"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"importConfiguration": {
"description": "Fhir Service import configuration.",
"oneOf": [
{
"$ref": "#/definitions/FhirServiceImportConfiguration"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"publicNetworkAccess": {
"description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.",
"oneOf": [
{
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"resourceVersionPolicyConfiguration": {
"description": "Determines tracking of history for resources.",
"oneOf": [
{
"$ref": "#/definitions/ResourceVersionPolicyConfiguration"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"ImplementationGuidesConfiguration": {
"description": "The settings for Implementation Guides - defining capabilities for national standards, vendor consortiums, clinical societies, etc.",
"properties": {
"usCoreMissingData": {
"description": "If US Core Missing Data requirement is enabled.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"IotConnectorProperties": {
"description": "IoT Connector properties.",
"properties": {
"deviceMapping": {
"description": "Device Mappings.",
"oneOf": [
{
"$ref": "#/definitions/IotMappingProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"ingestionEndpointConfiguration": {
"description": "Source configuration.",
"oneOf": [
{
"$ref": "#/definitions/IotEventHubIngestionEndpointConfiguration"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"IotEventHubIngestionEndpointConfiguration": {
"description": "Event Hub ingestion endpoint configuration",
"properties": {
"consumerGroup": {
"description": "Consumer group of the event hub to connected to.",
"type": "string"
},
"eventHubName": {
"description": "Event Hub name to connect to.",
"type": "string"
},
"fullyQualifiedEventHubNamespace": {
"description": "Fully qualified namespace of the Event Hub to connect to.",
"type": "string"
}
},
"type": "object"
},
"IotFhirDestinationProperties": {
"description": "IoT Connector destination properties for an Azure FHIR service.",
"properties": {
"fhirMapping": {
"description": "FHIR Mappings",
"oneOf": [
{
"$ref": "#/definitions/IotMappingProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"fhirServiceResourceId": {
"description": "Fully qualified resource id of the FHIR service to connect to.",
"type": "string"
},
"resourceIdentityResolutionType": {
"description": "Determines how resource identity is resolved on the destination.",
"oneOf": [
{
"enum": [
"Create",
"Lookup"
],
"type": "string"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"required": [
"resourceIdentityResolutionType",
"fhirServiceResourceId",
"fhirMapping"
],
"type": "object"
},
"IotMappingProperties": {
"description": "The mapping content.",
"properties": {
"content": {
"description": "The mapping.",
"oneOf": [
{
"type": "object"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"PrivateEndpoint": {
"description": "The Private Endpoint resource.",
"properties": {},
"type": "object"
},
"PrivateEndpointConnection": {
"description": "The Private Endpoint Connection resource.",
"properties": {
"properties": {
"description": "Resource properties.",
"oneOf": [
{
"$ref": "#/definitions/PrivateEndpointConnectionProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"PrivateEndpointConnectionProperties": {
"description": "Properties of the PrivateEndpointConnectProperties.",
"properties": {
"privateEndpoint": {
"description": "The resource of private end point.",
"oneOf": [
{
"$ref": "#/definitions/PrivateEndpoint"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"privateLinkServiceConnectionState": {
"description": "A collection of information about the state of the connection between service consumer and provider.",
"oneOf": [
{
"$ref": "#/definitions/PrivateLinkServiceConnectionState"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"required": [
"privateLinkServiceConnectionState"
],
"type": "object"
},
"PrivateLinkServiceConnectionState": {
"description": "A collection of information about the state of the connection between service consumer and provider.",
"properties": {
"actionsRequired": {
"description": "A message indicating if changes on the service provider require any updates on the consumer.",
"type": "string"
},
"description": {
"description": "The reason for approval/rejection of the connection.",
"type": "string"
},
"status": {
"description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.",
"oneOf": [
{
"enum": [
"Pending",
"Approved",
"Rejected"
],
"type": "string"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"ResourceVersionPolicyConfiguration": {
"description": "The settings for history tracking for FHIR resources.",
"properties": {
"default": {
"description": "The default value for tracking history across all resources.",
"oneOf": [
{
"enum": [
"no-version",
"versioned",
"versioned-update"
],
"type": "string"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"resourceTypeOverrides": {
"description": "A list of FHIR Resources and their version policy overrides.",
"oneOf": [
{
"additionalProperties": {
"enum": [
"no-version",
"versioned",
"versioned-update"
],
"type": "string"
},
"properties": {},
"type": "object"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"ServiceAccessPolicyEntry": {
"description": "An access policy entry.",
"properties": {
"objectId": {
"description": "An Azure AD object ID (User or Apps) that is allowed access to the FHIR service.",
"oneOf": [
{
"pattern": "^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$",
"type": "string"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"required": [
"objectId"
],
"type": "object"
},
"ServiceAcrConfigurationInfo": {
"description": "Azure container registry configuration information",
"properties": {
"loginServers": {
"description": "The list of the ACR login servers.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"ociArtifacts": {
"description": "The list of Open Container Initiative (OCI) artifacts.",
"oneOf": [
{
"items": {
"$ref": "#/definitions/ServiceOciArtifactEntry"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"ServiceAuthenticationConfigurationInfo": {
"description": "Authentication configuration information",
"properties": {
"audience": {
"description": "The audience url for the service",
"type": "string"
},
"authority": {
"description": "The authority url for the service",
"type": "string"
},
"smartProxyEnabled": {
"description": "If the SMART on FHIR proxy is enabled",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"ServiceCorsConfigurationInfo": {
"description": "The settings for the CORS configuration of the service instance.",
"properties": {
"allowCredentials": {
"description": "If credentials are allowed via CORS.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"headers": {
"description": "The headers to be allowed via CORS.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"maxAge": {
"description": "The max age to be allowed via CORS.",
"oneOf": [
{
"maximum": 99999,
"minimum": 0,
"type": "integer"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"methods": {
"description": "The methods to be allowed via CORS.",
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"origins": {
"description": "The origins to be allowed via CORS.",
"oneOf": [
{
"items": {
"pattern": "^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\\:\\/\\/(?:[a-zA-Z0-9-]+[.]?)+(?:\\:[0-9]{1,5})?|[*]))$",
"type": "string"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"ServiceCosmosDbConfigurationInfo": {
"description": "The settings for the Cosmos DB database backing the service.",
"properties": {
"crossTenantCmkApplicationId": {
"description": "The multi-tenant application id used to enable CMK access for services in a data sovereign region.",
"oneOf": [
{
"pattern": "^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$",
"type": "string"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"keyVaultKeyUri": {
"description": "The URI of the customer-managed key for the backing database.",
"type": "string"
},
"offerThroughput": {
"description": "The provisioned throughput for the backing database.",
"oneOf": [
{
"minimum": 400,
"type": "integer"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"ServiceExportConfigurationInfo": {
"description": "Export operation configuration information",
"properties": {
"storageAccountName": {
"description": "The name of the default export storage account.",
"type": "string"
}
},
"type": "object"
},
"ServiceImportConfigurationInfo": {
"description": "Import operation configuration information",
"properties": {
"enabled": {
"description": "If the import operation is enabled.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"initialImportMode": {
"description": "If the FHIR service is in InitialImportMode.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"integrationDataStore": {
"description": "The name of the default integration storage account.",
"type": "string"
}
},
"type": "object"
},
"ServiceManagedIdentityIdentity": {
"description": "Setting indicating whether the service has a managed identity associated with it.",
"properties": {
"type": {
"description": "Type of identity being specified, currently SystemAssigned and None are allowed.",
"oneOf": [
{
"enum": [
"None",
"SystemAssigned",
"UserAssigned",
"SystemAssigned,UserAssigned"
],
"type": "string"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"userAssignedIdentities": {
"description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/UserAssignedIdentity"
},
"properties": {},
"type": "object"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"required": [
"type"
],
"type": "object"
},
"ServiceOciArtifactEntry": {
"description": "An Open Container Initiative (OCI) artifact.",
"properties": {
"digest": {
"description": "The artifact digest.",
"type": "string"
},
"imageName": {
"description": "The artifact name.",
"type": "string"
},
"loginServer": {
"description": "The Azure Container Registry login server.",
"type": "string"
}
},
"type": "object"
},
"ServicesProperties": {
"description": "The properties of a service instance.",
"properties": {
"accessPolicies": {
"description": "The access policies of the service instance.",
"oneOf": [
{
"items": {
"$ref": "#/definitions/ServiceAccessPolicyEntry"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"acrConfiguration": {
"description": "The azure container registry settings used for convert data operation of the service instance.",
"oneOf": [
{
"$ref": "#/definitions/ServiceAcrConfigurationInfo"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"authenticationConfiguration": {
"description": "The authentication configuration for the service instance.",
"oneOf": [
{
"$ref": "#/definitions/ServiceAuthenticationConfigurationInfo"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"corsConfiguration": {
"description": "The settings for the CORS configuration of the service instance.",
"oneOf": [
{
"$ref": "#/definitions/ServiceCorsConfigurationInfo"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"cosmosDbConfiguration": {
"description": "The settings for the Cosmos DB database backing the service.",
"oneOf": [
{
"$ref": "#/definitions/ServiceCosmosDbConfigurationInfo"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"exportConfiguration": {
"description": "The settings for the export operation of the service instance.",
"oneOf": [
{
"$ref": "#/definitions/ServiceExportConfigurationInfo"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"importConfiguration": {
"description": "The settings for the import operation of the service instance.",
"oneOf": [
{
"$ref": "#/definitions/ServiceImportConfigurationInfo"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"privateEndpointConnections": {
"description": "The list of private endpoint connections that are set up for this resource.",
"oneOf": [
{
"items": {
"$ref": "#/definitions/PrivateEndpointConnection"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"publicNetworkAccess": {
"description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.",
"oneOf": [
{
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"ServicesResourceIdentity": {
"description": "Setting indicating whether the service has a managed identity associated with it.",
"properties": {
"type": {
"description": "Type of identity being specified, currently SystemAssigned and None are allowed.",
"oneOf": [
{
"enum": [
"SystemAssigned",
"None"
],
"type": "string"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"SmartIdentityProviderApplication": {
"description": "An Application configured in the Identity Provider used to access FHIR resources.",
"properties": {
"allowedDataActions": {
"description": "The actions that are permitted to be performed on FHIR resources for the application.",
"oneOf": [
{
"items": {
"enum": [
"Read"
],
"type": "string"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"audience": {
"description": "The audience that will be used to validate bearer tokens against the given authority.",
"type": "string"
},
"clientId": {
"description": "The application client id defined in the identity provider. This value will be used to validate bearer tokens against the given authority.",
"type": "string"
}
},
"type": "object"
},
"SmartIdentityProviderConfiguration": {
"description": "An object to configure an identity provider for use with SMART on FHIR authentication.",
"properties": {
"applications": {
"description": "The array of identity provider applications for SMART on FHIR authentication.",
"oneOf": [
{
"items": {
"$ref": "#/definitions/SmartIdentityProviderApplication"
},
"type": "array"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"authority": {
"description": "The identity provider token authority also known as the token issuing authority.",
"type": "string"
}
},
"type": "object"
},
"StorageConfiguration": {
"description": "The configuration of connected storage",
"properties": {
"fileSystemName": {
"description": "The filesystem name of connected storage account.",
"type": "string"
},
"storageResourceId": {
"description": "The resource id of connected storage account.",
"type": "string"
}
},
"type": "object"
},
"UserAssignedIdentity": {
"description": "User assigned identity properties",
"properties": {},
"type": "object"
},
"WorkspaceProperties": {
"description": "Workspaces resource specific properties.",
"properties": {
"publicNetworkAccess": {
"description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.",
"oneOf": [
{
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
}
},
"type": "object"
},
"services_privateEndpointConnections_childResource": {
"description": "Microsoft.HealthcareApis/services/privateEndpointConnections",
"properties": {
"apiVersion": {
"enum": [
"2024-03-31"
],
"type": "string"
},
"name": {
"description": "The name of the private endpoint connection associated with the Azure resource",
"type": "string"
},
"properties": {
"description": "Resource properties.",
"oneOf": [
{
"$ref": "#/definitions/PrivateEndpointConnectionProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"type": {
"enum": [
"privateEndpointConnections"
],
"type": "string"
}
},
"required": [
"name",
"properties",
"apiVersion",
"type"
],
"type": "object"
},
"workspaces_dicomservices_childResource": {
"description": "Microsoft.HealthcareApis/workspaces/dicomservices",
"properties": {
"apiVersion": {
"enum": [
"2024-03-31"
],
"type": "string"
},
"etag": {
"description": "An etag associated with the resource, used for optimistic concurrency when editing it.",
"type": "string"
},
"identity": {
"description": "Setting indicating whether the service has a managed identity associated with it.",
"oneOf": [
{
"$ref": "#/definitions/ServiceManagedIdentityIdentity"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"location": {
"description": "The resource location.",
"type": "string"
},
"name": {
"description": "The name of DICOM Service resource.",
"maxLength": 24,
"minLength": 3,
"type": "string"
},
"properties": {
"description": "Dicom Service configuration.",
"oneOf": [
{
"$ref": "#/definitions/DicomServiceProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"tags": {
"description": "Resource tags.",
"oneOf": [
{
"additionalProperties": {
"type": "string"
},
"properties": {},
"type": "object"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"type": {
"enum": [
"dicomservices"
],
"type": "string"
}
},
"required": [
"name",
"properties",
"apiVersion",
"type"
],
"type": "object"
},
"workspaces_fhirservices_childResource": {
"description": "Microsoft.HealthcareApis/workspaces/fhirservices",
"properties": {
"apiVersion": {
"enum": [
"2024-03-31"
],
"type": "string"
},
"etag": {
"description": "An etag associated with the resource, used for optimistic concurrency when editing it.",
"type": "string"
},
"identity": {
"description": "Setting indicating whether the service has a managed identity associated with it.",
"oneOf": [
{
"$ref": "#/definitions/ServiceManagedIdentityIdentity"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"kind": {
"description": "The kind of the service.",
"oneOf": [
{
"enum": [
"fhir-Stu3",
"fhir-R4"
],
"type": "string"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"location": {
"description": "The resource location.",
"type": "string"
},
"name": {
"description": "The name of FHIR Service resource.",
"maxLength": 24,
"minLength": 3,
"type": "string"
},
"properties": {
"description": "Fhir Service configuration.",
"oneOf": [
{
"$ref": "#/definitions/FhirServiceProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"tags": {
"description": "Resource tags.",
"oneOf": [
{
"additionalProperties": {
"type": "string"
},
"properties": {},
"type": "object"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"type": {
"enum": [
"fhirservices"
],
"type": "string"
}
},
"required": [
"name",
"properties",
"apiVersion",
"type"
],
"type": "object"
},
"workspaces_iotconnectors_childResource": {
"description": "Microsoft.HealthcareApis/workspaces/iotconnectors",
"properties": {
"apiVersion": {
"enum": [
"2024-03-31"
],
"type": "string"
},
"etag": {
"description": "An etag associated with the resource, used for optimistic concurrency when editing it.",
"type": "string"
},
"identity": {
"description": "Setting indicating whether the service has a managed identity associated with it.",
"oneOf": [
{
"$ref": "#/definitions/ServiceManagedIdentityIdentity"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"location": {
"description": "The resource location.",
"type": "string"
},
"name": {
"description": "The name of IoT Connector resource.",
"maxLength": 24,
"minLength": 3,
"type": "string"
},
"properties": {
"description": "IoT Connector configuration.",
"oneOf": [
{
"$ref": "#/definitions/IotConnectorProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"tags": {
"description": "Resource tags.",
"oneOf": [
{
"additionalProperties": {
"type": "string"
},
"properties": {},
"type": "object"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"type": {
"enum": [
"iotconnectors"
],
"type": "string"
}
},
"required": [
"name",
"properties",
"apiVersion",
"type"
],
"type": "object"
},
"workspaces_iotconnectors_fhirdestinations_childResource": {
"description": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations",
"properties": {
"apiVersion": {
"enum": [
"2024-03-31"
],
"type": "string"
},
"etag": {
"description": "An etag associated with the resource, used for optimistic concurrency when editing it.",
"type": "string"
},
"location": {
"description": "The resource location.",
"type": "string"
},
"name": {
"description": "The name of IoT Connector FHIR destination resource.",
"maxLength": 24,
"minLength": 3,
"type": "string"
},
"properties": {
"description": "IoT FHIR Destination settings.",
"oneOf": [
{
"$ref": "#/definitions/IotFhirDestinationProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"type": {
"enum": [
"fhirdestinations"
],
"type": "string"
}
},
"required": [
"name",
"properties",
"apiVersion",
"type"
],
"type": "object"
},
"workspaces_privateEndpointConnections_childResource": {
"description": "Microsoft.HealthcareApis/workspaces/privateEndpointConnections",
"properties": {
"apiVersion": {
"enum": [
"2024-03-31"
],
"type": "string"
},
"name": {
"description": "The name of the private endpoint connection associated with the Azure resource",
"type": "string"
},
"properties": {
"description": "Resource properties.",
"oneOf": [
{
"$ref": "#/definitions/PrivateEndpointConnectionProperties"
},
{
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
}
]
},
"type": {
"enum": [
"privateEndpointConnections"
],
"type": "string"
}
},
"required": [
"name",
"properties",
"apiVersion",
"type"
],
"type": "object"
}
}
}