Get guideline coverage
pgx_get_guidelineRetrieve guideline coverage by source ID, exact gene symbol or exact drug name/ID. Default summary pages complete guideline records with exact drugCount/pairCount. view=drugs or pairs requires by=id and pages only that related collection, retaining its guideline descriptor. Ambiguous drug names page candidates for retry with drugId. Follow page.nextOffset; the 24,000-byte soft budget cuts only between complete rows, with oversizedRow for an indivisible exception. Missing coverage is found=false. Consult linked guidelines before clinical use.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| by | Yes | id requires guidelineId; gene requires geneSymbol; drug requires exactly one exact drugName or drugId. Other selectors must be omitted. | |
| view | No | Summary pages guideline descriptors; drugs or pairs requires by=id and pages only that related collection. | summary |
| 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 | Exact case-insensitive source drug name for by=drug; blank means unset. | |
| geneSymbol | No | Gene symbol for by=gene; blank means unset. | |
| guidelineId | No | Positive source guideline ID from pgx_get_guideline by=gene or by=drug results; no valid ID range is inferred. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | Effective public page limit. | |
| page | No | Source pagination metadata. | |
| view | No | Selected guideline view. | |
| drugs | No | Selected drugs page; omitted in other views. | |
| error | No | Present when the call failed. Absent on success. | |
| found | No | Whether guideline coverage was found. | |
| pairs | No | Selected pairs page; omitted in other views. | |
| shown | No | Number of returned rows, equal to page.returned. | |
| notices | No | Notices about this result; empty when none apply. | |
| guidance | No | Next lookup step when missing or ambiguous; empty when found. | |
| truncated | No | Whether more matching rows remain after this page. | |
| candidates | No | Paged exact drug-name candidates when resolution is ambiguous; page and shown then refer to candidates. | |
| guidelines | No | Paged complete guideline descriptors, or the retained descriptor for a related view. | |
| provenance | No | Live source attribution and retrieval details. | |
| oversizedRow | No | Whether one complete indivisible row exceeds the soft byte budget. | |
| clinicalCaveat | No | Clinical qualification for source guidance. | |
| effectiveQuery | No | Normalized guideline selectors and effective page bounds. |