← LeaderboardThe Skill Leaderboard

azure-health-data-services

Expert knowledge for Azure Health Data Services development including troubleshooting, best practices, decision making, architecture & design patterns, limits & quotas, security, configuration, integrations & coding patterns, and deployment. Use when using FHIR/DICOM APIs, bulk import/export, de-identification, events, or Synapse/ADF/Fabric integrations, and other Azure Health Data Services related development tasks. Not for Azure Health Bot (use azure-health-bot), Azure Data Factory (use azure-data-factory), Azure Synapse Analytics (use azure-synapse-analytics), Azure Machine Learning (use az

Published by MicrosoftDocs ↗MicrosoftDocs/Agent-Skills

Try your first task

A source-grounded starter task has not been verified for this skill yet.

SKILL.md

name: azure-health-data-servicesdescription: Expert knowledge for Azure Health Data Services development including troubleshooting, best practices, decision making, architecture & design patterns, limits & quotas, security, configuration, integrations & coding patterns, and deployment. Use when using FHIR/DICOM APIs, bulk import/export, de-identification, events, or Synapse/ADF/Fabric integrations, and other Azure Health Data Services related development tasks. Not for Azure Health Bot (use azure-health-bot), Azure Data Factory (use azure-data-factory), Azure Synapse Analytics (use azure-synapse-analytics), Azure Machine Learning (use azure-machine-learning).compatibility: Requires network access. Uses mcp_microsoftdocs:microsoft_docs_fetch or fetch_webpage to retrieve documentation.metadata:   generated_at: "2026-11-01"  generator: "docs2skills/1.0.0"

Azure Health Data Services Skill

This skill provides expert guidance for Azure Health Data Services. Covers troubleshooting, best practices, decision making, architecture & design patterns, limits & quotas, security, configuration, integrations & coding patterns, and deployment. It combines local quick-reference content with remote documentation fetching capabilities.

How to Use This Skill

IMPORTANT for Agent: Use the Category Index below to locate relevant sections. For categories with line ranges (e.g., L35-L120), use read_file with the specified lines. For categories with file links (e.g., [security.md](security.md)), use read_file on the linked reference file

IMPORTANT for Agent: If metadata.generated_at is more than 3 months old, suggest the user pull the latest version from the repository. If mcp_microsoftdocs tools are not available, suggest the user install it: Installation Guide

This skill requires network access to fetch documentation content:

  • Preferred: Use mcp_microsoftdocs:microsoft_docs_fetch with query string from=learn-agent-skill. Returns Markdown.
  • Fallback: Use fetch_webpage with query string from=learn-agent-skill&accept=text/markdown. Returns Markdown.

Category Index

CategoryLinesDescription
TroubleshootingL37-L46Diagnosing and fixing Azure Health Data Services issues: FHIR token validation, event delivery, $convert-data errors/performance, identity provider setup, and known service limitations.
Best PracticesL47-L54BCDR planning, CMK encryption for FHIR/DICOM, FHIR performance tuning, and safe configuration/operation of FHIR reindex jobs
Decision MakingL55-L60Guidance for planning and executing migrations from Azure API for FHIR to Azure Health Data Services, including architecture, data, and operational considerations.
Architecture & Design PatternsL61-L68BCDR planning, reliable de-identification deployments, and reference architectures for integrating DICOM service with Azure Data Lake and digital pathology workflows.
Limits & QuotasL69-L77Autoscaling, capacity, DR behavior, deprecation impacts, de-identification language/locale support, and DICOM service requirements, quotas, and limits.
SecurityL78-L118Configuring secure access to FHIR/DICOM/HD services: Entra auth, RBAC, tokens, app registrations, Private Link, CMK encryption, SMART on FHIR, external/B2C IDs, and network security.
ConfigurationL119-L167Configuring Azure FHIR and DICOM services: CORS, logging, storage, bulk import/export, de-identification, profiles/validation, search parameters, events, and FHIR operations like $import/$export/$member-match.
Integrations & Coding PatternsL168-L204Patterns and code samples for calling FHIR/DICOM APIs, bulk operations, de-identification, events, and integrating Azure Health Data Services with Synapse, ADF/Fabric, Logic Apps, and compliance profiles.
DeploymentL205-L220Guides for deploying and moving Azure Health Data Services (FHIR, DICOM, de-identification, workspaces) using portal, ARM, Bicep, PowerShell, and CLI across subscriptions and storage options.

Troubleshooting

Best Practices

Decision Making

TopicURL
Plan and execute migration from Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/migration-faq
Plan and execute migration from Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/migration-strategies

Architecture & Design Patterns

Limits & Quotas

Security

TopicURL
Configure authentication and authorization for Health Data Serviceshttps://learn.microsoft.com/en-us/azure/healthcare-apis/authentication-authorization
Configure Entra-based auth for Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/azure-active-directory-identity-configuration
Configure Azure RBAC for Azure API for FHIR datahttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/configure-azure-rbac
Configure local RBAC with secondary Entra tenant for Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/configure-local-rbac
Configure Private Link for Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/configure-private-link
Configure customer-managed keys for Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/customer-managed-key
Register Entra applications for Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-app-registration
Find identity object IDs for Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/find-identity-object-ids
Get Azure API for FHIR access token via CLIhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/get-healthcare-apis-access-token-cli
Apply built-in Azure Policy definitions to Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/policy-reference
Register confidential client app for Azure FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/register-confidential-azure-ad-client-app
Register public client app for Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/register-public-azure-ad-client-app
Register FHIR resource app in Microsoft Entra IDhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/register-resource-azure-ad-client-app
Register service client app for Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/register-service-azure-ad-client-app
Apply regulatory compliance policies to Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/security-controls-policy
Enable SMART on FHIR security for Azure APIhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/smart-on-fhir
Apply built-in Azure Policies to Health Datahttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-health-data-services-policy-reference
Configure Azure RBAC for Health Data Serviceshttps://learn.microsoft.com/en-us/azure/healthcare-apis/configure-azure-rbac
Grant FHIR and DICOM access using CLI and RESThttps://learn.microsoft.com/en-us/azure/healthcare-apis/configure-azure-rbac-using-scripts
Configure Private Link for Azure Health Data Serviceshttps://learn.microsoft.com/en-us/azure/healthcare-apis/configure-private-link
Set up private endpoint access for de-identificationhttps://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/configure-private-endpoints
Manage de-identification service access using Azure RBAChttps://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/manage-access-rbac
Use managed identities with de-identification servicehttps://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/managed-identities
Configure customer-managed keys for DICOM encryptionhttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/configure-customer-managed-keys
Configure Azure RBAC roles for DICOM servicehttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/dicom-configure-azure-rbac
Register client applications for DICOM service in Entra IDhttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/dicom-register-application
Request access tokens for DICOM servicehttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/get-access-token
Configure Azure AD B2C access to FHIR servicehttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/azure-ad-b2c-setup
Configure Entra External ID access for Azure FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/azure-entra-external-id-setup
Configure customer-managed keys for FHIR encryptionhttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/configure-customer-managed-keys
Configure secure FHIR export to Azure Storagehttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/configure-export-data
Configure multiple identity providers for FHIR servicehttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/configure-identity-providers
Configure SMART on FHIR security for AHDS FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/smart-on-fhir
Obtain access tokens for FHIR and DICOM serviceshttps://learn.microsoft.com/en-us/azure/healthcare-apis/get-access-token
Configure network access security for Health Data Serviceshttps://learn.microsoft.com/en-us/azure/healthcare-apis/network-access-security
Register Entra client app for Azure Health Data Serviceshttps://learn.microsoft.com/en-us/azure/healthcare-apis/register-application
Scripted Entra app registration for Health Data Serviceshttps://learn.microsoft.com/en-us/azure/healthcare-apis/register-application-cli-rest

Configuration

TopicURL
Configure bulk delete operations for Azure FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/bulk-delete-operation
Configure Azure FHIR for CARIN Blue Button testshttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/carin-implementation-guide-blue-button-tutorial
Configure CORS for Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/configure-cross-origin-resource-sharing
Configure database RUs and settings for Azure FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/configure-database
Configure export settings for Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/configure-export-data
Configure Azure FHIR for Da Vinci Drug Formularyhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/davinci-drug-formulary-tutorial
Configure Azure API for FHIR for Da Vinci PDexhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/davinci-pdex-tutorial
Configure Azure FHIR for Da Vinci Plan-Net testshttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/davinci-plan-net
Configure and run de-identified export in Azure FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/de-identified-export
Enable and query diagnostic logs for Azure FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/enable-diagnostic-logging
Review supported FHIR features in Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-features-supported
Define and use custom search parameters in Azure FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/how-to-do-custom-search
Run and manage reindex jobs in Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/how-to-run-a-reindex
Manage FHIR resource history and purge in Azure FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/purge-history
Store and manage FHIR profiles in Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/store-profiles-in-fhir
Add custom headers to Azure API for FHIR audit logshttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/use-custom-headers
Configure FHIR profile validation in Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/validation-against-profiles
Configure Azure Storage for de-identification batch jobshttps://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/configure-storage
Configure monitoring and alerts for de-identification servicehttps://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/monitor-deidentification-service
Reference for de-identification service monitoring datahttps://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/monitor-deidentification-service-reference
Define custom redaction formats for de-identification servicehttps://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format
Configure CORS settings for DICOM servicehttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/configure-cross-origin-resource-sharing
Customize image location URLs in DICOM responseshttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/dicom-proxy-url-support
Understand DICOM service v1 conformance and APIshttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/dicom-services-conformance-statement
Implement Azure DICOM service v2 conformancehttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/dicom-services-conformance-statement-v2
Enable and query DICOM diagnostic logginghttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/enable-diagnostic-logging
Configure bulk import for Azure DICOM servicehttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/import-files
Disable FHIR and DICOM events by deleting subscriptionshttps://learn.microsoft.com/en-us/azure/healthcare-apis/events/events-disable-delete-workspace
Understand Azure Health Data Services event message schemahttps://learn.microsoft.com/en-us/azure/healthcare-apis/events/events-message-structure
Configure CORS settings for Azure FHIR servicehttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/configure-cross-origin-resource-sharing
Configure FHIR $import storage and permissionshttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/configure-import-data
Configure $convert-data templates in Azure FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/convert-data-configuration
Configure de-identified FHIR data exporthttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/deidentified-export
Run bulk $export operations on FHIR datahttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/export-data
Use $docref to fetch patient DocumentReferenceshttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/fhir-docref
Use $expand to resolve FHIR ValueSetshttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/fhir-expand
Configure and query FHIR diagnostic logshttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/fhir-service-diagnostic-logs
Configure FHIR versioning policy and history retentionhttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/fhir-versioning-policy-and-history-management
Define and manage custom FHIR search parametershttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/how-to-do-custom-search
Use Patient-everything operation in FHIR servicehttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/patient-everything
Use $purge-history to delete FHIR resource historyhttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/purge-history
Configure selectable search parameters in Azure FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/selectable-search-parameters
Use $member-match operation on FHIR servicehttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/tutorial-member-match
Configure custom HTTP headers for FHIR audit logshttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/use-custom-headers-diagnosticlog
Validate FHIR resources against stored profileshttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/validation-against-profiles

Integrations & Coding Patterns

TopicURL
Access FHIR and DICOM APIs with cURL and SDKshttps://learn.microsoft.com/en-us/azure/healthcare-apis/access-healthcare-apis
Use $convert-data endpoint in Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/convert-data
Copy Azure API for FHIR data into Synapsehttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/copy-to-synapse
Execute FHIR bulk $export from Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/export-data
Use Azure API for FHIR REST capabilitieshttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-rest-api-capabilities
Use Patient-everything operation in Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/patient-everything
Use FHIR search examples with Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/search-samples
Use $member-match operation with Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/tutorial-member-match
Build a web app that calls Azure API for FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/tutorial-web-app-write-web-app
Bulk de-identify documents via Python batch APIhttps://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/quickstart-asynchronous-python
Call synchronous de-identification endpoint with Pythonhttps://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/quickstart-python
Use Azure Health De-identification .NET client libraryhttps://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/quickstart-sdk-net
Call DICOMweb APIs with C# and sample DICOM fileshttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/dicomweb-standard-apis-c-sharp
Call DICOMweb APIs with cURL and sample DICOM fileshttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/dicomweb-standard-apis-curl
Call DICOMweb APIs with Python and sample DICOM fileshttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/dicomweb-standard-apis-python
Use DICOMweb and custom APIs to manage DICOM datahttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/dicomweb-standard-apis-with-dicom-services
Export DICOM files to Azure Blob Storagehttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/export-files
Store and query external metadata in DICOM servicehttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/external-metadata
Use DICOM data with Azure Data Factory and Fabrichttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/get-started-with-analytics-dicom
Consume DICOM Change Feed using C# clienthttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/pull-dicom-changes-from-change-feed
Use bulk update API for DICOM file metadatahttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/update-files
Consume FHIR events with Azure Logic Apps workflowshttps://learn.microsoft.com/en-us/azure/healthcare-apis/events/events-consume-logic-apps
Configure Azure FHIR for CARIN Blue Button testshttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/carin-implementation-guide-blue-button-tutorial
Copy FHIR data to Azure Synapse Analyticshttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/copy-to-synapse
Set up Azure FHIR for Da Vinci Drug Formularyhttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/davinci-drug-formulary-tutorial
Configure Azure FHIR for Da Vinci PDex compliancehttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/davinci-pdex-tutorial
Implement Da Vinci Plan Net on Azure FHIRhttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/davinci-plan-net
Use FHIR bulk delete operations in Azure Health Data Serviceshttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/fhir-bulk-delete
Use $bulk-update for FHIR data at scalehttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/fhir-bulk-update
Import NDJSON FHIR data into Azure Health Data Serviceshttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/import-data
Use FHIR search examples in Azure Health Data Serviceshttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/search-samples
Access Azure Health Data Services APIs with cURLhttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/using-curl
Access Azure Health Data Services using VS Code REST Clienthttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/using-rest-client

Deployment

TopicURL
Deploy Azure API for FHIR with ARM templateshttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/azure-api-fhir-resource-manager-template
Deploy Azure API for FHIR via Azure portalhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-portal-quickstart
Deploy Azure API for FHIR using PowerShellhttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-paas-powershell-quickstart
Deploy Azure FHIR service using Bicep templateshttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/fhir-service-bicep
Move Azure API for FHIR across subscriptionshttps://learn.microsoft.com/en-us/azure/healthcare-apis/azure-api-for-fhir/move-fhir-service
Deploy de-identification service using ARM templateshttps://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/quickstart-arm
Deploy de-identification service via Azure CLIhttps://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/quickstart-azure-cli
Automate de-identification service deployment with Bicephttps://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/quickstart-bicep
Provision de-identification service with PowerShellhttps://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/quickstart-powershell
Deploy Azure Health Data Services workspace with Bicephttps://learn.microsoft.com/en-us/azure/healthcare-apis/deploy-healthcare-apis-using-bicep
Deploy DICOM service using Azure portalhttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/deploy-dicom-services-in-azure
Deploy DICOM service backed by Azure Data Lake Storagehttps://learn.microsoft.com/en-us/azure/healthcare-apis/dicom/deploy-dicom-services-in-azure-data-lake
Deploy FHIR service via Azure portalhttps://learn.microsoft.com/en-us/azure/healthcare-apis/fhir/deploy-azure-portal