Supported FHIR Features

Important

Azure Healthcare APIs is currently in PREVIEW. The Supplemental Terms of Use for Microsoft Azure Previews include additional legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.

The FHIR® service in the Azure Healthcare APIs (hear by called the FHIR service) provides a fully managed deployment of the open-source FHIR Server and is an implementation of the FHIR standard. This document lists the main features of the FHIR service.

FHIR version

Latest version supported: 4.0.1

Previous versions also currently supported include: 3.0.2

REST API

API Azure API for FHIR FHIR service in Healthcare APIs Comment
read Yes Yes
vread Yes Yes
update Yes Yes
update with optimistic locking Yes Yes
update (conditional) Yes Yes
patch Yes Yes Support for JSON Patch only
patch (conditional) No No
delete Yes Yes See Note below.
delete (conditional) Yes Yes
history Yes Yes
create Yes Yes Support both POST/PUT
create (conditional) Yes Yes Issue #1382
search Partial Partial See Overview of FHIR Search.
chained search Yes Yes
reverse chained search Yes Yes
batch Yes Yes
transaction No Yes
paging Partial Partial self and next are supported
intermediaries No No

Note

Delete defined by the FHIR spec requires that after deleting, subsequent non-version specific reads of a resource returns a 410 HTTP status code and the resource is no longer found through searching. The FHIR service in the Azure Healthcare APIs and the Azure API for FHIR also enable you to fully delete (including all history) the resource. To fully delete the resource, you can pass a parameter settings hardDelete to true (DELETE {server}/{resource}/{id}?hardDelete=true). If you do not pass this parameter or set hardDelete to false, the historic versions of the resource will still be available.

Extended Operations

All the operations that are supported that extend the RESTful API.

Search parameter type Azure API for FHIR FHIR service in Healthcare APIs Comment
$export (whole system) Yes Yes
Patient/$export Yes Yes
Group/$export Yes Yes
$convert-data Yes Yes
$validate Yes Yes
$member-match Yes Yes
$patient-everything Yes Yes
$purge-history Yes Yes

Role-based access control

The FHIR service uses Azure Active Directory for access control.

Service limits

  • Bundle size - Each bundle is limited to 500 items.

  • Subscription Limit - By default, each subscription is limited to a maximum of 10 FHIR services. This can be in one or many workspaces.

Next steps

In this article, you've read about the supported FHIR features in the FHIR service. Next deploy the FHIR service.