atulai-sg / abdm-wrapper Goto Github PK

Project Description

Parent issue: atulai-sg/abdm-sdk#5

Currently, data transfer between an HIU (Health Information User) and HIP (Health Information Provider) involves multiple API interactions.

More details related to data transfer can be found here.

SDK integrated at HRP on both fronts (HIP and HIU) should simplify this data transfer workflow.

Features to be implemented

• APIs receiving health data requests
• Encryption Engine
• Decryption Engine
• APIs to provide health records

Learning Path

Complexity

Medium

Skills required

Java, SpringBoot, NoSQL

Name of mentors

@atulai-sg

Project size

8 weeks

Acceptance Criteria

• Interfaces for end user developers or system integrators should reduce.
• Understanding and integrating with the APIs / SDK should be fairly simple and less complicated.
• All APIs should be backed with detailed documentation.

Milestones

• Understanding the domain
• Understanding the problem statement
• Understanding goals and scopes of this project
• Setup Sandbox environment
• Setting up a local dev environment
• Define API contracts
• Develop APIs
• Comprehensive Testing of the APIs
• Documentation

Project Description

Parent issue: atulai-sg/abdm-sdk#5

A patient needs to provide consent to a facility (HIP) for it to share their health records. NHA's Consent Manager does provide apis which help in managing consents but if we provide mechanisms to store consent on HIP front then the whole process of data transfer along with consents can be simplified.

Features to be implemented

• APIs to fetch and store consents
• Storage layer for consents and mappings
• APIs to provide consents
• Service to audit and govern consents

Learning Path

Complexity

Medium

Skills required

Java, SpringBoot, NoSQL

Name of mentors

@atulai-sg

Project size

8 weeks

Acceptance Criteria

• Interfaces for end user developers or system integrators should reduce.
• Understanding and integrating with the APIs / SDK should be fairly simple and less complicated.
• All APIs should be backed with detailed documentation.

Milestones

• Understanding the domain
• Understanding the problem statement
• Understanding goals and scopes of this project
• Setup Sandbox environment
• Setting up a local dev environment
• Define API contracts
• Develop APIs
• Comprehensive Testing of the APIs
• Documentation

Project Description

Parent issue: atulai-sg/abdm-sdk#5

A patient should be discoverable in ABDM ecosystem using their ABHA number. HIPs (Health Information Providers) then link that ABHA number / id to patient's profile enabling the data transfer if requested. Currently, NHA does provide APIs to support this but they are very complex to understand and implement.

More details regarding existing workflows can be found here.

We need to simplify this process so that it becomes easy for developers from adoption and implementation standpoint.

Features to be implemented

• APIs to simplify discovery workflows
• APIs to simplify linking workflows
• APIs definition and maintenance layer

Learning Path

Complexity

Medium

Skills required

Java, SpringBoot, NoSQL

Name of mentors

@atulai-sg

Project size

8 weeks

Acceptance Criteria

• Interfaces for end user developers or system integrators should reduce.
• Understanding and integrating with the APIs / SDK should be fairly simple and less complicated.
• All APIs should be backed with detailed documentation.

Milestones

• Understanding the domain
• Understanding the problem statement
• Understanding goals and scopes of this project
• Setup Sandbox environment
• Setting up a local dev environment
• Define API contracts
• Develop APIs
• Comprehensive Testing of the APIs
• Documentation

initial commit for discovery and linking workflows - pushing Springboot structure project

Project Description

Parent issue: atulai-sg/abdm-sdk#5

HIUs (Health Information Users) need to pull health records periodically. Any health data published should notify concerned HIU.

A subscription based mechanism should simplify this workflow.
Wrapper should initiate subscription request so that it receives notifications/alerts whenever new information is available for following categories.

• LINK - linking of a new Care-context from HIPs
• DATA - availability against an existing care-context from HIP.

Features to be implemented

• APIs for enabling subscriptions.
• APIs to receive notifications
• APIS to receive health records.

Learning Path

Complexity

Medium

Skills required

Java, SpringBoot, NoSQL

Name of mentors

@atulai-sg

Project size

8 weeks

Acceptance Criteria

• Interfaces for end user developers or system integrators should reduce.
• Understanding and integrating with the APIs / SDK should be fairly simple and less complicated.
• All APIs should be backed with detailed documentation.

Milestones

• Understanding the domain
• Understanding the problem statement
• Understanding goals and scopes of this project
• Setup Sandbox environment
• Setting up a local dev environment
• Define API contracts
• Develop APIs
• Comprehensive Testing of the APIs
• Documentation

Project Description

The Ayushman Bharat Digital Mission (ABDM) aims to develop the backbone necessary to support the integrated digital health infrastructure of the country. It will bridge the existing gap amongst different stakeholders of the Healthcare ecosystem through digital highways.

Following are the components defined by ABDM which are essentially the building blocks for the ecosystem:

• ABHA Number
• Healthcare Professionals Registry (HPR)
• ABHA Mobile App (PHR)
• Health Facility Registry (HFR)
• Unified Health Interface (UHI)

ABDM Architecture:

Key components in the above diagram are:

• Health Information Providers (HIPs)
• Health Information Users (HIUs)
• Repositories (HRPs / Health Repository Providers)
• Consent Managers (CMs)
• Gateway
• Health Lockers
• Facilities (Hospitals / Labs / Clinics)

ABHA milestones

In order to make an application ABDM compliant, it has to go through 3 milestones:
Milestone 1: ABHA Id creation, verification and obtaining link token
Milestone 2: Linking and exporting health data
Milestone 3: Sending a consent request and importing data from other applications in the ecosystem

Current challenges

Currently, developers are facing challenges when building applications around the interfaces provided by NHA:

• Majority of ABDM use cases involve asynchronous API calls, implementation of which is turning out to be a challenge for developers.
• The 2-way Encryption and Decryption steps suggested by ABDM are quite complex. Developers have raised concerns regarding this.
• Developers have often pointed out that the API contract published on their Swagger is not up to date.
• The use-cases are very complex and involve multiple steps which in turn is difficult to implement.

Project Goals

• This project aims to build ABDM Wrapper (SDK) which abstracts HRP complexities for developers. This abstraction can be achieved at both HIP and HIU sides:
• Handles metadata storage such as consent artifacts, schemas, mappings, etc.
• Abstracts out ABDM version upgrades, contract changes, deprecation, etc by giving a constant workflow interface to developers
• Provides capabilities of both async and sync apis. Developers will have the option to opt according to their convenience.
• Handles encryption decryption
• Take care of security auditing and compliance
• Store audit logs for consent and data flows.
• Governance around data retention and policies.

Modules and Features

Discovery and Linking Workflows - Allow discovery of a patient’s managed by HIP in the ABDM network and allow linking of ABHA Id to the patient profile. atulai-sg/abdm-sdk#1

Consent Management - Manages lifecycle of consents granted by a patient to an HIP/HIU atulai-sg/abdm-sdk#2

Data Transfer - Allow consented medical data transfer to the ABDM network. atulai-sg/abdm-sdk#3

Subscription Management - Subscription management for continuously pulling the medical records for a patient from other HIPs. atulai-sg/abdm-sdk#4