# abha
It is important to standardize the process of identification of an individual across healthcare providers, to ensure that the created medical records are issued to the right individual or accessed by a Health Information User through appropriate consent. In order to issue an ABHA Number to an individual, one only needs basic demographic details like Name, Year of Birth, Gender. In addition, citizens should be able to update contact information easily. The ABHA Number will be used for the purposes of uniquely identifying persons and authenticating them. An ABHA Address will be used for threading their health records (only with the informed consent of the patient) across multiple systems and stakeholders.
Notes:
1. In case you want to consume the ABHA APIs and use creation on your own interface, use authentication methods as OTP only.
2. In order to have access to ABHA APIs, your clientId must have hid role in gateway. So if you want access to these APIs then please request it in your ABDM on-boarding request.
3. In order to have access to Integrated Programs ABHA APIs, your clientId must have integrated_program role in gateway. So if you want access to these APIs then please request it in your ABDM on-boarding request. Also you will need to share integrated program benefit name to be used in this case.
4. When calling APIs, please ensure that Authorization header must have format as Bearer {Token_Value}. Please note that prefix Bearer is followed by space before the token value.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: v3
- Package version: 1.0.0
- Generator version: 7.5.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## 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/Technoculture/ABDM-ABHA-SDK/tree/dev
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/Technoculture/ABDM-ABHA-SDK/tree/dev`)
Then import the package:
```python
import abha
```
### 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 abha
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import abha
from abha.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://abhasbx.abdm.gov.in/abha/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = abha.Configuration(
host = "https://abhasbx.abdm.gov.in/abha/api/v3"
)
# Enter a context with an instance of the API client
with abha.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = abha.ABHAEnrollmentApi(api_client)
request_id = 'request_id_example' # str |
timestamp = 'timestamp_example' # str |
body = 'body_example' # str | (optional)
try:
# AUTH - OF AADHAAR OTP FOR PARENT VERIFICATION
api_response = api_instance.api_v3_enrollment_auth_by_aadhaar_post(request_id, timestamp, body=body)
print("The response of ABHAEnrollmentApi->api_v3_enrollment_auth_by_aadhaar_post:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ABHAEnrollmentApi->api_v3_enrollment_auth_by_aadhaar_post: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://abhasbx.abdm.gov.in/abha/api/v3*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ABHAEnrollmentApi* | [**api_v3_enrollment_auth_by_aadhaar_post**](docs/ABHAEnrollmentApi.md#api_v3_enrollment_auth_by_aadhaar_post) | **POST** /api/v3/enrollment/auth/byAadhaar | AUTH - OF AADHAAR OTP FOR PARENT VERIFICATION
*ABHAEnrollmentApi* | [**api_v3_enrollment_auth_by_abdm_post**](docs/ABHAEnrollmentApi.md#api_v3_enrollment_auth_by_abdm_post) | **POST** /api/v3/enrollment/auth/byAbdm | VERIFY - EMAIL, MOBILE UPDATE
*ABHAEnrollmentApi* | [**api_v3_enrollment_enrol_by_aadhaar_post**](docs/ABHAEnrollmentApi.md#api_v3_enrollment_enrol_by_aadhaar_post) | **POST** /api/v3/enrollment/enrol/byAadhaar | ENROL - BY AADHAAR VERIFICATION
*ABHAEnrollmentApi* | [**api_v3_enrollment_enrol_by_document_post**](docs/ABHAEnrollmentApi.md#api_v3_enrollment_enrol_by_document_post) | **POST** /api/v3/enrollment/enrol/byDocument | ENROL - BY DOCUMENT
*ABHAEnrollmentApi* | [**api_v3_enrollment_enrol_suggestion_get**](docs/ABHAEnrollmentApi.md#api_v3_enrollment_enrol_suggestion_get) | **GET** /api/v3/enrollment/enrol/suggestion | SUGESSTION
*ABHAEnrollmentApi* | [**api_v3_enrollment_request_otp_post**](docs/ABHAEnrollmentApi.md#api_v3_enrollment_request_otp_post) | **POST** /api/v3/enrollment/request/otp | REQUEST - OTP FOR ENROLLMENT, UPDATE MOBILE and UPDATE EMAIL
## Documentation For Models
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Endpoints do not require authorization.
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "abha",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, ABHA Enrollment & Profile Management API V3",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/9a/2b/9f05355a357c9a48e0beb3ce7d80d2c5e3d4b73f350034c2cb349042a5bd/abha-1.0.0.tar.gz",
"platform": null,
"description": "# abha\nIt is important to standardize the process of identification of an individual across healthcare providers, to ensure that the created medical records are issued to the right individual or accessed by a Health Information User through appropriate consent. In order to issue an ABHA Number to an individual, one only needs basic demographic details like Name, Year of Birth, Gender. In addition, citizens should be able to update contact information easily. The ABHA Number will be used for the purposes of uniquely identifying persons and authenticating them. An ABHA Address will be used for threading their health records (only with the informed consent of the patient) across multiple systems and stakeholders.\n \nNotes:\n 1. In case you want to consume the ABHA APIs and use creation on your own interface, use authentication methods as OTP only.\n 2. In order to have access to ABHA APIs, your clientId must have hid role in gateway. So if you want access to these APIs then please request it in your ABDM on-boarding request.\n 3. In order to have access to Integrated Programs ABHA APIs, your clientId must have integrated_program role in gateway. So if you want access to these APIs then please request it in your ABDM on-boarding request. Also you will need to share integrated program benefit name to be used in this case.\n 4. When calling APIs, please ensure that Authorization header must have format as Bearer {Token_Value}. Please note that prefix Bearer is followed by space before the token value.\n \n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: v3\n- Package version: 1.0.0\n- Generator version: 7.5.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\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/Technoculture/ABDM-ABHA-SDK/tree/dev\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/Technoculture/ABDM-ABHA-SDK/tree/dev`)\n\nThen import the package:\n```python\nimport abha\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 abha\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 abha\nfrom abha.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://abhasbx.abdm.gov.in/abha/api/v3\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = abha.Configuration(\n host = \"https://abhasbx.abdm.gov.in/abha/api/v3\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith abha.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = abha.ABHAEnrollmentApi(api_client)\n request_id = 'request_id_example' # str | \n timestamp = 'timestamp_example' # str | \n body = 'body_example' # str | (optional)\n\n try:\n # AUTH - OF AADHAAR OTP FOR PARENT VERIFICATION\n api_response = api_instance.api_v3_enrollment_auth_by_aadhaar_post(request_id, timestamp, body=body)\n print(\"The response of ABHAEnrollmentApi->api_v3_enrollment_auth_by_aadhaar_post:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling ABHAEnrollmentApi->api_v3_enrollment_auth_by_aadhaar_post: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://abhasbx.abdm.gov.in/abha/api/v3*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ABHAEnrollmentApi* | [**api_v3_enrollment_auth_by_aadhaar_post**](docs/ABHAEnrollmentApi.md#api_v3_enrollment_auth_by_aadhaar_post) | **POST** /api/v3/enrollment/auth/byAadhaar | AUTH - OF AADHAAR OTP FOR PARENT VERIFICATION\n*ABHAEnrollmentApi* | [**api_v3_enrollment_auth_by_abdm_post**](docs/ABHAEnrollmentApi.md#api_v3_enrollment_auth_by_abdm_post) | **POST** /api/v3/enrollment/auth/byAbdm | VERIFY - EMAIL, MOBILE UPDATE\n*ABHAEnrollmentApi* | [**api_v3_enrollment_enrol_by_aadhaar_post**](docs/ABHAEnrollmentApi.md#api_v3_enrollment_enrol_by_aadhaar_post) | **POST** /api/v3/enrollment/enrol/byAadhaar | ENROL - BY AADHAAR VERIFICATION\n*ABHAEnrollmentApi* | [**api_v3_enrollment_enrol_by_document_post**](docs/ABHAEnrollmentApi.md#api_v3_enrollment_enrol_by_document_post) | **POST** /api/v3/enrollment/enrol/byDocument | ENROL - BY DOCUMENT\n*ABHAEnrollmentApi* | [**api_v3_enrollment_enrol_suggestion_get**](docs/ABHAEnrollmentApi.md#api_v3_enrollment_enrol_suggestion_get) | **GET** /api/v3/enrollment/enrol/suggestion | SUGESSTION\n*ABHAEnrollmentApi* | [**api_v3_enrollment_request_otp_post**](docs/ABHAEnrollmentApi.md#api_v3_enrollment_request_otp_post) | **POST** /api/v3/enrollment/request/otp | REQUEST - OTP FOR ENROLLMENT, UPDATE MOBILE and UPDATE EMAIL\n\n\n## Documentation For Models\n\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\nEndpoints do not require authorization.\n\n\n## Author\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "ABHA Enrollment & Profile Management API V3",
"version": "1.0.0",
"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",
" abha enrollment & profile management api v3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1e7a2f7a5b6d94a809e2aeb9c82b05f1d470e372f86aa610e55e61175ab42f86",
"md5": "ece8bd12ef7917eebc8cae4b3315c30a",
"sha256": "607e8af45e1b7aba3431b7a7ad16d00c93fa595e914a4554c96f1b9e2f9aabc4"
},
"downloads": -1,
"filename": "abha-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ece8bd12ef7917eebc8cae4b3315c30a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 27309,
"upload_time": "2024-04-26T10:22:41",
"upload_time_iso_8601": "2024-04-26T10:22:41.175666Z",
"url": "https://files.pythonhosted.org/packages/1e/7a/2f7a5b6d94a809e2aeb9c82b05f1d470e372f86aa610e55e61175ab42f86/abha-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9a2b9f05355a357c9a48e0beb3ce7d80d2c5e3d4b73f350034c2cb349042a5bd",
"md5": "0f1c8212d25527f74cb6d4578aae7482",
"sha256": "3d161ae6d2c3ae86c551f68302583e91d4b245df759d9134e58afdd4e17e1fd4"
},
"downloads": -1,
"filename": "abha-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "0f1c8212d25527f74cb6d4578aae7482",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 21538,
"upload_time": "2024-04-26T10:22:43",
"upload_time_iso_8601": "2024-04-26T10:22:43.416105Z",
"url": "https://files.pythonhosted.org/packages/9a/2b/9f05355a357c9a48e0beb3ce7d80d2c5e3d4b73f350034c2cb349042a5bd/abha-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 10:22:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "abha"
}
JSON
