Using FHIR REST API interactions with a HealthLake data store
In AWS HealthLake, you use Fast Healthcare Interoperability Resources (FHIR) REST API interactions to manage and search FHIR resources in your data store.
FHIR REST API interactions are used to perform Create, Read, Update, and Delete (CRUD) interactions on resources in a
data store. You can also form complex search strings using either a GET
or POST
HTTP request, as HealthLake
supports a subset of FHIR-supported search operations.
For conformance purposes, FHIR resource types are validated according to the HL7 FHIR R4 StructureDefinitionGET
request where metadata
is specified in the URL, as follows.
GET https://healthlake.
region
.amazonaws.com/datastore/datastore-id
/r4/metadata
When successful, you will receive a 200
HTTP response code and the Capability Statement for your HealthLake data store. For
more information, see CapabilityStatement
The following table lists FHIR interactions supported by AWS HealthLake.
FHIR interaction | Description |
---|---|
Whole system interactions | |
capabilities |
Get a capability statement for the system |
batch/transaction |
Update, create or delete a set of resources in a single interaction |
Type level interactions | |
create |
Create a new resource with a server-assigned ID |
search |
Search a resource type based on some filter criteria |
history |
Retrieve the change history for a particular resource type |
Instance level interactions | |
read |
Read the current state of a resource |
history |
Read the change history for a particular resource |
vread |
Read the state of a specific version of the resource |
update |
Update a resource by its ID (or create it if it's new) |
delete |
Delete a resource |
Topics
- 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
- Reading FHIR resource history
- Getting patient data with the Patient $everything FHIR REST API operation
- Exporting data from your HealthLake data store using $export