Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated URLs related to HID generation.
API HeadersContent-Type: application/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 search with UID
      by
      1. 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
    Generate HIDs:-
    All HIDs:- POST  https



Internal APIs 

  1. Approvals (in catchments)https
    1. Get list of pending approvals for patients in catchment:  https://{mci-service}/api/{version}/healthIds/generateA range of HIDs:- POST httpscatchments/{location code}/approvals
    2. Get details of a pending approval: https://{mci-service}/api/{version}/catchments/603602/healthIds/generateRange?start=9800100010&end=9800100215
    Get Next block of healthIds:- GET 
    1. approvals/{id}
    Approvals (in catchments)
    1. Get list of pending approvals for patients in catchment: Get pending approvals since: https://{mci-service}/api/{version}/
    healthIds/nextblock

Internal APIs 

    1. catchments/100409/approvals?after=(after)
    2. Accept pending approval:  PUT https://{mci-service}/api/{version}/catchments/{location code}603602/approvals
      Get details of a pending approval: https/11140871455
    3. Reject pending approval:  DELETE https://{mci-service}/api/{version}/catchments/603602/approvals/{id}11140871455
  1. Get pending approvals since: httpsaudit logs for patient:  https://{mci-service}/api/{version}/catchmentsaudit/100409/approvals?after=(after)Accept pending approval:  PUT httpspatients/5975391576157847553
  2. Update feed for SHR: https://{mci-service}/api/{version}/catchments/603602/approvals/11140871455Reject pending approval:  DELETEfeed/patients?since=(ISO_FORMAT_TIME)   ISO_FORMAT_TIME : 2015-01-15T06:16:57Z
  3. Update active and merged_with (patient): https://{mci-service}/api/{version}/catchmentspatients/603602/approvals/11140871455Get audit logs for patient:  active/{hid}
  4.  Duplicates in a catchment:- GET https://{mci-service}/api/{version}/audit/patients/5975391576157847553
  5. Update feed for SHR: https://{mci-service}/api/{version}/feed/patients?since=(ISO_FORMAT_TIME)   ISO_FORMAT_TIME : 2015-01-15T06:16:57Z
  6. Update active and merged_with (patient): duplicates/catchments/{catchmentId}
    E.g.- https://{mci-service}/api/{version}/patients/active/{hid} Duplicates in a catchment:- GET duplicates/catchments/3026
  7. Merge/Retain two duplicate patients:- PUT https://{mci-service}/api/{version}/patients/duplicates/

    catchments/{catchmentId}
    E.g.-



Internal System APIs

  1. Heath ID 
    1. Generations
      1. All HIDsPOST  https://{mci-service}/api/{version}/
    patients/duplicates/catchments/3026Merge/Retain two duplicate patients:- PUT
      1. healthIds/generate
      2. A range of HIDs for MCI: POST https://{mci-service}/api/{version}/
    patients/duplicates/  
      1. healthIds/generateBlock?start={start}&totalHIDs={number_of_hids}
      2. 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}
    1. 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.