Share HIP patient
Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL.
This is an API will be invoked to the <b>HIP</b> to share the response of HIECM's /api/hiecm/patient-share/v3/share API.
<ol type='1'> <li> <b>Header</b> <ol type='a'> <br/> <li>REQUEST-ID unique UUID[ Example: 18235d89-cb13-479d-ad71-7a57d5f669a8 ]</li> <li>TIMESTAMP actual time of the requested was initiated[ Example: 2022-10-06T10:10:00.587Z ]</li> <li>X-HIP-ID</li> <li>Authorisation will be provided by the gateway session API after the successful verification of client ID and Secret [ Example: <TOKEN> ]</li></ol> </li> <br/><li> <b>Request Body</b> <ol type='a'><br/> <li>intent This is a key value pair which contains the purpose [ Example: {purpose: PROFILE_SHARE } ]</li> <li>metaData This is a key value pair which contains the location longitude and latitude[ Example: {HIP_ID: ABDM_HIP, context: 123, lat: 20.5937 long: 78.9629} ]</li> <li>profile which contains user details.</li> </ol></ol> Unique UUID for track the end to end request transaction Actual time of the 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 milliseconds Identifier of the health information provider to which the request was intended The intention of share API call One of A key-value pair carrying the location longitude and latitude. The service ID of the health information provider. Allows alpha numeric character and special characters like [A-Z a-z 0-9]+[A-Z a-z 0-9 @//_//-]*[A-Z a-z 0-9] This is a counter Id. Allows alpha numeric character and special characters like ^(?:[a-zA-Z0-9 ]|[a-zA-Z0-9 ][a-zA-Z0-9.\\-_ ]*[a-zA-Z0-9 ]){1,250}$ Healthcare Professionals Registry id. Allows alpha numeric character and special characters like [a-zA-Z0-9][a-zA-Z0-9_.]+[a-zA-Z0-9]@(dr.abdm|hpr.abdm)$|^[1-9][0-9]{13}$ The latitude of the location.Allows alpha numeric character and special characters like ^[0-9-.]+$ The longitude of the location.Allows alpha numeric character and special characters like ^[0-9-.]+$ This should populated only for PROFILE_SHARE The abha number of the patient.It should be passed based on the X-AUTH-TOKEN. Should be only 14 digit. Allows alpha numeric character and special characters like ^(\\d+-?){13}\\d$ The abha address of the patient. Should start with Alphanumeric . and _ in the middle and must be ending with @abdm or @sbx and Allows alpha numeric character and special characters like ^[a-zA-Z0-9][a-zA-Z0-9_.\-!]+[a-zA-Z0-9]@(abdm|sbx)$ The name of the patient. Allows alpha numeric character and special characters like ^[a-zA-Z0-9.-_,]+(([',. -][a-zA-Z0-9. ])?[a-zA-Z0-9. ]*)*$ The gender of the patient One of The day of birth of the patient. Only allows numeric values between 1 abd 31 and ^(?!\\s*$)(0?[1-9]|[12][0-9]|3[01])$ The month of birth of the patient. Only allows numeric values between 1 abd 12 and ^(?!\\s*$)(0?[1-9]|[1][0-2])$ The month of birth of the patient. Only allows numeric values and must be 4 digit ranging between 1900 and 2200 and ^(?!\\s*$)(19|20|21|22)\\d{2}$ The address line The district and should only contain alphabets The state and should only contain alphabets like [A-Z a-z]+[A-Z a-z //' ']*$ Should be 5 digits and only contain numbers The mobile number of the patient. Must be 10 digit and contain only 0-9 and it allows only numbers like ^(\+\d{1,3}[- ]?)?\d{10}$ OK Bad Request. The request could not be processed because it was malformed or failed validation - a missing mandatory field, a value in the wrong format, or a header that did not match the body. Unauthorized. The request carried no valid credentials, or the access token has expired. Obtain a fresh token from the session API and retry. Forbidden. The caller is authenticated but is not permitted to perform this operation on this resource.Authorizations
Authorizationbearer tokenRequiredHeaders
REQUEST-IDstringRequiredTIMESTAMPstringRequiredX-HIP-IDstringRequiredBody
intentstringRequiredPROFILE_SHARERECORD_SHAREPAYMENT_SHAREmetaDataobjectRequiredmetaData.hipIdstringRequiredmetaData.contextstringRequiredmetaData.hprIdstringmetaData.latitudenumberRequiredmetaData.longitudenumberRequiredprofileobjectRequiredprofile.patientobjectRequiredprofile.patient.abhaNumberstringprofile.patient.abhaAddressstringRequiredprofile.patient.namestringRequiredprofile.patient.genderstringRequiredMFODTUprofile.patient.dayOfBirthstringprofile.patient.monthOfBirthstringprofile.patient.yearOfBirthstringRequiredprofile.patient.addressobjectRequiredprofile.patient.address.linestringRequiredprofile.patient.address.districtstringprofile.patient.address.statestringprofile.patient.address.pincodestringprofile.patient.phoneNumberstringRequiredResponses
200400401403
Where this fits
hiecm-m2.yaml declares this callback at module level and names no call against it. Which call produces it is not documented, so this page does not say.