Looking for help?
List of all MCI URLs
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
- by secondary identifiers – phone number, household code
- for PhoneNo: https://{mci-service}/api/{version}//patients?phone_no=01678904560
- for HouseHold code: https://{mci-service}/api/{version}//patients?household_code=5
- by name or location within an area.
- for Name within geo coded area: https://{mci-service}/api/{version}/patients?given_name=Kabir&present_address=3026149994&sur_name=Das
- for PhoneNo within geo coded area: https://{mci-service}/api/{version}/patients?phone_no=9678909&present_address=100419
- for HouseHold within area: https://{mci-service}/api/{version}/patients?household_code=5&present_address=100419
- Get All Patient by Catchment: GET https://{mci-service}/api/{version}/catchments/100409/patients
Internal APIs
- Approvals (in catchments)
- Get list of pending approvals for patients in catchment: https://{mci-service}/api/{version}/catchments/{location code}/approvals
- Get details of a pending approval: https://{mci-service}/api/{version}/catchments/603602/approvals/{id}
- Get pending approvals since: https://{mci-service}/api/{version}/catchments/100409/approvals?after=(after)
- Accept pending approval: PUT https://{mci-service}/api/{version}/catchments/603602/approvals/11140871455
- Reject pending approval: DELETE https://{mci-service}/api/{version}/catchments/603602/approvals/11140871455
- Get list of pending approvals for patients in catchment: https://{mci-service}/api/{version}/catchments/{location code}/approvals
- Get audit logs for patient: https://{mci-service}/api/{version}/audit/patients/5975391576157847553
- Update feed for SHR: 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): https://{mci-service}/api/{version}/patients/active/{hid}
- Duplicates in a catchment:- GET https://{mci-service}/api/{version}/patients/duplicates/catchments/{catchmentId}
E.g.- https://{mci-service}/api/{version}/patients/duplicates/catchments/3026 - Merge/Retain two duplicate patients:- PUT https://{mci-service}/api/{version}/patients/duplicates/
Internal System APIs
- Heath ID
- Generations
- All HIDs: POST https://{mci-service}/api/{version}/healthIds/generate
- A range of HIDs for MCI: POST https://{mci-service}/api/{version}/healthIds/generateBlock?start={start}&totalHIDs={number_of_hids}
- A range of HIDs for a given organization: POST https://{mci-service}/api/{version}/healthIds/generateBlockForOrg?org={org_code_from_hrm}&start={start}&totalHIDs={number_of_hids}
- Get next block of healthIds: GET https://{mci-service}/api/{version}/healthIds/nextblock
- Generations
All the deduplication URLs – Retain as distinct, merge 2 patients, merge while updating a patient, show all duplicates belonging to one catchment.