Use FHIR R4 RESTful API interactions to manage FHIR resources in a HealthLake data store. The following sections describe all HealthLake-supported FHIR R4 RESTful API interactions available for FHIR resource management. For information about HealthLake data store capabilities and which portions of the FHIR specification it supports, see FHIR R4 Capability Statement for AWS HealthLake.
Note
The FHIR interactions listed in this chapter are built in conformance to the HL7 FHIR
R4 standard for health care data exchange. Because they are representations of HL7 FHIR
services, they are not offered through AWS CLI and AWS SDKs. For more information, see RESTful API
The following table lists FHIR R4 interactions supported by AWS HealthLake. For information about FHIR resource types supported by HealthLake, see Resource types.
| Interaction | Description |
|---|---|
| Whole system interactions | |
capabilities |
Get a capability statement for the system. See FHIR R4 Capability Statement for AWS HealthLake. |
batch |
Update, create, or delete a set of resources in a single interaction. See Bundling FHIR resources. |
| Type level interactions | |
create |
Create a new resource with a server-assigned ID. See Creating a FHIR resource. |
search |
Search a resource type based on some filter criteria. See Searching FHIR resources. |
history |
Retrieve the change history for a particular resource type. See Reading FHIR resource history. |
| Instance level interactions | |
read |
Read the current state of a resource. See Reading a FHIR resource. |
history |
Read the change history for a particular resource. See Reading FHIR resource history. |
vread |
Read the state of a specific version of the resource. See Reading version-specific FHIR resource history. |
update |
Update a resource by its ID (or create it if it's new). See Updating a FHIR resource. |
delete |
Delete a resource. See Deleting a FHIR resource. |
Topics
