Skip to main content

Settings for the HealthLake Inbound Query Adapter

Provides reference information for settings of EnsLib.AmazonHealthLake.InboundAdapterQueryOpens in a new tab.

Summary

EnsLib.AmazonHealthLake.InboundAdapterQueryOpens in a new tab has the following settings:

Group Settings
HealthLake DatastoreId, SearchType, SearchParameters
AWS CredentialsFile, Region, AssumeRole ARN, AssumeRole Session Name, AssumeRole External ID

The remaining settings are common to all business services. For information, see Settings for All Business Services.

See Settings for the HealthLake Inbound Adapter for information on the other inbound HealthLake adapter.

AssumeRole ARN

Specifies the ARN (Amazon Resource Name) of the role to assume. See the Amazon documentationOpens in a new tab on the AssumeRole feature, which enables you to use a set of temporary security credentials to access AWS resources. 

AssumeRole External ID

Specifies a unique identifier that might be required when you assume a role in another account. See the Amazon documentationOpens in a new tab on the AssumeRole feature.

AssumeRole Session Name

Specifies an identifier for the assumed role session. For requirements, see the Amazon documentationOpens in a new tab on the AssumeRole feature.

CredentialsFile

If this setting is blank, Amazon uses the default credential provider chainOpens in a new tab to obtain the credentials needed to access HealthLake. If you prefer to use an AWS credential file, enter its pathname.

DatastoreId

Specifies the ID of the data store to query.

Region

Specifies the AWS region that you want to access. For a list of regions, see Amazon Regions, Availability Zones, and Local ZonesOpens in a new tab.

SearchType

Specifies the resource type of the search, for example, Patient or Observation.

For example, consider a search like this:

GET [base]/datastore/12asdf45/Patient?name=Smith&birthdate=1944-08-23

For this search, specify SearchType as Patient.

SearchParameters

A comma-separated list of valid FHIR search parameters supported by HealthLake.

For example, consider a search like this:

GET [base]/datastore/12asdf45/Patient?name=Smith&birthdate=1944-08-23

For this search, specify SearchParameters as name=Smith&birthdate=1944-08-23.

For a list of search parameters supported by HealthLake, see the HealthLake DocumentationOpens in a new tab.

FeedbackOpens in a new tab