The individualByID query is used to get details on an individual/HCP.
Schema |
|
type Query { individualByID( id: ID!, locale: String ): Individual }
|
|
Field |
Type |
Description |
id |
ID! |
ID of HCP. |
locale |
String |
Optional. Specifies the language in which translatable fields are translated. If not specified, then the default locale "en" is used. |
|
|
|
Individual
A JSON response with an object of the Individual type (Activity API 1.0) or Individual type (Activity API 2.0) as a result.
ActivityException
If a server error occurs or an incorrect input is specified.
Criteria in this query is from a "details/profile request" made by your app for an HCP, such as an HCP selected (such as a result of an individuals query to the Activity API 2.0 or individualsByName query to the Activity API 1.0) in a list/map on the prebuilt Results screen. To get data without implementing a UI, HealthCare Locator provides the following call:
● hclAPI.individualsByID (SDK for JavaScript)
This query is sent to the Activities endpoint of the Activity API.
HealthCare Locator SDK 1.0 and higher
GraphQL Activity API 1.0 and Activity API 2.0