API Headers
- Content-Type: application/json
External APIs
...
API Headers
- Content-Type: application/json
External APIs
- A Patient: GET https://{mci-service}/api/{version}/patients/{hid}
e.g https://{mci-service}/api/{version}//patients/5945343868835725313 - Create Patient: POST https://{mci-service}/api/{version}/patients
- Update Patient by HID: PUT https://bdshr-mci-qa.twhosted.com/api/v1/patients/11140871455
- Search Patient: GET https://{mci-service}/api/{version}//patients?nid=(nid)&bin_brn=(brn)&given_name=(name)&sur_name=(surname)&present_address=(geolocation code)
- by other primary identifiers - National ID, Birth Regd No
- ?bin_brn=76543210123456789
- for search with UID
- by secondary identifiers - phone number, household code
- for PhoneNo: https://{mci-service}/api/{version}//patients
- ?phone_no=01678904560
- for HouseHold code: https://
- by name or location within an area.
- for Name within geo coded area: https://{mci-service}/api/{version}
- by other primary identifiers - National ID, Birth Regd No
- for Nid: 3026149994&sur_name=Das
- for PhoneNo within geo coded area: https://{mci-service}/api/{version}//patients?nid=9000000610077for BRN: httpsphone_no=9678909&present_address=100419
- for HouseHold within area: https://{mci-service}/api/{version}//patients?bin_brn=76543210123456789
- for search with UID
- for PhoneNo: httpshousehold_code=5&present_address=100419
- Get All Patient by Catchment: GET https://{mci-service}/api/{version}/catchments/100409/patients?phone_no=01678904560for HouseHold code:
- Generate HIDs:-
- All HIDs:- POST https://{mci-service}/api/{version}//patients?household_code=5by name or location within an area. for Name within geo coded area: healthIds/generate
- A range of HIDs:- POST https://{mci-service}/api/{version}/healthIds/patientsgenerateRange?given_namestart=Kabir9800100010&present_address=3026149994&sur_name=Dasfor PhoneNo within geo coded area: end=9800100215
- Get Next block of healthIds:- GET https://{mci-service}/api/{version}/patients?phone_no=9678909&present_address=100419for HouseHold within area/healthIds/nextblock
Internal APIs
- Approvals (in catchments)
- Get list of pending approvals for patients in catchment: https://{mci-service}/api/{version}/patients?household_code=5&present_address=100419
- catchments/{location code}/approvals
- Get details of a pending approval: https://{mci-service}/api/{version}/catchments/603602/
- approvals/
Generate HIDs:-- All HIDs:- POST https:{id}
- Get pending approvals since: https://{mci-service}/api/{version}/healthIds/generateA range of HIDs:- POST httpscatchments/100409/approvals?after=(after)
- Accept pending approval: PUT https://{mci-service}/api/{version}/catchments/healthIds/generateRange?start=9800100010&end=9800100215
Internal APIs
- Approvals (in catchments)
- Get list of pending approvals for patients in catchment: https603602/approvals/11140871455
- Reject pending approval: DELETE https://{mci-service}/api/{version}/catchments/{location code}603602/approvals/11140871455
- Get details of a pending approval: httpsaudit logs for patient: https://{mci-service}/api/{version}/catchmentsaudit/603602/approvals/{id}Get pending approvals since: httpspatients/5975391576157847553
- Update feed for SHR: https://{mci-service}/api/{version}/catchmentsfeed/100409/approvalspatients?after=(after)Accept pending approval: PUT httpssince=(ISO_FORMAT_TIME) ISO_FORMAT_TIME : 2015-01-15T06:16:57Z
- Update active and merged_with (patient): https://{mci-service}/api/{version}/catchmentspatients/603602/approvals/11140871455Reject pending approval: DELETE active/{hid}
- Duplicates in a catchment:- GET https://{mci-service}/api/{version}/catchmentspatients/603602/approvals/11140871455
- Get audit logs for patient: https://{mci-service}/api/{version}/audit/patients/5975391576157847553
- Update feed for SHR: duplicates/catchments/{catchmentId}
E.g.- https://{mci-service}/api/{version}/feed/patients?since=(ISO_FORMAT_TIME) ISO_FORMAT_TIME : 2015-01-15T06:16:57Z
Update active and merged_with (patient): /patients/duplicates/catchments/3026 Merge/Retain two duplicate patients:- PUT https://{mci-service}/api/{version}/patients/
active/{hid}
All the deduplication URLs - Retain as distinct, merge 2 patients, merge while updating a patient, show all duplicates belonging to one catchment.