rxfoundry.clients.cwp-api
The Pharmacy Prescription Intake API serves as a unified interface for the intake of prescriptions from external clients to CenterWell Traditional and Specialty Pharmacies. The API abstracts the complexities of interacting with multiple pharmacy systems and provides a standardized mechanism for prescription intake. As part of the intake process, prescriptions are evaluated according to routing rules, and new prescriptions are created and fulfilled through either the Traditional or Specialty pharmacy as appropriate.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 2.0
- Package version: 1.0.0
- Generator version: 7.13.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://inspirewellness.sharepoint.com/sites/MailOrderRxIT/Tools/Shared%20Documents/Forms/AllItems.aspx?viewid=3ac2b2b6%2Db738%2D4a59%2Dba2d%2D7e4024e9261d&id=%2Fsites%2FMailOrderRxIT%2FTools%2FShared%20Documents%2FeRx10%2E6
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.cwp_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.cwp_api
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import rxfoundry.clients.cwp_api
from rxfoundry.clients.cwp_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/cw-api
# See configuration.py for a list of all supported configuration parameters.
configuration = rxfoundry.clients.cwp_api.Configuration(
host = "http://localhost/cw-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.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure API key authorization: Apikey
configuration.api_key['Apikey'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'
# Enter a context with an instance of the API client
with rxfoundry.clients.cwp_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rxfoundry.clients.cwp_api.PrescriptionIntakeApi(api_client)
x_src_sys = 'x_src_sys_example' # str | Source system originating the request
x_trace_id = 'x_trace_id_example' # str | Unique correlation identifier (UUID) for tracking requests
prescription_intake_request = rxfoundry.clients.cwp_api.PrescriptionIntakeRequest() # PrescriptionIntakeRequest |
try:
# Accepts prescription intake submissions from external client systems.
api_response = api_instance.v2_rxintake_prescriptions_post(x_src_sys, x_trace_id, prescription_intake_request)
print("The response of PrescriptionIntakeApi->v2_rxintake_prescriptions_post:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling PrescriptionIntakeApi->v2_rxintake_prescriptions_post: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost/cw-api
| Class | Method | HTTP request | Description |
|---|---|---|---|
| PrescriptionIntakeApi | v2_rxintake_prescriptions_post | POST /v2/rxintake/prescriptions | Accepts prescription intake submissions from external client systems. |
| VersionApi | get_version | GET /v2/rxintake/version | Get the api version |
Documentation For Models
- Address
- Allergen
- AlternatePharmacy
- ClientImage
- ClientInfo
- ClientPatientId
- ClinicalStatus
- Conditions
- ContactInfo
- ContactInfoFax
- Diagnosis
- ErxPayload
- ExceptionState
- Identifier
- InsuranceCoverage
- InsuranceCoveragePayor
- InsuranceCoveragePayorGroup
- MedicationDetails
- Model400Error
- Model401Error
- Model403Error
- Model404Error
- Model422Error
- Model500Error
- Model502Error
- Model503Error
- Name
- OtherMeds
- Patient
- PatientContactInfo
- PatientContactInfoFax
- PatientIdentification
- PharmacyIdentification
- Prescriber
- PrescriberIdentification
- Prescription
- PrescriptionIntakeRequest
- ResponseBody
- SendingPharmacy
- StartEndDates
- Telephone
- Version
Documentation For Authorization
Authentication schemes defined for the API:
Apikey
- Type: API key
- API key parameter name: x-apikey
- Location: HTTP header
OAuth2
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes:
- Domain.*.Read: Grants read access
- Domain.*.Write: Grants write access
Author
Release files for rxfoundry.clients.cwp-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)
| File | Size | Uploaded | |
|---|---|---|---|
| rxfoundry_clients_cwp_api-1.16.0.5441.tar.gz | 53.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rxfoundry_clients_cwp_api-1.16.0.5441-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 159.7 kB
Release files / rxfoundry_clients_cwp_api-1.16.0.5441.tar.gz
| Download URL | rxfoundry_clients_cwp_api-1.16.0.5441.tar.gz |
|---|---|
| Size | 53.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d249b66457a3a26edbcb8bd86f2749c8f3ba3e15b850693c6c1fac92cb0bf4fc
|
|
BLAKE2b-256 checksum How to use checksums |
cfdff4ea42a62aac58f9399df1b0f6d467c02532868815b8d82ce11a1b065171
|
| Upload date | |
|
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_cwp_api-1.16.0.5441-py3-none-any.whl
| Download URL | rxfoundry_clients_cwp_api-1.16.0.5441-py3-none-any.whl |
|---|---|
| Size | 106.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7eca6faff8d4a88532cf053b74521e2b0d93789ccaabe2375ed9cc0795a9b884
|
|
BLAKE2b-256 checksum How to use checksums |
4cc497058ff9621fd645b82b002e995da8cbf58dad3d5ac6c2366a8bddf661b2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.2.1 CPython/3.12.3 Linux/6.12.94+
|