rxfoundry.clients.swifty-api

API for the SwiftyRX Backend

This Python package is automatically generated by the OpenAPI Generator project:

API version: 1.16.0.BUILD
Package version: 1.0.0
Generator version: 7.13.0
Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import rxfoundry.clients.swifty_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import rxfoundry.clients.swifty_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import rxfoundry.clients.swifty_api
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.AsyncApi(api_client)
    patient_activity_notification = rxfoundry.clients.swifty_api.PatientActivityNotification() # PatientActivityNotification | 

    try:
        # Receive notification of patient data activity from an external system.  This will be processed asynchronously.
        api_response = api_instance.create_patient_activity(patient_activity_notification)
        print("The response of AsyncApi->create_patient_activity:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AsyncApi->create_patient_activity: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /api

Class	Method	HTTP request	Description
AsyncApi	create_patient_activity	POST /swifty/1/async/patient_activity	Receive notification of patient data activity from an external system. This will be processed asynchronously.
AsyncApi	create_patient_merge_request	POST /swifty/1/async/patient/merge_request	Create a new patient merge request that will be processed asynchronously.
AsyncApi	create_prescription	POST /swifty/1/async/prescription	Create a new prescription that will be processed asynchronously.
AsyncApi	create_prescription_change_request	POST /swifty/1/async/prescription/change_request	Create a new prescription change request that will be processed asynchronously.
AsyncApi	create_prescription_change_request_response	POST /swifty/1/async/prescription/change_request/{message_id}/response	Approves a prescription change request and creates a new prescription with the changes.
AsyncApi	create_prescription_patch	PATCH /swifty/1/async/prescription/{prescription_id}/patch	Update a prescription by UUID or RxNumber. Only "patchable" fields can be updated.
AsyncApi	create_prescription_renewal_request	POST /swifty/1/async/prescription/renewal_request	Create a new renewal request that will be processed asynchronously.
AsyncApi	create_prescription_transfer_in_request	POST /swifty/1/async/prescription/transfer_in_request	Create a new prescription transfer in request that will be processed asynchronously.
AsyncApi	create_prescription_transfer_out_request	POST /swifty/1/async/prescription/transfer_out_request	Create a new prescription transfer request that will be processed asynchronously.
AsyncApi	create_prescription_transfer_out_request_multi	POST /swifty/1/async/prescription/transfer_out_request_multi	Create a new multi-prescription transfer request that will be processed asynchronously.
AsyncApi	create_workflow_request	POST /swifty/1/async/workflow/request	Create a new workflow request that will be processed asynchronously. Only use this endpoint if instructed to do so by Swifty support team.
AsyncApi	get_patient_activity	GET /swifty/1/async/patient_activity/{message_id}	Check the processing status of a previously submitted patient activity
AsyncApi	get_prescription	GET /swifty/1/async/prescription/{message_id}	Check the processing status of a previously submitted prescription
AsyncApi	get_prescription_change_request	GET /swifty/1/async/prescription/change_request/{message_id}	Check the processing status of a previously submitted prescription change request
AsyncApi	get_prescriptions	GET /swifty/1/async/prescription	Get all prescriptions that have been processed asynchronously
AsyncApi	retry_notification	POST /swifty/1/async/notification/{notification_uuid}/retry	Retry a notification that previously failed
CodeApi	get_code_types	GET /swifty/1/code_types	Get all code types
CodeApi	get_codes	GET /swifty/1/codes	Get all codes for a typename
IntakeApi	get_fax	GET /swifty/1/intake/faxes/{fax_uuid}	Get a fax by ID
IntakeApi	get_faxes	GET /swifty/1/intake/faxes	Get all faxes
IntakeApi	get_prescription_messages	GET /swifty/1/intake/direct	Gets the PrescriptionMessage objects
IntakeApi	get_surescripts_messages	GET /swifty/1/intake/surescripts	Gets the SurescriptsMessage objects
MedicationApi	get_medication	GET /swifty/1/medications/{medication_uuid}	Get a medication by UUID
MedicationApi	get_medication_formularies	GET /swifty/1/medications/{medication_uuid}/formularies	Get a medication's formularies by medication UUID
MedicationApi	get_medication_instructions	GET /swifty/1/medications/{medication_uuid}/instructions	Get a medication by UUID
MedicationApi	get_medication_pricing	GET /swifty/1/medications/{medication_uuid}/pricing	Get a medication's prices by medication UUID
MedicationApi	get_medications	GET /swifty/1/medications	Get all medications
PatientApi	create_patient	POST /swifty/1/patients	Create a patient
PatientApi	find_patient_possible_matches	GET /swifty/1/patients/possible_matches	Get partial matches grouped by the patient the possible match applies to
PatientApi	get_patient	GET /swifty/1/patients/{patient_id}	Get patient by id
PatientApi	get_patient_allergies	GET /swifty/1/patients/{patient_id}/allergies	Get allergies for a patient
PatientApi	get_patient_conditions	GET /swifty/1/patients/{patient_id}/conditions	Get conditions for a patient
PatientApi	get_patient_insurances	GET /swifty/1/patients/{patient_id}/insurances	Get insurances for a patient
PatientApi	get_patient_medications	GET /swifty/1/patients/{patient_id}/medications	Get medications for a patient
PatientApi	get_patient_pharmacies	GET /swifty/1/patients/{patient_id}/pharmacies	Get pharmacies near a patient
PatientApi	get_patient_possible_matches	GET /swifty/1/patients/{patient_id}/possible_matches	Get possible matches for a patient
PatientApi	get_patients	GET /swifty/1/patients	Get all patients
PatientApi	review_patient_possible_matches	POST /swifty/1/patients/possible_matches/review	Mark possible matches as reviewed and optionally merge two patients
PharmacistApi	get_pharmacist	GET /swifty/1/pharmacists/{pharmacist_id}	Get a pharmacist by UUID or NPI
PharmacistApi	get_pharmacists	GET /swifty/1/pharmacists	Get all pharmacists
PharmacyApi	get_pharmacies	GET /swifty/1/pharmacies	Get all pharmacies
PharmacyApi	get_pharmacy	GET /swifty/1/pharmacies/{pharmacy_id}	Get a pharmacy by UUID or NPI
PrescriberApi	get_prescriber	GET /swifty/1/prescribers/{prescriber_id}	Get a prescriber by UUID or NPI
PrescriberApi	get_prescribers	GET /swifty/1/prescribers	Get all prescribers
PrescriptionApi	create_pharmacist_verification	POST /swifty/1/prescriptions/{prescription_id}/pv	Create a new prescription verification setting
PrescriptionApi	get_prescription	GET /swifty/1/prescriptions/{prescription_id}	Get a prescription by UUID or RxNumber
PrescriptionApi	get_prescription_change_requests	GET /swifty/1/prescriptions/{prescription_id}/change_requests	Get all prescription change requests for a prescription
PrescriptionApi	get_prescription_issues	GET /swifty/1/prescriptions/{prescription_id}/issues	Get all issues for a prescription
PrescriptionApi	get_prescription_messages	GET /swifty/1/prescriptions/{prescription_id}/messages	Get all prescription messages for a prescription
PrescriptionApi	get_prescription_patches	GET /swifty/1/prescriptions/{prescription_id}/patches	Get all patches for a prescription
PrescriptionApi	get_prescription_tasks	GET /swifty/1/prescriptions/{prescription_id}/tasks	Get all tasks for a prescription
PrescriptionApi	get_prescriptions	GET /swifty/1/prescriptions	Get all prescriptions
PrescriptionApi	get_surescripts_messages	GET /swifty/1/prescriptions/{prescription_id}/surescripts_messages	Get surescripts message(s) for a prescription
PrescriptionApi	update_prescription	PATCH /swifty/1/prescriptions/{prescription_id}	Update a prescription by UUID or RxNumber. Only "patchable" fields can be updated. Deprecated
TaskApi	get_patient_task_statuses	GET /swifty/1/tasks/patient_tasks/{patient_task_uuid}/statuses	Gets list of statuses for a patient task
TaskApi	get_patient_tasks	GET /swifty/1/tasks/patient_tasks	Get all patient tasks
TaskApi	get_prescription_message_task_statuses	GET /swifty/1/tasks/prescription_message_tasks/{prescription_message_task_uuid}/statuses	Gets list of statuses for a prescription message task
TaskApi	get_prescription_message_tasks	GET /swifty/1/tasks/prescription_message_tasks	Gets list of prescription message tasks
TaskApi	get_prescription_task_statuses	GET /swifty/1/tasks/prescription_tasks/{prescription_task_uuid}/statuses	Gets list of statuses for a prescription task
TaskApi	get_prescription_tasks	GET /swifty/1/tasks/prescription_tasks	Get all prescription tasks
TokenApi	get_token_for_token	POST /swifty/1/token	Get a delegated token based upon an already authorized token
ValidationApi	validate_address	POST /swifty/1/validation/address	Validate and correct an address using Radar API
VersionApi	get_api_version	GET /swifty/1/version	Get the api version
VirtualPharmacyApi	get_virtual_pharmacies	GET /swifty/1/virtual_pharmacies	Get all virtual pharmacies
VirtualPharmacyApi	get_virtual_pharmacy	GET /swifty/1/virtual_pharmacies/{virtual_pharmacy_uuid}	Get a virtual pharmacy by UUID
WorkflowApi	get_workflow_tasks	GET /swifty/1/workflows/{workflow_uuid}	Gets the details for a workflow
WorkflowApi	get_workflows	GET /swifty/1/workflows	Get a list of workflows for the tenant

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

opaque_token

Type: Bearer authentication (opaque)

Author

paul.tindall@rxfoundry.com

Release files for rxfoundry.clients.swifty-api 1.16.0.5441

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rxfoundry.clients.swifty-api 1.16.0.5441
File	Size	Uploaded
rxfoundry_clients_swifty_api-1.16.0.5441.tar.gz	120.5 kB	Sep 1, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for rxfoundry.clients.swifty-api 1.16.0.5441
File	Interpreter	ABI	Platform	Reset
rxfoundry_clients_swifty_api-1.16.0.5441-py3-none-any.whl 224.4 kB Sep 1, 2026	Python 3	none	any	Details

Total release size: 344.8 kB

Release files / rxfoundry_clients_swifty_api-1.16.0.5441.tar.gz

Download URL	rxfoundry_clients_swifty_api-1.16.0.5441.tar.gz
Size	120.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`b57b6842f7ef5d25d0a3e8e1add33487881976ccd54f736c785b2193e7b9bf01`
BLAKE2b-256 checksum How to use checksums	`7428d490fa638ff729e8524a9f7d53882f7905304c9551db57e5ded2e4475df7`
Upload date	Sep 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.2.1 CPython/3.12.3 Linux/6.12.94+`

Release files / rxfoundry_clients_swifty_api-1.16.0.5441-py3-none-any.whl

Download URL	rxfoundry_clients_swifty_api-1.16.0.5441-py3-none-any.whl
Size	224.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`ae35a39e93a7c2e73229d9f21afa8d8b3df3f813e060f554b56325ead305a738`
BLAKE2b-256 checksum How to use checksums	`be8d67db7526306ac1acb1620f1dca49ef6deb7cb2c7ee936da36446834b6f6e`
Upload date	Sep 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.2.1 CPython/3.12.3 Linux/6.12.94+`