Using FHIR REST API operations with an AWS HealthLake data store
In AWS HealthLake, you can use Fast Healthcare Interoperability Resources (FHIR) REST API operations to manage and search resources in your HealthLake data store.
You can use FHIR REST API operations to perform Create, Read, Update, and Delete (CRUD) operations on resources in a
data store. You can also form complex search strings using either a GET
or POST
HTTP requests. HealthLake
supports a subset of FHIR-supported search operations. To learn more, see Searching your HealthLake data store by using the FHIR REST API operations.
To find the FHIR-related capabilities of an active HealthLake data store, make a GET
request where
metadata
is specified in the URL, as follows.
GET https://healthlake.
your-region
.amazonaws.com/datastore/your-datastore-id
/r4/metadata
When successful, you will receive a 200
HTTP response code and the capability statement for your data store. For
more information on the capability statement, see Resource
CapabilityStatement - Content
FHIR resource types are validated according to the FHIR R4 Structure Definition. If a resource is not valid, you will
receive an OperationOutcome
message with details explaining the exception.
The following table lists the operations that are supported by HealthLake.
Supported Operations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Operation |
Description |
Instance-level, Type-level or Whole-system interaction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Read |
Read the current state of a resource | Instance-level | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Update | Update a resource by its ID (or create it if it's new) | Instance-level | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Delete |
Delete a resource | Instance-level | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Create |
Create a new resource with a server-assigned ID |
Type-level | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Search |
Search the resource type based on filter criteria | Type-level | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Capabilities |
Get a capability statement for the system | Whole-system level |
Contents
- Supported FHIR resource types in AWS HealthLake
- Performing Create, Read, Update, and Delete (CRUD) operations on HealthLake data stores
- Searching your HealthLake data store by using the FHIR REST API operations
- Getting patient data with the Patient $everything FHIR REST API operation
- Exporting data from your HealthLake data store using $export