Skip to main content

Supported Interactions and Operations

The FHIR Accelerator Service supports the following FHIR® interactions and operations through its REST API.

Interactions

FHIR interactionsOpens in a new window are the set of actions that a FHIR client can take on resources. These interactions can be grouped according to whether they act upon an instance, a type, or the whole system. An instance is a specific instance of a resource, for example, Patient/1 refers to an instance of a Patient resource with an id of 1. A type refers to a particular FHIR resource, for example, a Patient or Observation.

The following table summarizes the support for FHIR interactions in the FHIR Accelerator Service. If an interaction is not listed, it is not supported.

Interaction Limitations/Notes
createOpens in a new window Fully supported, including conditional create.
readOpens in a new window The _elementsparameter is not supported.
Conditional read is not supported.
vreadOpens in a new window The _elementsparameter is not supported.
Conditional read is not supported.
updateOpens in a new window Fully supported, including conditional update.
patchOpens in a new window Only JSON Patch documents are supported.
deleteOpens in a new window Supported, but conditional delete is not supported.
historyOpens in a new window Supported for instance interactions only, not type or system. For example, GET [baseURL]/Patient/1/_history is supported, but not GET [baseURL]/Patient/_history or GET [baseURL]/_history.
The _count and _at parameters are not supported.
Paging is not supported.
transactionOpens in a new window Circular references within the bundle are not supported.
search Supported with some limitations. For details, see Search Interaction.

Operations

The FHIR Accelerator Service supports the following operations:

Operation Limitations/Notes
$everything Fully supported
$validate
The validation modes (create, update, delete) are supported.
Validation by profile is not supported.
When a FHIR $validate request includes a resource payload, the resource may be enclosed in a Parameters resource.
$lastn Fully supported
FeedbackOpens in a new window