# 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)
prescription_data = rxfoundry.clients.swifty_api.PrescriptionData() # PrescriptionData |
try:
# Create a new prescription that will be processed asynchronously.
api_response = api_instance.create_async_prescription(prescription_data)
print("The response of AsyncApi->create_async_prescription:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AsyncApi->create_async_prescription: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to */api*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AsyncApi* | [**create_async_prescription**](/api_client_docs/AsyncApi.html#create-async-prescription) | **POST** /swifty/1/async/prescription | Create a new prescription that will be processed asynchronously.
*AsyncApi* | [**create_patient_activity**](/api_client_docs/AsyncApi.html#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**](/api_client_docs/AsyncApi.html#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**](/api_client_docs/AsyncApi.html#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_async_prescription**](/api_client_docs/AsyncApi.html#get-async-prescription) | **GET** /swifty/1/async/prescription/{message_id} | Check the processing status of a previously submitted prescription
*AsyncApi* | [**get_async_prescriptions**](/api_client_docs/AsyncApi.html#get-async-prescriptions) | **GET** /swifty/1/async/prescription | Get all prescriptions that have been processed asynchronously
*AsyncApi* | [**get_patient_activity**](/api_client_docs/AsyncApi.html#get-patient-activity) | **GET** /swifty/1/async/patient_activity/{message_id} | Check the processing status of a previously submitted patient activity
*CodeApi* | [**get_code_types**](/api_client_docs/CodeApi.html#get-code-types) | **GET** /swifty/1/code_types | Get all code types
*CodeApi* | [**get_codes**](/api_client_docs/CodeApi.html#get-codes) | **GET** /swifty/1/codes | Get all codes for a typename
*FaxApi* | [**get_fax**](/api_client_docs/FaxApi.html#get-fax) | **GET** /swifty/1/faxes/{fax_uuid} | Get a fax by ID
*FaxApi* | [**get_faxes**](/api_client_docs/FaxApi.html#get-faxes) | **GET** /swifty/1/faxes | Get all faxes
*MedicationApi* | [**get_medication**](/api_client_docs/MedicationApi.html#get-medication) | **GET** /swifty/1/medications/{medication_uuid} | Get a medication by UUID
*MedicationApi* | [**get_medication_formularies**](/api_client_docs/MedicationApi.html#get-medication-formularies) | **GET** /swifty/1/medications/{medication_uuid}/formularies | Get a medication's formularies by medication UUID
*MedicationApi* | [**get_medication_instructions**](/api_client_docs/MedicationApi.html#get-medication-instructions) | **GET** /swifty/1/medications/{medication_uuid}/instructions | Get a medication by UUID
*MedicationApi* | [**get_medications**](/api_client_docs/MedicationApi.html#get-medications) | **GET** /swifty/1/medications | Get all medications
*PatientApi* | [**get_patient**](/api_client_docs/PatientApi.html#get-patient) | **GET** /swifty/1/patients/{patient_uuid} | Get patient by uuid
*PatientApi* | [**get_patient_pharmacies**](/api_client_docs/PatientApi.html#get-patient-pharmacies) | **GET** /swifty/1/patients/{patient_uuid}/pharmacies | Get pharmacies near a patient
*PatientApi* | [**get_patients**](/api_client_docs/PatientApi.html#get-patients) | **GET** /swifty/1/patients | Get all patients
*PharmacistApi* | [**get_pharmacist**](/api_client_docs/PharmacistApi.html#get-pharmacist) | **GET** /swifty/1/pharmacists/{pharmacist_id} | Get a pharmacist by UUID or NPI
*PharmacistApi* | [**get_pharmacists**](/api_client_docs/PharmacistApi.html#get-pharmacists) | **GET** /swifty/1/pharmacists | Get all pharmacists
*PharmacyApi* | [**get_pharmacies**](/api_client_docs/PharmacyApi.html#get-pharmacies) | **GET** /swifty/1/pharmacies | Get all pharmacies
*PharmacyApi* | [**get_pharmacy**](/api_client_docs/PharmacyApi.html#get-pharmacy) | **GET** /swifty/1/pharmacies/{pharmacy_id} | Get a pharmacy by UUID or NPI
*PrescriberApi* | [**get_prescriber**](/api_client_docs/PrescriberApi.html#get-prescriber) | **GET** /swifty/1/prescribers/{prescriber_id} | Get a prescriber by UUID or NPI
*PrescriberApi* | [**get_prescribers**](/api_client_docs/PrescriberApi.html#get-prescribers) | **GET** /swifty/1/prescribers | Get all prescribers
*PrescriptionApi* | [**create_pharmacist_verification**](/api_client_docs/PrescriptionApi.html#create-pharmacist-verification) | **POST** /swifty/1/prescriptions/{prescription_id}/pv | Create a new prescription verification setting
*PrescriptionApi* | [**create_prescription_change_request**](/api_client_docs/PrescriptionApi.html#create-prescription-change-request) | **POST** /swifty/1/prescriptions/{prescription_id}/change_requests | Create a new prescription change request
*PrescriptionApi* | [**get_prescription**](/api_client_docs/PrescriptionApi.html#get-prescription) | **GET** /swifty/1/prescriptions/{prescription_id} | Get a prescription by UUID or RxNumber
*PrescriptionApi* | [**get_prescription_change_requests**](/api_client_docs/PrescriptionApi.html#get-prescription-change-requests) | **GET** /swifty/1/prescriptions/{prescription_id}/change_requests | Get a list of prescription change requests
*PrescriptionApi* | [**get_prescriptions**](/api_client_docs/PrescriptionApi.html#get-prescriptions) | **GET** /swifty/1/prescriptions | Get all prescriptions
*PrescriptionApi* | [**update_prescription**](/api_client_docs/PrescriptionApi.html#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**](/api_client_docs/TokenApi.html#get-token-for-token) | **POST** /swifty/1/token | Get a delegated token based upon an already authorized token
*VersionApi* | [**get_api_version**](/api_client_docs/VersionApi.html#get-api-version) | **GET** /swifty/1/version | Get the api version
*VirtualPharmacyApi* | [**get_virtual_pharmacies**](/api_client_docs/VirtualPharmacyApi.html#get-virtual-pharmacies) | **GET** /swifty/1/virtual_pharmacies | Get all virtual pharmacies
*VirtualPharmacyApi* | [**get_virtual_pharmacy**](/api_client_docs/VirtualPharmacyApi.html#get-virtual-pharmacy) | **GET** /swifty/1/virtual_pharmacies/{virtual_pharmacy_uuid} | Get a virtual pharmacy by UUID
## Documentation For Models
- [Address](/api_client_docs/Address.md)
- [AsynchronousResponse](docs/AsynchronousResponse.md)
- [Code](docs/Code.md)
- [CodeQualifierCode](docs/CodeQualifierCode.md)
- [CodeType](docs/CodeType.md)
- [ErrorMessage](docs/ErrorMessage.md)
- [Fax](docs/Fax.md)
- [Formulary](docs/Formulary.md)
- [Insurance](docs/Insurance.md)
- [Medication](docs/Medication.md)
- [MedicationInstruction](docs/MedicationInstruction.md)
- [MedicationProgramPricing](docs/MedicationProgramPricing.md)
- [MedicationVariant](docs/MedicationVariant.md)
- [Patient](docs/Patient.md)
- [PatientActivityMessage](docs/PatientActivityMessage.md)
- [PatientActivityNotification](docs/PatientActivityNotification.md)
- [PatientActivityNotificationActivityData](docs/PatientActivityNotificationActivityData.md)
- [PatientAddressData](docs/PatientAddressData.md)
- [PatientData](docs/PatientData.md)
- [PatientExternalIdentifier](docs/PatientExternalIdentifier.md)
- [PatientInsuranceData](docs/PatientInsuranceData.md)
- [PatientTask](docs/PatientTask.md)
- [PatientTaskStatus](docs/PatientTaskStatus.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)
- [PrescriptionData](docs/PrescriptionData.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.html)
## Documentation For Authorization
Authentication schemes defined for the API:
### opaque_token
- **Type**: Bearer authentication (opaque)
## Author
paul.tindall@rxfoundry.com