Release notes: Azure Health Data Services

Azure Health Data Services is a set of managed API services based on open standards and frameworks for the healthcare industry. They enable you to build scalable and secure healthcare solutions by bringing protected health information (PHI) datasets together and connecting them end-to-end with tools for machine learning, analytics, and AI.

This article provides details about the features and enhancements made to Azure Health Data Services, including the different services (FHIR service, DICOM service, and MedTech service) that seamlessly work with one another.

Important

Azure Health Data Services is generally available. For more information, see the Service Level Agreement (SLA) for Azure Health Data Services.

January 2024

DICOM service

Bulk update of files in the DICOM service is generally available

The bulk update operation enables you to change imaging metadata for multiple files stored in the DICOM service. For example, bulk update enables you to modify DICOM attributes for one or more studies in a single, asynchronous operation. You can use an API to perform updates to patient demographics and avoid the cost of repeating time-consuming uploads.

Beyond the efficiency gains, the bulk update capability preserves a record of the changes in the change feed and persists the original, unmodified instances for future retrieval.

Learn more:

FHIR service

Selectable search parameter capability is available for preview

The selectable search parameter capability allows you to customize and optimize searches on FHIR resources. The capability lets you choose which inbuilt search parameters to enable or disable for the FHIR service. By enabling only the search parameters you need, you can store more FHIR resources and potentially improve performance of FHIR search queries

Learn more:

FHIR service integration with Azure Active Directory B2C is generally available

Healthcare organizations can use the FHIR service in Azure Health Data Services with Azure Active Directory B2C (Azure AD B2C). This capability gives organizations a secure and convenient way to grant access to the FHIR service in Azure Health Data Services with fine-grained access control for different users or groups, without creating or comingling user accounts in their organization’s Microsoft Entra ID tenant. With this integration, organizations can:

  • Use additional identity providers to authenticate and access FHIR resources with SMART on FHIR scopes.
  • Manage and customize user access rights or permissions with SMART on FHIR scopes that support fine-grained access control, FHIR resource types and interactions, and a user’s underlying privileges.

Learn more:

Request up to 100 TB of storage for the FHIR service

The FHIR service can store and exchange large amounts of health data, and each FHIR service instance has a 4 TB storage limit by default. If you have more data, you can ask Microsoft to increase storage up to 100 TB for your FHIR service.

By adding more storage, organizations can handle large data sets to enable analytics scenarios. For example, you can use more storage to manage population health, conduct research, and gain new insights from health data. Plus, more storage enables Azure API for FHIR customers with high-volume data (greater than 4 TB) to migrate to the FHIR service in Azure Health Data Services.

To request storage greater than 4 TB, create a support request on the Azure portal and use the issue type Service and Subscription limit (quotas).

December 2023

Azure Health Data Services

Encryption with customer-managed keys is generally available for the FHIR and DICOM services

Data stored in Azure Health Data Services is automatically and seamlessly encrypted with service-managed keys managed by Microsoft. You can enable data encryption with customer-managed keys (CMK) for new and existing FHIR® and DICOM® services, providing your organization with improved flexibility to manage access controls.

Learn more:

DICOM service

Store and manage medical imaging data with Azure Data Lake Storage (Preview)

With the integration of Azure Data Lake Storage available for preview, organizations have full control over their imaging data and increased flexibility for accessing and working with that data through the Azure storage ecosystem and APIs. By using Azure Data Lake Storage with the DICOM service, organizations are able to:

  • Enable direct access to medical imaging data stored by the DICOM service using Azure storage APIs and DICOMweb APIs, providing more flexibility to access and work with the data.
  • Open medical imaging data up to the entire ecosystem of tools for working with Azure storage, including AzCopy, Azure Storage Explorer, and the Data Movement library.
  • Unlock new analytics and AI/ML scenarios by using services that natively integrate with Azure Data Lake Storage, including Azure Synapse, Azure Databricks, Azure Machine Learning, and Microsoft Fabric.
  • Grant controls to manage storage permissions, access controls, tiers, and rules.

Learn more:

FHIR service

Additional capabilities added to the $export operation

The $export operation supports exporting versioned resources and soft deleted resources. For more information, see Export query parameters.

November 2023

Azure Health Data Services

Unified Azure portal landing page

In the Azure portal, we launched a unified landing page that lets users access all Microsoft Healthcare Data and AI Services in one place. The landing page makes it easier to find and use all related Healthcare Data and AI Services and includes links to relevant documentation to help users get started. To check out the landing page, sign into your Azure subscription and then search for Healthcare Data and AI Services.

FHIR service

Bulk delete capability available for public preview

$bulk-delete allows you to delete resources from FHIR server asynchronously. The bulk delete operation can be executed at the system level or for individual resource types. For more information, see bulk-delete operation.

$import operation supports importing soft deleted resources

The capability to import soft deleted resources is useful during migration from Azure API for FHIR to Azure Health Data Services. For more information, see Fix SQL Import for Soft Delete and History.

Performance improvement of FHIR queries

In this release we improved performance of FHIR queries with _include parameter. For more information, see Change query generator to use INNER JOIN.

Bug fixes

  • Searching with _include and wildcard resulted in query failure. The issue is fixed and permits only the wild character “*” to be present for _include and _revinclude searches. For more information, see Fix syntax check for : when wildcard is used.

  • Multiple export jobs created resulting in increase data storage volume. Due to a bug, Export jobs created multiple child jobs when used with the typefilter parameter. The fix addresses the issue. For more information, see Fix export.

  • Retriable exception for import operation, when using duplicate files. In case of duplicate files during import, an exception would be thrown. This exception was considered as a retriable exception. This fix addresses the issue. Import operations with same file are no longer retriable. For information, see Handles exception message for duplicate file in import operation.

October 2023

DICOM Service

Bulk import is available for public preview

Bulk import simplifies the process of adding data to the DICOM service. When enabled, the capability creates a storage container and .dcm files that are copied to the container are automatically added to the DICOM service. For more information, see Import DICOM files (preview).

September 2023

FHIR service

Retirement announcement for Azure API for FHIR

Azure API for FHIR will be retired on September 30, 2026. Azure Health Data Services FHIR service is the evolved version of Azure API for FHIR that enables customers to manage FHIR, DICOM, and MedTech services with integrations into other Azure services. Due to retirement of Azure API for FHIR, new deployments won't be allowed beginning April 1, 2025. For more information, see migration strategies.

Documentation navigation improvements

Documentation navigation improvements include a new hub page for Azure Health Data Services: Azure Health Data Services Documentation. Also, fixes to breadcrumbs across the FHIR, DICOM, and MedTech services documentation and the table of contents make it easier and more intuitive to find documentation.

August 2023

FHIR service

Incremental Import feature is generally available (GA)

$Import operation supports new capability of "Incremental Load" mode, which is optimized for periodically loading data into the FHIR service.

With Incremental Load mode, customers can:

  1. Perform concurrent ingestion of data while simultaneously executing API CRUD operations on the FHIR server.
  2. Ingest versioned FHIR resources.
  3. Maintain the lastUpdated field value in FHIR resources during ingestion.
  4. Supports conditional references For details on Incremental Import, see Import Documentation.

Batch-Bundle parallelization capability available in Public Preview

Batch bundles are executed serially in FHIR service by default. To improve throughput with bundle calls, we're enabling parallel processing of batch bundles.For details, visit Batch Bundle Parellization

Batch-bundle parallelization capability is in public preview. Review disclaimer for more details.

Important

Preview APIs and SDKs are provided without a service-level agreement. We recommend that you don't use them for production workloads. Some features might not be supported, or they might have constrained capabilities. For more information, review Supplemental Terms of Use for Microsoft Azure Previews.

Decimal value precision in FHIR service is updated per FHIR specification

Prior to the fix, FHIR service allowed precision value of [18,6]. The service is updated to support decimal value precision of [36,18] per FHIR specification. For details, visit FHIR specification Data Types

Reindex on targeted search parameter sets the status correctly

We identified a bug where after performing targeted search parameter reindex, resource data with search parameter was still not searchable. This bug was addressed by changing the status of the search parameter. The issue is fixed, for details visit 3400.

$convert-data documentation updates

Customers can find detailed documentation on the $convert-data operation, allowing them to have an easier self-service experience. The documentation includes an overview, how to configure settings, a ready-made pipeline template in Azure Data Factory, troubleshooting tips, and an FAQ.

July 2023

FHIR Service

Continuous retry on Import operation

We observed an issue where $import kept on retrying when NDJSON file size is greater than 2 GB. The issue is fixed, for details visit 3342.

Patient and Group level export job restart

Patient and Group level exports on interruption would restart from the beginning. Bug is fixed to restart the export jobs from the last successfully completed page of results. For more information, visit 3205.

DICOM Service

API Version 2 is Generally Available (GA)

The DICOM service API v2 is Generally Available (GA) and introduces several changes and new features. Most notable is the change to validation of DICOM attributes during store (STOW) operations - beginning with v2, the request fails only if required attributes fail validation. See the DICOM Conformance Statement v2 for full details.

June 2023

FHIR Service

Introducing Incremental Import

$Import operation supports new capability of "Incremental Load" mode, which is optimized for periodically loading data into the FHIR service.

With Incremental Load mode, customers can:

  1. Perform concurrent ingestion of data while simultaneously executing API CRUD operations on the FHIR server.
  2. Ingest versioned FHIR resources.
  3. Maintain the lastUpdated field value in FHIR resources during ingestion. For details on Incremental Import, visit Import Documentation.

Reindex operation provides job status at resource level

Reindex operation supports determining the status of the reindex operation with help of API call GET {{FHIR_URL}}/_operations/reindex/{{reindexJobId}}. Details per resource, on the number of completed reindexed resources can be obtained with help of the new field, added in the response- "resourceReindexProgressByResource". For details, see 3286.

FHIR Search Query optimization of complex queries

We have seen issues where complex FHIR queries with Reference Search Parameters would time out. Issue is fixed by updating the SQL query generator to use an INNER JOIN for Reference Search Parameters. For details, visit #3295.

Metadata endpoint URL in capability statement is relative URL

Per FHIR specification, metadata endpoint URL in capability statement needs to be an absolute URL. For details on the FHIR specification, visit Capability Statement. This fix addresses the issue, for details visit 3265.

DICOM Service

Retrieve rendered image is GA

Rendered images can be retrieved from the DICOM service by using the new rendered endpoint. This API allows a DICOM instance or frame to be accessed in a consumer format (jpeg or png), a capability that can simplify scenarios such as a client application displaying an image preview.

Fixed issue where DICOM events and Change Feed may miss changes

The DICOM Change Feed API could previously return results that incorrectly skipped pending changes when the DICOM server was under load. Identical calls to the Change Feed resource could have resulted in new change events appearing in the middle of the result set. For example, if the first call returned sequence numbers 1, 2, 3, and 5, then the second identical call could have incorrectly returned 1, 2, 3, 4, and 5. This behavior also impacted the DICOM events sent to Azure Event Grid System Topics, and could have resulted in missing events in downstream event handlers. For more information, see #2611.

MedTech service

Encounter identifiers included in the device message

Customers can include encounter identifiers in the device message so that they can look up the corresponding FHIR encounter and link it to the observation created in the FHIR transformation. This look up feature is supported in OSS and was a request from customers for the PaaS MedTech service.

May 2023

FHIR Service

SMART on FHIR : Fixed clinical scope mapping for applications

This bug fix addresses issue with clinical scope not interpreted correctly for backend applications. For more information, visit #3250

Addresses duplicate key error when passed in request parameters and body

This bug fix handles the issue, when using the POST {resourcetype}/search endpoint to query FHIR resources, the server returns 415 Unsupported Media Type. This issue is due to repeating a query parameter in the URL query string and the request body. This fix considers all the query parameters from request and body as input. For more information, visit #3232

April 2023

Azure Health Data Services

Azure Health Data services General Available (GA) in new regions

General availability (GA) of Azure Health Data services in West Central US region.

FHIR Service

Fixed performance for Search Queries with identifiers

This bug fix addresses timeout issues observed for search queries with identifiers, by using the OPTIMIZE clause. For more information, visit #3207

Fixed transient issues associated with loading custom search parameters

This bug fix addresses the issue where the FHIR service wouldn't load the latest SearchParameter status in a failure. For more information, visit #3222

March 2023

Azure Health Data Services

Azure Health Data services General Available (GA) in new regions

General availability (GA) of Azure Health Data services in Japan East region.

February 2023

FHIR service

Introduction of _till parameters and throughput improvement by 50x

_till parameter is introduced as optional parameter and allows you to export resources that have been modified until the specified time.

This feature improvement is applicable to System export, for more information on export, see FHIR specification

Also see Export your FHIR data by invoking the $export command on the FHIR service

Fixed issue for Chained search with :contains modifier results with no resources are returned

This bug fix addresses the issue and identified resources, per search criteria with :contains modifier are returned.

For more information, visit #2990

Provide the ability to tweak continuation token size limit with header.

Previous to this change, during pagination Cosmos DB continuation token had a default limit of 3 Kb. With this change, customers can send Cosmos DB Continuation Token limit in the header. Valid range is set to 1-3 Kb. Header value that can be used to send this value is x-ms-documentdb-responsecontinuationtokenlimitinkb

For more information, visit #2971 and Overview of search in Azure API for FHIR | Microsoft Learn

Fixed issue related to HTTP Status code 500 was encountered when :not modifier was used with chained searches

This bug fix addresses the issue. Identified resources are returned per search criteria with :contains modifier. for more information on bug fix visit #3041

Versioning policy enabled at resource level still required If-match header for transaction requests.

Bug fix addresses the issue and versioned policy at resource level doesn't require if-match header, for more information on bug fix visit #2994

MedTech service

Mapping Debugger released in public-preview

The MedTech service's new Mapping Debugger is a self-service tool that is used for creating, updating, and troubleshooting the MedTech service device and FHIR destination mappings. It enables you to easily view and make inline adjustments in real-time, without ever having to leave the Azure portal.

For more information, visit How to use the MedTech service Mapping debugger - Azure Health Data Services | Microsoft Learn

Error Message released in private-preview

The MedTech service has an error message feature that allows you to easily view any errors generated, and the message that caused each error. You can understand the context behind any errors without manual effort. For more info on error logs, visit Troubleshoot errors using the MedTech service logs - Azure Health Data Services | Microsoft Learn

DICOM service

New DICOM Event Types are GA

DICOM Events are generally available in the HDS workspace-level event subscriptions. These new event types enable event-driven workflows in medical imaging applications by subscribing to events for newly created and deleted DICOM images.

Validation errors included with the FailedSOPSequence

Previously, DICOM validation failures returned by the Store (STOW) API have lacked the detail necessary to diagnose and resolve problems. The latest API changes improve the error messages by including more information about the specific attributes that failed validation and the reason for the failures. See the conformance statement for details.

Toolkit and Samples Open Source

Two new sample apps have been released in the open source samples repo: Azure-Samples/azure-health-data-services-samples: Samples for using the Azure Health Data Services (github.com)

January 2023

Azure Health Data Services

Azure Health Data services General Available (GA) in new regions

General availability (GA) of Azure Health Data services in France Central, North Central US and Qatar Central Regions.

DICOM service

Added support for ModalitiesInStudy attribute

The DICOM service supports ModalitiesInStudy as a searchable attribute at the Study, Series, and Instance level. Support for this attribute allows for the list of modalities in a study to be returned more efficiently, without needing to query each series independently.

Added support for NumberOfStudyRelatedInstances and NumberOfSeriesRelatedInstances attributes

Two new attributes for returning the count of Instances in a Study or Series are available in Search responses.

Toolkit and Samples Open Source

New sample app has been released

One new sample app has been released in the Health Data Services samples repo

December 2022**

DICOM service

DICOM Events available in public preview

Azure Health Data Services Events include a public preview of two new event types for the DICOM service. These new event types enable applications that use Event Grid to use event-driven workflows when DICOM images are created or deleted.

November 2022**

FHIR service

Fixed the Error generated when resource is updated using if-match header and PATCH

Bug is fixed and Resource is updated if it matches the Etag header. For details, see #2877

Toolkit and Samples Open Source

Azure Health Data Services Toolkit is released

The Azure Health Data Services Toolkit, which was previously in a prerelease state, is in Public Preview . The toolkit is open-source project and allows customers to more easily customize and extend the functionality of their Azure Health Data Services implementations. The NuGet packages of the toolkit are available for download from the NuGet gallery, and you can find links to them from the repo documentation.

October 2022**

MedTech service

Added Deploy to Azure button

Customers can deploy the MedTech service fully, including Event Hubs, AHDS workspace, FHIR service, MedTech service, and managed identity roles, all by clicking the "Deploy to Azure" button. Deploy the MedTech service using an Azure Resource Manager template

Added the Dropped Event Metrics

Customers can determine if their mappings are working as intended, as they can see dropped events as a metric to ensure that data is flowing through accurately.

September 2022**

Azure Health Data Services

Fixed issue where Querying with :not operator was returning more results than expected

The issue is fixed and querying with :not operator should provide correct results. For more information, see #2790.

FHIR Service

Provided an Error message for failure in export resulting from long time span

With failure in export job due to a long time span, a customer sees RequestEntityTooLarge HTTP status code. For more information, see #2790.

Fixed issue in a query sort, where functionality throws an error when chained search is performed with same field value.

The functionality returns a response. For more information, see #2794.

Fixed issue where Server doesn't indicate _text not supported

When passed as URL parameter,_text returns an error in response when using the Prefer heading with value handling=strict. For more information, see #2779.

Added a Verbose error message for invalid resource type

Verbose error message is added when resource type is invalid or empty for _include and _revinclude searches. For more information, see #2776.

DICOM service

Export is Generally Available (GA)

The export feature for the DICOM service is generally available. Export enables a user-supplied list of studies, series, and/or instances to be exported in bulk to an Azure Storage account. Learn more about the export feature.

Improved deployment performance

Performance improvements have cut the time to deploy new instances of the DICOM service by more than 55% at the 50th percentile.

Reduced strictness when validating STOW requests

Some customers have run into issues storing DICOM files that don't perfectly conform to the specification. To enable those files to be stored in the DICOM service, we reduced the strictness of the validation performed on STOW.

The service accepts:

  • DICOM UIDs that contain trailing whitespace
  • IS, DS, SV, and UV VRs that aren't valid numbers
  • Invalid private creator tags

Toolkit and Samples Open Source

The Azure Health Data Services Toolkit is in the public preview.

The toolkit is open-source and allows you to easily customize and extend the functionality of their Azure Health Data Services implementations.

August 2022**

FHIR service

Azure Health Data services availability expands to new regions

Azure Health Data Services is available in the following regions: Central India, Korea Central, and Sweden Central.

$import is Generally Available.

$import API is generally available in Azure Health Data Services API version 2022-06-01. See Executing the import by invoking the $import operation on FHIR service in Azure Health Data Services.

$convert-data updated by adding STU3-R4 support.

$convert-data added support for FHIR STU3-R4 conversion. See Data conversion for Azure API for FHIR.

Analytics pipeline supports data filtering.

Data filtering is supported in FHIR to data lake pipeline. See FHIR-Analytics-Pipelines_Filter FHIR data microsoft/FHIR-Analytics-Pipelines github.com.

Analytics pipeline supports FHIR extensions.

Analytics pipeline can process FHIR extensions to generate parquet data. See FHIR-Analytics-Pipelines_Process in pipeline.md at main.

Fixed issue related to History bundles being sorted with the oldest version first.

We've recently identified an issue with the sorting order of history bundles on FHIR® server. History bundles were sorted with the oldest version first. Per FHIR specification, the sorting of versions defaults to the oldest version last. This bug fix addresses FHIR server behavior for sorting history bundle.

We understand if you would like to keep the sorting per existing behavior (oldest version first). To support existing behavior, we recommend you append _sort=_lastUpdated to the HTTP GET command utilized for retrieving history.

For example: <server URL>/_history?_sort=_lastUpdated

For more information, see #2689.

Fixed issue where Queries were not providing consistent result count after appended with _sort operator. The issue is fixed and queries should provide consistent result count, with and without sort operator.

MedTech service

Added New Metric Chart

Customers can see predefined metrics graphs in the MedTech landing page, complete with alerts to ease customers' burden of monitoring their MedTech service.

Availability of Diagnostic Logs

There are predefined queries with relevant logs for common issues so that customers can easily debug and diagnose issues in their MedTech service.

DICOM service

Modality worklists (UPS-RS) is Generally Available (GA).

The modality worklists (UPS-RS) service is generally available. Learn more about the worklists service.

July 2022

FHIR service

(Open Source) History bundles were sorted with the oldest version first. We've recently identified an issue with the sorting order of history bundles on FHIR® server. History bundles were sorted with the oldest version first. Per FHIR specification, the sorting of versions defaults to the oldest version last. This bug fix addresses FHIR server behavior for sorting history bundle.

We understand if you would like to keep the sorting per existing behavior (oldest version first). To support existing behavior, we recommend you append _sort=_lastUpdated to the HTTP GET command utilized for retrieving history.

For example: <server URL>/_history?_sort=_lastUpdated

For more information, see #2689.

MedTech service

Improvements to documentations for Events and MedTech and availability zones.

Tested and enhanced usability and functionality. Added new documents to enable customers to better take advantage of the new improvements. See Consume Events with Logic Apps and Deploy Events Using the Azure portal.

One touch launch Azure MedTech deploy.

Deploy the MedTech Service in the Azure portal

DICOM service

DICOM Service availability expands to new regions.

The DICOM Service is available in the following regions: Southeast Asia, Central India, Korea Central, and Switzerland North.

Fast retrieval of individual DICOM frames

For DICOM images containing multiple frames, performance improvements have been made to enable fast retrieval of individual frames (60-KB frames as fast as 60 MS). These improved performance characteristics enable workflows such as viewing digital pathology images, which require rapid retrieval of individual frames.

June 2022

FHIR service

Fixed issue with Export Job not being queued for execution. Fixes issue with export job not being queued due to duplicate job definition caused due to reference to container URL. For more information, see #2648.

Fixed issue related to Queries not providing consistent result count after appended with the _sort operator.

Fixes the issue with the help of distinct operator to resolve inconsistency and record duplication in response.For more information, see #2680.

May 2022

FHIR service

Removes SQL retry on upsert

Removes retry on SQL command for upsert. The error still occurs, but data is saved correctly in success cases. For more information, see #2571.

Added handling for SqlTruncate errors

Added a check for SqlTruncate exceptions and tests. In particular, exceptions and tests catch SqlTruncate exceptions for Decimal type based on the specified precision and scale. For more information, see #2553.

DICOM service

DICOM service supports cross-origin resource sharing (CORS)

DICOM service supports CORS. CORS allows you to configure settings so that applications from one domain (origin) can access resources from a different domain, known as a cross-domain request.

DICOMcast supports Private Link

DICOMcast has been updated to support Azure Health Data Services workspaces that have been configured to use Private Link.

UPS-RS supports Change and Retrieve work item

Modality worklist (UPS-RS) endpoints have been added to support Change and Retrieve operations for work items.

API version is required as part of the URI

All REST API requests to the DICOM service must include the API version in the URI. For more information, see API versioning for DICOM service.

Index the first value for DICOM tags that incorrectly specify multiple values

Attributes that are defined to have a single value but have specified multiple values are leniently accepted. The first value for such attributes is indexed.

April 2022

FHIR service

Added FHIRPath Patch

FHIRPath Patch was added as a feature to both the Azure API for FHIR. This implements FHIRPath Patch as defined on the HL7 website.

Handles invalid header on versioned update

When the versioning policy is set to versioned-update, we required that the most recent version of the resource is provided in the request's if-match header on an update. The specified version must be in ETag format. Previously, a 500 would be returned if the version was invalid or in an incorrect format. This update returns a 400 Bad Request. For more information, see PR #2467.

Bulk import in public preview The bulk-import feature enables importing FHIR data to the FHIR server at high throughput using the $import operation. It's designed for initial data load into the FHIR server. For more information, see Bulk-import FHIR data (Preview).

Added back the core to resource path

Part of the path to a string resource was accidentally removed in the versioning policy. This fix adds it back in. For more information, see PR #2470.

DICOM service

Reduced the strictness of validation applied to incoming DICOM files

When value representation (VR) is a decimal string (DS)/ integer string (IS), fo-dicom serialization treats value as a number. Customer DICOM files could be old and contains invalid numbers. Our service blocks such file upload due to the serialization exception. For more information, see PR #1450.

Correctly parse a range of input in the content negotiation headers

Currently, WADO with Accept: multipart/related; type=application/dicom throws an error. It accepts Accept: multipart/related; type="application/dicom", but they should be equivalent. For more information, see PR #1462.

Fixed an issue where parallel upload of images in a study could fail under certain circumstances

Handle race conditions during parallel instance inserts in the same study. For more information, see PR #1491 and PR #1496.

March 2022

Azure Health Data Services

Private Link is available With Private Link, you can access Azure Health Data Services securely from your VNet as a first-party service without having to go through a public Domain Name System (DNS). For more information, see Configure Private Link for Azure Health Data Services.

FHIR service

FHIRPath Patch operation available |This new feature enables you to use the FHIRPath Patch operation on FHIR resources. For more information, see FHIR REST API capabilities for Azure Health Data Services FHIR service.

SQL timeout that returns 408 status code Previously, a SQL timeout would return a 500. Now a timeout in SQL returns a FHIR OperationOutcome with a 408 status code. For more information, see PR #2497.

Fixed issue related to duplicate resources in search with _include Fixed issue where a single resource can be returned twice in a search that has _include. For more information, see PR #2448.

Fixed issue PUT creates on versioned update Fixed issue where creates with PUT resulted in an error when the versioning policy is configured to versioned-update. For more information, see PR #2457.

Invalid header handling on versioned update

Fixed issue where invalid if-match header would result in an HTTP 500 error. Now an HTTP Bad Request is returned instead. For more information, see PR #2467.

MedTech service

The Events feature within Health Data Services is generally available (GA).

The Events feature allows customers to receive notifications and triggers when FHIR observations are created, updated, or deleted. For more information, see Events message structure and What are events?.

Events documentation for Azure Health Data Services Updated docs to allow for better understanding, knowledge, and help for Events as it went GA. Updated troubleshooting for ease of use for the customer.

One touch deploy button for MedTech service launch in the portal Enables easier deployment and use of MedTech service for customers without the need to go back and forth between pages or interfaces.

January 2022

Export FHIR data behind firewalls This new feature enables exporting FHIR data to storage accounts behind firewalls. For more information, see Configure export settings and set up a storage account.

Deploy Azure Health Data Services with Azure Bicep This new feature enables you to deploy Azure Health Data Services using Azure Bicep. For more information, see Deploy Azure Health Data Services using Azure Bicep.

DICOM service

Customers can define their own query tags using the Extended Query Tags feature

With Extended Query Tags feature, customers efficiently query non-DICOM metadata for capabilities like multi-tenancy and cohorts. It's available for all customers in Azure Health Data Services.

December 2021

Azure Health Data Services

Quota details for support requests We've updated the quota details for customer support requests with the latest information.

**Local RBAC documentation updated **

We've updated the local RBAC documentation to clarify the use of the secondary tenant and the steps to disable it.

Deploy and configure Azure Health Data Services using scripts

We've started the process of providing PowerShell, CLI scripts, and ARM templates to configure app registration and role assignments. Scripts for deploying Azure Health Data Services will be available after GA.

FHIR service

Added Publisher to CapabilityStatement.name

You can find the publisher in the capability statement at CapabilityStatement.name. #2319

Log FhirOperation linked to anonymous calls to Request metrics

We weren't logging operations that didn’t require authentication. We extended the ability to get FhirOperation type in RequestMetrics for anonymous calls. #2295

Fixed 500 error when SearchParameter Code is null

Fixed an issue with SearchParameter if it had a null value for Code, the result would be a 500. Now it results in an InvalidResourceException like the other values do. #2343

Returned BadRequestException with valid message when input JSON body is invalid

For invalid JSON body requests, the FHIR server was returning a 500 error. Now the server returns a BadRequestException with a valid message instead of 500. #2239

Handled SQL Timeout issue

If SQL Server timed out, the PUT /resource{id} returned a 500 error. Now we handle the 500 error and return a timeout exception with an operation outcome. #2290

November 2021

FHIR service

Process Patient-everything links

We've expanded the Patient-everything capabilities to process patient links #2305. For more information, see Patient-everything in FHIR documentation.

Added software name and version to capability statement. In the capability statement, the software name distinguishes if you're using Azure API for FHIR or Azure Health Data Services. The software version specifies which open-source release package is live in the managed service #2294. Addresses: #1778 and #2241

Compress continuation tokens

In certain instances, the continuation token was too long to be able to follow the next link in searches and would result in a 404. To resolve the issue, we compressed the continuation token to ensure it stays below the size limit #2279. Addresses issue #2250.

FHIR service autoscale

The FHIR service autoscale is designed to provide optimized service scalability automatically to meet customer demands when they perform data transactions in consistent or various workloads at any time. It's available in all regions where the FHIR service is supported.

Resolved 500 error when the date was passed with a time zone.

This fix addresses a 500 error when a date with a time zone was passed into a datetime field #2270.

Resolved issue when posting a bundle with incorrect Media Type returned a 500 error.

Previously when posting a search with a key that contains certain characters, a 500 error is returned. This fixes issue #2264 and addresses #2148.

DICOM service

Content-Type header includes transfer-syntax.

This enhancement enables the user to know which transfer syntax is used in case multiple accept headers are being supplied.

October 2021

Azure Health Data Services

Test Data Generator tool

We've updated Azure Health Data Services GitHub samples repo to include a Test Data Generator tool using Synthea data. This tool is an improvement to the open source public test projects, based on Apache JMeter that can be deployed to Azure AKS for performance tests.

FHIR service

Added support for _sort on strings and dateTime. #2169

Fixed issue where Conditional Delete could result in an infinite loop.#2269

Resolved 500 error possibly caused by a malformed transaction body in a bundle POST. We've added a check that the URL is populated in the transaction bundle requests.**#2255

DICOM service

Regions

South Brazil and Central Canada. For more information about Azure regions and availability zones, see Azure services that support availability zones.

Extended Query tags DateTime (DT) and Time (TM) Value Representation (VR) types

Implemented fix to workspace names. Enabled DICOM service to work with workspaces that have names beginning with a letter.

September 2021

FHIR service

Added support for conditional patch

Conditional patch #2163

Added conditional patch audit event. #2213

Allow JSON patch in bundles

Allows for search history bundles with Patch requests. #2156

Enabled JSON patch in bundles using Binary resources. #2143

Added new audit event OperationName subtypes #2170

Running a reindex job

Added boundaries for reindex parameters. #2103

Updated error message for reindex parameter boundaries#2109

Added final reindex count check.#2099

Bug fixes

Wider catch for exceptions during applying patch #2192

Fix history with PATCH in STU3#2177

Custom search bugs

Addresses the delete failure with Custom Search parameters #2133

Added retry logic while Deleting Search parameter #2121

Set max item count in search options in SearchParameterDefinitionManager #2141

Better exception if there's a bad expression in a search parameter #2157

Resolved SQL batch reindex if one resource fails Updates SQL batch reindex retry logic #2118

GitHub issues closed

Unclear error message for conditional create with no ID #2168

DICOM service**

Implemented fix to resolve QIDO paging-ordering issues #989

MedTech service**

MedTech service normalized improvements with calculations to support and enhance health data standardization.

See Use device mappings and CalculatedContent

Next steps

Learn about:

Known issues: Azure Health Data Services

Release notes: Azure API for FHIR

FHIR® is a registered trademark of Health Level Seven International, registered in the U.S. Trademark Office and is used with their permission.