AWS HealthLake Import API
Asynchronous bulk import operations for loading FHIR resources from Amazon S3
AWS HealthLake Import API is one of 8 APIs that AWS HealthLake publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Import. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 3 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 2017-07-01.
Requests are made against a single base URL, https://healthlake.{region}.amazonaws.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
AWS HealthLake Import API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (aws_v4).
By default, every request must be authenticated.
aws_v4— AWS Signature Version 4. Sign requests with your AWS access key and secret key. See: https://docs.aws.amazon.com/general/latest/gr/signingawsapirequests.html
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.
Asynchronous bulk import operations for loading FHIR resources from Amazon S3
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ListFHIRImportJobsRequest (7 properties), StartFHIRImportJobRequest (6 properties), StartFHIRImportJobResponse (3 properties), DescribeFHIRImportJobRequest (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from AWS HealthLake 7
Other APIs AWS HealthLake publishes across the network.