Search evaluated gene–drug pairs
pgx_search_pairsSearch evaluated gene–drug pairs by gene, literal drug-name substring, exact drug/RxNorm/ATC identifiers, evaluation level or testing label. Filters combine with AND; identifiers never fall back to name-only search. Results include source drug identifiers and guideline links for pgx_get_guideline. A pair evaluation is not a prescribing recommendation. Follow nextOffset to continue.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| atcId | No | Exact ATC code (1–7 letters/digits) in any casing, optionally prefixed ATC: in any casing; outer whitespace is ignored and blank means unset. | |
| limit | No | Positive safe-integer row limit; values above 100 are clamped to 100 with a notice (default 25). | |
| drugId | No | Exact drugId returned by pgx_search_pairs; blank means unset. | |
| offset | No | Zero-based offset; use nextOffset to continue (default 0). | |
| drugName | No | Literal case-insensitive drug-name substring; blank means unset. | |
| rxnormId | No | Decimal RxNorm ID, optionally prefixed RxNorm: in any casing; outer whitespace is ignored and blank means unset. | |
| cpicLevel | No | Exact source CPIC evaluation level, not a prescribing recommendation. | |
| geneSymbol | No | Exact gene symbol, case-insensitive input; blank means unset. | |
| pgxTesting | No | ClinPGx label-annotation testing level; not an FDA label. | |
| provisional | No | Filter by source provisional flag. | |
| includeRetired | No | Include Retired pairs; also included when cpicLevel is Retired. | |
| usedForRecommendation | No | Whether the source marks the pair as used for a recommendation. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | Effective public page limit. | |
| page | No | Source pagination metadata. | |
| error | No | Present when the call failed. Absent on success. | |
| items | No | Complete evaluated pairs and related drugs. | |
| shown | No | Number of returned rows, equal to page.returned. | |
| notices | No | Notices about this result; empty when none apply. | |
| truncated | No | Whether more matching rows remain after this page. | |
| provenance | No | Live source attribution and retrieval details. | |
| effectiveQuery | No | Normalized filters and effective paging. |