Receive a patient's share request, as the HIU
Hosted by the HIU, not by ABDM. The HIE-CM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL.
This is a callback API for the HIU. The HIE-CM provides the record share request the PHR app raised: the patient's profile, the number of records and the care contexts to share, and a transactionId for the transfer. Reply by calling POST /api/hiecm/patient-record/v3/on-share with the data push URL and the encryption key, carrying this transactionId and this request's REQUEST-ID. 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 callback. ISO 8601 timestamp of when the callback was sent. Identifier of the health information user to which the request was intended. 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 transfer's identifier, assigned by the HIE-CM. Carry it in on-share and in notify. 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 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.Authorizations
Authorizationbearer tokenRequiredHeaders
request-idstringRequiredtimestampstringRequiredx-hiu-idstringRequiredBody
metaDataobjectRequiredmetaData.hiuIdstringRequiredmetaData.counterIdstringRequiredtransactionIdstringRequiredprofileobjectRequiredprofile.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
Where this fits
You produce this callback by calling Share a patient's records with the HIU whose QR code was scanned..