Data retrieval APIs for AWS HealthLake
AWS HealthLake provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| DescribeFHIRDatastore | Get the properties associated with the FHIR datastore, including the datastore ID, datastore ARN, datastore name, datastore status, created at, datastore type version, and datastore endpoint | Read |
| DescribeFHIRExportJob | Display the properties of a FHIR export job, including the ID, ARN, name, and the status of the datastore | Read |
| DescribeFHIRExportJobWithGet | Display the properties of a FHIR export job, including the ID, ARN, name, and the status of the datastore with Get | Read |
| DescribeFHIRImportJob | Display the properties of a FHIR import job, including the ID, ARN, name, and the status of the datastore | Read |
| GetCapabilities | Get the capabilities of a FHIR datastore | Read |
| GetExportedFile | Access exported files from a FHIR Export job initiated with Get | Read |
| GetHistoryByResourceId | Read resource history | Read |
| ListFHIRDatastores | List all FHIR datastores that are in the user's account, regardless of datastore status | List |
| ListFHIRExportJobs | Get a list of export jobs for the specified datastore | List |
| ListFHIRImportJobs | Get a list of import jobs for the specified datastore | List |
| ListTagsForResource | Get a list of tags for the specified datastore | List |
| ReadResource | Read resource | Read |
| SearchEverything | Search all resources related to a patient | Read |
| SearchWithGet | Search resources with GET method | Read |
| SearchWithPost | Search resources with POST method | Read |
| VersionReadResource | Read version of a resource | Read |
