Shared Health Record (EN)

Looking for help?
< All Topics
Print

List of all MCI URLs

API Headers
  • Content-Type: application/json
External APIs 
  1. A Patient: GET https://{mci-service}/api/{version}/patients/{hid}
    e.g  https://{mci-service}/api/{version}//patients/5945343868835725313
  2. Create Patient: POST https://{mci-service}/api/{version}/patients
  3. Update Patient by HID: PUT https://bdshr-mci-qa.twhosted.com/api/v1/patients/11140871455
  4. Search Patient: GET https://{mci-service}/api/{version}//patients?nid=(nid)&bin_brn=(brn)&given_name=(name)&sur_name=(surname)&present_address=(geolocation code)
    1. by other primary identifiers – National ID, Birth Regd No
      1. for Nid: https://{mci-service}/api/{version}//patients?nid=9000000610077
      2. for BRN: https://{mci-service}/api/{version}//patients?bin_brn=76543210123456789
      3. for UID: ahttps://{mci-service}/api/{version}//patients?uid=(uid)
    2. by secondary identifiers –  phone number, household code
      1. for PhoneNo:  https://{mci-service}/api/{version}//patients?phone_no=01678904560
      2. for HouseHold code: https://{mci-service}/api/{version}//patients?household_code=5
    3. by name or location within an area.
      1. for Name within geo coded area:  https://{mci-service}/api/{version}/patients?given_name=Kabir&present_address=3026149994&sur_name=Das
      2. for PhoneNo within geo coded area:  https://{mci-service}/api/{version}/patients?phone_no=9678909&present_address=100419
      3. for HouseHold within area: https://{mci-service}/api/{version}/patients?household_code=5&present_address=100419
  5. Get All Patient by Catchment: GET https://{mci-service}/api/{version}/catchments/100409/patients

Internal APIs 

  1. Approvals (in catchments)
    1. Get list of pending approvals for patients in catchment:  https://{mci-service}/api/{version}/catchments/{location code}/approvals
    2. Get details of a pending approval: https://{mci-service}/api/{version}/catchments/603602/approvals/{id}
    3. Get pending approvals since: https://{mci-service}/api/{version}/catchments/100409/approvals?after=(after)
    4. Accept pending approval:  PUT https://{mci-service}/api/{version}/catchments/603602/approvals/11140871455
    5. Reject pending approval:  DELETE https://{mci-service}/api/{version}/catchments/603602/approvals/11140871455
  2. Get audit logs for patient:  https://{mci-service}/api/{version}/audit/patients/5975391576157847553
  3. Update feed for SHR: https://{mci-service}/api/{version}/feed/patients?since=(ISO_FORMAT_TIME)   ISO_FORMAT_TIME : 2015-01-15T06:16:57Z
  4. Update active and merged_with (patient): https://{mci-service}/api/{version}/patients/active/{hid}
  5.  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
  6. Merge/Retain two duplicate patients:- PUT https://{mci-service}/api/{version}/patients/duplicates/

Internal System APIs

  1. Heath ID
    1. Generations

      1. All HIDsPOST  https://{mci-service}/api/{version}/healthIds/generate
      2. A range of HIDs for MCI: POST https://{mci-service}/api/{version}/healthIds/generateBlock?start={start}&totalHIDs={number_of_hids}
      3. 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}
    2. Get next block of healthIds: GET https://{mci-service}/api/{version}/healthIds/nextblock

All the deduplication URLs – Retain as distinct, merge 2 patients, merge while updating a patient, show all duplicates belonging to one catchment.

Table of Contents