This page is part of the US Drug Formulary (v1.1.0: STU 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

Queries

Anticipated Client Queries

Find All CoveragePlans

For each CoveragePlan, the PlanID is mapped to the List.identifier field. The value of List.identifier is the most general way to query the FormularyDrugs that are part of a specific plan.

  
    GET [base]/List?code=http://terminology.hl7.org/CodeSystem/v3-ActCode|DRUGPOL
  

Find CoveragePlan by its PlanID

To find the CoveragePlan for a plan with id 'myPlanID':

  
    GET [base]/List?code=http://terminology.hl7.org/CodeSystemv3-ActCode|DRUGPOL&identifier=myPlanID
  

Find All FormularyDrugs in a CoveragePlan

To find all FormularyDrugs in a CoveragePlan for a plan with id 'myPlanID':

  
    GET [base]/MedicationKnowledge?DrugPlan=myPlanID 
  

Alternatively, these FormularyDrugs are also in the array of entries that is part of the List.

Find all FormularyDrugs in a Specific Tier of CoveragePlan

To find all FormularyDrugs in the generic tier of plan myPlanID:

  
    GET [base]/MedicationKnowledge?DrugPlan=myPlanID&DrugTier=generic
  

Find A FormularyDrug by code in a CoveragePlan

To find a FormularyDrug by its RxNorm code within a CoveragePlan:

  
    GET [base]/MedicationKnowledge?DrugPlan=myPlanID&code=myCode
  

Find A FormularyDrug by code across all CoveragePlans

To find a FormularyDrug by its RxNorm code within all CoveragePlans:

  
    GET [base]/MedicationKnowledge?code=myCode