Manage PHR App User’s Profile

Functionality Overview

  • PHR applications need to have a (this) section, where users can view their demographic details and update (edit) their information.

  • The section should also display ABHA QR code as part of the Profile information

  • They should also be able to set/change password from this section.

  • Similarly, they should also have an option to set/change consent pin.

  • The user should also be able to upload a profile photo from this section.

Test Cases

Display Profile Details with status as KYC Verified / Self-Declared

S.NoFunctionalityTest CaseSteps To Be Executed
1Mandatory Showing individual’s profile details in the PHR appIndividual’s profile is displayed in the PHR app with their status such as KYC verified and Self-Declared.Display all profile details filled by the individual, when individual click on Profile after Login. Also display KYC Verified with green tick mark for those profiles where ABHA address is linked with ABHA number. Display Self Delared with exclaimation mark for those profiles where ABHA address is not linked with ABHA number. ABHA number is visible in KYC verified profile and ABHA number is not visible in Self-Declared profile.

Download ABHA address card in the PDF format

S.NoFunctionalityTest CaseSteps To Be Executed
1Mandatory Download ABHA address cardPost clicking on “QR Code” icon, an individual can scan QR Code, share ABHA address card and download ABHA address cardFollowing fields will be displayed in the ABHA address card: Profile Photo, Full Name, ABHA number - It will be displayed if, 14-digit Health ID number is linked to the ABHA address. ABHA number is displayed as XX-XXXX-XXXX-3421 (Hide starting 12 digits of ABHA number), ABHA address - It will be displayed as XXXXam@abdm (Hide starting alphabets of ABHA address), QR Code, Date of Birth, Gender, Mobile Number - It will be displayed as XXXXXX2278 (Hide starting 6 digits of ABHA number)

Consent Pin

S.NoFunctionalityTest CaseSteps To Be Executed
1Mandatory Set Consent PinValidate OTP received on registered mobile numberCheck that OTP is received on registered mobile number.
2Mandatory Set Consent PinValidate OTP received on registered mobile numberResend OTP option is provided,if OTP is not received on mobile in 60 seconds
3Mandatory Set Consent PinEnter 4 digit consent pinCheck that only 4 digit consent pin is accepted
4Mandatory Set Consent PinConfirm Consent PinRe-enter the consent pin to confirm the consent pin. Check that confirmation of consent pin is taken by re-entering it.
5Mandatory Set Consent PinDisplay message, so that an individual knows that consent pin is set successfullyDisplay message “Congratulations! Your consent pin is successfully updated”. Below this message “Go Back To Home Screen” tab is provided to navigate the individual to home screen.
6Mandatory Reset Consent PinEnter 4 digit old consent pinCheck if old consent pin entered is correct
7Mandatory Reset Consent PinEnter 4 digit new consent pinCheck that only 4 digit consent pin are accepted
8Mandatory Reset Consent PinConfirm new consent pinRe-enter the consent pin to confirm the consent pin. Check that confirmation of consent pin is taken by re-entering it.
9Mandatory Reset Consent PinDisplay message, so that an individual knows that consent pin is updatedDisplay message Congratulations! Your new consent pin is successfully updated. Below this message “Go Back To Home Screen tab is provided to navigate the individual to home screen.
10Mandatory Forgot Consent PinEnter OTPCheck that OTP is received on registered mobile number.
11Mandatory Forgot Consent PinResend OTP, if OTP is not received in 60 secondsCheck that resend OTP option is provided, if OTP is not received on mobile device
12Mandatory Forgot Consent PinEnter 4 digit new consent pin4 digit consent pin is only accepted
13Mandatory Forgot Consent PinConfirm new consent pinRe-enter the consent pin to confirm the consent pin. Check that confirmation of consent pin is taken by re-entering it.
14Mandatory Forgot Consent PinDisplay message, so that an individual knows that consent pin is updatedDisplay message “Congratulations! Your new consent pin is successfully updated”. Below this message “Go Back To Home Screen” tab is provided to navigate the individual to home screen.

Edit Profile

S.NoFunctionalityTest CaseSteps To Be Executed
1Mandatory Edit profile for KYC verified profilesUpdate mobile numberMobile OTP is received on updated mobile number. Post mobile OTP validation, mobile no is updated.
2Mandatory Edit profile for KYC verified profilesUpdate email IDE-mail OTP is received on updated e-mail ID. Post e-mail OTP validation, e-mail ID is updated.
3Mandatory Edit profile for KYC verified profilesUpdate addressAll fields of address such as address line 1, district, state and pin-code can be updated.
4Mandatory Edit profile for Self-Declared profileUpdate PhotoPhoto can be edited by an individul taking the picture from mobile camera / upload photo from gallery of the device
5Mandatory Edit profile for Self-Declared profileUpdate Full NameUpdate First Name, Middle name and Last Name
6Mandatory Edit profile for Self-Declared profileUpdate GenderUpdate Gender
7Mandatory Edit profile for Self-Declared profileUpdate DoBUpdate Day, Month and Year
8Mandatory Edit profile for Self-Declared profileUpdate Mobile NoMobile OTP is received on updated mobile number. Post mobile OTP validation, mobile number is updated.
9Mandatory Edit profile for Self-Declared profileUpdate Email IDE-mail OTP is received on updated e-mail ID. Post e-mail OTP validation, e-mail ID is updated.
10Mandatory Edit profile for Self-Declared profileUpdate AddressAll fields of address such as address line 1, district, state and pin-code can be updated.

API Sequence Diagram

%%{init:{"fontSize": "1.0rem", "sequence":{"showSequenceNumbers":true}}}%% sequenceDiagram title Manager User Profiles with PHR App note over PHR App,HIE-CM: Get User Profile PHR App->>HIE-CM:GET /v1/apps/profile/me note over PHR App,HIE-CM: Update Profile PHR App->>HIE-CM:POST v1/apps/profile/update note over PHR App,HIE-CM: Reset Password PHR App->>HIE-CM:/v1/apps/patients/profile/reset-password note over PHR App,HIE-CM: Get patient QR Code PHR App->>HIE-CM:GET /v1/apps/patients/qr-code note over PHR App,HIE-CM: Create Consent Pin PHR App->>HIE-CM:POST /patients/pin note over PHR App,HIE-CM: Reset Consent Pin PHR App->>HIE-CM:POST /patients/verify-pin PHR App->>HIE-CM:POST /patients/change-pin note over PHR App,HIE-CM: Forgot Consent Pin PHR App->>HIE-CM:POST /patients/forgot-pin/generate-otp PHR App->>HIE-CM:POST /patients/forgot-pin/validate-otp PHR App->>HIE-CM:POST /patients/reset-pin

API Information Request Response

Utilities

  • For encrypting the mobileNumber/AadharNumber/otp refer the link

    • To get public key for encrypting refer the link
  • For converting an image into Base64 string refer the link

Profile Collection API

1. Get User Details

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

2. Update User Profile Details

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

3. Reset Password

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

4. Get Patient’s QR Code

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

5. Create Transaction Pin

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

6. Verify Pin

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

Note:

scope (in request body):

  • consentrequest.approve for Grant Consent
  • consent.revoke for Revoke Consent
  • profile.changepin for Change PIN
  • consent.autoapprove for Autoapprove all consents for HIU

7. Change Pin

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

8. Generate OTP For Forgot Pin

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

9. Validate OTP For Forgot Pin

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

10. Reset Pin

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