HealthLake supported search parameters - Amazon HealthLake

HealthLake supported search parameters

This topic provides you details about supported search parameters, parameter types, modifiers, and comparators. Supported parameters are available for all FHIR resources, regardless of type.

Supported search parameters

For a full list of supported search parameters, see the FHIR search parameter registry. HealthLake supports all search parameters except for those listed in the following table.

Account-patient

Group-characteristic-value

Appointment-practitioner

Group-value

AppointmentResponse-patient

GuidanceResponse-patient

Appointment-patient

List-patient

AppointmentResponse-location

Location-near

AppointmentResponse-practitioner

MeasureReport-patient

Bundle-composition

Person-practitioner

Bundle-identifier

Person-relatedperson

Bundle-message

PlanDefinition-definition

Bundle-type

Provenance-patient

Bundle-timestamp

QuestionnaireResponse-patient

Consent-source-reference

Resource-content

Contract-patient

Resource-query

Communication-patient

Resource-security

CommunicationRequest-patient

Resource-source

DeviceRequest-patient

RequestGroup-patient

DomainResource-text

RiskAssessment-probability

EpisodeOfCare-care-manager

Specimen-patient

Additionally, the Clinical-patient parameter is only supported for the AllergyIntolerance and Immunization resource types.

Supported search parameter types

The following table shows the supported search parameter types in HealthLake.

Supported search parameters types
Search parameter

Description

_id

Resource id (not a full URL)

_lastUpdated Date last updated. Server has discretion on the boundary precision.
_tag

Search by a resource tag.

_profile

Search for all resources tagged with a profile.

The following table shows examples of how to modify query strings based on specified data types for a given resource type.

Search Parameter Types Details Examples

Number

Searches for a numerical value in a specified resource. Significant figures are observed.

The number of significant digits are specific in by search parameter value, excluding leading zeros.

Comparison prefixes are allowed.

[parameter]=100

[parameter]=1e2

[parameter]=lt100

Date/DateTime

Searches for a specific date or time. The expected format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] but can vary.

Accepts the following data types: date, dateTime, instant, Period, and Timing. For more details using these data types in searches, see date in the FHIR Documentation Index.

Comparison prefixes are allowed.

[parameter]=eq2013-01-14

[parameter]=gt2013-01-14T10:00

[parameter]=ne2013-01-14

String

Searches for a sequence of characters in a case-sensitive manner.

Supports both HumanName and Address types. For more details, see the HumanName data type entry and the Address data type entries in the FHIR Documentation Index.

Advanced search is supported using :text modifiers.

[base]/Patient?given=eve

[base]/Patient?given:contains=eve

Token

Searches for a close-to-exact match against a string of characters, often compared to a pair of medical code values.

Case sensitivity is linked to the code system used when creating a query.

Subsumption-based queries can help reduce issues linked to case sensitivity.

[parameter]=[system]|[code]: Here [system] refers a coding system, and [code] refers to code value found within that specific system.

[parameter]=[code]: Here your input will match either a code or a system.

[parameter]=|[code]: Here your input will match a code, and the system property has no identifier.

Composite

Searches for multiple parameters within a single resource type, using the modifiers$ and , operation.

Comparison prefixes are allowed.

/Patient?language=FR,NL&language=EN

Observation?component-code-value-quantity=http://loinc.org|8480-6$lt60

[base]/Group?characteristic-value=gender$mixed

Quantity

Searches for a number, system, and code as values. A number is required, but system and code are optional. Based on the Quantity data type. For more details, see Quantity in the FHIR Documentation Index.

Uses the following assumed syntax [parameter]=[prefix][number]|[system]|[code]

[base]/Observation?value-quantity=5.4|http://unitsofmeasure.org|mg

[base]/Observation?value-quantity=5.4|http://unitsofmeasure.org|mg

[base]/Observation?value-quantity=5.4|http://unitsofmeasure.org|mg

[base]/Observation?value-quantity=le5.4|http://unitsofmeasure.org|mg

Reference

Searches for references to other resources.

[base]/Observation?subject=Patient/23

test

URI

Searches for a string of characters that unambiguously identifies a particular resource.

The modifiers :above and :below can be used to specify partial matches.

[base]/ValueSet?url=http://acme.org/fhir/ValueSet/123

[base]/ValueSet?url:below=http://acme.org/fhir/

[base]/ValueSet?url:above=http://acme.org/fhir/ValueSet/123/_history/5

Special

Searches based on integrated medical NLP extensions.

Supported search modifiers

Search modifiers are used with string-based fields. All search modifiers in HealthLake use Boolean-based logic. For example, you could specify :contains to specify that larger string field should include a small string in order for it to be included in your search results.

Supported search modifiers

Search modifier

Type
:missing All parameters except Composite
:exact String
:contains String
:not Token
:text Token
:identifier Reference

Supported search comparators

You can use search comparators to control the nature of the matching in a search. You can use comparators when searching on number, date, and quantity fields. The following table lists search comparators and their definitions that are supported by HealthLake.

Supported search comparators

Search comparator

Description

eq

The value for the parameter in the resource is equal to the provided value.
ne The value for the parameter in the resource is not equal to the provided value.
gt The value for the parameter in the resource is greater than the provided value.

lt

The value for the parameter in the resource is less than the provided value.
ge The value for the parameter in the resource is greater or equal to the provided value.
le The value for the parameter in the resource is less or equal to the provided value.
sa The value for the parameter in the resource starts after the provided value.
eb The value for the parameter in the resource ends before the provided value.