Suggestion

The Suggestion type represents root result retrieved by the suggestions query.

Schema

 

 

type Suggestion implements SearchResultNode {

    id: ID!

    individual: IndividualSuggestionFragment

    workplace: WorkplaceSuggestionFragment

    address: Address

    specialty: KeyedString

    medTerm: KeyedString

}

 

 

Field

Type

Description

id

ID!

Enitity ID of result (entity type depending on the query scope).

individual

IndividualSuggestionFragment

HCP of result (only filled for "Individual" query scope).

workplace

WorkplaceSuggestionFragment

HCO of result (only filled for "Workplace" query scope).

address

Address

Address of result (only filled for "Address" query scope).

specialty

KeyedString

HCP specialty of result (only filled for "Specialty" query scope).

medTerm

KeyedString

Medical term of result (only filled for "MedTerm" query scope).

 

 

 

Discussion

The Suggestion type represents one unit of results returned by the suggestions query.

Conceptually, a  Suggestion type represents a single autocomplete option—whether it is a single individual, a single workplace, a single address, a single specialty, or a single medical term—that is returned in a "search as you type" context to help narrow down a search.

Depending on the scope of the suggestions query—each text field in the search form uses a different scope—only one of these fields gets populated in the query results.

Availability

HealthCare Locator SDK 1.2.15 and higher

GraphQL Activity API 2.0