Clover Health fhir-r4-formulary-api API

The fhir-r4-formulary-api API from Clover Health — 5 operation(s) for fhir-r4-formulary-api.

OpenAPI Specification

clover-health-fhir-r4-formulary-api-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: FHIR fhir-r4-formulary-api API
  version: 1.0.0
  description: Formulary and Provider Directory API
tags:
- name: fhir-r4-formulary-api
paths:
  /formulary/api/List:
    get:
      operationId: list_formulary
      description: This interaction searches a set of resources based on some filter criteria.
      summary: This interaction searches a set of resources based on some filter criteria.
      parameters:
      - in: query
        name: _count
        schema:
          type: integer
          maximum: 10000
          minimum: 1
          default: 20
          title: ' count'
        description: Maximum number of results to be returned
      - in: query
        name: _offset
        schema:
          type: integer
          minimum: 0
          default: 0
          title: ' offset'
        description: Number of results to be offset
      - in: query
        name: _profile
        schema:
          type: string
          title: ' profile'
          minLength: 1
        description: An URL of profile in structured definition
      - in: query
        name: identifier
        schema:
          type: string
          minLength: 1
        description: CoveragePlan identifier. It can be in the type of CloverHealth's identifier (E.g. 001, 002) or the plan ID (E.g. H5141)
      - in: query
        name: item
        schema:
          type: string
          minLength: 1
        description: The identifier of the associated FormularyDrug (also known as MedicationKnowledge) under the CoveragePlan
      - in: query
        name: status
        schema:
          enum:
          - current
          - retired
          - entered-in-error
          type: string
          minLength: 1
        description: '* `current` - current

          * `retired` - retired

          * `entered-in-error` - entered-in-error'
      tags:
      - fhir-r4-formulary-api
      security:
      - cookieAuth: []
      - basicAuth: []
      - {}
      responses:
        '200':
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FormularyListResponse'
              examples:
                JSONExample:
                  value:
                    resourceType: Bundle
                    id: 14f5b0a7-2d8b-43fb-a46e-b6c7d92aa59e
                    meta:
                      lastUpdated: '2021-05-27T03:30:14.877Z'
                    type: searchset
                    total: 1
                    link:
                    - relation: self
                      url: https://public-api.cloverhealth.com/formulary/api/List
                    entry:
                    - fullUrl: https://public-api.cloverhealth.com/formulary/api/List/a1bf521c-7fe0-5329-b1bb-8858a52cd807
                      search:
                        mode: match
                      resource:
                        resourceType: List
                        id: a1bf521c-7fe0-5329-b1bb-8858a52cd807
                        meta:
                          lastUpdated: '2021-05-18T10:18:01.162981+00:00'
                          profile:
                          - http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-CoveragePlan
                        identifier:
                        - system: https://www.cloverhealth.com/plans
                          value: '001'
                        - system: https://www.cloverhealth.com/plans
                          value: '002'
                        - value: H5141
                        status: current
                        mode: snapshot
                        title: H5141
                        date: '2021-05-18T10:18:01.162981+00:00'
                        extension:
                        - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension
                          extension:
                          - url: drugTierID
                            valueCodeableConcept:
                              coding:
                              - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS
                                code: preferred-brand
                                display: 'Preferred Brand: Brand name drugs'
                          - url: mailOrder
                            valueBoolean: true
                        - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension
                          extension:
                          - url: drugTierID
                            valueCodeableConcept:
                              coding:
                              - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS
                                code: specialty
                                display: 'Specialty: Drugs used to treat complex conditions like cancer and multiple sclerosis.They can be generic or brand name, and are typically the most expensive drugs on the formulary.'
                          - url: mailOrder
                            valueBoolean: true
                        - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension
                          extension:
                          - url: drugTierID
                            valueCodeableConcept:
                              coding:
                              - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS
                                code: non-preferred-generic
                                display: 'Non-preferred Generic: Generic drugs that cost more than drugs in ‘generic’ tier.'
                          - url: mailOrder
                            valueBoolean: true
                        - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension
                          extension:
                          - url: drugTierID
                            valueCodeableConcept:
                              coding:
                              - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS
                                code: generic
                                display: 'Generic: Commonly prescribed generic drugs that cost more than drugs in the ‘preferred generic’ tier.'
                          - url: mailOrder
                            valueBoolean: true
                        - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension
                          extension:
                          - url: drugTierID
                            valueCodeableConcept:
                              coding:
                              - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS
                                code: non-preferred-brand
                                display: 'Non-preferred Brand: Brand name drugs that cost more than ‘brand’ drugs.'
                          - url: mailOrder
                            valueBoolean: true
                        - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Network-extension
                          valueString: Not Applicable
                        - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-SummaryURL-extension
                          valueString: https://cdn.cloverhealth.com/filer_public/d0/b6/d0b6294a-2e6b-4504-b9d4-bf65a4753210/76207_nj_eng_ch_nj_cy21_5t_gs_core_april_21.pdf
                        - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanIDType-extension
                          valueString: HIOS-PLAN-ID
                        entry:
                        - item:
                            reference: MedicationKnowledge/000212621243033
                        - item:
                            reference: MedicationKnowledge/000212621923056
                  summary: JSON Example
                  description: '

                    ListBundle


                    Contains a collection of resources


                    - Rule: total only when a search or history

                    - Rule: entry.search only when a search

                    - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited

                    - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited

                    - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)

                    - Rule: A document must have an identifier with a system and a value

                    - Rule: A document must have a date

                    - Rule: A document must have a Composition as the first resource

                    - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language

                    '
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FormularyListResponse'
              examples:
                XMLExample:
                  value: "\n<?xml version='1.0' encoding='UTF-8'?>\n<Bundle xmlns=\"http://hl7.org/fhir\">\n  <id value=\"901d94d9-cbcf-4e11-abc9-4c7b88370987\"/>\n  <meta>\n    <lastUpdated value=\"2021-05-27T03:29:00.024Z\"/>\n  </meta>\n  <type value=\"searchset\"/>\n  <total value=\"1\"/>\n  <link>\n    <relation value=\"self\"/>\n    <url value=\"https://public-api.cloverhealth.com/formulary/api/List\"/>\n  </link>\n  <entry>\n    <fullUrl value=\"https://public-api.cloverhealth.com/formulary/api/List/a1bf521c-7fe0-5329-b1bb-8858a52cd807\"/>\n    <resource>\n      <List xmlns=\"http://hl7.org/fhir\">\n        <id value=\"a1bf521c-7fe0-5329-b1bb-8858a52cd807\"/>\n        <meta>\n          <lastUpdated value=\"2021-05-18T10:18:01.162981+00:00\"/>\n          <profile value=\"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-CoveragePlan\"/>\n        </meta>\n        <extension url=\"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension\">\n          <extension url=\"drugTierID\">\n            <valueCodeableConcept>\n              <coding>\n                <system value=\"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS\"/>\n                <code value=\"preferred-brand\"/>\n                <display value=\"Preferred Brand: Brand name drugs\"/>\n              </coding>\n            </valueCodeableConcept>\n          </extension>\n          <extension url=\"mailOrder\">\n            <valueBoolean value=\"true\"/>\n          </extension>\n        </extension>\n        <extension url=\"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension\">\n          <extension url=\"drugTierID\">\n            <valueCodeableConcept>\n              <coding>\n                <system value=\"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS\"/>\n                <code value=\"specialty\"/>\n                <display value=\"Specialty: Drugs used to treat complex conditions like cancer and multiple sclerosis.They can be generic or brand name, and are typically the most expensive drugs on the formulary.\"/>\n              </coding>\n            </valueCodeableConcept>\n          </extension>\n          <extension url=\"mailOrder\">\n            <valueBoolean value=\"true\"/>\n          </extension>\n        </extension>\n        <extension url=\"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension\">\n          <extension url=\"drugTierID\">\n            <valueCodeableConcept>\n              <coding>\n                <system value=\"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS\"/>\n                <code value=\"non-preferred-generic\"/>\n                <display value=\"Non-preferred Generic: Generic drugs that cost more than drugs in ‘generic’ tier.\"/>\n              </coding>\n            </valueCodeableConcept>\n          </extension>\n          <extension url=\"mailOrder\">\n            <valueBoolean value=\"true\"/>\n          </extension>\n        </extension>\n        <extension url=\"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension\">\n          <extension url=\"drugTierID\">\n            <valueCodeableConcept>\n              <coding>\n                <system value=\"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS\"/>\n                <code value=\"generic\"/>\n                <display value=\"Generic: Commonly prescribed generic drugs that cost more than drugs in the ‘preferred generic’ tier.\"/>\n              </coding>\n            </valueCodeableConcept>\n          </extension>\n          <extension url=\"mailOrder\">\n            <valueBoolean value=\"true\"/>\n          </extension>\n        </extension>\n        <extension url=\"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension\">\n          <extension url=\"drugTierID\">\n            <valueCodeableConcept>\n              <coding>\n                <system value=\"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS\"/>\n                <code value=\"non-preferred-brand\"/>\n                <display value=\"Non-preferred Brand: Brand name drugs that cost more than ‘brand’ drugs.\"/>\n              </coding>\n            </valueCodeableConcept>\n          </extension>\n          <extension url=\"mailOrder\">\n            <valueBoolean value=\"true\"/>\n          </extension>\n        </extension>\n        <extension url=\"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Network-extension\">\n          <valueString value=\"Not Applicable\"/>\n        </extension>\n        <extension url=\"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-SummaryURL-extension\">\n          <valueString value=\"https://cdn.cloverhealth.com/filer_public/d0/b6/d0b6294a-2e6b-4504-b9d4-bf65a4753210/76207_nj_eng_ch_nj_cy21_5t_gs_core_april_21.pdf\"/>\n        </extension>\n        <extension url=\"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanIDType-extension\">\n          <valueString value=\"HIOS-PLAN-ID\"/>\n        </extension>\n        <identifier>\n          <system value=\"https://www.cloverhealth.com/plans\"/>\n          <value value=\"001\"/>\n        </identifier>\n        <identifier>\n          <system value=\"https://www.cloverhealth.com/plans\"/>\n          <value value=\"002\"/>\n        </identifier>\n        <identifier>\n          <value value=\"H5141\"/>\n        </identifier>\n        <status value=\"current\"/>\n        <mode value=\"snapshot\"/>\n        <title value=\"H5141\"/>\n        <date value=\"2021-05-18T10:18:01.162981+00:00\"/>\n        <entry>\n          <item>\n            <reference value=\"MedicationKnowledge/000212621243033\"/>\n          </item>\n        </entry>\n        <entry>\n          <item>\n            <reference value=\"MedicationKnowledge/000212621923056\"/>\n          </item>\n        </entry>\n      </List>\n    </resource>\n    <search>\n      <mode value=\"match\"/>\n    </search>\n  </entry>\n</Bundle>\n"
                  summary: XML Example
                  description: '

                    ListBundle


                    Contains a collection of resources


                    - Rule: total only when a search or history

                    - Rule: entry.search only when a search

                    - Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited

                    - Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited

                    - Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)

                    - Rule: A document must have an identifier with a system and a value

                    - Rule: A document must have a date

                    - Rule: A document must have a Composition as the first resource

                    - Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language

                    '
          description: ''
  /formulary/api/List/{id}:
    get:
      operationId: list_formulary_item
      description: The read interaction accesses the current contents of a resource.
      summary: The read interaction accesses the current contents of a resource.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - fhir-r4-formulary-api
      security:
      - cookieAuth: []
      - basicAuth: []
      - {}
      responses:
        '200':
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FormularyListItemResponse'
              examples:
                JSONExample:
                  value:
                    resourceType: List
                    id: a1bf521c-7fe0-5329-b1bb-8858a52cd807
                    meta:
                      lastUpdated: '2021-05-18T10:18:01.162981+00:00'
                      profile:
                      - http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-CoveragePlan
                    identifier:
                    - system: https://www.cloverhealth.com/plans
                      value: '001'
                    - system: https://www.cloverhealth.com/plans
                      value: '002'
                    - value: H5141
                    status: current
                    mode: snapshot
                    title: H5141
                    date: '2021-05-18T10:18:01.162981+00:00'
                    extension:
                    - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension
                      extension:
                      - url: drugTierID
                        valueCodeableConcept:
                          coding:
                          - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS
                            code: preferred-generic
                            display: 'Preferred Generic: Commonly prescribed generic drugs.'
                      - url: mailOrder
                        valueBoolean: true
                    - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension
                      extension:
                      - url: drugTierID
                        valueCodeableConcept:
                          coding:
                          - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS
                            code: non-preferred-generic
                            display: 'Non-preferred Generic: Generic drugs that cost more than drugs in ‘generic’ tier.'
                      - url: mailOrder
                        valueBoolean: true
                    - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension
                      extension:
                      - url: drugTierID
                        valueCodeableConcept:
                          coding:
                          - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS
                            code: non-preferred-brand
                            display: 'Non-preferred Brand: Brand name drugs that cost more than ‘brand’ drugs.'
                      - url: mailOrder
                        valueBoolean: true
                    - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Network-extension
                      valueString: Not Applicable
                    - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-SummaryURL-extension
                      valueString: https://cdn.cloverhealth.com/filer_public/d0/b6/d0b6294a-2e6b-4504-b9d4-bf65a4753210/76207_nj_eng_ch_nj_cy21_5t_gs_core_april_21.pdf
                    - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanIDType-extension
                      valueString: HIOS-PLAN-ID
                    entry:
                    - item:
                        reference: MedicationKnowledge/000212621000001
                    - item:
                        reference: MedicationKnowledge/000212621000048
                  summary: JSON Example
                  description: '

                    List


                    A list is a curated collection of resources


                    - Rule: A list can only have an emptyReason if it is empty

                    - Rule: The deleted flag can only be used if the mode of the list is "changes"

                    - Rule: An entry date can only be used if the mode of the list is "working" Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension

                    '
            application/fhir+xml:
              schema:
                $ref: '#/components/schemas/FormularyListItemResponse'
              examples:
                XMLExample:
                  value: "<?xml version='1.0' encoding='UTF-8'?>\n<List xmlns=\"http://hl7.org/fhir\">\n  <id value=\"a1bf521c-7fe0-5329-b1bb-8858a52cd807\"/>\n  <meta>\n    <lastUpdated value=\"2021-05-18T10:18:01.162981+00:00\"/>\n    <profile value=\"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-CoveragePlan\"/>\n  </meta>\n  <extension url=\"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension\">\n    <extension url=\"drugTierID\">\n      <valueCodeableConcept>\n        <coding>\n          <system value=\"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS\"/>\n          <code value=\"preferred-generic\"/>\n          <display value=\"Preferred Generic: Commonly prescribed generic drugs.\"/>\n        </coding>\n      </valueCodeableConcept>\n    </extension>\n    <extension url=\"mailOrder\">\n      <valueBoolean value=\"true\"/>\n    </extension>\n  </extension>\n  <extension url=\"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension\">\n    <extension url=\"drugTierID\">\n      <valueCodeableConcept>\n        <coding>\n          <system value=\"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS\"/>\n          <code value=\"non-preferred-generic\"/>\n          <display value=\"Non-preferred Generic: Generic drugs that cost more than drugs in ‘generic’ tier.\"/>\n        </coding>\n      </valueCodeableConcept>\n    </extension>\n    <extension url=\"mailOrder\">\n      <valueBoolean value=\"true\"/>\n    </extension>\n  </extension>\n  <extension url=\"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension\">\n    <extension url=\"drugTierID\">\n      <valueCodeableConcept>\n        <coding>\n          <system value=\"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS\"/>\n          <code value=\"non-preferred-brand\"/>\n          <display value=\"Non-preferred Brand: Brand name drugs that cost more than ‘brand’ drugs.\"/>\n        </coding>\n      </valueCodeableConcept>\n    </extension>\n    <extension url=\"mailOrder\">\n      <valueBoolean value=\"true\"/>\n    </extension>\n  </extension>\n  <extension url=\"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Network-extension\">\n    <valueString value=\"Not Applicable\"/>\n  </extension>\n  <extension url=\"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-SummaryURL-extension\">\n    <valueString value=\"https://cdn.cloverhealth.com/filer_public/d0/b6/d0b6294a-2e6b-4504-b9d4-bf65a4753210/76207_nj_eng_ch_nj_cy21_5t_gs_core_april_21.pdf\"/>\n  </extension>\n  <extension url=\"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanIDType-extension\">\n    <valueString value=\"HIOS-PLAN-ID\"/>\n  </extension>\n  <identifier>\n    <system value=\"https://www.cloverhealth.com/plans\"/>\n    <value value=\"001\"/>\n  </identifier>\n  <identifier>\n    <system value=\"https://www.cloverhealth.com/plans\"/>\n    <value value=\"002\"/>\n  </identifier>\n  <identifier>\n    <value value=\"H5141\"/>\n  </identifier>\n  <status value=\"current\"/>\n  <mode value=\"snapshot\"/>\n  <title value=\"H5141\"/>\n  <date value=\"2021-05-18T10:18:01.162981+00:00\"/>\n  <entry>\n    <item>\n      <reference value=\"MedicationKnowledge/000212621000001\"/>\n    </item>\n  </entry>\n  <entry>\n    <item>\n      <reference value=\"MedicationKnowledge/000212621000048\"/>\n    </item>\n  </entry>\n</List>"
                  summary: XML Example
                  description: '

                    List


                    A list is a curated collection of resources


                    - Rule: A list can only have an emptyReason if it is empty

                    - Rule: The deleted flag can only be used if the mode of the list is "changes"

                    - Rule: An entry date can only be used if the mode of the list is "working" Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension

                    '
          description: ''
  /formulary/api/MedicationKnowledge:
    get:
      operationId: search_medication_knowledge
      description: This interaction searches a set of resources based on some filter criteria.
      summary: This interaction searches a set of resources based on some filter criteria.
      parameters:
      - in: query
        name: DrugName
        schema:
          type: string
          minLength: 1
        description: Name of the drug
      - in: query
        name: DrugPlan
        schema:
          type: string
          minLength: 1
        description: Plan of the drug
      - in: query
        name: DrugTier
        schema:
          type: string
          minLength: 1
        description: Drug tier of the drug
      - in: query
        name: _count
        schema:
          type: integer
          maximum: 10000
          minimum: 1
          default: 20
          title: ' count'
        description: Maximum number of results to be returned
      - in: query
        name: _offset
        schema:
          type: integer
          minimum: 0
          default: 0
          title: ' offset'
        description: Number of results to be offset
      - in: query
        name: _profile
        schema:
          type: string
          title: ' profile'
          minLength: 1
        description: An URL of profile in structured definition
      - in: query
        name: code
        schema:
          type: string
          minLength: 1
        description: Rx code of the drug
      tags:
      - fhir-r4-formulary-api
      security:
      - cookieAuth: []
      - basicAuth: []
      - {}
      responses:
        '200':
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/FormularyMedicationKnowledgeResponse'
              examples:
                JSONExample:
                  value:
                    resourceType: Bundle
                    id: 2f6e91d0-60ea-41b6-96cb-354ec38697ad
                    meta:
                      lastUpdated: '2021-05-27T12:10:37.416+08:00'
                    type: searchset
                    total: 2
                    link:
                    - relation: self
                      url: https://public-api.cloverhealth.com/formulary/api/MedicationKnowledge
                    entry:
                    - fullUrl: https://public-api.cloverhealth.com/formulary/api/MedicationKnowledge/000211871000001
                      resource:
                        resourceType: MedicationKnowledge
                        id: 000211871000001
                        meta:
                          profile:
                          - http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug
                        text:
                          status: generated
                          div: '<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative</b></p><p><b>Drug Tier ID</b>:<span title="Codes: {http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS preferred-generic}">Preferred Generic: Commonly prescribed generic drugs.</span></p><p><b>Prior Authorization</b>: false</p><p><b>Step Therapy Limit</b>: false</p><p><b>Quantity Limit</b>: true</p><p><b>Plan ID</b>: H5141</p><p><b>code</b>:<span title="Codes: {http://www.nlm.nih.gov/research/umls/rxnorm 1000001}">OLMESARTAN-AMLODIPINE-HYDROCHLOROTHIAZIDE TAB 40-5-25 MG</span></p></div>'
                        extension:
                        - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierID-extension
                          valueCodeableConcept:
                            coding:
                            - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS
                              code: preferred-generic
                              display: 'Preferred Generic: Commonly prescribed generic drugs.'
                            - system: https://www.cloverhealth.com/members/formulary/DrugTierLevel
                              code: Tier 1
                              display: Preferred Generic drugs
                        - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PriorAuthorization-extension
                          valueBoolean: false
                        - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-StepTherapyLimit-extension
                          valueBoolean: false
                        - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimit-extension
                          valueBoolean: true
                        - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanID-extension
                          valueString: H5141
                        - url: https://www.cloverhealth.com/members/formulary
                          valueString: 00021187
                        code:
                          coding:
                          - system: http://www.nlm.nih.gov/research/umls/rxnorm
                            code: '1000001'
                            display: OLMESARTAN-AMLODIPINE-HYDROCHLOROTHIAZIDE TAB 40-5-25 MG
                      search:
                        mode: match
                    - fullUrl: https://public-api.cloverhealth.com/formulary/api/MedicationKnowledge/000211871000048
                      resource:
                        resourceType: MedicationKnowledge
                        id: 000211871000048
                        meta:
                          profile:
                          - http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug
                        text:
                          status: generated
                          div: '<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative</b></p><p><b>Drug Tier ID</b>:<span title="Codes: {http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS non-preferred-generic}">Non-preferred Generic: Generic drugs that cost more than drugs in ‘generic’ tier.</span></p><p><b>Prior Authorization</b>: false</p><p><b>Step Therapy Limit</b>: false</p><p><b>Quantity Limit</b>: false</p><p><b>Plan ID</b>: H8010</p><p><b>code</b>:<span title="Codes: {http://www.nlm.nih.gov/research/umls/rxnorm 1000048}">DOXEPIN HCL CAP 10 MG</span></p></div>'
                        extension:
                        - url: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierID-extension
                          valueCodeableConcept:
                            coding:
                            - system: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS
      

# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clover-health/refs/heads/main/openapi/clover-health-fhir-r4-formulary-api-api-openapi.yml