HIP Initiated linking

This is applicable when User has shared an ABHA address during registration.

Whenever a new health record is created for a patient, decide which care context this will be a part of.
The HRP must link the care context as soon as the health record is ready to be shared with the user
Linking the care context requires a linking token. This is obtained and saved at the time of registration.
if the HRP does not have a valid linking token, they need to generate linking token via demographic auth.
Whenever a new care context is linked or an existing care context is updated with new health records, a notification is sent to all PHR applications that have subscribed to receive notifications for this ABHA address.

Test Cases

Function: Health Record Creation

Functionality	Test Case	Steps To Be Executed
Mandatory Creation of Health Records (Health_RECORD_CREATION_101)	The system should have a provision to create digital health records	1. Check if digital Health Records are being created in HIP systems (valid for HI types as applicable to the integrating entity). 2. Recommend to have the health record in FHIR format.

Function: HIP Initiated Health Record Linking Using Mobile OTP

(Testcase incorrect for this section)

Functionality	Test Case	Steps To Be Executed
Mandatory Link record via mobile OTP (HIP_INTI_LINK_201)	The system should have provision to link patient’s Health record with ABHA address	1. Enter patient’s ABHA address on the System. 2. OTP receive by the patient.
Mandatory OTP validation (HIP_INTI_LINK_203)	The user shares the OTP with the HIP for validation	1. Share Mobile OTP with HIP System. 2. Validate the OTP. 3. Upon successful validation of OTP linking token is generated.
Mandatory Linking of Health Records (HIP_INTI_LINK_205)	HIP system links the ABHA number / address with the patient records	1. Link Health Records. 2. Through PHR Application check if the linked records can be pulled

Function: HIP Initiated Health Record Linking Using Aadhaar OTP

(Testcase incorrect for this section)

Functionality	Test Case	Steps To Be Executed
Mandatory Link record via aadhaar linked mobile OTP (HIP_INTI_LINK_301)	The system should have provision to link patient’s Health record with ABHA address	1. Enter patient’s ABHA address on the System. 2. OTP receive by the patient.
Mandatory OTP validation (HIP_INTI_LINK_303)	The user shares the OTP with the HIP for validation	1. Share Mobile OTP with HIP System. 2. Validate the OTP. 3. Upon successful validation of OTP linking token is generated.
Mandatory Linking of Health Records (HIP_INTI_LINK_305)	HIP system links the ABHA number / address with the patient records	1. Link Health Records. 2. Through PHR Application check if the linked records can be pulled

Function: HIP Initiated Health Record Linking Using Direct Auth

(Testcase incorrect for this section)

Functionality	Test Case	Steps To Be Executed
Mandatory for the Govt. Integartors Direct Auth mode for Linking of Health Records (HIP_INTI_LINK_401)	The system should have provision to link patient’s Health record with ABHA address	1. Enter patient’s ABHA address on the System. 2. The user logs into their PHR Application receives the request for approval and approves it. 3. Search the request in the Notification tab. 4. Approve the request.(User may approve or reject the request. if the request is rejected process ends there). 5. Upon successful validation of OTP linking token is generated.
Mandatory Linking of Health Records (HIP_INTI_LINK_404)	HIP system links the ABHA Address with the patient records	1. Link Health Records. 2. Through PHR Application check if the linked records can be pulled.

Function: HIP Initiated Health Record Linking Using Demographic Auth

(Testcase needs language modification)

Functionality	Test Case	Steps To Be Executed
Mandatory for the Govt. Integartors Link record via Demographic Auth (HIP_INTI_LINK_501)	The system should have provision to link patient’s Health record with ABHA address.	1. For the verified ABHA Address of the patient in the HIP System. 2. The user provides their demographic details (name, gender, DOB, mobile number). 3. Enter user/patient’s demographic details in the HIP System
Mandatory Validate the demographic details (HIP_INTI_LINK_503)	The HIP validates demographic details of patient	1. Validate Demographic Details ( Provided by the user and fetch by the ABHA address). 2. Upon successful validation of OTP linking token is generated.
Mandatory Linking of Health Records (HIP_INTI_LINK_505)	HIP system links the ABHA Address with the patient records	1. Link Health Records. 2. Through PHR Application check if the linked records can be pulled

API Versions

V0.5 API
- Sequence Diagram for V0.5 API
- API Information Request Response for V0.5
V3 API
- Sequence Diagram for V3 API
- API Information Request Response for V3

Note: V0.5 APIs are currently in production. V3 APIs are currently only available in sandbox

V0.5 API Sequence Diagram

%%{init:{"fontSize": "1.0rem", "sequence":{"showSequenceNumbers":true}}}%% sequenceDiagram title HIP Initiated Linking activate HRP/HIP activate HIE-CM HRP/HIP->>HIE-CM: POST V0.5/links/link/add-contexts HIE-CM-->>HRP/HIP: return deactivate HRP/HIP deactivate HIE-CM activate HRP/HIP activate HIE-CM HIE-CM->>HRP/HIP: (callback_url)V0.5/links/link/on-add-contexts HRP/HIP-->>HIE-CM:return deactivate HRP/HIP deactivate HIE-CM

V0.5 API Information Request Response

1. Care-Context Linking

API to submit care-context to HIE-CM for HIP initiated linking. The API must accompany the “accessToken” (linking token) fetched in the users/auth process or via demographic auth

BASE URLs: https://dev.abdm.gov.in/gateway

2. Call Back API for add-contexts

Callback API for HIP initiated patient linking /link/add-context. If the accessToken is valid for purpose of linking, and specified details provided, HIE-CM will send “acknoweldgement.status” as SUCCESS.

BASE URLs: https://your-hrp-server.com

V3 API Sequence Diagram

%%{init:{"fontSize": "1.0rem", "sequence":{"showSequenceNumbers":true}}}%% sequenceDiagram title HIP Initiated Linking activate HRP/HIP activate HIE-CM HRP/HIP->>HIE-CM : POST/hiecm/api/v3/link/carecontext HIE-CM-->>HRP/HIP: return deactivate HRP/HIP deactivate HIE-CM activate HRP/HIP activate HIE-CM HIE-CM->>HRP/HIP:(callback_url)/v3/hip/link/on-carecontext HRP/HIP-->>HIE-CM :return deactivate HRP/HIP deactivate HIE-CM HIE-CM->>PHR App:(callback_url)/v3/hiu/subscriptions/notify PHR App-->>HIE-CM :s

V3 API Information Request Response

-YAML Not yet released-