diff --git a/writable/tmp_abha_qr_docx/[Content_Types].xml b/writable/tmp_abha_qr_docx/[Content_Types].xml new file mode 100644 index 0000000..405dcae --- /dev/null +++ b/writable/tmp_abha_qr_docx/[Content_Types].xml @@ -0,0 +1,2 @@ + + diff --git a/writable/tmp_abha_qr_docx/_rels/.rels b/writable/tmp_abha_qr_docx/_rels/.rels new file mode 100644 index 0000000..90848dc --- /dev/null +++ b/writable/tmp_abha_qr_docx/_rels/.rels @@ -0,0 +1,2 @@ + + diff --git a/writable/tmp_abha_qr_docx/docProps/app.xml b/writable/tmp_abha_qr_docx/docProps/app.xml new file mode 100644 index 0000000..6f8e1a9 --- /dev/null +++ b/writable/tmp_abha_qr_docx/docProps/app.xml @@ -0,0 +1,2 @@ + +0Microsoft Office Word0falsefalsefalsefalse12.0000 diff --git a/writable/tmp_abha_qr_docx/docProps/core.xml b/writable/tmp_abha_qr_docx/docProps/core.xml new file mode 100644 index 0000000..fed4f57 --- /dev/null +++ b/writable/tmp_abha_qr_docx/docProps/core.xml @@ -0,0 +1,2 @@ + +Atishay Prasad NHA122026-05-08T17:13:27Z2026-05-08T17:13:27Z diff --git a/writable/tmp_abha_qr_docx/docProps/custom.xml b/writable/tmp_abha_qr_docx/docProps/custom.xml new file mode 100644 index 0000000..441785b --- /dev/null +++ b/writable/tmp_abha_qr_docx/docProps/custom.xml @@ -0,0 +1,2 @@ + +2025-08-06T00:00:00ZMicrosoft® Word for Microsoft 3652026-05-08T00:00:00ZMicrosoft® Word for Microsoft 365 diff --git a/writable/tmp_abha_qr_docx/word/_rels/document.xml.rels b/writable/tmp_abha_qr_docx/word/_rels/document.xml.rels new file mode 100644 index 0000000..71e8091 --- /dev/null +++ b/writable/tmp_abha_qr_docx/word/_rels/document.xml.rels @@ -0,0 +1,2 @@ + + diff --git a/writable/tmp_abha_qr_docx/word/document.xml b/writable/tmp_abha_qr_docx/word/document.xml new file mode 100644 index 0000000..a454759 --- /dev/null +++ b/writable/tmp_abha_qr_docx/word/document.xml @@ -0,0 +1,2 @@ + +API SpecificationFind ABHA using mobile (Search ABHA): To initiate the search Use this APIhttps://abhasbx.abdm.gov.in/abha/api/v3/profile/account/abha/search with scope as search-abha and mobile number in encrypted form.Encryption Request: Please use public key which can be retrieved from cert API for mobile encryptionResponse:914400128965Login via Face-Auth Using QR Code:Call the Verify by Face Auth API using the txnId obtained from the Search API response. Note that the transaction ID is valid for 10 minutes.1371600-2390200Response:{"txnId": "d059e607-564b-4202-8bd6-6e45a7d9a477","message": "Transaction Id generated Successfully"}Use the following approach: - First approach: QR code scanUse the transaction ID to generate QR code using any QR generator tool or customized code. Open ABHA app and scan this QR code on ABHA App to start and complete the face capture process. https://phrsbx.abdm.gov.in/face-auth?txnId=10bc499f-42c1-48eb-8c02- 6d00a9fd4b42Sample QR-Code:143133472498Second Approach: Intent base sharingThis approach is applicable if you want to integrate your mobile application with ABHA App. In this case the above url will be passed directly from your application and it will directly open the ABHA app Face capture Event.For this ABHA package ID will be shared so that intent could be invoked.Next, scan this QR code using the ABHA App by tapping the QR icon located at the top-left corner of the login and registration screen.Proceed to complete the face scan process in the ABHA App. The app will then submit the captured PID to the ABHA service.Next, call the API below to retrieve the PID submitted from the ABHA App in the previous step: https://abhasbx.abdm.gov.in/abha/api/v3/enrollment/enrol/capturePIDYou can poll the capturePID API in every 5 - 10 seconds interval to check the status of face capture process.1371600405358Request body contains:Status: PENDINGIf the status in the response is 'PENDING,' it indicates that the transaction is not yet verified from ABHA App.Status: VERIFIEDIf the response status is 'VERIFIED,' it means the transaction is verified, but face authentication has not yet been completed.Status: FAILEDIf the response status is 'FAILED,' it means that the face authentication process using the RD service from the ABHA app was unsuccessful due to technical issues.Status: COMPLETEIf the response status is 'COMPLETE,' it means the face authentication process using the RD service from the ABHA app was successfully completed, and the user has been authenticated.1371600661416Call the login verify face Auth API to get the details of the user:- Request Body:-This feature was recently made live on the ABHA portal. You can refer to the SBX portal for one possible implementation approach. Below is the workflow from the portal for your reference.Home – Click on Find ABHA using mobile number link914400129428Find ABHA - Provide mobile number of ABHA holder, captcha answer and click on Next914400100064Select ABHA – Select 'ABHA' to log in, then choose the 'Face Authentication' option from the dropdown.QR Code Screen – Click the 'Generate QR Code' button to obtain the transaction ID—this action triggers the Request OTP API. Please review the 'Prerequisites' and 'Steps to Follow' sections for the necessary actions to be performed on a mobile or tablet device.914400100500QR Code Generated – A QR code is generated, and the app also supports uploading images from the gallery. Additionally, a download option is available on the portal for this purpose.Polling for PID Capture Event914400128919Face Captured and Submitted by App – Once face captured and PID is submitted by App, capture PID API will respond with status as COMPLETE along with PID data.91440099370Successful Login914400129300 \ No newline at end of file diff --git a/writable/tmp_abha_qr_docx/word/fontTable.xml b/writable/tmp_abha_qr_docx/word/fontTable.xml new file mode 100644 index 0000000..63d3159 --- /dev/null +++ b/writable/tmp_abha_qr_docx/word/fontTable.xml @@ -0,0 +1,2 @@ + + diff --git a/writable/tmp_abha_qr_docx/word/media/image1.jpeg b/writable/tmp_abha_qr_docx/word/media/image1.jpeg new file mode 100644 index 0000000..5c2144e Binary files /dev/null and b/writable/tmp_abha_qr_docx/word/media/image1.jpeg differ diff --git a/writable/tmp_abha_qr_docx/word/media/image10.png b/writable/tmp_abha_qr_docx/word/media/image10.png new file mode 100644 index 0000000..aa05f98 Binary files /dev/null and b/writable/tmp_abha_qr_docx/word/media/image10.png differ diff --git a/writable/tmp_abha_qr_docx/word/media/image11.jpeg b/writable/tmp_abha_qr_docx/word/media/image11.jpeg new file mode 100644 index 0000000..d49b6a5 Binary files /dev/null and b/writable/tmp_abha_qr_docx/word/media/image11.jpeg differ diff --git a/writable/tmp_abha_qr_docx/word/media/image12.jpeg b/writable/tmp_abha_qr_docx/word/media/image12.jpeg new file mode 100644 index 0000000..3a8951d Binary files /dev/null and b/writable/tmp_abha_qr_docx/word/media/image12.jpeg differ diff --git a/writable/tmp_abha_qr_docx/word/media/image13.jpeg b/writable/tmp_abha_qr_docx/word/media/image13.jpeg new file mode 100644 index 0000000..6a21a59 Binary files /dev/null and b/writable/tmp_abha_qr_docx/word/media/image13.jpeg differ diff --git a/writable/tmp_abha_qr_docx/word/media/image14.jpeg b/writable/tmp_abha_qr_docx/word/media/image14.jpeg new file mode 100644 index 0000000..a9105a8 Binary files /dev/null and b/writable/tmp_abha_qr_docx/word/media/image14.jpeg differ diff --git a/writable/tmp_abha_qr_docx/word/media/image15.jpeg b/writable/tmp_abha_qr_docx/word/media/image15.jpeg new file mode 100644 index 0000000..261ebf5 Binary files /dev/null and b/writable/tmp_abha_qr_docx/word/media/image15.jpeg differ diff --git a/writable/tmp_abha_qr_docx/word/media/image16.jpeg b/writable/tmp_abha_qr_docx/word/media/image16.jpeg new file mode 100644 index 0000000..37a7f03 Binary files /dev/null and b/writable/tmp_abha_qr_docx/word/media/image16.jpeg differ diff --git a/writable/tmp_abha_qr_docx/word/media/image2.jpeg b/writable/tmp_abha_qr_docx/word/media/image2.jpeg new file mode 100644 index 0000000..4517216 Binary files /dev/null and b/writable/tmp_abha_qr_docx/word/media/image2.jpeg differ diff --git a/writable/tmp_abha_qr_docx/word/media/image3.png b/writable/tmp_abha_qr_docx/word/media/image3.png new file mode 100644 index 0000000..30f676d Binary files /dev/null and b/writable/tmp_abha_qr_docx/word/media/image3.png differ diff --git a/writable/tmp_abha_qr_docx/word/media/image4.jpeg b/writable/tmp_abha_qr_docx/word/media/image4.jpeg new file mode 100644 index 0000000..b404067 Binary files /dev/null and b/writable/tmp_abha_qr_docx/word/media/image4.jpeg differ diff --git a/writable/tmp_abha_qr_docx/word/media/image5.jpeg b/writable/tmp_abha_qr_docx/word/media/image5.jpeg new file mode 100644 index 0000000..d3b09a3 Binary files /dev/null and b/writable/tmp_abha_qr_docx/word/media/image5.jpeg differ diff --git a/writable/tmp_abha_qr_docx/word/media/image6.jpeg b/writable/tmp_abha_qr_docx/word/media/image6.jpeg new file mode 100644 index 0000000..f68903c Binary files /dev/null and b/writable/tmp_abha_qr_docx/word/media/image6.jpeg differ diff --git a/writable/tmp_abha_qr_docx/word/media/image7.jpeg b/writable/tmp_abha_qr_docx/word/media/image7.jpeg new file mode 100644 index 0000000..44d3489 Binary files /dev/null and b/writable/tmp_abha_qr_docx/word/media/image7.jpeg differ diff --git a/writable/tmp_abha_qr_docx/word/media/image8.jpeg b/writable/tmp_abha_qr_docx/word/media/image8.jpeg new file mode 100644 index 0000000..31b2d5b Binary files /dev/null and b/writable/tmp_abha_qr_docx/word/media/image8.jpeg differ diff --git a/writable/tmp_abha_qr_docx/word/media/image9.jpeg b/writable/tmp_abha_qr_docx/word/media/image9.jpeg new file mode 100644 index 0000000..5942d06 Binary files /dev/null and b/writable/tmp_abha_qr_docx/word/media/image9.jpeg differ diff --git a/writable/tmp_abha_qr_docx/word/numbering.xml b/writable/tmp_abha_qr_docx/word/numbering.xml new file mode 100644 index 0000000..ded1cbc --- /dev/null +++ b/writable/tmp_abha_qr_docx/word/numbering.xml @@ -0,0 +1,2 @@ + + diff --git a/writable/tmp_abha_qr_docx/word/settings.xml b/writable/tmp_abha_qr_docx/word/settings.xml new file mode 100644 index 0000000..13d7d8e --- /dev/null +++ b/writable/tmp_abha_qr_docx/word/settings.xml @@ -0,0 +1,2 @@ + + diff --git a/writable/tmp_abha_qr_docx/word/styles.xml b/writable/tmp_abha_qr_docx/word/styles.xml new file mode 100644 index 0000000..f84ffa9 --- /dev/null +++ b/writable/tmp_abha_qr_docx/word/styles.xml @@ -0,0 +1,2 @@ + + diff --git a/writable/tmp_abha_qr_docx/word/theme/theme1.xml b/writable/tmp_abha_qr_docx/word/theme/theme1.xml new file mode 100644 index 0000000..f0d7a44 --- /dev/null +++ b/writable/tmp_abha_qr_docx/word/theme/theme1.xml @@ -0,0 +1,281 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/writable/tmp_m1_xml/[Content_Types].xml b/writable/tmp_m1_xml/[Content_Types].xml new file mode 100644 index 0000000..1f68abf --- /dev/null +++ b/writable/tmp_m1_xml/[Content_Types].xml @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/writable/tmp_m1_xml/_rels/.rels b/writable/tmp_m1_xml/_rels/.rels new file mode 100644 index 0000000..b56d8ce --- /dev/null +++ b/writable/tmp_m1_xml/_rels/.rels @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/writable/tmp_m1_xml/customXml/_rels/item1.xml.rels b/writable/tmp_m1_xml/customXml/_rels/item1.xml.rels new file mode 100644 index 0000000..b4bc8d6 --- /dev/null +++ b/writable/tmp_m1_xml/customXml/_rels/item1.xml.rels @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/writable/tmp_m1_xml/customXml/_rels/item2.xml.rels b/writable/tmp_m1_xml/customXml/_rels/item2.xml.rels new file mode 100644 index 0000000..49b7c94 --- /dev/null +++ b/writable/tmp_m1_xml/customXml/_rels/item2.xml.rels @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/writable/tmp_m1_xml/customXml/_rels/item3.xml.rels b/writable/tmp_m1_xml/customXml/_rels/item3.xml.rels new file mode 100644 index 0000000..0bdc1ef --- /dev/null +++ b/writable/tmp_m1_xml/customXml/_rels/item3.xml.rels @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/writable/tmp_m1_xml/customXml/item1.xml b/writable/tmp_m1_xml/customXml/item1.xml new file mode 100644 index 0000000..014fe64 --- /dev/null +++ b/writable/tmp_m1_xml/customXml/item1.xml @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/writable/tmp_m1_xml/customXml/item2.xml b/writable/tmp_m1_xml/customXml/item2.xml new file mode 100644 index 0000000..b1a6c9a --- /dev/null +++ b/writable/tmp_m1_xml/customXml/item2.xml @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This value indicates the number of saves or revisions. The application is responsible for updating this value after each revision. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/writable/tmp_m1_xml/customXml/item3.xml b/writable/tmp_m1_xml/customXml/item3.xml new file mode 100644 index 0000000..607faca --- /dev/null +++ b/writable/tmp_m1_xml/customXml/item3.xml @@ -0,0 +1 @@ +DocumentLibraryFormDocumentLibraryFormDocumentLibraryForm \ No newline at end of file diff --git a/writable/tmp_m1_xml/customXml/itemProps1.xml b/writable/tmp_m1_xml/customXml/itemProps1.xml new file mode 100644 index 0000000..bfc6b22 --- /dev/null +++ b/writable/tmp_m1_xml/customXml/itemProps1.xml @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/writable/tmp_m1_xml/customXml/itemProps2.xml b/writable/tmp_m1_xml/customXml/itemProps2.xml new file mode 100644 index 0000000..88cefe6 --- /dev/null +++ b/writable/tmp_m1_xml/customXml/itemProps2.xml @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/writable/tmp_m1_xml/customXml/itemProps3.xml b/writable/tmp_m1_xml/customXml/itemProps3.xml new file mode 100644 index 0000000..b2db5bc --- /dev/null +++ b/writable/tmp_m1_xml/customXml/itemProps3.xml @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/writable/tmp_m1_xml/docProps/app.xml b/writable/tmp_m1_xml/docProps/app.xml new file mode 100644 index 0000000..f0d386d --- /dev/null +++ b/writable/tmp_m1_xml/docProps/app.xml @@ -0,0 +1,2 @@ + +Microsoft Excel0falseWorksheets1ABHA CREATION AND VERIFICATIONfalsefalsefalse16.0300 \ No newline at end of file diff --git a/writable/tmp_m1_xml/docProps/core.xml b/writable/tmp_m1_xml/docProps/core.xml new file mode 100644 index 0000000..2087540 --- /dev/null +++ b/writable/tmp_m1_xml/docProps/core.xml @@ -0,0 +1,2 @@ + +Jha, MeenakshiPriyanka Varude2022-02-05T14:25:08Z2024-08-14T08:54:27Z \ No newline at end of file diff --git a/writable/tmp_m1_xml/docProps/custom.xml b/writable/tmp_m1_xml/docProps/custom.xml new file mode 100644 index 0000000..d309639 --- /dev/null +++ b/writable/tmp_m1_xml/docProps/custom.xml @@ -0,0 +1,2 @@ + +0x010100BE669522E3A6BB4D8ABDFF9957EC5C19 \ No newline at end of file diff --git a/writable/tmp_m1_xml/xl/_rels/workbook.xml.rels b/writable/tmp_m1_xml/xl/_rels/workbook.xml.rels new file mode 100644 index 0000000..5dcfc88 --- /dev/null +++ b/writable/tmp_m1_xml/xl/_rels/workbook.xml.rels @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/writable/tmp_m1_xml/xl/drawings/_rels/drawing1.xml.rels b/writable/tmp_m1_xml/xl/drawings/_rels/drawing1.xml.rels new file mode 100644 index 0000000..69e2d72 --- /dev/null +++ b/writable/tmp_m1_xml/xl/drawings/_rels/drawing1.xml.rels @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/writable/tmp_m1_xml/xl/drawings/drawing1.xml b/writable/tmp_m1_xml/xl/drawings/drawing1.xml new file mode 100644 index 0000000..bc4cac3 --- /dev/null +++ b/writable/tmp_m1_xml/xl/drawings/drawing1.xml @@ -0,0 +1,2 @@ + +0705600111762011341807 \ No newline at end of file diff --git a/writable/tmp_m1_xml/xl/media/image1.png b/writable/tmp_m1_xml/xl/media/image1.png new file mode 100644 index 0000000..23fdee0 Binary files /dev/null and b/writable/tmp_m1_xml/xl/media/image1.png differ diff --git a/writable/tmp_m1_xml/xl/printerSettings/printerSettings1.bin b/writable/tmp_m1_xml/xl/printerSettings/printerSettings1.bin new file mode 100644 index 0000000..cf5a783 Binary files /dev/null and b/writable/tmp_m1_xml/xl/printerSettings/printerSettings1.bin differ diff --git a/writable/tmp_m1_xml/xl/sharedStrings.xml b/writable/tmp_m1_xml/xl/sharedStrings.xml new file mode 100644 index 0000000..2c15dd6 --- /dev/null +++ b/writable/tmp_m1_xml/xl/sharedStrings.xml @@ -0,0 +1,350 @@ + +Project Name:ABDM - Sandbox IntegrationTest Designed by: NHAModule Name:ABHA Creation and VerificationTest Designed date: Release Version:Test Executed by: Test Execution date: Application/ System Name:Value{{baseUri}}PrerequisitesClient ID and Client SecretPostman and Postman CollectionS.NoFunctionApplicable ToMandatory/ OptionalTest Case IDFunctionalityTest Case +(to be checked during functional testing)Steps To Be Executed +(By User or Functional Tester)Expected ResultSuggestions for the Functional TesterStatusRemarkABHA Creation ProcessABHA Creation Through +Aadhaar OTPAllhttps://dev.abdm.gov.in/gateway/v0.5/sessionshttps://dev.abdm.gov.in/api/hiecm/gateway/v3/sessionsMandatoryCRT_ABHA_101Create ABHA OptionThe system must provide an option to create ABHA through Aadhaar OTPUser will have an option to create ABHACRT_ABHA_102Consent collectionThe system must display the consent language/ disclaimer language and collect user's consent as per the ABDM published consent. +Refer Cell No-: M141. Read consent language +2. Agree to the consent language (through 'I agree' checkbox or any other form of signature)User provides consent for sharing of Aadhaar details and creation of ABHA. + +System records user consent for compliance with Health Data Management Policy. + +Please refer the approved consent language.Optional CRT_ABHA_103Suggestions:- +Consent collection should be multilingual The system should be able to provide the consent in languages other than English alsoCRT_ABHA_104Aadhaar collection and Error MessageSystem must allow the user to enter Aadhaar Number and the system will display an error message for invalid Aadhaar Number1. Enter Aadhaar numberUser is prompted to enter correct Aadhaar Number + +In case user enters an invalid Aadhaar number (A valid Aadhaar is a 12-digit number), the system shows an error message "Aadhaar Number is not valid".CRT_ABHA_105Aadhaar OTP CollectionUser receives Aadhaar OTP and System must allow the user to enter Aadhaar OTP.1. Receive OTP on mobile number registered with Aadhaar +2. Enter Aadhaar OTPUser will be able to enter a valid Aadhaar OTP (A valid Aadhaar OTP is a 6-digit number). +Example - +Modified text for the "Please enter 6 -digit OTP sent to Aadhaar linked mobile number " step during the ABHA Creation workflow with “We just sent an OTP on the Mobile Number *******XXXX linked with Aadhaar. Enter the OTP below to proceed with ABHA creation".CRT_ABHA_106Resend OTPSystem may activate the Resend OTP button maximum 2 times after 60 seconds1. Click on Resend OTP Button +2. Receive OTP on mobileUser will able to send OTP again and verify itCRT_ABHA_107OTP based Aadhaar AuthenticationSystem must verify the OTPClick on verify button (For Resend and Send) + +It is recommended that verify button be auto enabledSystem authenticates the user's Aadhaar through OTP + +In case of incorrect OTP, the system displays an error +In case of correct OTP, the system allows the user to proceedNote: Many integrating entities have not implemented API for OTP not to be sent in case communication mobile is same as Aadhaar linked mobile. In that case the test scenario detailed under sl. No 1.8 will only be considered. However, it is recommended that API = checkAndGenerateMobileOTP be implemented. This will reduce one step of OTP verification in case communication mobile is same as the Aadhaar linked mobileOptionalCRT_ABHA_108Communication Mobile Number verification-I1. If communication mobile number is same as Aadhaar linked mobile number then it should directly go to ABHA creation screen . + +2. Alternatively , Integrators may also prompt for OTP again from the user and then post verification of OTP user can go to ABHA creation screen. This is applicable for testcase cell no -G20 , point no-1 + +1. System will check entered mobile is same as Aadhaar linked mobile number. If returns true then user will directed to ABHA creation screen. + + +2. For point number 2 step are already mentioned in test case cell no- G20 , point no-2 + + +Redirect to the ABHA creation screen.CRT_ABHA_109Communication Mobile Number verification-IIIf communication mobile number is not same as Aadhaar linked mobile number then system must ask for the OTP to verify comuncation mobile number.1. System must verify the mobile number. +1. System must send OTP on mobile number +2. User enters the OTP and clicks on verify +3. In case of incorrect OTP, the system displays an error +4. In case of correct OTP, the system allows the user to proceedSystem verifies the communication mobile numberMandatory for Private /Government (Optional for integrated program using demo auth as they have default ABHA address generated)CRT_ABHA_112Suggested ABHA Address1. The system should allow the user to select the ABHA address giving atleast 3 available suggestions + +2. Otherwise the system should have a provision to create a ABHA address with ABHA address Policy and validation rule should be print beside the field where ABHA Address is entered. + +Validation rules on ABHA Address to be set at the API level: +1. Minimum length - 8 characters +2. Maximum length - 18 characters +3. Special characters allowed - 1 dot (.) and/or 1 underscore (_) +4. Special character dot and underscore should be in between. Special characters cannot be in the beginning or at the end +5. Alphanumeric - only numbers, only letters or any combination of numbers and letters is allowed. + +1. Governemnt integrator may use the option for creating default ABHA address. However, it is recommended that user-defined or system suggested ABHA address be used +2. System should have a provision for private integrators to proceed with the suggested ABHA address. +3. If beneficary use the existing ABHA address then system displays the "ABHA Address is already exist".System should prompt / display the available or suggested ABHA addresses. System should allow the user to proceed with the enterered ABHA Address. In case, entered ABHA address is already in use then system should allow the user to input and proceed with any one of the suggested ABHA address. + +CRT_ABHA_113Display of ABHA NumberSystem must display the created ABHA Number1. System shows the 14-digit ABHA number and ABHA address generated +User should be able to view the generated ABHA Number and linked ABHA addressMandatory for Private CRT_ABHA_114View and Download ABHA details. +(If integrators is generating ABHA card) System must have a provision to View / Download ABHA card 1. System should show the user their ABHA Card +2. ABHA Card should be generated by API and should contain - +a. ABHA Number (Mandatory) +b. User Photo-Optional +c. ABHA QR code +d. date of birth and gender +e. ABHA AddressUser should be able to view their ABHA Card with all the demographc details as mentioned in cell H26Either of the test cases CRT_ABHA_114 or CRT_ABHA_115 is mandatory for Governement + + +Optional for Private CRT_ABHA_115View and Download ABHA details. +(If integrators is not generating ABHA card) System must have a provision to View details like ABHA number and ABHA address in the card (either ABHA card or any card being generated for their program/scheme/entity)1. If Integrator is not generating ABHA card then They print the mentioned information on their program/scheme or any other card +a. ABHA Number (Mandatory) +b. ABHA AddressUser should be able to view card with ABHA number and ABHA address and the details should be saved in HIMS system and linked with the HIMS unique beneficary 's ID.g or as per their business requirement.ABHA Creation Through Aadhaar BiometricCRT_ABHA_201Create ABHA +OptionThe system must provide an option to create ABHA through Aadhaar BiometricUser will have a choice to create ABHA using Aadhaar BiometricsCRT_ABHA_202 + + +The system must display the consent language/ disclaimer language and collect user's consent as per the ABDM published consent. + +Refer Cell No-: M14CRT_ABHA_203CRT_ABHA_204User is prompted to enter correct Aadhaar Number + +In case user enters an invalid Aadhaar number (A valid Aadhaar is a 12-digit number), the system shows an error message "Aadhaar Number is not valid".CRT_ABHA_205Biometric based Aadhaar AuthenticationSystem must verify the biometrics (fingerprint or face) of the user1. Scan biometrics (Fingerprint) +2. Click on verify buttonSystem authenticates the user's Aadhaar though user's biometrics +In case of incorrect biometrics, the system displays an error +In case of correct biometrics, the system allows the user to proceedNote: Many integrating entities have not implemented API for OTP not to be sent in case communication mobile is same as Aadhaar linked mobile. In that case the test scenario detailed under sl. No 2.6 will only be considered. However, it is recommended that API = checkAndGenerateMobileOTP be implemented. This will reduce one step of OTP verification in case communication mobile is same as the Aadhaar linked mobileCRT_ABHA_206CRT_ABHA_207CRT_ABHA_208User should be able to view the generated ABHA NumberCRT_ABHA_209User should be able to view their ABHA CardEither of the test cases CRT_ABHA_209 or CRT_ABHA_210 is mandatory for Governement + + +Optional for Private CRT_ABHA_210User should be able to view card with ABHA number and ABHA address and the details should be saved in HIMS system and linked with the HIMS unique beneficary 's ID.g or as per their business requirement.ABHA Creation Through Demo Auth/ Offline Mode +(Available Only for trusted entities. All government Entities are eligible. GovernmentCRT_ABHA_301The system must provide an option to create ABHA through Aadhaar Demographic/ Offline ModeCRT_ABHA_302CRT_ABHA_303CRT_ABHA_304CRT_ABHA_305Demographic Information based authenticationSystem must verify the demographic information of the user against their Aadhaar1. Enter beneficiary's name, date of birth, gender, Aadhaar Number, Mobile Number, Address, State name, and district name in accordance with the details on their Aadhaar card. +2. Case 1:If the beneficiary has an existing ABHA address, it should be displayed on both the ABHA card and the ABHA profile. + OR + Case 2: If beneficary want to create a customize ABHA address then same ABHA address should be displayed on both the ABHA card and the ABHA profile. +3 : Case 3 : If the beneficiary have no ABHA address then system will create a Default ABHA Address ( ABHA Number @sbx) and same ABHA address should be displayed on both the ABHA card and the ABHA profile. (Mandatory ) +4. If a beneficiary's deatils are matched with Aadhaaar information then system will not allow to create ABHA. +5. If If a beneficiary's deatils are matched with Aadhaaar information then system will allow to create ABHA . +1. System authenticates the user's Aadhaar though user's demographic data. +2.The fields for name, date of birth, and gender are set as non-editable, while the remaining fields can be open for editing i.e (Address, Email , Mobile Number, State, district , City e.t.c)CRT_ABHA_306Profile CompletionSystem should accepts user's profile information - 1. System auto-populates beneficiary's name, date of birth, gender, Aadhaar number, mobile number, address, state name, district name + and ABHA Number. +2.The fields for name, date of birth, and gender are set as non-editable, while the remaining fields can be open for editing. +CRT_ABHA_3071. The system displays the 14-digit ABHA number and generates the corresponding ABHA Address, adhering to the implementation chosen by integrators, either as a default setting or a customized one. +CRT_ABHA_3081. System should show the user their ABHA Card +2. ABHA Card should be generated by API and should contain - +a. ABHA Number (Mandatory) +b. ABHA QR code +c. Name, date of birth and gender +d. ABHA AddressEither of the test cases CRT_ABHA_308 or CRT_ABHA_309 is mandatory for Governement + + +Optional for Private CRT_ABHA_3091. If Integrator is not generating ABHA card then They print the mentioned information on their program/scheme or any other card with the beneficiary's demographic details. +a. ABHA Number (Mandatory) +b. ABHA AddressUser should be able to view card with ABHA number and ABHA address.and the details should be saved in HIMS system and linked with the HIMS unique beneficary 's ID.g or as per their business requirement.ABHA Creation Through Driving License / PANOptional for Private + +Mandatory for GovernmentCRT_ABHA_401The system must provide an option to create ABHA through Driving License / PAN CRT_ABHA_402Consent CollectionThe System must display the consent/ disclaimer language and collect user's consent1. Read the consent language +2. Agree to the consent language (through 'I agree' checkbox or any other form of signature)User provides consent for sharing of Aadhaar details and creation of ABHA. + +System records user consent for compliance with Health Data Management Policy.CRT_ABHA_403Communication Mobile NumberSystem must collect the communication mobile number1. Enters a valid mobile number for communication purposeUser will be able to enter their Mobile NumberCRT_ABHA_404Mobile Number VerificationSystem must verify the provided mobile number1. Receive OTP on mobile number +2. Enter the OTP and clicks on verifyIn case of incorrect OTP, the system displays an error +In case of correct OTP, the system allows the user to proceedCRT_ABHA_405Document VerificationSystem must verify the provided document - Driving License / PAN + + +1. Enter the Driving License / PAN number +2. Enter name, date of birth and gender as per the document. +3. successfully verification will generate enrollment number +4. With this enrollment number patient/ user will approach with any ABDM facilty for creation of ABHA number .System validates user's Driving License / PANCRT_ABHA_406Document UploadSystem must allow upload of front and back page of the Driving licence/ PAN1. Upload the front and back page of the document i.e Driving License / PAN.Document photos are uploaded in the systemCRT_ABHA_407Manual Verification and ABHA CreationSystem Operator / healthcare worker must manually check the documents - Driving License / PAN 1. A healthcare worker/ system operator manually verifies the Driving License / PANDocuments are manually verified. + +In case the document is valid, the operator approves ABHA creation. + +In case the document is invalid, the operator rejects the ABHA creation.CRT_ABHA_408System should display the created ABHA Number1. Show the 14-digit ABHA number generated +2. Show ABHA Number instead of Health IDCRT_ABHA_410User should be able to view their ABHA Card and the details should be saved in HIMS system and linked with the HIMS unique beneficary 's ID.g or as per their business requirement.CRT_ABHA_411 If Integrator is not generating ABHA card.1. If Integrator is not generating ABHA card then They print the mentioned information on their own card. +a. ABHA Number (Mandatory) +b. ABHA AddressUser should be able to view card with ABHA number and ABHA address.ABHA Verification ProcessABHA VerificationVRFY_ABHA_101 ABHA Number Verification using Aadhaar OTPSystem must allow ABHA Number verification using Aadhaar OTP1. Share ABHA Number or ABHA Address +2. Receive OTP on the Aadhaar linked mobile number +3. Enter the OTP. +4. System may activate the Resend OTP button maximum 2 times after 60 seconds in the OTP not received. +5. If beneficiary updates their mobile number in the HIMS system and It is advisable to provide users with the option to update their mobile number in the ABHA profile with (Yes/No) using the profile API you should be able to update the details. 1. In case of correct OTP, the verification is complete and the System can fetch user's ABHA profile - name, date of birth, gender, mobile number, photo and address, ABHA Number , ABHA Address and other details from the APIs. +2. In case of incorrect OTP, the verification fails. + +3. The fields for name, date of birth, and gender are set as non-editable, while the remaining fields can be open for editing i.e (Address, Email , Mobile Number, State, district , City e.t.c) + +4. After verification , the details should be saved in HIMS system and linked with the HIMS unique beneficary 's ID.g or as per their business requirement.VRFY_ABHA_102ABHA Address Verification using Aadhaar OTPSystem must allow ABHA Address verification using Aadhaar OTP1. Share ABHA Number or ABHA Address. +2. Receive OTP on the Aadhaar linked mobile number. +3. Enter the OTP. +4. System may activate the Resend OTP button maximum 2 times after 60 seconds in the OTP not received. +5. If beneficiary updates their mobile number in the HIMS system and It is advisable to provide users with the option to update their mobile number in the ABHA profile with (Yes/No) using the profile API you should be able to update the details. 1. In case of correct OTP, the verification is complete and the System can fetch user's ABHA profile - name, date of birth, gender, mobile number, photo and address, , state,district, ABHA Number , ABHA Address and other details from the APIs. + +2. In case of incorrect OTP, the verification fails. + +3. The fields for name, date of birth, and gender are set as non-editable, while the remaining fields can be open for editing i.e (Address, Email , Mobile Number, State, district , City e.t.c) + +4. After verification , the details should be saved in HIMS system and linked with the HIMS unique beneficary 's ID.g or as per their business requirement.ABHA VerificationVRFY_ABHA_201ABHA Number verification using mobile OTP(ABHA Linked Mobile Number )System must allow ABHA Number verification using +mobile OTP(ABHA Linked Mobile Number ) 1. Share ABHA Number or ABHA Address +2. Receive OTP on the Communication mobile number +3. Enter the OTP. +4. System may activate the Resend OTP button maximum 2 times after 60 seconds in the OTP not received. +5. If beneficiary updates their mobile number in the HIMS system and It is advisable to provide users with the option to update their mobile number in the ABHA profile with (Yes/No) using the profile API you should be able to update the details. 1. In case of correct OTP, the verification is complete and the System can fetch user's ABHA profile - name, date of birth, gender, mobile number, photo and address, , state,district,ABHA Number , ABHA Address and other details from the APIs. +2.In case of incorrect OTP, the verification fails. + +2. The fields for name, date of birth, and gender are set as non-editable, while the remaining fields can be open for editing i.e (Address, Email , Mobile Number, State, district , City e.t.c) + +4. After verification , the details should be saved in HIMS system and linked with the HIMS unique beneficary 's ID. + +VRFY_ABHA_202ABHA Address verification using mobile OTP(ABHA Linked Mobile Number )System must allow ABHA Address verification using +mobile OTP(ABHA Linked Mobile Number ) 1. Share ABHA Number or ABHA Address +2. Receive OTP on the Communication mobile number +3. Enter the OTP. +4. System may activate the Resend OTP button maximum 2 times after 60 seconds in the OTP not received. +5. If beneficiary updates their mobile number in the HIMS system and It is advisable to provide users with the option to update their mobile number in the ABHA profile with (Yes/No) using the profile API you should be able to update the details. 1. In case of correct OTP, the verification is complete and the System can fetch user's ABHA profile - name, date of birth, gender, mobile number, photo and address,, state,district, ABHA Number , ABHA Address and other details from the APIs. + +2. In case of incorrect OTP, the verification fails. + +3. The fields for name, date of birth, and gender are set as non-editable, while the remaining fields can be open for editing i.e (Address, Email , Mobile Number, State, district , City e.t.c) + +4. After verification , the details should be saved in HIMS system and linked with the HIMS unique beneficary 's ID.g or as per their business requirement. + + +MandatoryVRFY_ABHA _301Fetch ABHA details using Mobile (communication)authentication . +Multi authentication feature also need to be implemented like Captcha preferredSystem must allow ABHA retrieval using communication mobile OTP1. If the user enters a in-valid mobile number(communication) then system will display an error message " Please enter a valid mobile number". + + Display relevant error messgae.VRFY_ABHA _302ABHA Details not exists to communicated Mobile Number1. Incase ABHA Details not exists to communicated Mobile Number in ABHA system. + System will display an error message i.e. + " ABHA Number not found + We did not find any ABHA number linked to this mobile number. + Please use ABHA linked mobile number" + Kindly Note: System should allow to create ABHA option should be open.VRFY_ABHA _303ABHA Details exists to communicated Mobile Number. 1. Incase ABHA Details exists to communicated Mobile Number. + 1.1. If ABHA Details exists to comunication mobile number exists in ABHA system , In case ' Yes' then system will display a message "ABHA Exists to communication Mobile" and user will receive the OTP i.e "OTP sent to ABHA linked mobile number ending with ******XXXX" and then Upon verification completion, the system will display a list of ABHA numbers linked to the mobile number, including the following details: Name, ABHA Number, ABHA Address, and the beneficiary's photograph. When the user attempts to link selected ABHA details, the system will verify if the selected record is present in the HIMS system. If so, it will display a message indicating that the record is already linked in the HIMS with the HIMS beneficiary's ID. + 1.2 If the selected ABHA Profile is not present in HIMS, the system will allow it to be Register and linked in their HIMS beneficary's ID or proceed as per bussiness requirement OR benefciary can download the ABHA card (Optional)1. Fetching ABHA Details. +2. Register and Linked in their HIMS OR OR benefciary can download the ABHA card.VRFY_ABHA _304Incorrect OTP1. In case of incorrect OTP, the verification fails and display the relevant message.VRFY_ABHA _305Resend OTP Functionality1. System may activate the Resend OTP button maximum 2 times after 60 seconds in the OTP not received.Fetching ABHA details using Aadhaar Number +VRFY_ABHA_401Fetch ABHA details using Aadhaar Number +System must allow ABHA retrieval using Aadhaar Number 1.If the user enters wrong Aadhaar Number then system will display an error message "Invalid LoginId" or some relevant message i.e "Aadhaar Number is not valid". + VRFY_ABHA_402VRFY_ABHA_403ABHA Details not exists to Aadhaar Number1. Beneficary enter Aadhaar Number . +2. Beneficary will receive the OTP i.e "OTP sent to Aadhaar linked mobile number ending with ******XXXX" +3. After OTP verfication then system will display "NO ABHA user registered with this Aadhaar Number". +4. The system should have a provision to create ABHA. + + VRFY_ABHA_404ABHA Details exists to Aadhaar Number1. Enter Aadhaar Number. +2. Beneficary will receive the OTP i.e "OTP sent to Aadhaar linked mobile number ending with ******XXXX" . +3. After the OTP verfication. If ABHA Number exists then system will display Beneficary ABHA profile details and user can download the ABHA card. +4. If ABHA Profile is not present in HIMS, the system will allow it to be Register and linked in their HIMS beneficary's ID or proceed as per bussiness requirement .1. Display ABHA Profile details. +2. Download ABHA Card. +3. Register and linked in their HIMS beneficary's ID or proceed as per bussiness requirement .VRFY_ABHA_4051. System may activate the Resend OTP button maximum 2 times after 60 seconds in the OTP not received.ABHA Verification +(Applicable for Government Entites)VRFY_ABHA_501ABHA Number verification using Aadhaar Biometric - FingerprintSystem must allow ABHA Number verification using Biometric scan1. Share ABHA Number or ABHA Address +2. Scan fingerprint or faceIn case the biometrics match, the verification is complete and the System can fetch user's ABHA profile - name, date of birth, gender, mobile number, photo and address, ABHA Number , ABHA Address and other details from the APIs. + +In case the biometrics do not match, the verification fails.VRFY_ABHA_502ABHA Address verification using Aadhaar Biometric - FingerprintSystem must allow ABHA Address verification using Biometric scanReading ABHA Info using ABHA QR CodeReading ABHA Profile Info using ABHA QR CodeSystem must allow scanning of ABHA QR code to read the ABHA information1. EMR/HMIS scans the user's ABHA QR codeSystem reads the user information from the ABHA QR code - name, date of birth, gender, mobile and other details into the system for registration.Profile UpdatePROF_ABHA_601Mobile UpdateSystem must allow the user to update their Mobile number1. Enter new mobile number +2. Enter OTP +3. Enter Password/ OTP on old mobile numberMobile number on ABHA profile is updatedPROF_ABHA_602Photo UpdateSystem must allow the user to update their Photo1. Click on Edit Photo +2. Upload new photoPhoto on ABHA profile is updatedPROF_ABHA_603Email UpdateSystem must allow the user to update their Email1. Enter new Email ID +2. Enter OTPEmail ID on ABHA profile is updatedPROF_ABHA_604Re-KYCSystem must allow the user to perform re-KYC1. Click on re-KYC option +2. Enter OTP received on Aadhaar linked mobile numerKYC details on ABHA profile are updatedPROF_ABHA_605Delete ABHASystem must allow the user to Delete/ Deactivate ABHA1. Click on Delete/ Deactivate ABHA +2. Enter OTP received on mobile number to confirm deletion/ deactivation +3. Try to login again using the same ABHAABHA Number should be deleted. + +The system should not allow login through the same ABHAVerify one ABHA Number is linked to the unique patient ID in HIMS TAGGING_UNIQUEPATIENTID_UNIQUEABHANUMBER Intergrator's HIMS System should allow tagging of one ABHA Number with unique patient Id.ABHA Number should be validated in the database if already exists before creating a new patient id to avoid tagging of multiple patient id with same ABHA Number. +Kindly Note: This test scenario is applicable for both new and existing beneficiaries and linking will be happens with ABHA creation and verification flow. +HIMS is able to tag Patient ID with ABHA number.Share Profile PHR appSHARE _PATIENT_PROFILE_701Share Patient ProfileUser will scan the QR code which is placed the facility premises1. Log into PHR app. +2. User will scan the QR code which is placed at the facility premises/registration desk. +3. Post scanning, patient profile details are displayed including ABHA number, ABHA address, Name, Gender, DoB, Mobile No and Address. Below this consent language is displayed - "Your consent to the above information to be shared with <HIP Name>. They can use this information for your registration and linking your health records" and both "Cancel" / "Share" buttons are provided. +4.Check that after clicking on "Share" button, user profile is successfully shared with the HIP and if user click on "Cancel" button then user profile is not shared with the HIP. +5. User clicks on share and gets a token number. +6. User clicks on ok and gets token number with validity of 30 minutes./v1/patients/profile/share +/v0.5/patients/profile/on-sharehttps://dev.abdm.gov.in/api/hiecm/v3/patient-share/share +https://dev.abdm.gov.in/api/hiecm/v3/patient-share/on-shareNote:For teams utilizing APIs from version 1 (v1) or version 2 (v2), this document provides comprehensive mapping to the version 3 (v3) APIs. Although we have consistently referenced version 2 (v2) throughout this document, the guidance and mappings provided are equally applicable to version 1 (v1) APIs. +This ensures that regardless of the API version currently in use, teams can seamlessly transition to the updated v3 APIs by referring to the detailed mappings and representations included herein. +Please utilize this document as a primary resource for understanding the changes and enhancements in v3, and for ensuring compatibility with your existing API implementations.V1 API'sV2 API'sV3 API's1. v3/enrollment/enrol/byAadhaar1. v1/hid/benefit/createHealthId/demo/auth1. v2/hid/benefit/createHealthId/demo/auth +1. v2/document/generate/mobile/otp +2. v2/document/verify/mobile/otp +3. v2/document/validate1. v2/auth/init +2. v2/auth/confirmWithAadhaarOtp1. v1/auth/init +2. v1/auth/confirmWithAadhaarOtp1. v1/phr/search/authMethods?phrAddress=singh128@sbx +2. v1/auth/init +3. v1/auth/confirmWithAadhaarOTP1. v1/phr/search/authMethods?phrAddress=singh128 +2. v1/auth/init +3. v1/auth/confirmWithMobileOTP1. v1/auth/init +2. v1/auth/confirmWithMobileOTP1. v2/auth/init +2. v2/auth/confirmWithMobileOTP1. v2/registration/mobile/login/generateOtp +2. v2/registration/mobile/login/verifyOtp +3. v2/registration/mobile/login/userAuthorizedToken1. v2/account/qrCode1. v1/account/qrCodeDelete using Aadhaar OTP OR ABDM OTP +1. v2/account/aadhaar/generateOTP +2. v2/account/profile/delete + +Deactivate using Aadhaar OTP OR ABDM OTP + +1. v2/account/aadhaar/generateOTP +2. v2/account/profile/delete + +Re-activate using Aadhaar OTP OR ABDM OTP + +1. v2/auth/reactivate/init +2. v2/auth/reactivateNo APIsLogin via PasswordLogin via password1. v2/auth/authPassword1. v1/auth/authPassword1. v3/profile/login/verifyForgot ABHAVia Aadhaar OTP1. v2/auth/reactivate/init +2. v2/auth/reactivate1. v3/profile/login/request/otp +2. v3/profile/login/verifyVia Mobile OTP1. v2/account/change/mobile/new/generateOTP +2. v2/account/change/mobile/new/verifyOTP1. v2/account/email/verification/send/otp +2. v2/account/email/verification/verify/otp1. v2/account/aadhaar/generateOTP +2. v2/account/aadhaar/verifyOTPSet / Update PasswordSet PasswordUpdate Password Via Aadhaar Otp1. v1/account/change/passwd/generateAadhaarOTP +2. v1/account/change/passwd/byAadhaar1. v2/account/change/passwd/generateAadhaarOTP +2. v2/account/change/passwd/byAadhaar1. v3/profile/account/request/otp +2. v3/profile/account/verifyUpdate Password Via PasswordUpdate Password Via Mobile Otp1. v1/account/change/passwd/generateMobileOTP +2. v1/account/change/passwd/byMobile1. v2/account/change/passwd/generateMobileOTP +2. v2/account/change/passwd/byMobile1. v3/profile/account/verify1. v2/account/change/passwd/byAadhaarBenefit API'sCreate ABHA using Aadhaar 1. v1/hid/benefit/aadhaar/generateOtp +2. v1/hid/benefit/aadhaar/verifyAadharOtp1. v2/hid/benefit/aadhaar/generateOtp +2. v2/hid/benefit/aadhaar/verifyAadharOtp1. v3/enrollment/request/otp +2. v3/enrollment/enrol/byAadhaar Link ABHA With Benefit Name1. v1/hid/benefit/link1. v2/hid/benefit/link1. v3/profile/benefit/linkAndDelink De-link ABHA With Benefit Name1. v1/hid/benefit/deLinkHid1. v2/hid/benefit/deLinkHidBenefit Link Delink ABHABenefit Update ABHA Profile Details Update Mobile Number1. v1/hid/benefit/update/mobile1. v2/hid/benefit/update/mobile1. v3/profile/accountUpdate Profile1. v1/hid/benefit/update/profile +2. v1/hid/benefit/update/status1. v2/hid/benefit/update/profile +2. v2/hid/benefit/update/statusSearch Benefit Details Search by xmlUid1. v1/hid/benefit/search/aadhaar1. v2/hid/benefit/search/aadhaar1. v3/profile/benefit/search Search by Health Id Number1. v1/hid/benefit/search/healthIdNumber1. v2/hid/benefit/search/healthIdNumber1. v3/profile/benefit/abha/healthIdNumberSearch1. v3/profile/benefit/abha/{{healthIdNumber}}1. No APIFind ABHA via Mobile1. v3/profile/account/abha/search +2. v3/profile/login/request/otp +3. v3/profile/login/verify Find ABHA using Mobile numberChild ABHA1. v2/hid/benefit/integrator/child/createHealthId +2. v2/hid/benefit/integrator/child/parent/mappedAbhaId +3. v2/account/profile1. v3/enrollment/enrol/byAadhaar +2. v3/enrollment/profile/children +3. v3/profile/account +ABHA Address CreationABHA address creation via mobileCreate child ABHA1. v1/registration/mobile/generateOtp +2. v1/registration/mobile/verifyOtp +3. No API +4. v1/phr/registration/phr/suggestion +5. v1/search/existsByHealthId +6. v1/phr/registration/create/phr1. v3/phr/web/enrollment/abha/request/otp +2. v3/phr/web/enrollment/abha/verify +3. v3/phr/web/login/abha/verify/user +4. v3/phr/web/enrollment/suggestion +5. v3/phr/web/enrollment/isExists?abhaAddress=dharam123@sbx +6. v3/phr/web/enrollment/abha/enrolGet ABHA address1. v1/account/profile +2. v1/account/getPngCard1. v2/account/profile +2. v2/account/getPngCard1. v3/phr/web/login/profile/abha-profile +2. v3/phr/web/login/profile/abha/phr-card1. v2/account/logout1. v1/account/logout1. v3/profile/account/request/logoutLogoutProfile logout1. v3/profile/account +2. No API1. v1/account/change/passwd/byAadhaarLogin via Aadhaar(input Aadhaar) - Forgot ABHA via Aadhaarhttps://abhasbx.abdm.gov.in/abha/api/1. v3/enrollment/request/otp +2. v3/enrollment/auth/byAbdm +3. v3/enrollment/enrol/byDocument1. v3/profile/login/request/otp +2. v3/profile/login/verify +3. v3/profile/account +4. v3/profile/account/abha-card1. v3/phr/web/login/abha/search +2. v3/phr/web/login/abha/request/otp +3. v3/phr/web/login/abha/verify +4. v3/phr/web/login/profile/abha-profile +5. v3/phr/web/login/profile/abha/phr-card1. v3/profile/login/request/otp +2. v3/profile/login/verify +3. v3/profile/account +4. v3/profile/account/abha-card1. v3/profile/login/request/otp +2. v3/profile/login/verify +3. v3/profile/login/verify/user +4. v3/profile/account +5. v3/profile/account/abha-card +Delete using Aadhaar OTP OR ABDM OTP +1. v3/profile/account/request/otp +2. v3/profile/account/verify + +Deactivate using Aadhaar OTP OR ABDM OTP + +1. v3/profile/account/request/otp +2. v3/profile/account/verify + +Re-activate using Aadhaar OTP OR ABDM OTP + +1. v3/profile/login/request/otp +2. v3/profile/login/verify/user1. v2/account/change/password1. v3/profile/login/request/otp +2. v3/profile/login/verify +Create ABHA using Aadhaar Bio1. v3/enrollment/enrol/byAadhaar 1. v1/account/profile1. v2/account/profile1. v3/profile/account/qrCode1. v2/registration/aadhaar/verifyBio1. v1/registration/aadhaar/verifyBio1. v1/account/change/password1. v2/auth/init +2. v2/auth/confirmWithAadhaarBio + +1. v1/auth/init +2. v1/auth/confirmWithAadhaarBio + +https://healthidsbx.abdm.gov.in/api/1. v2/registration/aadhaar/generateOtp +2. v2/registration/aadhaar/resendAadhaarOtp +3. v2/registration/aadhaar/verifyOTP +4. v2/registration/aadhaar/checkAndGenerateMobileOTP +5. v2/registration/aadhaar/generateMobileOTP +6. v2/registration/aadhaar/verifyMobileOTP +7. No APIs +8. v2/registration/aadhaar/createHealthIdByAdhaar +9. No APIs +10. No APIs +11. No APIs +12. v2/search/existsByHealthId +13. No APIs1. v3/enrollment/request/otp +2. v3/enrollment/request/otp +3. v3/enrollment/enrol/byAadhaar +4. No APIs +5. v3/enrollment/request/otp +6. v3/enrollment/auth/byAbdm +7. v3/profile/account/request/emailVerificationLink +8. No APIs +9. No APIs +10. No APIs +11. v3/enrollment/enrol/suggestion +12. No APIs +13. v3/enrollment/enrol/abha-address1. v1/registration/aadhaar/generateOtp +2. v1/registration/aadhaar/resendAadhaarOtp +3. v1/registration/aadhaar/verifyOTP +4. No APIs +5. v1/registration/aadhaar/generateMobileOTP +6. v1/registration/aadhaar/verifyMobileOTP +7. No APIs +8. v1/registration/aadhaar/createHealthIdWithAadhaarOtp +9. v1/registration/aadhaar/createHealthIdWithPreVerified +10. {{baseUri}}/v1/phr/profile/link/profileDetails +11. {{baseUri}}/v1/phr/registration/phr/suggestion +12. {{baseUri}}/v1/search/existsByHealthId +13. {{baseUri}}/v1/phr/registration/hid/create-phr-addresshttps://phrsbx.abdm.gov.in/api/V1 and V2 APIsBase URLV3 APIs (SBX)V3 APIs (Prod)https://abha.abdm.gov.in/api/abha/ \ No newline at end of file diff --git a/writable/tmp_m1_xml/xl/styles.xml b/writable/tmp_m1_xml/xl/styles.xml new file mode 100644 index 0000000..415a795 --- /dev/null +++ b/writable/tmp_m1_xml/xl/styles.xml @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/writable/tmp_m1_xml/xl/theme/theme1.xml b/writable/tmp_m1_xml/xl/theme/theme1.xml new file mode 100644 index 0000000..0e63055 --- /dev/null +++ b/writable/tmp_m1_xml/xl/theme/theme1.xml @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/writable/tmp_m1_xml/xl/workbook.xml b/writable/tmp_m1_xml/xl/workbook.xml new file mode 100644 index 0000000..51adf4c --- /dev/null +++ b/writable/tmp_m1_xml/xl/workbook.xml @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/writable/tmp_m1_xml/xl/worksheets/_rels/sheet1.xml.rels b/writable/tmp_m1_xml/xl/worksheets/_rels/sheet1.xml.rels new file mode 100644 index 0000000..6343615 --- /dev/null +++ b/writable/tmp_m1_xml/xl/worksheets/_rels/sheet1.xml.rels @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/writable/tmp_m1_xml/xl/worksheets/sheet1.xml b/writable/tmp_m1_xml/xl/worksheets/sheet1.xml new file mode 100644 index 0000000..608f7cf --- /dev/null +++ b/writable/tmp_m1_xml/xl/worksheets/sheet1.xml @@ -0,0 +1,2 @@ + +012345678910432114334074314261243043443513141516171819202122232425262730830931028129303131321.100000000000000133343536374294274281.2333839404142431.34445464741421.43348495051521.53353545556571.63358596061621.73363646566671.8686970717273741.93375767778791.10000000000000018081828384851.11000000000000013386878889901.12000000000000019192939495961.12999999999999999798991001011022103302.1691041051061074223833112.200000000000000269108391094142432.299999999999999869110464741422.4691114950511122.5691131141151161172.611869119717273742.769120767778792.8691218788891222.9911239394951242.11251269910010112731281293.1331301051313123133113.233132391094142433.344133464741423.4331344950511123.5331351361371381393.6331401411421433.73314487881451223.89114693941471243.91481499910015015141521534.099999999999999669154351551073253144084.269156157158159160434.3691611621631641654.4000000000000004691661671681691704.5691711721731741754.5999999999999996691761771781791804.7691811821831841854.869186871871881224.9000000000000004691899394951904.099999999999999669191991921931941955196305.0999999999999996331971981992002013163154095.233202203204205206317325410620730332082092102112123193204116.1332132142152162173183254107196307.12182192202212222233253214127.22182242252262277.32182282292302317.42182322332342237.52182352362378238308.133239240241242223325325415406332432332342238.1999999999999993332442452462238.3000000000000007332472482492508.4332512362522239253309.1692542552562572584254243259.199999999999999369259260261257258325325325102623010.169254263264265266323322420112673011.16926826927027127232533634411.26927327427527627741841936811.36927827928028128232533734411.46928328428528628732533834411.56928828929029129232532441316293301633294293295296297325325325172982993317.10000000000000133300301302303303304304305183263273293283301933119.10000000000000133232533333419.23353253333342033920.10000000000000134040535034920.234134234334420.334542341434920.33463473483442135121.135235335435521.24164224214172236322.135635735835922.23603613623592336423.136536636736823.23693703714042437224.137337437537624.237737837938024.338138338338225384386325325385263873923253883892739027.139139332539427.239539639739828402403400399401306307 \ No newline at end of file diff --git a/writable/tmp_scan_share_docx/[Content_Types].xml b/writable/tmp_scan_share_docx/[Content_Types].xml new file mode 100644 index 0000000..a29ee6b --- /dev/null +++ b/writable/tmp_scan_share_docx/[Content_Types].xml @@ -0,0 +1,2 @@ + + diff --git a/writable/tmp_scan_share_docx/_rels/.rels b/writable/tmp_scan_share_docx/_rels/.rels new file mode 100644 index 0000000..90848dc --- /dev/null +++ b/writable/tmp_scan_share_docx/_rels/.rels @@ -0,0 +1,2 @@ + + diff --git a/writable/tmp_scan_share_docx/docProps/app.xml b/writable/tmp_scan_share_docx/docProps/app.xml new file mode 100644 index 0000000..6f8e1a9 --- /dev/null +++ b/writable/tmp_scan_share_docx/docProps/app.xml @@ -0,0 +1,2 @@ + +0Microsoft Office Word0falsefalsefalsefalse12.0000 diff --git a/writable/tmp_scan_share_docx/docProps/core.xml b/writable/tmp_scan_share_docx/docProps/core.xml new file mode 100644 index 0000000..70c5c61 --- /dev/null +++ b/writable/tmp_scan_share_docx/docProps/core.xml @@ -0,0 +1,2 @@ + +Kundurthi Harish2026-05-08T17:16:13Z2026-05-08T17:16:13Z diff --git a/writable/tmp_scan_share_docx/docProps/custom.xml b/writable/tmp_scan_share_docx/docProps/custom.xml new file mode 100644 index 0000000..06590b5 --- /dev/null +++ b/writable/tmp_scan_share_docx/docProps/custom.xml @@ -0,0 +1,2 @@ + +SolidFramework v10.0.19910.12025-03-04T00:00:00ZMicrosoft® Word for Microsoft 3652026-05-08T00:00:00ZMicrosoft® Word for Microsoft 365 diff --git a/writable/tmp_scan_share_docx/word/_rels/document.xml.rels b/writable/tmp_scan_share_docx/word/_rels/document.xml.rels new file mode 100644 index 0000000..4e47f60 --- /dev/null +++ b/writable/tmp_scan_share_docx/word/_rels/document.xml.rels @@ -0,0 +1,2 @@ + + diff --git a/writable/tmp_scan_share_docx/word/_rels/header1.xml.rels b/writable/tmp_scan_share_docx/word/_rels/header1.xml.rels new file mode 100644 index 0000000..9f28ac4 --- /dev/null +++ b/writable/tmp_scan_share_docx/word/_rels/header1.xml.rels @@ -0,0 +1,2 @@ + + diff --git a/writable/tmp_scan_share_docx/word/document.xml b/writable/tmp_scan_share_docx/word/document.xml new file mode 100644 index 0000000..1d0b633 --- /dev/null +++ b/writable/tmp_scan_share_docx/word/document.xml @@ -0,0 +1,2 @@ + +SANDBOX DOCUMENTATION(ABDM_SCAN & SHARE)Version 1.0regCreated on 03.03.2025Base URL and X-CM-ID3Terminology Definition3Gateway3Overview3List of APIs3Auth token API3OpenID Configuration API5Keycloak Certificate API6Update bridge URL API9Registration of Facility & Software Linkage10Find bridge by service id12Find services by bridge id14Scan and Profile Share16Overview16Sequence Diagram17List of APIs17Profile share17Profile share – Callback21Profile on-share25Profile on share – Callback27Scan and Record Share29Overview29Sequence Diagram30Record share30Record share - Callback33Record on-share36Record on-share – Callback38Scan and Pay41Overview41Sequence Diagram41List of APIs41Error Codes Listing53Base URL and X-CM-IDEnvironmentBase URLX-CM-IDSandboxhttps://dev.abdm.gov.inSbxProductionhttps://apis.abdm.gov.inAbdmTerminology Definition:Bridge ID: Is client ID which provided by NHA to HIP (Its alphanumerical eg: SBX_00XXXX)Service ID: Is Facility ID which is generated from NHPR application (Its alphanumeric eg: IN02100000XX)GatewayOverviewThis is the key ABDM building block that manages ABHA addresses, maintains links to health data for each ABHA address and manages consents provided by the user for sharing of their health data. It also supports exchange of interoperable health data between HIPs and HIUs. The HIE-CM enables exchange of personal health data with consent as per the Health Data Management Policy issued by NHA.List of APIsAuth token APIThis API will be invoked to generate auth token.URL: /api/hiecm/gateway/v3/sessionsRequest: POSTHeader Parameters:Property NameExample ValueRequiredDescriptionREQUEST-ID18235d89-cb13-479d-ad71-7a57d5f669a8YesUnique UUID for tracking the end-toend request transactionTIMESTAMP2022-10-06T10:10:00.587ZYesThe actual time when the request was initiated, ISO Date time format represents the date and timeX-CM-IDSbxYesSuffix of the consent manager to which the request was intended.Body Parameters:Property NameExample ValueRequiredDescriptionclientIdSBX_XXXXXXYesClient id for authenticationclientSecret“XXXXXXXXXXXXX”YesClientsecretfor authenticationgrantTypeclient_credentialsYesGrant type for authenticationRequest Body:Request Body{"clientId": "SBX_XXXXX","clientSecret": "XXXX-XXX-XXXX-XXXX-XXXXXXX","grantType": "client_credentials"}Response:ResponseCode : 202 Accepted132308629717{"accessToken":"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJBbFJiNVdDbThUbTlFSl9JZk85ejA2ajlvQ3Y1MXBLS0ZrbkdiX1RCdkswIn0.eyJleHAiOjE3MjMyMjU3MTEsImlhdCI6MTcyMzIyNDUxMSwianRpIjoiMzE3MjVkN2Qt NmM1Mi00OWE0LTk0M2MtZmY2ZjhkNjNhYmRlIiwiaXNzIjoiaHR0cHM6Ly9kZXYubmRobS5nb3YuaW4vYX V0aC9yZWFsbXMvY2VudHJhbC1yZWdpc3RyeSIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiJjN2NhMjk3Yi0yZTVh LTRkN2UtOGY5YS0xYWU2NDAxYWQ0Y2YiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJTQlhfMDAwMTM1Iiwic2Vzc2lvbl9zdGF0ZSI6IjhiYjQ4ZGM5LTJmMDUtNDA0OC05MGUxLWRjYjgxNWRmOGU5MyIsImFjciI6IjEiLCJhbGx vd2VkLW9yaWdpbnMiOlsiaHR0cDovL2xvY2FsaG9zdDo5MDA3Il0sInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6W yJIaWRJbnRlZ3JhdGVkUHJvZ3JhbSIsIkhJVV9QQVlFUiIsImhmciIsImhpdSIsIm9mZmxpbmVfYWNjZXNzIi wiaGVhbHRoSWQiLCJwaHIiLCJPSURDIiwiaGVhbHRoX2xvY2tlciIsImhpcCIsImhwX2lkIl19LCJyZXNvdXJjZV 9hY2Nlc3MiOnsiU0JYXzAwMDEzNSI6eyJyb2xlcyI6WyJ1bWFfcHJvdGVjdGlvbiJdfSwiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19f Swic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsImNsaWVudEhvc3QiOiIxMDAuNjUuMTYwLjIxNCIsImNsaWVudElkIjoiU0JYXzAwMDEzNSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwicHJlZmVycmVkX3VzZXJ uYW1lIjoic2VydmljZS1hY2NvdW50LXNieF8wMDAxMzUiLCJjbGllbnRBZGRyZXNzIjoiMTAwLjY1LjE2MC4yMTQifQ.L56AYZYfzFrO_gNedAbSwR9foEO661z2cMGEeOKsz2ZXsIpTb9oLd9fmRiixIS7ToGoW2VzzXC14qrXnwZIqknBZchTRJrmyGk6iRJ NQYR4k12hrn4tbdW- h5e9m4NWFAvPtGbBUyKA8gotrne9fn7T0MOC7N_J8TS3JLr2gothJSgc9P3VDKm8c6zpAObQPmwEpH qJH6j2Q07nGsoaBygxovoIeFn6G6zwIa-_mKw_a86L_CYxr8Gxw5-5PXkh2XwYp_xLIiJ3t7vLM97UFThwSn_TmRF6W1LH145m_6NxY4hQclHi1elK3OP4LvR1SLDwtAQZSCm4Jpihd0uMw", "expiresIn": 1200,"refreshExpiresIn": 1800,"refreshToken":"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyMWU5NzA4OS00ZTcxLTQyNGEtOTAzYS1jOTAyMW M1NmFlNWYifQ.eyJleHAiOjE3MjMyMjYzMTEsImlhdCI6MTcyMzIyNDUxMSwianRpIjoiZGY5ODdmYzQtYzdk Ni00OGNmLTliM2EtNzRmNWVkMTljMmNmIiwiaXNzIjoiaHR0cHM6Ly9kZXYubmRobS5nb3YuaW4vYXV0a C9yZWFsbXMvY2VudHJhbC1yZWdpc3RyeSIsImF1ZCI6Imh0dHBzOi8vZGV2Lm5kaG0uZ292LmluL2F1dGg vcmVhbG1zL2NlbnRyYWwtcmVnaXN0cnkiLCJzdWIiOiJjN2NhMjk3Yi0yZTVhLTRkN2UtOGY5YS0xYWU2ND AxYWQ0Y2YiLCJ0eXAiOiJSZWZyZXNoIiwiYXpwIjoiU0JYXzAwMDEzNSIsInNlc3Npb25fc3RhdGUiOiI4YmI0O GRjOS0yZjA1LTQwNDgtOTBlMS1kY2I4MTVkZjhlOTMiLCJzY29wZSI6Im9wZW5pZCBlbWFpbCBwcm9maWx lIn0._cOnTXMf2bObS1nySL-AjvM5PQxgCHJRm2oO66nrx1M","tokenType": "bearer"}OpenID Configuration APIOpenid-configuration API, defined within OpenID Connect which provides configuration information about the Identity Provider (IDP).URL: /api/hiecm/gateway/v3/.well-known/openid-configurationRequest: GETHeader Parameters:Property NameExample ValueRequiredDescriptionREQUEST-ID18235d89-cb13-479d-ad71-7a57d5f669a8YesUnique UUID for tracking the end-toend request transactionTIMESTAMP2022-10-06T10:10:00.587ZYesThe actual time when the request was initiated, ISO Date time format represents the date and timeX-CM-IDSbxYesSuffix of the consent manager to which the request was intended.ResponseResponseCode : 202 OK{"jwks_uri": "https://dev.abdm.gov.in/api/hiecm/gateway/v3/certs"}Keycloak Certificate APIIn response to open ID configuration API, Keycloak, the open-source identity provider, provides an OAuth certificate that can be used with open source authentication requests for certificates.URL: /api/hiecm/gateway/v3/certsRequest: GETHeader Parameters:Property NameExample ValueRequiredDescriptionREQUEST-ID18235d89-cb13-479d-ad71-7a57d5f669a8YesUnique UUID for tracking the end-toend request transactionTIMESTAMP2022-10-06T10:10:00.587ZYesThe actual time when the request was initiated, ISO Date time format represents the date and timeX-CM-IDSbxYesSuffix of the consent manager to which the request was intended.ResponseResponseCode : 202 OK{"keys": [{"e": "AQAB","kid": "AlRb5WCm8Tm9EJ_IfO9z06j9oCv51pKKFknGb_TBvK0", "kty": "RSA","n": "mgmW7W5ZGF_G5cJevwYi8HiPcI-6qS_psnZxa4v3bkwAkyOoOd8-6ketrOI-ZA2PbRbGnxFfZHiI94rdFXJ4Q9ampscsz9NocTIPMPmWydJ8A50pZaYWyikYDSJiDltq7i3WspPKSOuQHrC 5h9dMcCVveX5oeg0tO68Z79gwDlpcxiqDbFaphsqDvx-5XkfwiqvOBaybK6_BCBPuTqWMUEuUklLYXu2X7ESHdVNFMFAjxCcCXUtP7LFdvT3nnFekRmG82QbSQSVe4N5tPH8q0MCxSWWn2c15bDnzOF-dvfRCVPRabCzw0M-utHR9diTrWtq6Koi5buxgwM1rbk0p8Q", "use": "sig","x5c": ["MIICrzCCAZcCBgFy/3WZBjANBgkqhkiG9w0BAQsFADAbMRkwFwYDVQQDDBBjZW50cmFsLXJlZ2lzdHJ5 MB4XDTIwMDYyOTA5NDEzNloXDTMwMDYyOTA5NDMxNlowGzEZMBcGA1UEAwwQY2VudHJhbC1yZWdpc3RyeTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJoJlu1uWRhfxuXCXr8GIvB4j3CPuqkv6bJ2cWuL925MAJMjqDnfPupHraziPmQNj20Wxp8RX2R4iPeK3RVyeEPWpqbHLM/TaHEyDzD5lsnSfAOdKWW mFsopGA0iYg5bau4t1rKTykjrkB6wuYfXTHAlb3l+aHoNLTuvGe/YMA5aXMYqg2xWqYbKg78fuV5H8Iqrzg WsmyuvwQgT7k6ljFBLlJJS2F7tl+xEh3VTRTBQI8QnAl1LT+yxXb0955xXpEZhvNkG0kElXuDebTx/KtDAsUllp91321562914399nNeWw58zhfnb30QlT0Wmws8NDPrrR0fXYk61rauiqIuW7sYMDNa25NKfECAwEAATANBgkqhkiG9w0BAQs FAAOCAQEACkC3TijrXIgi4vn+l1uL1nfdK6vOIL5UZ6yCjSOq7zYW6b3Qe8j7NrPb9RJC+pbIERyNbB+t9hsa5 g1L7lkjCNlUuxfJprsJ9LJKlM5g7dYEA6XPCJ7C6AVlarj72vlWXQvwjnQMO2/CM9/Jp5Hnv2Qwjn7NME2OW M0iblc/TD+DEZK5L5mlWMyuBSQo2o/AcOmfG4MoE5Gm/CaOJ47rSrf+lq83e5+dyKh7uLVAa+5WK8Im 5nEs6BLSGyo2KlaV0mW9yCkoRLLbipjH8+rJwkUU6iu7QVjz0peGZzYldya5n35gMWH7Bu4HqFneKNRwwD6w8rGNC+uWtgWejDZ3yQ=="],"x5t": "EaMhYGUIvMkp8tvSM3QoaqaF8xM","x5t2": "vGer6Pt8AhZn8RlbHhAFksOCcGf3u1UWU7Qq-Doy7ro", "alg": "RS256"},{"e": "AQAB","kid": "oc-l6O1yJ7wJKYEeyeUafsz3Aecq7YnCIqbzbIfkJk8", "kty": "RSA","n":"jDOehgMzurNQT0WJCTWN6a34639uIKOLO1LnXZes_kTakWh6iRxmkExLLCD7MJjz9aijTHwIuKAtOCSbFO pwbqSfF6dMBS2c8cv0AU3pE8kSMpGJKDZ9diA-BuUriwr9BUYSUW8SM68QH_HCaz2mmN_Z8ynTQ4kWw_Idj-enVpkHYtq00DriG98l6RXF1Ao9Kd16ctoNbthuQYH0RSRIXnt0Qtm4GSAY7abPCNa64mir0auldU72DJHXwDo6g5OGz6E Mm86ZAV_pvh_5YzFpfkUA8TK2LFVAmC3Up- IMxv0yMMKFZjkFGA0QKYMkMTC5ruLaE7cec-njA7dJQnQ","use": "sig", "x5c": ["MIICrzCCAZcCBgGHxvQVmDANBgkqhkiG9w0BAQsFADAbMRkwFwYDVQQDDBBjZW50cmFsLXJlZ2lzdHJ 5MB4XDTIzMDQyODA4MTk1N1oXDTMzMDQyODA4MjEzN1owGzEZMBcGA1UEAwwQY2VudHJhbC1yZWdpc3RyeTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAIwznoYDM7qzUE9FiQk1jemt+Ot/biCjiztS 512XrP5E2pFoeokcZpBMSywg+zCY8/Woo0x8CLigLTgkmxTqcG6knxenTAUtnPHL9AFN6RPJEjKRiSg2fXYg PgblK4sK/QVGElFvPkjOvEB/xwms9ppjf2fMp00OJFsPyHY/np1aZB2LatNA64hvfJekVxdQKPSndenLaDW7Y bkGB9EUkSF57dELZuBkgGO2mzwjWuuJoq9PmrpXVPu9gyR18A6OoOThs+hDJvOmQFf6b4f+WMxaX5FA PEytixVQJgt1KfiDMb9MjDChWY5BRgNECmDJDEwua7i2hO3HnPp4wO3SUJ0CAwEAATANBgkqhkiG9w0B AQsFAAOCAQEABYAcXOSr+WgOxKVmygID9WjB4rDuAVDyU3GmjBvckdWhYJuBX8Vs04hNVNgf904gqy+D5wZIQU985stK3PdogFGN2jVw2kO9G3hG4/7uwYKqciKApT/pSPMeHRltHGp/Mwr6e5poVwgQyrn+Be H373U1Q6eB1QUYnElP+16y7bbvQhfDAS2X9sqdfurB9YIL5xZMPddZaf7pPX8oWOVlB0XH1JEZfsX125qq0Xn K8z/Rd8KI8zTfJw6D2Kzrk1WvQSlM5KnTQmcSk3kwDlW5Dg657dT49Y68mI4azq34q17JgBhTx3IbTuf94QT w7QC5wmFtO+hc6zPVODX8JWu7sQ=="],"x5t": "-HZ-fkkNBhTsPHWrhATwlZflhdU","x5t2": "tjVDNCTx7Fn0TfM-6uHvbwjWlIxIaFtGxiZZ6uJFxr4", "alg": "RS512"}]}],"x5t": "-HZ-fkkNBhTsPHWrhATwlZflhdU","x5t2": "tjVDNCTx7Fn0TfM-6uHvbwjWlIxIaFtGxiZZ6uJFxr4", "alg": "RS512"}]}Update bridge URL APIThis API will be called to update the bridge base URL.URL: /api/hiecm/gateway/v3/bridge/urlRequest: PATCHHeader Parameters:Property NameExample ValueRequiredDescriptionAuthorizationeyJhbGciOiJSUzUxMiJ9. eyJzdWIiOiJ2YXNhbnRoY Wt1bWFyLmtlc2F2YW5Ac 2J4IiwiY2xpZW50SWQiOi JzYngiLCJzeXN0ZW0iOiJBQkhBLUEiLCJyZXF1ZXN0Z XJJZCI6IlBIUi1XRUIiLCJwaHJNb2JpbGUiOm51bGwsYesJWT Access token which was issued by ABDM session API after successful validation of client id and secret.REQUEST-ID18235d89-cb13-479dad71-7a57d5f669a8YesUnique UUID for tracking the end-to-endrequest transactionTIMESTAMP2022-10-06T10:10:00.587ZYesThe actual time when the request was initiated, ISO Date time format represents the date and timeX-CM-IDsbxYesSuffix of the consent manager to which the request was intended.Body Parameters:Property NameExample ValueRequiredDescriptionurlhttps://webhook.site/b7 99c0b8-4e75-4545-8eb2-d8c2d5f0c9f6YesBridge base URLRequest Body:Request Body{"url": "https://webhook.site/b799c0b8-4e75-4545-8eb2-d8c2d5f0c9f6"}Response:ResponseCode : 202 AcceptedRegistration of Facility & Software LinkageOverview: The software being used by the provider must integrate with the digital building blocks of ABDM and comply with the guidelines outlined NHA. NHA maintains the national directory of all healthcare facilities. Any participating facility needs to sign up in the health facility registry at (nhpr.abdm.gov.in) This ensures that they are a valid facility which is authorized to issue health records in the ecosystem. HFR consists of information for each healthcare facility in the country – hospitals, clinics, diagnostic centers, pharmacies etc., across all systems of medicine and covering both public and private health facilities. HFR offers APIs that can be used by various stakeholders in the ecosystem. Healthcare information service provider application or healthcare repository provider application must be upgraded to become ABDM compliant.Registration of facility:Through website: https://hspsbx.abdm.gov.in/home(sandbox), https://nhpr.abdm.gov.in/home (production) Step-by-step user manual document access:Goto: https://hspsbx.abdm.gov.in/home (sandbox) , https://nhpr.abdm.gov.in/home (production)>>Resource center >> User Manual>> Select “For Health Fecility” >>Download “User Manual” >>Refer Content“A” (Health Professional ID (HPID) creation), “B” (Facility Registration) Registration of bridge services (HIP/HIU) on facility:Option1:Linkingthroughwebsite:https://hspsbx.abdm.gov.in/home(sandbox), https://nhpr.abdm.gov.in/home (production) Step-by-step user manual document access:Goto: https://hspsbx.abdm.gov.in/home (sandbox) , https://nhpr.abdm.gov.in/home (production)>>Resource center >> User Manual >> Select “For Health Facility”>>Download “User Manual” >>Refer Content “C” (Software Linkage).Option2:ThroughAPIThisAPI( https://facilitysbx.abdm.gov.in/v1/bridges/MutipleHRPAddUpdateServi ces ) will be used to link multiple bridges against a facility. It will accept the facility id , facility name and list of HRP i.e. bridges.Please note:You must pass in all the required parameters to create the API.The data needs to be passed in the required format as mentioned for each field. API can refer swagger link :https://facilitysbx.abdm.gov.in/swaggerui.html#/Multiple_HRP_API >>>Go to Multi HRP API >>>and Select“/v1/bridges/MutipleHRPAddUpdateServices v1MutipleHRPAddUpdateServices”Parameters:ParamsRequiredDescriptionData typeFormat if anyfacilityIdYesWill be validated if present in HFR or notStringStarting with IN andof12charactersfacilityNameYesName of the facility to be linkedStringAlphanumericbridgeIdYesValid Bridge Id to be linked.StringAlphanumeric and validity to be checked by HIECMhipNameYesTo provide uniqueness against each bridges that is linked . HIPname is theStringHIP name can be the Hospital name addedbridgeNamename ofthehospital which will reflectwithsuffixof bridge name. exampleon ABHA/PHR app when the patent will search for the respective hospital.Hospitalname=XYZ and bridge name=BRIDGE TEST, sothe HIP name = XYZ BRIDGE.HIP name can not be more than15characters., No specialcharacteris allowed(%$*#@(~&!), and it should be unique for everybridge for a facilitytypeYesHIP / HIU etcStringValidated by HIECMActiveYesTrue/falsebooleanAccept Boolean valueFind bridge by service idThis API will fetch the bridge details for the given service id.URL: /api/hiecm/gateway/v3/bridge-service/serviceId/{serviceId}Request: GETHeader Parameters:Property NameExample ValueRequiredDescriptionAuthorizationeyJhbGciOiJSUzUxMiJ9. eyJzdWIiOiJ2YXNhbnRoY Wt1bWFyLmtlc2F2YW5Ac 2J4IiwiY2xpZW50SWQiOi JzYngiLCJzeXN0ZW0iOiJBQkhBLUEiLCJyZXF1ZXN0Z XJJZCI6IlBIUi1XRUIiLCJwaHJNb2JpbGUiOm51bGws ImV4cCI6MTY2NzI5ODExNSwiaWF0IjoxNjY3MjkwOTE1LCJwaHJBZGRyZXNzIjoidmFzYW50aGFrdW1hci5 rZXNhdmFuQHNieCIsInR 4bklkIjoiYjEwMGM4ZDMt NTE1ZC00YWFiLTg1OWQtY zNlMTUwOTE3ZGY1In0YesJWT Access token which was issued by ABDM session API after successful validation of client id and secret.REQUEST-ID18235d89-cb13-479dad71-7a57d5f669a8YesUnique UUID for tracking the end-to-endrequest transactionTIMESTAMP2022-10-06T10:10:00.587ZYesThe actual time when the request was initiated, ISO Date time format represents the date and timeX-CM-IDsbxYesSuffix of the consent manager to which the request was intended.Response:ResponseCode : 200 Ok{"id": 1561,"bridgeId": "SBX_XXXX", "serviceId": "TestClinicHIP", "name": "TestClinicHIP","isHip": true,"isHiu": true, "isPhr": false,"endpoints": {}, "active": true,"registerTime": "2021-03-01 11:17:35.1735","dateCreated": "2021-03-01 11:17:35.1735","dateModified": "2024-04-22 11:04:46.446"}Find services by bridge idThis API will fetch all the service ID details linked with the respective bridge id.URL: /api/hiecm/gateway/v3/bridge-servicesRequest: GETHeader Parameters:Property NameExample ValueRequiredDescriptionAuthorizationeyJhbGciOiJSUzUxMiJ9. eyJzdWIiOiJ2YXNhbnRoY Wt1bWFyLmtlc2F2YW5Ac 2J4IiwiY2xpZW50SWQiOi JzYngiLCJzeXN0ZW0iOiJBQkhBLUEiLCJyZXF1ZXN0Z XJJZCI6IlBIUi1XRUIiLCJwaHJNb2JpbGUiOmYesJWT Access token which was issued by ABDM session API after successful validation of client id and secret.REQUEST-ID18235d89-cb13-479dad71-7a57d5f669a8YesUnique UUID for tracking the end-to-endrequest transactionTIMESTAMP2022-10-06T10:10:00.587ZYesThe actual time when the request was initiated, ISO Date time format represents the date and timeX-CM-IDsbxYesSuffix of the consent manager to which the request was intended.Response:ResponseCode : 200 Ok{"bridge": {"id": "SBX_XXXX","name": "Testing","url": "https://abdcb.doctor9.com", "active": true,"blocklisted": false},"services": [{"id": "@#$%^&*(","name": "hello", "types": ["HIP", "HIU"],"endpoints": { "hipEndpoints": [{"use": "registration","connectionType": "HTTPS", "address":"https://events.hookdeck.com/e/src_3gsnEgI941mh/registration"},{"use": "data-upload","connectionType": "HTTPS", "address":"https://events.hookdeck.com/e/src_3gsnEgI941mh/data-upload"}],"hiuEndpoints": [{"use": "registration","connectionType": "HTTPS", "address":"https://events.hookdeck.com/e/src_3gsnEgI941mh/registration"},{"use": "data-upload","connectionType": "HTTPS", "address":"https://events.hookdeck.com/e/src_3gsnEgI941mh/data-upload"}],"healthLockerEndpoints": [{"use": "registration","connectionType": "HTTPS", "address":"https://events.hookdeck.com/e/src_3gsnEgI941mh/registration"},{"use": "data-upload","connectionType": "HTTPS", "address":"https://events.hookdeck.com/e/src_3gsnEgI941mh/data-upload"}]},"active": true}]}Scan and Profile ShareOverviewThe User/Patient can share his/her basic KYC information with theHMIS/LIMS by scanning the QR Code using the integrator application (Example: ABHA App), which enables them to complete the seamless profile share during their visit.The authenticity of the profile information is verified by the HIE-CM internally before sharing with the HMIS/LIMS.The content of the QR code is a URL (sample for reference: https://phrsbx.abdm.gov.in/share-profile?hipid=IN3410000260&counterid=12345) that contains 2 parameters:The HIP IDFacility defined context (for example: counter code)Sequence Diagram1234439284972List of APIsProfile shareThis API will be invoked from the integrator application (any PHR application, just like ABHA) to share the user/patient profile with HMIS/LIMS.URL: /api/hiecm/patient-share/v3/shareMethod: POSTRequest Headers:Property NameExample ValueRequiredDescriptionREQUEST-ID18235d89-cb13-479d-ad71-7a57d5f669a8YesUnique UUID for track the end to end requesttransactionTIMESTAMP2022-10-06T10:10:00.587ZYesActual time when request was initiated, ISO Date time format represents date and timeAuthorizatio neyJhbGciOiJSUzUxMiJ9. eyJzdWIiOiJ2YXNhbnRoYWt1bWFyLmtlc 2F2 YW5Ac2J4IiwiY2xpZW50SWQiOiJzYngiLCJzeXN0ZW0iOiJBQkhBLUEiLCJy ZXF1ZXN0ZXJJZCI6IlBIUi1XRUIiLCJwaHJNb2JpbGUiOm51bGwsImV4c CI6MTY2NzI5ODExNSwiaWF0IjoxNjY3MjkwOTE1LCJwaHJBZGRyZXNzIjoidmFzYW50aGFrdW1hci5rZX NhdmFuQHNieCIsInR4bklkIjoiYjEwMGM4ZDMtNTE1ZC00YWFiLTg1O WQtYzNlMTUwOTE3ZGY1In0YesJWT Access token which was issuedby ABDM session API after successfulvalidation of client id and secretX-HIU-IDIN2810014366YesIdentifier of the health information user to which the request was intendedX-CM-IDsbxYesSuffix of the consent manager to which the request was intendedX-AUTH-TOKENeyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJna XJpamFAc2J4IiwiY2xpZW50SWQiOiJQS FItV0VCIiwicmVxdWVzdGVySWQiOiJrX 2hpcCIsInN5c3RlbSI6IkFCRE0iLCJtb2Jp bGUiOiI4MjgxMTQ3MDgwIiwiZXhwIjoxNjc3NjY5NDU1LCJpYXQiOjE2Nzc2NjIyNTUsInRyYW5zYWN0aW9uSWQiOiJkMmY5O TNkNi1kODg4LTQyMTMtOTc3My0wYmJj MzMwMjVhNGYiLCJhYmhhQWRkcmVzc yI6ImdpcmlqYUBzYngifQ.Ad_jGrduH6_krBBnlRO912mQabxMOiB0GN6FjdZjoiCQY4AkUD3McGq2NR-X- GAjHVpkRtKx69m4_44h-YesJWT Access token which was issued by IDP service after successfully user authenticatio nFqTCbZlo09hq0SEM1KBMkPDl163JcFNMJGnXBa5E-mu6DpBSPA-VirSvBVj6CEpZLbTa2nBBSJJi_leszwHNrkdope6rSc2G3SJfCW_DzFmzd_fxdvbFCN1yyhN3Rw5r8A1GnSrVSBhRjm4qy5O_ gutl1XW9CaBaZSah7GOxGRr4gpSIJJvIL WovwG58DyNzEhrHtAfIje_pegqRsNMO FI-xPYJd2x6CcDKSoAXvXO0jbuoOvlPl5kh plOKU-WcFeWABody Parameters:Property NameExample ValueRequire dDescriptionintent"PROFILE_SHARE"YesThis is a key value pair which contains the purpose with following possible values.Profile_share PaymentHealth_record_sharingmetaData{"hipId": "Test_HIP", "context": "ABC123", "hprId":"abdulkalam@abdm", "latitude": "-38.679","longitude": "58.498" }YesThis is a key value pair which contains the location longitude and latitude.hipId:- healthInformationProviderId context:- counterCodehprId:- healthprofessionalregisterIdprofile{"patient": {"abhaNumber": 18443810806111,"abhaAddress": "1844381@abdm","name": "User 1","gender": "M","dayOfBirth": "20","monthOfBirth": "1","yearOfBirth": "1999", "address": {"line":"C/OSandipan Kshirsagar Ambejogai Road Renuka Nagar Latur","district": null, "state": null, "pincode": null ,}"phoneNumber": "9876543210"}}YesThis is key value pair which contains patient detailsRequest Body1320038248374Request Body:Request Body:{"intent": "PROFILE_SHARE","metaData": {"hipId": "MAYUR_HIP","context": "ABC123","hprId": "abdulkalam@abdm", "latitude": "-38.679","longitude": "58.498"},"profile": {"patient": {"abhaNumber": 91178386101251, "abhaAddress": "9117838@sbx", "name": "User 1","gender": "M","dayOfBirth": "10","monthOfBirth": "10","yearOfBirth": "1994", "address": {"line": "C/O Sandipan Kshirsagar Ambejogai Road Renuka Nagar", "district": null,"state": null, "pincode": null},"phoneNumber": "9876543210"}}}{"intent": "PROFILE_SHARE","metaData": {"hipId": "MAYUR_HIP","context": "ABC123","hprId": "abdulkalam@abdm", "latitude": "-38.679","longitude": "58.498"},"profile": {"patient": {"abhaNumber": 91178386101251, "abhaAddress": "9117838@sbx", "name": "User 1","gender": "M","dayOfBirth": "10","monthOfBirth": "10","yearOfBirth": "1994", "address": {"line": "C/O Sandipan Kshirsagar Ambejogai Road Renuka Nagar", "district": null,"state": null, "pincode": null},"phoneNumber": "9876543210"}}}ResponseResponse:Code: 202 ACCEPTEDProfile share – CallbackThis is a callback API for patient share API.URL: {callback_url}/api/v3/hip/patient/shareMethod: PostRequest Headers:Property NameExample ValueRequiredDescriptionREQUEST-ID18235d89-cb13-479d-ad717a57d5f669a8YesUnique UUID for track the end to end request transactionTIMESTAMP2022-10-06T10:10:00.587ZYesActual time when request was initiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds and millisecondsX-HIP-IDIN2810014366YesIdentifier of the health information provider to which the request was intendedBody parametersProperty NameExample ValueRequiredDescriptionintentPROFILE_SHAREYesThis is a key value pair which contains the purpose with following possible values.Profile_share PaymentHealth_record_sharingmetaData"metaData": {"hipId":"MAYUR_HIP","context": "ABC123","hprId": "abdulkalam@abdm","latitude": "-38.679","longitude": "58.498"}YesThis is a key value pair which contains the location longitude and latitude. hipId:- healthInformationProviderId context:- counterCodehprId:- healthprofessionalregisterIdprofile"profile": {"patient": {"abhaNumber": 91178386176531,YesThis is key value pair which contains all the patient details"abhaAddress": "91178386@sbx","name": "User 1","gender": "M","dayOfBirth": "10","monthOfBirth": "10","yearOfBirth": "1994", "address": {"line": "C/O Sandipan Kshirsagar Ambejogai Road","district": null, "state": null, "pincode": null},"phoneNumber": "9876543210"}Request Body1316989246588Request Body:Request Body:{"intent": "PROFILE_SHARE","metaData": {"hipId": "MAYUR_HIP","context": "ABC123","hprId": "abdulkalam@abdm", "latitude": "-38.679","longitude": "58.498"},"profile": {"patient": {"abhaNumber": 9117838615XXXX, "abhaAddress": "91178XXXX@sbx", "name": "User 1","gender": "M","dayOfBirth": "XX", "monthOfBirth": "XX", "yearOfBirth": "XXXX", "address": {"line": "C/O Sandipan Kshirsagar Ambejogai Road Renuka Nagar", "district": null,"state": null, "pincode": null},"phoneNumber": "987654XXXX"}} }{"intent": "PROFILE_SHARE","metaData": {"hipId": "MAYUR_HIP","context": "ABC123","hprId": "abdulkalam@abdm", "latitude": "-38.679","longitude": "58.498"},"profile": {"patient": {"abhaNumber": 9117838615XXXX, "abhaAddress": "91178XXXX@sbx", "name": "User 1","gender": "M","dayOfBirth": "XX", "monthOfBirth": "XX", "yearOfBirth": "XXXX", "address": {"line": "C/O Sandipan Kshirsagar Ambejogai Road Renuka Nagar", "district": null,"state": null, "pincode": null},"phoneNumber": "987654XXXX"}} }ResponseResponse:Response: In call back url below details should be displayed as per the Xauth token{"intent":"PROFILE_SHARE","metaData":{"hipId":"MAYUR_HIP","context":"6","hprId":"abdulkal am@hpr.abdm","latitude":"-38.670","longitude":"58.498"},"profile":{"patient":{"abhaNumber":"91178386156891","abhaAddr ess":"911783XX@sbx","name":"User 1","gender":"M","dayOfBirth":"XX","monthOfBirth":"XX","yearOfBirth":"XXXX","address":{"line":null,"district":null,"state":null,"pincode":null},"phoneNumber":"987654XXXX"}}}Code: 200 OKProfile on-shareThis API will be invoked by HIP to acknowledge the request by the user/patient to share the profile details.URL: /api/hiecm/patient-share/v3/on-shareMethod: PostRequest Headers:Property NameExample ValueRequiredDescriptionREQUEST-ID18235d89-cb13-479d-ad71-7a57d5f669a8YesUnique UUID for track the end to end request transactionTIMESTAMP2022-10-06T10:10:00.587ZYesActual time when request wasinitiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds and millisecondsAuthorizationeyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJ2YXNhbnRoYWt1bWFyLmtlc 2F2YW5Ac2J4IiwiY2xpZW50SWQiOiJz YngiLCJzeXN0ZW0iOiJBQkhBLUEiLCJy ZXF1ZXN0ZXJJZCI6IlBIUi1XRUIiLCJwaHJNb2JpbGUiOm51bGwsImV4c CI6MTY2NzI5ODExNSwiaWF0IjoxNjY3MjkwOTE1LCJwaHJBZGRyZXNzIjoidmFzYW50aGFrdW1hci5rZX NhdmFuQHNieCIsInR4bklkIjoiYjEwMGM4ZDMtNTE1ZC00YWFiLTg1O WQtYzNlMTUwOTE3ZGY1In0YesJWT Access token which was issued by ABDM session API after successful validation of client id and secretX-CM-IDsbxYesSuffix of the consent manager to which the request was intendedBody ParametersProperty NameExample ValueRequiredDescriptionabhaAddressABHA addressYesPatient ABHA address against which the health records needs to be linkedstatus“SUCCESS”YesTransaction status from HIP to HIE-CM,“success” “failed”context43YesHMIS/LMIS Counter IDtokenNumber3YesToken number at HMIS/LMIS to be provided to the patientexpiry180YesPatient year of birthrequestIdf29f0e59-8388-46989fe605db67aeac46YesThis is a key value pair which contains the purposeRequest BodyRequest Body:{"acknowledgement": {"abhaAddress": "abc@abdm", "status": "success","profile": {"context": "43","tokenNumber": "3","expiry": "180"}},"response": {"requestId": "f29f0e59-8388-4698-9fe6-05db67aeac46"}}ResponseResponse:Code : 200 OKRequest Body : ERROR-> Use this in case of error response (Ex: This is the one example for error payload and the code will be same. But, message will be change each error).Request Body:{"error": {"code": "ABDM-9999: ","message": "string"},"response": {"requestId": "6f0b4665-a915-4c92-aa36-65afb4a2cd71"}}Profile on share – CallbackThis is a callback API for patient on-share API.URL: {callback_url}/api/v3/hiu/patient/on-shareMethod: PostRequest Headers:Property NameExample ValueRequiredDescriptionREQUEST-ID18235d89-cb13-479d-ad717a57d5f669a8YesUnique UUID for track the end to end request transactionTIMESTAMP2022-10-06T10:10:00.587ZYesActual time when request was initiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds and millisecondsX-HIU-IDABDM_sbxYesSuffix of the HIU to which the request was intendedBody Parameters:Property NameExample ValueRequiredDescriptionabhaAddressABHA addressYesPatient ABHA address against which the health records needs to be linkedStatus“success”YesTrasaction status from HIP to HIE-CM,“success” “failed”Context43YesHMIS/LMIS Counter IDtokenNumber3YesToken number at HMIS/LMIS to be provided to the patientExpiry180YesPatient year of birthrequestIdf29f0e59-8388-46989fe605db67aeac46YesThis is a key value pair which contains the purposeRequest Body1320038118540Request Body:Request Body:"acknowledgement": {"abhaAddress": "abc@abdm", "status": "success","context": "43","tokenNumber": "3","expiry": 180},"response": {"requestId": "f29f0e59-8388-4698-9fe6-05db67aeac46"}}"acknowledgement": {"abhaAddress": "abc@abdm", "status": "success","context": "43","tokenNumber": "3","expiry": 180},"response": {"requestId": "f29f0e59-8388-4698-9fe6-05db67aeac46"}}ResponseResponse:Code: 200 OK1111885265556Scan and Record ShareOverviewThe User/Patient can share his/her basic KYC information with the HMIS/LIMS by scanning the QR Code using the integrator application (Example: ABHA App), which enables them to complete the seamless profile share during their visit.The authenticity of the profile information is verified by the HIE-CM internally before sharing with the HMIS/LIMS.Sequence Diagram1094105197836Record shareThis API will be invoked from the integrator application (any PHR application, just like ABHA) to share the user/patient record with HMIS/LIMS.URL: /api/hiecm/patient-share/v3/share Method:Post Request Headers:Property NameExample ValueRequiredDescriptionREQUEST-ID18235d89-cb13-479d-ad71-7a57d5f669a8YesUnique UUID for track the end to end request transactionTIMESTAMP2022-10-06T10:10:00.587ZYesActual time when request was initiated, ISO 8601 represents date andtime by starting with the year, followed by the month, the day, the hour, the minutes, seconds and millisecondsAuthorizationeyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJ2YXNhbnRoYWt1bWFyLmtlc 2F2YW5Ac2J4IiwiY2xpZW50SWQiOiJz NhdmFuQHNieCIsInR4bklkIjoiYjEwMGM4ZDMtNTE1ZC00YWFiLTg1O WQtYzNlMTUwOTE3ZGY1In0YesJWT Access token which was issued by ABDM session API after successful validation of client id and secretX-CM-IDsbxYesSuffix of the consent manager to which the request was intendedX-Auth-TOKENeyJhbGciOiJSUzUxMiJ9._gutl1XW9CaBaZSah7GOxGRr4gpSIJJvILWovwG58DyNzEhrHtAfIje_pegqRsNM OFI-xPYJd2x6CcDKSoAXvXO0jbuoOvlPl5kh plOKU-WcFeWAYesJWT Access token which was issued by IDP service after successfully user authenticationX-HIU-IDHIU_IDYesIdentifier of the health information user to which the request was intendedBody ParametersProperty NameExample ValueRequiredDescriptionIntentRECORD_SHAREYesThis is a key value pair which contains the purpose with following possible values.Profile_share PaymentHealth_record_sharingmetadata{"hipId":"Test_HIP","context":"ABC123", "hprId":"XXXXXX@abdm","latitude": "-38.679","longitude": "58.498" }YesThis is a key value pair which contains the location longitude and latitude.hipId:- healthInformationProviderId context:- counterCodehprId:- healthprofessionalregisterIdhealthInfo Bundle{"content":"eyJhbGciOiJSUzUxMiJ 9-KCAiC5GZd3aPROr5WtlyQ-Csz2N0taGCOMNjrd5J TbbayA","media": "Json", "checkSum": "abcdefg12","careContextReferenc e": "Blood test"}YesPatient health record to be shared.Request Body1373377116757Request BodyRequest Body{"intent" : "RECORD_SHARE" ,"metaData" : { "hipId" : "HIP_ID" ,"context" : "ABC123" ,"hprId" : "abdulkalam@abdm" , "latitude" : "-37.519 ","longitude" : "58.498"},"profile": {"patient": {"abhaNumber": 9117838615XXXX, "abhaAddress": "91178XXX@sbx", "name": "User 1","gender": "M","dayOfBirth": "XX", "monthOfBirth": "XX", "yearOfBirth": "XXXX", "address": {"line": "C/O Sandipan Kshirsagar Ambejogai Road Renuka Nagar", "district": null ,"state": null , "pincode": null},"phoneNumber": "987654XXXX"}},"healthInfoBundle" : {"content" : “eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxODQ0MzgxMDgwNjQ0MEBh0EtAAibtzTS2yF- Bq0_6fbIymHjv4_IpIcyU9aSFEC2VYgHxuoGEFC5FEje8-FAua8{"intent" : "RECORD_SHARE" ,"metaData" : { "hipId" : "HIP_ID" ,"context" : "ABC123" ,"hprId" : "abdulkalam@abdm" , "latitude" : "-37.519 ","longitude" : "58.498"},"profile": {"patient": {"abhaNumber": 9117838615XXXX, "abhaAddress": "91178XXX@sbx", "name": "User 1","gender": "M","dayOfBirth": "XX", "monthOfBirth": "XX", "yearOfBirth": "XXXX", "address": {"line": "C/O Sandipan Kshirsagar Ambejogai Road Renuka Nagar", "district": null ,"state": null , "pincode": null},"phoneNumber": "987654XXXX"}},"healthInfoBundle" : {"content" : “eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxODQ0MzgxMDgwNjQ0MEBh0EtAAibtzTS2yF- Bq0_6fbIymHjv4_IpIcyU9aSFEC2VYgHxuoGEFC5FEje8-FAua8109301259055FMrWAsTwioxbGujqjvcM9OC1BUrRakmAVxk7GGfmF7jQC8wBxHCsz2N0taGCOMNjrd5JTbbayA”,FMrWAsTwioxbGujqjvcM9OC1BUrRakmAVxk7GGfmF7jQC8wBxHCsz2N0taGCOMNjrd5JTbbayA”,483654059055-KCAiC5GZd3aPROr-KCAiC5GZd3aPROr6368541590555WtlyQ -5WtlyQ -1300225174154"media" : "Json" ,"checkSum" : "abcdefg12" ,"careContextReference" : "Blood test""media" : "Json" ,"checkSum" : "abcdefg12" ,"careContextReference" : "Blood test"1189024695362}}1079296898054}}1016000-6859085ResponseResponse:Code : 202 AcceptedRecord share - CallbackThis is a callback API for patient share API.URL: {callback_url}/api/v3/hip/patient/shareMethod: PostRequest Headers:Property NameExample ValueRequiredDescriptionREQUEST-ID18235d89-cb13-479d-ad71-7a57d5f669a8YesUnique UUID for track the end to end request transactionTIMESTAMP2022-10-06T10:10:00.587ZYesActual time when request wasinitiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds and millisecondsAuthorizationeyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJ2YXNhbnRoYWt1bWFyLmtlc 2F2CJwaHJNb2JpbGUiOm51bGwsImV4c CI6MTY2NzI5ODExNSwiaWF0IjoxNjY3MjkwOTE1LCJwaHJBZYesJWT Access token which was issued by ABDM session API after successful validation of client id and secretX-CM-IDsbxYesSuffix of the consent manager to which the request was intendedX-HIP-IDHIU_IDYesIdentifier of the health information provider to which the request was intendedBody ParametersProper tyNameExample ValueRequiredDescriptionIntentRECORD_SHAREYesThis is a key value pair which contains the purpose with following possible values.Profile_share PaymentHealth_record_sharingmetada ta{"hipId":"Test_HIP", "counterId":"ABC123", "hprId": "abdulkalam@abdm","latitude": "-38.679","longitude": "58.498" }YesThis is a key value pair which contains the location longitude and latitudehealthIn Bundle{"content":"eyJhbGciOiJSUzUxMi J9.eyJzdWIiOiIxODQ0 MzgxMDgwNjQ0MEB hYmRtIiwiY -FAua85WtlyQ-Csz2N0taGCOMNjrd 5JTbbayA","media": "Json", "checkSum": "abcdefg12","careContextReferen ce": "Blood test"}YesConsists of the health information that must be shared with the HIP with encrypted care context contentRequest BodyRequest Body:{"intent": "RECORD_SHARE","metaData": { "hipId": "HIP_ID","counterId": "ABC123", "hprId": "XXXXXXX@abdm","latitude": "-37.519","longitude": "58.498"},"healthInfoBundle": {"content": “eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxODQ0MzgxMDgwNjQ0MEBhYmRFAua8 FMrWAsTwioxbGujqjvcM9OC1BUrRakmAVxk7GGfmF7jQC8wBxH-KCAiC5GZd3aPROr5WtlyQCsz2N0taGCOMNjrd5JTbbayA”, "media": "Json","checkSum": "abcdefg12","careContextReference": "Blood test"}}"latitude": "-37.519","longitude": "58.498"},"healthInfoBundle": {"content": “eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxODQ0MzgxMDgwNjQ0MEBhYmRFAua8 FMrWAsTwioxbGujqjvcM9OC1BUrRakmAVxk7GGfmF7jQC8wBxH-KCAiC5GZd3aPROr5WtlyQCsz2N0taGCOMNjrd5JTbbayA”, "media": "Json","checkSum": "abcdefg12","careContextReference": "Blood test"}}ResponseResponse:Code: 202 Accepted1461683218440Record on-shareThis API will be invoked by HIP to acknowledge the request by the integrator application (any PHR application, just like ABHA) to share record.URL: /api/hiecm/patient-share/v3/on-shareMethod: POSTRequest Headers:Property NameExample ValueRequiredDescriptionREQUEST-ID18235d89-cb13-479d-ad71-7a57d5f669a8YesUnique UUID for track the end to end request transactionTIMESTAMP2022-10-06T10:10:00.587ZYesActual time when request was initiated, ISO Date time format represents date and timeAuthorizationeyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJ2YXNhbnRoYWt1bWFyLmtlc 2F2YW5Ac2J4IiwiY2xpZW50SWQiOiJz YngiLCJzeXN0ZW0iOiJBQkhBLUEiLCJy ZXF1ZXN0ZXJJZCI6IlBIUi1XRUIiLCJwaHJNb2JpbGUiOm51bGwsImV4c CI6MTY2NzI5ODExNSwiaWF0IjoxNjY3MjkwOTE1LCJwaHJBZGRyZXNzIjoidmFzYW50aGFrdW1hci5rZX NhdmFuQHNieCIsInR4bklkIjoiYjEwMGM4ZDMtNTE1ZC00YWFiLTg1O WQtYzNlMTUwOTE3ZGY1In0YesJWT Access token which was issued by ABDM session API after successful validation of client id and secretX-CM-IDsbxYesSuffix of the consent manager to which the request was intendedBody ParametersProperty NameExample ValueRequiredDescriptionabhaAddressABHA addressabhaAddressABHA addressStatus“success”Status“success”healthInformation{"healthInformationReference": "123456"}payment{"paymentReference": "abc"}requestIdf29f0e59-8388-46989fe605db67aeac46YesThis is a key value pair which contains the purposeRequest BodyRequest Body{"acknowledgement": { "status": "SUCCESS","abhaAddress": "XXXXXX@abdm", "healthInformation": {"healthInformationReference": "123456"}},"response": {"requestId": "ecf0cb2d-5178-40d3-85fa-14d25f6bdc0d"}ResponseResponse:Code: 202 ACCEPTEDRecord on-share – CallbackThis is a callback API for patient on-share.URL: {callback_url}/api/v3/hiu/patient/on-shareMethod: POSTRequest Headers:Property NameExample ValueRequiredDescriptionREQUEST-ID18235d89-cb13-479d-ad71-7a57d5f669a8YesUnique UUID for track the end to end request transactionTIMESTAMP2022-10-06T10:10:00.587ZYesActual time when request was initiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds and millisecondsX-HIU-IDABDM_sbxYesSuffix of the HIU to which the request was intendedAuthorizationeyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJ2YXNhbnRoYWt1bWFyLmtlc2F2 YW5Ac2J4IiwiY2xpZW50SWQiOiJz YngiLCJzeXN0ZW0iOiJBQkhBLUEiLCJyZXF1ZXN0ZXJJZCI6IlBIUi1XRUIiLCJwaHJNb2JpbGUiOm51bGwsImV4c CI6MTY2NzI5ODExNSwiaWF0IjoxNjY3MjkwOTE1LCJwaHJBZGRyZXNzIjoidmFzYW50aGFrdW1hci5rZX NhdmFuQHNieCIsInR4bklkIjoiYjEwMGM4ZDMtNTE1ZC00YWFiLTg1O WQtYzNlMTUwOTE3ZGY1In0YesJWT Access token which was issued by ABDM session API after successful validation of client id and secretBody parametersProperty NameExample ValueRequiredDescriptionabhaAddressABHA addressYesPatient ABHA address against which the health records needs to be linkedStatus“success”YesTrasaction status from HIP to HIE-CM,“success” “failed”healthInformationReferenceYesrequestIdf29f0e59-8388-46989fe605db67aeac46YesThis is a key value pair which contains the purposeRequest BodyRequest Body:{"acknowledgement": { "status": "SUCCESS","abhaAddress": "XXXXXXXX@abdm", "healthInformation": {"healthInformationReference": "123456"}},"response": {"requestId": "ecf0cb2d-5178-40d3-85fa-14d25f6bdc0d"}}ResponseResponse:Code: 200 OK1294130221284Scan and PayOverviewThe User/Patient can share his/her basic KYC information with theHMIS/LIMS by scanning the QR Code using the integrator application (Example: ABHA App), which enables them to complete the seamless profile share during their visit.The authenticity of the profile information is verified by the HIE-CM internally before sharing with the HMIS/LIMS.Sequence Diagram1456689262217List of APIsPayment shareThis API will be invoked from the integrator application (any PHR application, just like ABHA) to share the user/patient payment details with HMIS/LIMS.URL: /api/hiecm/patient-share/v3/shareMethod: PostRequest Headers:Property NameExample ValueRequiredDescriptionREQUEST-ID18235d89-cb13-479d-ad71-7a57d5f669a8YesUnique UUID for track the end to end request transactionTIMESTAMP2022-10-06T10:10:00.587ZYesActual time when request wasinitiated, ISO Date time format represents date and timeAuthorizationeyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJ2YXNhbnRoYWt1bWFyLmtlc 2F2YW5Ac2J4IiwiY2xpZW50SWQiOiJz YngiLCJzeXN0ZW0iOiJBQkhBLUEiLCJy ZXF1ZXN0ZXJJZCI6IlBIUi1XRUIiLCJwaHJNb2JpbGUiOm51bGwsImV4c CI6MTY2NzI5ODExNSwiaWF0IjoxNjY3MjkwOTE1LCJwaHJBZGRyZXNzIjoidmFzYW50aGFrdW1hci5rZX NhdmFuQHNieCIsInR4bklkIjoiYjEwMGM4ZDMtNTE1ZC00YWFiLTg1O WQtYzNlMTUwOTE3ZGY1In0YesJWT Access token which was issued by ABDM session API after successful validation of client id and secretX-HIU-IDHIU_IDYesIdentifier of the health information user to which the request was intendedX-CM-IDsbxYesSuffix of the consent manager to which the request was intendedX-AUTH-TOKENeyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJna XJpamFAc2J4IiwiY2xpZW50SWQiOiJQS FItV0VCIiwicmVxdWVzdGVySWQiOiJrX 2hpcCIsInN5c3RlbSI6IkFCRE0iLCJtb2Jp bGUiOiI4MjgxMTQ3MDgwIiwiZXhwIjoxNjc3NjY5NDU1LCJpYXQiOjE2Nzc2NjIyNT WcFeWAYesJWT Access token which was issued by IDP service after successfully user authenticationBody ParametersProperty NameExample ValueRequiredDescriptionIntent"PAYMENT_SHARE"YesThis is a key value pair which contains the purpose with following possible values.Profile_share PaymentHealth_record_sharingmetadata{"hipId": "Test_HIP", "counterId": "ABC123", "hprId":"abdulkalam@abdm", "latitude": "-38.679",YesThis is a key value pair which contains the location longitude and latitude.hipId:- healthInformationProviderId context:- counterCodehprId:- healthprofessionalregisterId"longitude": "58.498"}paymentBundle{"upiAddress": "upi@gmail.com","orderNo":"123","amount":1100.123, "merchantId":"LGKYL67895#567y","description": "Testt"}YesConsists of payment information such as the upi address, payment amount, order details and the merchant informationRequest Body1376425117782Request Body:Request Body:{"intent": "payment_share", "metaData": {"hipId": "HIP_ID","counterId": "ABC123", "hprId": "XXXXX@abdm", "latitude": "-37.519","longitude": "58.494"},"profile": {"patient": {"abhaNumber": {{abha-number}},"abhaAddress": "{{abha-address}}", "name": "User 1","gender": "M","dayOfBirth": "XX", "monthOfBirth": "XX", "yearOfBirth": "XXXX", "address": {"line": "C/O Sandipan Kshirsagar Ambejogai Road Renuka Nagar", "district": null,"state": null, "pincode": null},"phoneNumber": "9876543210"}},"paymentBundle": {"upiAddress": "upi@gmail.com", "orderNo": "123","amount": 1100.123,"merchantId": "LGKYL67895#567y", "description": "Testt"}}{"intent": "payment_share", "metaData": {"hipId": "HIP_ID","counterId": "ABC123", "hprId": "XXXXX@abdm", "latitude": "-37.519","longitude": "58.494"},"profile": {"patient": {"abhaNumber": {{abha-number}},"abhaAddress": "{{abha-address}}", "name": "User 1","gender": "M","dayOfBirth": "XX", "monthOfBirth": "XX", "yearOfBirth": "XXXX", "address": {"line": "C/O Sandipan Kshirsagar Ambejogai Road Renuka Nagar", "district": null,"state": null, "pincode": null},"phoneNumber": "9876543210"}},"paymentBundle": {"upiAddress": "upi@gmail.com", "orderNo": "123","amount": 1100.123,"merchantId": "LGKYL67895#567y", "description": "Testt"}}ResponseResponse:Code: 202 ACCEPTEDPayment share – CallbackThis is a callback API for payment share.URL: {callback_url}/api/v3/hip/patient/shareMethod: POSTRequest Headers:Property NameExample ValueRequiredDescriptionREQUEST-ID18235d89-cb13-479d-ad71-7a57d5f669a8YesUnique UUID for track the end to end request transactionTIMESTAMP2022-10-06T10:10:00.587ZYesActual time when request was initiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, thehour, the minutes, seconds and millisecondsX-HIP-IDIN2810014366YesIdentifier of the health information provider to which the request was intendedAuthorizationeyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJ2YXNhbnRoYWt1bWFyLmtlc2F2 YW5Ac2J4IiwiY2xpZW50SWQiOiJz YngiLCJzeXN0ZW0iOiJBQkhBLUEiLCJyZXF1ZXN0ZXJJZCI6IlBIUi1XRUIiLCJwaHJNb2JpbGUiOm51bGwsImV4c CI6MTY2NzI5ODExNSwiaWF0IjoxNjY3MjkwOTE1LCJwaHJBZGRyZXNzIjoidmFzYW50aGFrdW1hci5rZX NhdmFuQHNieCIsInR4bklkIjoiYjEwMGM4ZDMtNTE1ZC00YWFiLTg1OWQtYzNlMTUwOTE3ZGY1In0YesJWT Access token which was issued by ABDM session API after successful validation of client id and secretBody parametersProperty NameExample ValueRequiredDescriptionIntent{“purpose”: “profile_share”, “hip_id”: “ABDM_HIP”,"context”: “43”}YesThis is a key value pair which contains the purposemetadata{lat: 20.5937,long: 78.9629 }YesThis is a key value pair which contains the location longitude and latitude.hipId:- healthInformationProviderId context:- counterCodehprId:- healthprofessionalregisterIdpaymentBundle{"upiAddress": "upi@gmail.com","orderNo": "123","amount": 1100.123, "merchantId":"LGKYL67895#567y","description": "Testt"}YesConsists of payment information such as the upi address, payment amount, order details and the merchant informationRequest BodyRequest Body:{"intent": "payment_share", "metaData": {"hipId": "HIP_ID","counterId": "ABC123","hprId": "XXXXXXXX@abdm", "latitude": "-37.519","longitude": "58.494"},"profile": {"patient": {"abhaNumber": {{abha-number}},"abhaAddress": "{{abha-address}}", "name": "User 1","gender": "M","dayOfBirth": "XX","monthOfBirth": "XX", "yearOfBirth": "XXXX", "address": {"line": "C/O Sandipan Kshirsagar Ambejogai Road XXXXXX","district": null, "state": null,"pincode": null},"phoneNumber": "987654XXXX"}},"paymentBundle": {"upiAddress": "upi@gmail.com", "orderNo": "123","amount": 1100.123,"merchantId": "LGKYL67895#567y", "description": "Testt"}}ResponseResponse:Code: 200 OK1348739186144Payment on-shareThis is an API called by HIP as a response to payment share API call.URL: /api/hiecm/patient-share/v3/on-shareMethod: POSTRequest Headers:Property NameExample ValueRequiredDescriptionREQUEST-ID18235d89-cb13-479d-ad71-7a57d5f669a8YesUnique UUID for track the end to end request transactionTIMESTAMP2022-10-06T10:10:00.587ZYesActual time when request was initiated, ISO Date time format represents date and timeAuthorizationeyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJ2YXNhbnRoYWt1bWFyLmtlc 2F2YW5Ac2J4IiwiY2xpZW50SWQiOiJz YngiLCJzeXN0ZW0iOiJBQkhBLUEiLCJy ZXF1ZXN0ZXJJZCI6IlBIUi1XRUIiLCJwaHJNb2JpbGUiOm51bGwsImV4c CI6MTY2NzI5ODExNSwiaWF0IjoxNjY3MjkwOTE1LCJwaHJBZGRyZXNzIjoidmFzYW50aGFrdW1hci5rZX NhdmFuQHNieCIsInR4bklkIjoiYjEwMGM4ZDMtNTE1ZC00YWFiLTg1O WQtYzNlMTUwOTE3ZGY1In0YesJWT Access token which was issued by ABDM sessionAPI after successful validation of client id and secretX-CM-IDsbxYesSuffix of the consent manager to which the request was intendedBody ParametersProperty NameExample ValueRequiredDescriptionabhaAddressABHA addressYesPatient ABHA address against which the health records needs to be linkedstatus“success”YesTrasaction status from HIP to HIE-CM, “success”“failed”payment{"acknowledgement": {"status":"SUCCESS", "abhaAddress":"XXXXXXXXX@abdm","payment": {"paymentReference": "1234567"}YesSuccess payment statusresponse{"requestId": "37ba8d92ef3c-4a2b-9d4ff25c9e50a23b"}YesRequest Id from the Share apiRequest BodyRequest Body:{"acknowledgement": { "status": "SUCCESS","abhaAddress": "XXXXXX@abdm", "payment": {"paymentReference": "abc"}},"response": {"requestId": "37ba8d92-ef3c-4a2b-9d4f-f25c9e50a23b"}}ResponseResponse:Code: 202 ACCEPTEDPayment on-share – CallbackThis is a callback API for patient on-share.URL: {callback_url}/api/v3/hiu/patient/on-shareMethod: POSTRequest Headers:Property NameExample ValueRequiredDescriptionAuthorizationeyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJ2YXNhbnRoYWt1bWFyLmtlc2F2 YW5Ac2J4IiwiY2xpZW50SWQiOiJz YngiLCJzeXN0ZW0iOiJBQkhBLUEiLCJyZXF1ZXN0ZXJJZCI6IlBIUi1XRUIiLCJwaHJNb2JpbGUiOm51bGwsImV4c CI6MTY2NzI5ODExNSwiaWF0IjoxNjY3MjkwOTE1LCJwaHJBZGRyZXNzIjoidmFzYW50aGFrdW1hci5rZX NhdmFuQHNieCIsInR4bklkIjoiYjEwMGM4ZDMtNTE1ZC00YWFiLTg1OWQtYzNlMTUwOTE3ZGY1In0YesJWT Access token which was issued by ABDM session API after successful validation of client id and secretREQUEST-ID18235d89-cb13-479d-ad71-7a57d5f669a8YesUnique UUID for track the end to end request transactionTIMESTAMP2022-10-06T10:10:00.587ZYesActual time when request was initiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, thehour, the minutes, seconds and millisecondsX-HIU-IDABDM_sbxYesSuffix of the HIU to which the request was intendedBody parametersProperty NameExample ValueRequiredDescriptionabhaAddressABHA addressYesPatient ABHA address against which the health records need to be linkedStatus“success”YesTrasaction status from HIP to HIE-CM,“success” “failed”Payment{"acknowledgement":{ "status": "SUCCESS","abhaAddress": "XXXXXXX@abdm","payment": {"paymentReference": "1234567"}YesPayment statusResponse{"requestId": "37ba8d92-ef3c-4a2b-9d4f-f25c9e50a23b"}YesRequest Id from the share api7049769835765Request Body1393189249650Request Body:Request Body:{"acknowledgement": { "status": "SUCCESS","abhaAddress": "XXXXXXX@abdm", "payment": {"paymentReference": "abc"}},"response": {"requestId": "37ba8d92-ef3c-4a2b-9d4f-f25c9e50a23b"}}{"acknowledgement": { "status": "SUCCESS","abhaAddress": "XXXXXXX@abdm", "payment": {"paymentReference": "abc"}},"response": {"requestId": "37ba8d92-ef3c-4a2b-9d4f-f25c9e50a23b"}}ResponseResponse:Code: 200 OK1380489267969Error Codes ListingCodeErrorABDM-1000Unable to connect the databaseABDM-1001No data foundABDM-1002Integrity violationABDM-1003Email Gateway is unavailableABDM-1004SMS Gateway is unavailableABDM-1005Invalid receiverABDM-1006Bad Request, invalid request BodyABDM-1007Connection failed due to timeoutABDM-1008SMS service currently disabledABDM-1009Email service currently disabledABDM-1010Validation failedABDM-1011Gateway database unavailableABDM-1012No records found against the ABHA AddressABDM-1013Invalid ABHA NumberABDM-1014Invalid Mobile EmailABDM-1015Invalid ResponseABDM-1016Invalid TimeStampABDM-1017Invalid TransactionIdABDM-1018Share Profile database unavailableABDM-1019Dependent Service UnavailableABDM-1020Unknown databaseABDM-1021Lack of required priviledgesABDM-1022Too many requestsABDM-1023Invalid UserABDM-1024Dependent service unavailableABDM-1025Invalid ServiceIdABDM-1026Invalid Link TokenABDM-1027You are blocked. Please try again after 24 hours.ABDM-1028HIP is unavailableABDM-1029Redis server is unavailableABDM-1030Invalid request IDABDM-1031Invalid requestABDM-1032Invalid headerABDM-1033HIU is unavailableABDM-1034Notification service unavailableABDM-1035Invalid HIP IDABDM-1035OTP does not matchedABDM-1036Data does not matchedABDM-1037Counter and Care context count mismatchABDM-1038ABHA address and Link token mismatchABDM-1039Invalid Consent request idABDM-1040Invalid HIU IDABDM-1041Invalid AcknowledgementABDM-1042Provider MandatoryABDM-1043ABHA Address does not match with KYC details.ABDM-1044Broadcast FailedABDM-1045Database Access is restrictedABDM-1046Invalid PurposeABDM-1047Purpose does not existABDM-1048TimeoutABDM-1049Invalid Profile Share Intent KeysABDM-1050Invalid Profile Share Metadata KeysABDM-1051Invalid ABHA Number or ABHA AddressABDM-1052Invalid TransactionId or response's requestIdABDM-1053Data already existsABDM-1054Invalid Subscription Request IdABDM-1401HIP is not availableABDM-1402Acknowledgement is not received from HIPABDM-9999Unknown exceptionABDM-1061Consent artefact expiredABDM-1062Consent Not grantedABDM-1063Date Range given is invalidABDM-1064request with this request id already existsABDM-1017Invalid TransactionIdABDM-1109ABHA DB service unavailableABDM-1108Notification DB service unavailableABDM-1205Document DB Gateway is unavailableABDM-1034Notification service unavailableABDM-1029Redis server is unavailableABDM-1202Document Gateway is unavailableABDM-1200LGD Gateway is unavailableABDM-1201IDP Gateway is unavailableABDM-9999Unknown exceptionABDM-1101This ABHA Address already exists. Please create with unique ABHA AddressABDM-1006Invalid combinations of scopesABDM-1100You have requested multiple OTPs Or Exceeded maximum number of attempts for OTP match in this transaction.Please try again in 30 minutes.ABDM-1006Bad Request, invalid request Body \ No newline at end of file diff --git a/writable/tmp_scan_share_docx/word/fontTable.xml b/writable/tmp_scan_share_docx/word/fontTable.xml new file mode 100644 index 0000000..2db0236 --- /dev/null +++ b/writable/tmp_scan_share_docx/word/fontTable.xml @@ -0,0 +1,2 @@ + + diff --git a/writable/tmp_scan_share_docx/word/footer1.xml b/writable/tmp_scan_share_docx/word/footer1.xml new file mode 100644 index 0000000..ee7523c --- /dev/null +++ b/writable/tmp_scan_share_docx/word/footer1.xml @@ -0,0 +1,2 @@ + +38893759851676 PAGE 10 PAGE 10 diff --git a/writable/tmp_scan_share_docx/word/header1.xml b/writable/tmp_scan_share_docx/word/header1.xml new file mode 100644 index 0000000..bce00f6 --- /dev/null +++ b/writable/tmp_scan_share_docx/word/header1.xml @@ -0,0 +1,2 @@ + +450850285749 diff --git a/writable/tmp_scan_share_docx/word/media/image1.png b/writable/tmp_scan_share_docx/word/media/image1.png new file mode 100644 index 0000000..4f395fa Binary files /dev/null and b/writable/tmp_scan_share_docx/word/media/image1.png differ diff --git a/writable/tmp_scan_share_docx/word/media/image2.png b/writable/tmp_scan_share_docx/word/media/image2.png new file mode 100644 index 0000000..35d5458 Binary files /dev/null and b/writable/tmp_scan_share_docx/word/media/image2.png differ diff --git a/writable/tmp_scan_share_docx/word/media/image3.jpeg b/writable/tmp_scan_share_docx/word/media/image3.jpeg new file mode 100644 index 0000000..4ededf4 Binary files /dev/null and b/writable/tmp_scan_share_docx/word/media/image3.jpeg differ diff --git a/writable/tmp_scan_share_docx/word/media/image4.jpeg b/writable/tmp_scan_share_docx/word/media/image4.jpeg new file mode 100644 index 0000000..c9ecf6a Binary files /dev/null and b/writable/tmp_scan_share_docx/word/media/image4.jpeg differ diff --git a/writable/tmp_scan_share_docx/word/media/image5.jpeg b/writable/tmp_scan_share_docx/word/media/image5.jpeg new file mode 100644 index 0000000..4b7d985 Binary files /dev/null and b/writable/tmp_scan_share_docx/word/media/image5.jpeg differ diff --git a/writable/tmp_scan_share_docx/word/media/image6.jpeg b/writable/tmp_scan_share_docx/word/media/image6.jpeg new file mode 100644 index 0000000..07d3f61 Binary files /dev/null and b/writable/tmp_scan_share_docx/word/media/image6.jpeg differ diff --git a/writable/tmp_scan_share_docx/word/media/image7.jpeg b/writable/tmp_scan_share_docx/word/media/image7.jpeg new file mode 100644 index 0000000..6a02b87 Binary files /dev/null and b/writable/tmp_scan_share_docx/word/media/image7.jpeg differ diff --git a/writable/tmp_scan_share_docx/word/media/image8.jpeg b/writable/tmp_scan_share_docx/word/media/image8.jpeg new file mode 100644 index 0000000..887b2c1 Binary files /dev/null and b/writable/tmp_scan_share_docx/word/media/image8.jpeg differ diff --git a/writable/tmp_scan_share_docx/word/numbering.xml b/writable/tmp_scan_share_docx/word/numbering.xml new file mode 100644 index 0000000..ab73499 --- /dev/null +++ b/writable/tmp_scan_share_docx/word/numbering.xml @@ -0,0 +1,2 @@ + + diff --git a/writable/tmp_scan_share_docx/word/settings.xml b/writable/tmp_scan_share_docx/word/settings.xml new file mode 100644 index 0000000..13d7d8e --- /dev/null +++ b/writable/tmp_scan_share_docx/word/settings.xml @@ -0,0 +1,2 @@ + + diff --git a/writable/tmp_scan_share_docx/word/styles.xml b/writable/tmp_scan_share_docx/word/styles.xml new file mode 100644 index 0000000..79e391a --- /dev/null +++ b/writable/tmp_scan_share_docx/word/styles.xml @@ -0,0 +1,2 @@ + + diff --git a/writable/tmp_scan_share_docx/word/theme/theme1.xml b/writable/tmp_scan_share_docx/word/theme/theme1.xml new file mode 100644 index 0000000..f0d7a44 --- /dev/null +++ b/writable/tmp_scan_share_docx/word/theme/theme1.xml @@ -0,0 +1,281 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +