Share a patient's records with the HIU whose QR code was scanned
Is the first step in initiating the health data sharing process. It is invoked by an integrator application (such as any PHR application like ABHA) after scanning the HIU's QR code.
The QR code provides the Health Information User (HIU) identifier, which is then used to share the user's profile details and care-context information with the HIE-CM.
The HIE-CM answers 202 Accepted and forwards the request to the HIU as a POST to /api/v3/patient-record/share on the HIU's bridge. The HIU's reply, with the data push URL and encryption key, arrives on the PHR app's /api/v3/patient-record/on-share callback. JWT access token issued by the ABDM session API after successful validation of client id and secret. Random UUID, a v4 style guid, unique per request. ISO 8601 timestamp of when the request was initiated. Identifier of the health information user to which the request was intended. Suffix of the consent manager to which the request was intended. sbx in the sandbox, abdm in production. JWT access token issued by the PHR service after successful user authentication. If the HIP does not have any role, then it is mandatory. The HIU and the counter the QR code named. The HIU's identifier, read from the QR code. The counter at the HIU, read from the QR code. The essential patient details, including ABHA number, ABHA address and the patient's contact address, used for initiating the record share process. The 14 digit ABHA number, or null when the patient has an address only. The patient's ABHA address. M, F or O. Number of records that are to be shared to the health information user (HIU). The care contexts to share, the permission specifying how the records can be accessed, and the dataEraseAt date until which the data remains accessible. The patient reference the care context was linked under. How the HIU may use the records. One of Until when the data remains accessible to the HIU. Accepted. The HIE-CM forwards the request to the HIU; the HIU's data push URL and key arrive on the on-share callback.Authorizations
Authorizationbearer tokenRequiredHeaders
REQUEST-IDstringRequiredTIMESTAMPstringRequiredX-HIU-IDstringRequiredX-CM-IDstringRequiredX-AUTH-TOKENstringRequiredBody
metaDataobjectRequiredmetaData.hiuIdstringRequiredmetaData.counterIdstringRequiredprofileobjectRequiredprofile.patientobjectRequiredprofile.patient.abhaNumberstringnullprofile.patient.abhaAddressstringRequiredprofile.patient.namestringRequiredprofile.patient.genderstringRequiredprofile.patient.dayOfBirthstringprofile.patient.monthOfBirthstringprofile.patient.yearOfBirthstringRequiredprofile.patient.addressobjectRequiredprofile.patient.address.linestringprofile.patient.address.districtstringprofile.patient.address.statestringprofile.patient.address.pincodestringprofile.patient.phoneNumberstringRequiredsharedRecordCountintegerRequiredconsentobjectRequiredconsent.careContextsobject[]Requiredconsent.careContexts.patientReferencestringRequiredconsent.careContexts.careContextReferencestringRequiredconsent.permissionobjectRequiredconsent.permission.accessModestringRequiredVIEWconsent.dataEraseAtstringRequiredResponses
202
Callbacks
- After this call, ABDM posts Receive a patient's share request, as the HIU. to
/api/v3/patient-record/share. Open the callback.