rxfoundry.clients.swifty_api.PharmacistApi

All URIs are relative to /api

Method

HTTP request

Description

get_pharmacist

GET /swifty/1/pharmacists/{pharmacist_id}

Get a pharmacist by UUID or NPI

get_pharmacists

GET /swifty/1/pharmacists

Get all pharmacists

get_pharmacist

Pharmacist get_pharmacist(pharmacist_id)

Get a pharmacist by UUID or NPI

Example

  • Bearer (opaque) Authentication (opaque_token):

import rxfoundry.clients.swifty_api
from rxfoundry.clients.swifty_api.models.pharmacist import Pharmacist
from rxfoundry.clients.swifty_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api
# See configuration.py for a list of all supported configuration parameters.
configuration = rxfoundry.clients.swifty_api.Configuration(
    host = "/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (opaque): opaque_token
configuration = rxfoundry.clients.swifty_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with rxfoundry.clients.swifty_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rxfoundry.clients.swifty_api.PharmacistApi(api_client)
    pharmacist_id = 'pharmacist_id_example' # str | Pharmacist UUID or NPI

    try:
        # Get a pharmacist by UUID or NPI
        api_response = api_instance.get_pharmacist(pharmacist_id)
        print("The response of PharmacistApi->get_pharmacist:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PharmacistApi->get_pharmacist: %s\n" % e)

Parameters

Name

Type

Description

Notes

pharmacist_id

str

Pharmacist UUID or NPI

Return type

Pharmacist

Authorization

opaque_token

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

HTTP response details

Status code

Description

Response headers

200

A single pharmacy

-

404

No pharmacist found

-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_pharmacists

List[Pharmacist] get_pharmacists(q=q, page=page, results_per_page=results_per_page, deep=deep)

Get all pharmacists

Example

  • Bearer (opaque) Authentication (opaque_token):

import rxfoundry.clients.swifty_api
from rxfoundry.clients.swifty_api.models.pharmacist import Pharmacist
from rxfoundry.clients.swifty_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api
# See configuration.py for a list of all supported configuration parameters.
configuration = rxfoundry.clients.swifty_api.Configuration(
    host = "/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (opaque): opaque_token
configuration = rxfoundry.clients.swifty_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with rxfoundry.clients.swifty_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rxfoundry.clients.swifty_api.PharmacistApi(api_client)
    q = 'q_example' # str | Filter medications by query.  Searches on NPI, first name, last name, practice address street one, practice address city, practice address state. (optional)
    page = 1 # int | Page number to return.  Defaults to 1. (optional) (default to 1)
    results_per_page = 10 # int | Number of results to return per page.  Defaults to 10. (optional) (default to 10)
    deep = False # bool | Returned contained objects for the pharmacist or just minimal information.  Defaults to false. (optional) (default to False)

    try:
        # Get all pharmacists
        api_response = api_instance.get_pharmacists(q=q, page=page, results_per_page=results_per_page, deep=deep)
        print("The response of PharmacistApi->get_pharmacists:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PharmacistApi->get_pharmacists: %s\n" % e)

Parameters

Name

Type

Description

Notes

q

str

Filter medications by query. Searches on NPI, first name, last name, practice address street one, practice address city, practice address state.

[optional]

page

int

Page number to return. Defaults to 1.

[optional] [default to 1]

results_per_page

int

Number of results to return per page. Defaults to 10.

[optional] [default to 10]

deep

bool

Returned contained objects for the pharmacist or just minimal information. Defaults to false.

[optional] [default to False]

Return type

List[Pharmacist]

Authorization

opaque_token

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

HTTP response details

Status code

Description

Response headers

200

A list of all pharmacists

* X-Total-Count - Total number of prescriptions available
* X-Page - Current page number
* X-Per-Page - Number of prescriptions per page
* X-Total-Pages - Total number of pages available
* X-Scores - A dictionary of search scores for each prescriber

404

No pharmacists found

-

[Back to top] [Back to API list] [Back to Model list] [Back to README]