Sharp Health Plan Formulary API

Overview

The Sharp Health Plan Formulary API provides read-only access to the drugs covered by Sharp Health Plan's coverage plans, built according to the Da Vinci US Drug Formulary Implementation Guide to meet CMS interoperability requirements, conforming to the HL7® FHIR® R4 (4.0.1) standard.

This API helps you:

• List Sharp Health Plan's coverage plans and their formularies
• Find out whether a plan covers a drug, and on which tier
• Check whether a drug needs prior authorization or step therapy, or has a quantity limit
• Search the formulary by RxNorm code, drug name, plan, or tier

Pagination

All search endpoints return a FHIR searchset Bundle and support pagination via _count (results per page, default 20, max 100) and _getpagesoffset (starting offset, default 0). A next link is included in the Bundle when further pages exist.

Summarized search results

A plan's formulary runs to thousands of drugs, so some search results are summarized to keep responses within size limits. Summarized resources carry a SUBSETTED tag in meta.tag.

• GET /v1/List never includes each plan's entry[] drug references. Read a single plan with GET /v1/List/{id} to get them.
• GET /v1/MedicationKnowledge drops the per-plan extensions (tier, prior authorization, step therapy, quantity limit) when a page would exceed 2 MB. Narrow the search with DrugPlan to keep full detail, or read a single drug with GET /v1/MedicationKnowledge/{id}.

Connect & Register

All requests must include an API key in the x-api-key header:

x-api-key: <your-api-key>

Getting an API key

API keys are issued through our self-service registration form. Submit your name, email, company, and application name — your key is emailed to you and is active immediately on the default usage plan.

Environments

Support

For questions, issues, or access requests, contact Sharp Health Plan API support:

Phone: 858-499-8300

Please identify yourself as a developer and reference the name, email, company, and application name you submitted when you registered for your API key — this lets support locate your account quickly.

Terms of Use

Sharp supports the principles of the CARIN Trust Framework and Code of Conduct in promoting transparency to consumers for how their data is secured and used. App developers are encouraged to review and adopt it.

Sharp may suspend or revoke API access when it is reasonably determined that the security of our services or infrastructure may be compromised (e.g. hacking attempts, denial-of-service attacks, or other malicious activity). Affected users will be notified of any suspension or other action taken for security reasons.

Conformance

This API conforms to FHIR R4 (4.0.1) and the Da Vinci US Drug Formulary Implementation Guide.

GET /metadata — FHIR CapabilityStatement for this server (public, no API key required).

Resources & StructureDefinitions

API Reference

Interactive reference generated from our OpenAPI 3.0 document.