POST/v3/live/healthcare/discover/hcps/count
Count discover HCPs
Returns how many HCPs match the search criteria, exactly, without returning any of them and without consuming credits. The count is not subject to the 5,000-result paging ceiling.
Request body
- metadataobjectOptionalOptional metadata to associate with the request. Will be returned in the response.
- orobject[]OptionalOne or more filter groups. An HCP matches the request when they satisfy at least one group; within a group every block is ANDed
- congressesobjectOptionalCongress sessions the HCP presented at
- diagnosesobjectOptionalConditions the HCP diagnosed or referred for
- Manufacturers the HCP received non-meal payments from, as reported to CMS Open Payments. A payment is a financial relationship, not evidence the HCP uses the product; use 'not' on manufacturers to screen out conflicts of interest
- leaderboardsobjectOptionalThe HCP's decile on per-indication leaderboards
- namestringOptionalName for this group. Echoed in matchedFilterGroups on every result the group produced, and in validate warnings about the group
- practiceSettingobjectOptionalThe kind of organization the HCP currently works at. An HCP carries every setting that applies
- prescribingobjectOptionalDrugs the HCP prescribed or administered over the trailing twelve months
- proceduresobjectOptionalProcedures the HCP performed or ordered
- professionalobjectOptionalWho the HCP is and where they practice
- publicationsobjectOptionalPublications the HCP authored, by MeSH topic
- trialsobjectOptionalClinical trials the HCP is linked to on the trial record
- paginationobjectOptionalPage-based pagination controls
- Headers
x-api-keyRequired · API key for authentication
Response
- countinteger (int64)Number of HCPs matching the search criteria. Not capped at the 5,000 results the search endpoint can page through.
- hasProblemsbooleanWhether we hit a problem answering the request: the profile or company wasn't found, or a data source failed or timed out. Data may be missing or incomplete;
problems, where the response has it, says which. - isApproximatebooleanWhether
countis an estimate. Always false: every matching HCP is counted exactly. - isRetryablebooleanWhen
isSuccessisfalse, whether sending the same input again could succeed. AlwaystruewhenisSuccessistrue. - isSuccessboolean
truewhen the request was answered with a result.falsemeans no result was returned: checkisRetryable, which istruewhen a data source failed or timed out andfalsewhen the input matched nothing. - metadataobjectCaller-supplied metadata echoed back from the request.
- warningsstring[]Non-fatal warnings about the search, such as a brand, ingredient or class that expands to more values than are searched