Skip to main content

SwiftyRX API

Project description

rxfoundry.clients.swifty-api

API for the SwiftyRX Backend

This Python package is automatically generated by the OpenAPI Generator 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:

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)
    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 POST /swifty/1/async/prescription Create a new prescription that will be processed asynchronously.
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_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 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 GET /swifty/1/async/prescription/{message_id} Check the processing status of a previously submitted prescription
AsyncApi get_async_prescriptions GET /swifty/1/async/prescription Get all prescriptions that have been processed asynchronously
AsyncApi 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 GET /swifty/1/code_types Get all code types
CodeApi get_codes GET /swifty/1/codes Get all codes for a typename
FaxApi get_fax GET /swifty/1/faxes/{fax_uuid} Get a fax by ID
FaxApi get_faxes GET /swifty/1/faxes Get all faxes
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_medications GET /swifty/1/medications Get all medications
PatientApi get_patient GET /swifty/1/patients/{patient_uuid} Get patient by uuid
PatientApi get_patient_pharmacies GET /swifty/1/patients/{patient_uuid}/pharmacies Get pharmacies near a patient
PatientApi get_patients GET /swifty/1/patients Get all 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 create_prescription_change_request POST /swifty/1/prescriptions/{prescription_id}/change_requests Create a new prescription change request
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 a list of prescription change requests
PrescriptionApi get_prescriptions GET /swifty/1/prescriptions Get all prescriptions
PrescriptionApi 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 POST /swifty/1/token Get a delegated token based upon an already authorized token
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

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

opaque_token

  • Type: Bearer authentication (opaque)

Author

paul.tindall@rxfoundry.com

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rxfoundry_clients_swifty_api-0.0.871.tar.gz (65.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rxfoundry_clients_swifty_api-0.0.871-py3-none-any.whl (130.4 kB view details)

Uploaded Python 3

File details

Details for the file rxfoundry_clients_swifty_api-0.0.871.tar.gz.

File metadata

  • Download URL: rxfoundry_clients_swifty_api-0.0.871.tar.gz
  • Upload date:
  • Size: 65.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.11.14 Linux/5.10.0-32-cloud-amd64

File hashes

Hashes for rxfoundry_clients_swifty_api-0.0.871.tar.gz
Algorithm Hash digest
SHA256 44e2ba727fa08458b178079249bed1b7b0c2c152f0217b6ca4c935030a219e6a
MD5 86c7f8d40890d74667148a253c17efee
BLAKE2b-256 fd6da07f689f875192ab7c4982f552295eb722052c024d3317f381ca2360d835

See more details on using hashes here.

File details

Details for the file rxfoundry_clients_swifty_api-0.0.871-py3-none-any.whl.

File metadata

File hashes

Hashes for rxfoundry_clients_swifty_api-0.0.871-py3-none-any.whl
Algorithm Hash digest
SHA256 36cf35e6600e214dbcdb079f42021153c3c77a9344512b3eca2693f36170bb6e
MD5 d1bd9b4ac7c01fa4f303befb05a907f0
BLAKE2b-256 c981f9478344eb818696a69fb8113296e8ddac0ef7d32b7d7b92c4d3d57aafec

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page