ohcnetwork / care_abdm

ABDM plug for care

Care Abdm

Care Abdm is a plugin for care to add voice auto fill support using external services like OpenAI whisper and Google Speech to Text.

Features

• Voice auto fill support for care
• Support for OpenAI whisper and Google Speech to Text

Installation

https://care-be-docs.ohc.network/pluggable-apps/configuration.html

https://github.com/ohcnetwork/care/blob/develop/plug_config.py

To install care abdm, you can add the plugin config in care/plug_config.py as follows:

...

abdm_plug = Plug(
    name="abdm",
    package_name="git+https://github.com/ohcnetwork/care_abdm.git",
    version="@master",
    configs={
        "ABDM_CLIENT_ID": "abdm_client_id",
        "ABDM_CLIENT_SECRET": "abdm_client_secret",
        "ABDM_URL": "",
        "HEALTH_SERVICE_API_URL": "",
        "ABDM_FACILITY_URL": "",
        "HIP_NAME_PREFIX": "",
        "HIP_NAME_SUFFIX": "",
        "ABDM_USERNAME": "",
        "X_CM_ID": "",
        "AUTH_USER_MODEL": "users.User"
    },
)
plugs = [abdm_plug]
...

Configuration

The following configurations variables are available for Care Abdm:

• ABDM_CLIENT_ID: The client id for the ABDM service.
• ABDM_CLIENT_SECRET: The client secret for the ABDM service.
• ABDM_URL: The URL for the ABDM service APIs.
• HEALTH_SERVICE_API_URL: The URL for the health service APIs.
• ABDM_FACILITY_URL: The URL for the ABDM facility APIs.
• HIP_NAME_PREFIX: The prefix for the HIP name. Used to avoid conflicts while registering a facility as ABDM health facility.
• HIP_NAME_SUFFIX: The suffix for the HIP name. Used to avoid conflicts while registering a facility as ABDM health facility.
• ABDM_USERNAME: The internal username for the ABDM service. Intended to track the records created via ABDM.
• X_CM_ID: The X-CM-ID header value for the ABDM service.
• AUTH_USER_MODEL: The user model to use for the ABDM service.

The plugin will try to find the API key from the config first and then from the environment variable.

License

This project is licensed under the terms of the MIT license.

---

This plugin was created with Cookiecutter using the ohcnetwork/care-plugin-cookiecutter.

care_abdm's Issues

Cleanup Health Information Regularly

Clear out health information fetched from ABDM, clear them out as per the recommended norms of the government (10 years).

Implement Scan and Pull

Implement scan and pull functionality which was skipped during ABDM V3 migration.

Ref: https://sandbox.abdm.gov.in/sandbox/v3/new-documentation?doc=Milestone_one

Send notification to patient through ABDM when thier patient records are edited

Send OTP to the Patient while Discovery Flow

Send OTP to the patient while patient-initiated care context linking flow.

Add a prefix for care context id while linking care contexts

Add a prefix like (consultation::consultation_external_id) to careContextId while linking care context, so it is easy to map it back to care models even when the models are changed internally.

This would also be useful when multiple care contexts are added for a single consultation (#2).

Note: Consider managing existing care context linked without any prefixes

Refresh Patient's X-Token Regularly

Refresh the patient's x-token (AbhaNumber.access_token and bhaNumber.refresh_token) at regular intervals, like a day before the refresh token's expiry.

Look into the standard practice regarding this and check ABDM's norms regarding this.

Health Professional Registry Integration

Integrate HPR APIs with CARE users.

Ref: https://sandbox.abdm.gov.in/sandbox/v3/new-documentation?doc=HealthProfessionalRegistry

Track ABDM Transactions

Track all ABDM transactions, this would be used for analytics and dashboard.

Implement Scan and Share

Implement scan and share functionality which was skipped during ABDM V3 migration.

Ref: https://sandboxcms.abdm.gov.in/uploads/Scan_and_share_Document_Updated_1_0_22_Aug_2024_c1b570cbf6.pdf

Create multiple care context for a single consultation in care

Currently, only one care context is created for the whole of consultation, separate this to create multiple care contexts—Ex: 1 for prescriptions of consultation and likewise.