# rxfoundry.clients.swifty-api
API for the SwiftyRX Backend
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.1.DEV-0
- 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:
```sh
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:
```python
import rxfoundry.clients.swifty_api
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import rxfoundry.clients.swifty_api
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
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**](docs/AsyncApi.md#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_prescription_transfer_request**](docs/AsyncApi.md#create_prescription_transfer_request) | **POST** /swifty/1/async/prescription/request_transfer | Create a new prescription transfer request that will be processed asynchronously.
*AsyncApi* | [**create_workflow_request**](docs/AsyncApi.md#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.
*CodeApi* | [**get_codes**](docs/CodeApi.md#get_codes) | **GET** /swifty/1/codes | Get all codes for a typename
*FaxApi* | [**get_fax**](docs/FaxApi.md#get_fax) | **GET** /swifty/1/faxes/{fax_uuid} | Get a fax by ID
*FaxApi* | [**get_faxes**](docs/FaxApi.md#get_faxes) | **GET** /swifty/1/faxes | Get all faxes
*MedicationApi* | [**get_medication**](docs/MedicationApi.md#get_medication) | **GET** /swifty/1/medications/{medication_uuid} | Get a medication by UUID
*MedicationApi* | [**get_medications**](docs/MedicationApi.md#get_medications) | **GET** /swifty/1/medications | Get all medications
*PatientApi* | [**get_patient**](docs/PatientApi.md#get_patient) | **GET** /swifty/1/patients/{patient_uuid} | Get patient by uuid
*PatientApi* | [**get_patient_pharmacies**](docs/PatientApi.md#get_patient_pharmacies) | **GET** /swifty/1/patients/{patient_uuid}/pharmacies | Get pharmacies near a patient
*PatientApi* | [**get_patients**](docs/PatientApi.md#get_patients) | **GET** /swifty/1/patients | Get all patients
*PharmacistApi* | [**get_pharmacist**](docs/PharmacistApi.md#get_pharmacist) | **GET** /swifty/1/pharmacists/{pharmacist_id} | Get a pharmacist by UUID or NPI
*PharmacistApi* | [**get_pharmacists**](docs/PharmacistApi.md#get_pharmacists) | **GET** /swifty/1/pharmacists | Get all pharmacists
*PharmacyApi* | [**get_pharmacies**](docs/PharmacyApi.md#get_pharmacies) | **GET** /swifty/1/pharmacies | Get all pharmacies
*PharmacyApi* | [**get_pharmacy**](docs/PharmacyApi.md#get_pharmacy) | **GET** /swifty/1/pharmacies/{pharmacy_id} | Get a pharmacy by UUID or NPI
*PrescriberApi* | [**get_prescriber**](docs/PrescriberApi.md#get_prescriber) | **GET** /swifty/1/prescribers/{prescriber_id} | Get a prescriber by UUID or NPI
*PrescriberApi* | [**get_prescribers**](docs/PrescriberApi.md#get_prescribers) | **GET** /swifty/1/prescribers | Get all prescribers
*PrescriptionApi* | [**create_pharmacist_verification**](docs/PrescriptionApi.md#create_pharmacist_verification) | **POST** /swifty/1/prescriptions/{prescription_id}/pv | Create a new prescription verification setting
*PrescriptionApi* | [**create_prescription_change_request**](docs/PrescriptionApi.md#create_prescription_change_request) | **POST** /swifty/1/prescriptions/{prescription_id}/change_requests | Create a new prescription change request
*PrescriptionApi* | [**get_prescription**](docs/PrescriptionApi.md#get_prescription) | **GET** /swifty/1/prescriptions/{prescription_id} | Get a prescription by UUID or RxNumber
*PrescriptionApi* | [**get_prescription_change_requests**](docs/PrescriptionApi.md#get_prescription_change_requests) | **GET** /swifty/1/prescriptions/{prescription_id}/change_requests | Get a list of prescription change requests
*PrescriptionApi* | [**get_prescriptions**](docs/PrescriptionApi.md#get_prescriptions) | **GET** /swifty/1/prescriptions | Get all prescriptions
*PrescriptionApi* | [**update_prescription**](docs/PrescriptionApi.md#update_prescription) | **PATCH** /swifty/1/prescriptions/{prescription_id} | Update a prescription by UUID or RxNumber. Only \"patchable\" fields can be updated.
*TokenApi* | [**get_token_for_token**](docs/TokenApi.md#get_token_for_token) | **POST** /swifty/1/token | Get a delegated token based upon an already authorized token
*UserApi* | [**get_users**](docs/UserApi.md#get_users) | **GET** /swifty/1/users | Get one or more users
*VersionApi* | [**get_api_version**](docs/VersionApi.md#get_api_version) | **GET** /swifty/1/version | Get the api version
*VirtualPharmacyApi* | [**get_virtual_pharmacies**](docs/VirtualPharmacyApi.md#get_virtual_pharmacies) | **GET** /swifty/1/virtual_pharmacies | Get all virtual pharmacies
## Documentation For Models
- [Address](docs/Address.md)
- [AsynchronousResponse](docs/AsynchronousResponse.md)
- [Code](docs/Code.md)
- [CodeQualifierCode](docs/CodeQualifierCode.md)
- [ErrorMessage](docs/ErrorMessage.md)
- [Fax](docs/Fax.md)
- [Medication](docs/Medication.md)
- [MedicationProgramPricing](docs/MedicationProgramPricing.md)
- [MedicationVariant](docs/MedicationVariant.md)
- [Patient](docs/Patient.md)
- [PatientActivityNotification](docs/PatientActivityNotification.md)
- [PatientActivityNotificationActivityData](docs/PatientActivityNotificationActivityData.md)
- [PatientAddressData](docs/PatientAddressData.md)
- [PatientData](docs/PatientData.md)
- [PatientExternalIdentifier](docs/PatientExternalIdentifier.md)
- [Pharmacist](docs/Pharmacist.md)
- [Pharmacy](docs/Pharmacy.md)
- [PharmacyChain](docs/PharmacyChain.md)
- [PharmacyOtherIdentifier](docs/PharmacyOtherIdentifier.md)
- [PharmacyProgramPricing](docs/PharmacyProgramPricing.md)
- [Prescriber](docs/Prescriber.md)
- [Prescription](docs/Prescription.md)
- [PrescriptionChangeRequest](docs/PrescriptionChangeRequest.md)
- [PrescriptionIssue](docs/PrescriptionIssue.md)
- [PrescriptionPatch](docs/PrescriptionPatch.md)
- [PrescriptionTask](docs/PrescriptionTask.md)
- [PrescriptionTaskStatus](docs/PrescriptionTaskStatus.md)
- [PrescriptionTransferRequest](docs/PrescriptionTransferRequest.md)
- [PrescriptionVerification](docs/PrescriptionVerification.md)
- [PricingProgram](docs/PricingProgram.md)
- [SurescriptsMessage](docs/SurescriptsMessage.md)
- [Token](docs/Token.md)
- [User](docs/User.md)
- [Version](docs/Version.md)
- [VirtualPharmacy](docs/VirtualPharmacy.md)
- [WorkflowRequest](docs/WorkflowRequest.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="opaque_token"></a>
### opaque_token
- **Type**: Bearer authentication (opaque)
## Author
paul.tindall@rxfoundry.com
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "rxfoundry.clients.swifty_api",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, SwiftyRX API",
"author": "RxFoundry Team",
"author_email": "paul.tindall@rxfoundry.com",
"download_url": "https://files.pythonhosted.org/packages/e9/da/0473f2cd68f18e4d4c6fad1ff81b7f210f0372e992150f5e71a2b11c078a/rxfoundry_clients_swifty_api-0.0.711.tar.gz",
"platform": null,
"description": "# rxfoundry.clients.swifty-api\nAPI for the SwiftyRX Backend\n\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.1.DEV-0\n- Package version: 1.0.0\n- Generator version: 7.13.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.9+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport rxfoundry.clients.swifty_api\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport rxfoundry.clients.swifty_api\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport rxfoundry.clients.swifty_api\nfrom rxfoundry.clients.swifty_api.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to /api\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = rxfoundry.clients.swifty_api.Configuration(\n host = \"/api\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure Bearer authorization (opaque): opaque_token\nconfiguration = rxfoundry.clients.swifty_api.Configuration(\n access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith rxfoundry.clients.swifty_api.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = rxfoundry.clients.swifty_api.AsyncApi(api_client)\n patient_activity_notification = rxfoundry.clients.swifty_api.PatientActivityNotification() # PatientActivityNotification | \n\n try:\n # Receive notification of patient data activity from an external system. This will be processed asynchronously.\n api_response = api_instance.create_patient_activity(patient_activity_notification)\n print(\"The response of AsyncApi->create_patient_activity:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling AsyncApi->create_patient_activity: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to */api*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AsyncApi* | [**create_patient_activity**](docs/AsyncApi.md#create_patient_activity) | **POST** /swifty/1/async/patient_activity | Receive notification of patient data activity from an external system. This will be processed asynchronously.\n*AsyncApi* | [**create_prescription_transfer_request**](docs/AsyncApi.md#create_prescription_transfer_request) | **POST** /swifty/1/async/prescription/request_transfer | Create a new prescription transfer request that will be processed asynchronously.\n*AsyncApi* | [**create_workflow_request**](docs/AsyncApi.md#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.\n*CodeApi* | [**get_codes**](docs/CodeApi.md#get_codes) | **GET** /swifty/1/codes | Get all codes for a typename\n*FaxApi* | [**get_fax**](docs/FaxApi.md#get_fax) | **GET** /swifty/1/faxes/{fax_uuid} | Get a fax by ID\n*FaxApi* | [**get_faxes**](docs/FaxApi.md#get_faxes) | **GET** /swifty/1/faxes | Get all faxes\n*MedicationApi* | [**get_medication**](docs/MedicationApi.md#get_medication) | **GET** /swifty/1/medications/{medication_uuid} | Get a medication by UUID\n*MedicationApi* | [**get_medications**](docs/MedicationApi.md#get_medications) | **GET** /swifty/1/medications | Get all medications\n*PatientApi* | [**get_patient**](docs/PatientApi.md#get_patient) | **GET** /swifty/1/patients/{patient_uuid} | Get patient by uuid\n*PatientApi* | [**get_patient_pharmacies**](docs/PatientApi.md#get_patient_pharmacies) | **GET** /swifty/1/patients/{patient_uuid}/pharmacies | Get pharmacies near a patient\n*PatientApi* | [**get_patients**](docs/PatientApi.md#get_patients) | **GET** /swifty/1/patients | Get all patients\n*PharmacistApi* | [**get_pharmacist**](docs/PharmacistApi.md#get_pharmacist) | **GET** /swifty/1/pharmacists/{pharmacist_id} | Get a pharmacist by UUID or NPI\n*PharmacistApi* | [**get_pharmacists**](docs/PharmacistApi.md#get_pharmacists) | **GET** /swifty/1/pharmacists | Get all pharmacists\n*PharmacyApi* | [**get_pharmacies**](docs/PharmacyApi.md#get_pharmacies) | **GET** /swifty/1/pharmacies | Get all pharmacies\n*PharmacyApi* | [**get_pharmacy**](docs/PharmacyApi.md#get_pharmacy) | **GET** /swifty/1/pharmacies/{pharmacy_id} | Get a pharmacy by UUID or NPI\n*PrescriberApi* | [**get_prescriber**](docs/PrescriberApi.md#get_prescriber) | **GET** /swifty/1/prescribers/{prescriber_id} | Get a prescriber by UUID or NPI\n*PrescriberApi* | [**get_prescribers**](docs/PrescriberApi.md#get_prescribers) | **GET** /swifty/1/prescribers | Get all prescribers\n*PrescriptionApi* | [**create_pharmacist_verification**](docs/PrescriptionApi.md#create_pharmacist_verification) | **POST** /swifty/1/prescriptions/{prescription_id}/pv | Create a new prescription verification setting\n*PrescriptionApi* | [**create_prescription_change_request**](docs/PrescriptionApi.md#create_prescription_change_request) | **POST** /swifty/1/prescriptions/{prescription_id}/change_requests | Create a new prescription change request\n*PrescriptionApi* | [**get_prescription**](docs/PrescriptionApi.md#get_prescription) | **GET** /swifty/1/prescriptions/{prescription_id} | Get a prescription by UUID or RxNumber\n*PrescriptionApi* | [**get_prescription_change_requests**](docs/PrescriptionApi.md#get_prescription_change_requests) | **GET** /swifty/1/prescriptions/{prescription_id}/change_requests | Get a list of prescription change requests\n*PrescriptionApi* | [**get_prescriptions**](docs/PrescriptionApi.md#get_prescriptions) | **GET** /swifty/1/prescriptions | Get all prescriptions\n*PrescriptionApi* | [**update_prescription**](docs/PrescriptionApi.md#update_prescription) | **PATCH** /swifty/1/prescriptions/{prescription_id} | Update a prescription by UUID or RxNumber. Only \\"patchable\\" fields can be updated.\n*TokenApi* | [**get_token_for_token**](docs/TokenApi.md#get_token_for_token) | **POST** /swifty/1/token | Get a delegated token based upon an already authorized token\n*UserApi* | [**get_users**](docs/UserApi.md#get_users) | **GET** /swifty/1/users | Get one or more users\n*VersionApi* | [**get_api_version**](docs/VersionApi.md#get_api_version) | **GET** /swifty/1/version | Get the api version\n*VirtualPharmacyApi* | [**get_virtual_pharmacies**](docs/VirtualPharmacyApi.md#get_virtual_pharmacies) | **GET** /swifty/1/virtual_pharmacies | Get all virtual pharmacies\n\n\n## Documentation For Models\n\n - [Address](docs/Address.md)\n - [AsynchronousResponse](docs/AsynchronousResponse.md)\n - [Code](docs/Code.md)\n - [CodeQualifierCode](docs/CodeQualifierCode.md)\n - [ErrorMessage](docs/ErrorMessage.md)\n - [Fax](docs/Fax.md)\n - [Medication](docs/Medication.md)\n - [MedicationProgramPricing](docs/MedicationProgramPricing.md)\n - [MedicationVariant](docs/MedicationVariant.md)\n - [Patient](docs/Patient.md)\n - [PatientActivityNotification](docs/PatientActivityNotification.md)\n - [PatientActivityNotificationActivityData](docs/PatientActivityNotificationActivityData.md)\n - [PatientAddressData](docs/PatientAddressData.md)\n - [PatientData](docs/PatientData.md)\n - [PatientExternalIdentifier](docs/PatientExternalIdentifier.md)\n - [Pharmacist](docs/Pharmacist.md)\n - [Pharmacy](docs/Pharmacy.md)\n - [PharmacyChain](docs/PharmacyChain.md)\n - [PharmacyOtherIdentifier](docs/PharmacyOtherIdentifier.md)\n - [PharmacyProgramPricing](docs/PharmacyProgramPricing.md)\n - [Prescriber](docs/Prescriber.md)\n - [Prescription](docs/Prescription.md)\n - [PrescriptionChangeRequest](docs/PrescriptionChangeRequest.md)\n - [PrescriptionIssue](docs/PrescriptionIssue.md)\n - [PrescriptionPatch](docs/PrescriptionPatch.md)\n - [PrescriptionTask](docs/PrescriptionTask.md)\n - [PrescriptionTaskStatus](docs/PrescriptionTaskStatus.md)\n - [PrescriptionTransferRequest](docs/PrescriptionTransferRequest.md)\n - [PrescriptionVerification](docs/PrescriptionVerification.md)\n - [PricingProgram](docs/PricingProgram.md)\n - [SurescriptsMessage](docs/SurescriptsMessage.md)\n - [Token](docs/Token.md)\n - [User](docs/User.md)\n - [Version](docs/Version.md)\n - [VirtualPharmacy](docs/VirtualPharmacy.md)\n - [WorkflowRequest](docs/WorkflowRequest.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"opaque_token\"></a>\n### opaque_token\n\n- **Type**: Bearer authentication (opaque)\n\n\n## Author\n\npaul.tindall@rxfoundry.com\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "SwiftyRX API",
"version": "0.0.711",
"project_urls": {
"Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" swiftyrx api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4b5e00b4dd71a977f747cf598145c8982617485fbd62821a7b5d588b31dc69c4",
"md5": "6e9ac01113017febf42288f58e1457e3",
"sha256": "31df1399fa6b4921d4100292ccce0bdc89f53b09e20ebaf227052f232a026ab5"
},
"downloads": -1,
"filename": "rxfoundry_clients_swifty_api-0.0.711-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6e9ac01113017febf42288f58e1457e3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 108412,
"upload_time": "2025-08-30T01:27:46",
"upload_time_iso_8601": "2025-08-30T01:27:46.742278Z",
"url": "https://files.pythonhosted.org/packages/4b/5e/00b4dd71a977f747cf598145c8982617485fbd62821a7b5d588b31dc69c4/rxfoundry_clients_swifty_api-0.0.711-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e9da0473f2cd68f18e4d4c6fad1ff81b7f210f0372e992150f5e71a2b11c078a",
"md5": "28c5b18947d8fd635734995841ec485f",
"sha256": "a941368b7f4033a2183a462264e1d6d9e55809f1d3140f72ff89a21080dc1ea3"
},
"downloads": -1,
"filename": "rxfoundry_clients_swifty_api-0.0.711.tar.gz",
"has_sig": false,
"md5_digest": "28c5b18947d8fd635734995841ec485f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 56116,
"upload_time": "2025-08-30T01:27:47",
"upload_time_iso_8601": "2025-08-30T01:27:47.921959Z",
"url": "https://files.pythonhosted.org/packages/e9/da/0473f2cd68f18e4d4c6fad1ff81b7f210f0372e992150f5e71a2b11c078a/rxfoundry_clients_swifty_api-0.0.711.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-30 01:27:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "rxfoundry.clients.swifty_api"
}
JSON
