Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated URLs related to HID generation.
API Headers
  • Content-Type: application/json
External APIs 

...

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
    /5945343868835725313Create Patient: POST 
      1. ?uid=(uid)
    1. by secondary identifiers -  phone number, household code
      1. for PhoneNo:  https://{mci-service}/api/{version}//patients
    Update Patient by HID: PUT 
      1. ?phone_no=01678904560
      2. for HouseHold code: https://
    bdshr-
      1. {mci-
    qa.twhosted.com
      1. service}/api/{version}/
    v1
      1. /patients
    /11140871455Search Patient: GET
      1. ?household_code=5
    1. by name or location within an area. 
      1. for Name within geo coded area:  https://{mci-service}/api/{version}
    /
      1. /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: httpsgiven_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?nid=9000000610077for BRN: httpshousehold_code=5&present_address=100419
  5. Get All Patient by Catchment: GET https://{mci-service}/api/{version}/catchments/100409/patients?bin_brn=76543210123456789
  6. for search with UID
  7. by secondary identifiers -  phone number, household code
    for PhoneNo:  https



Internal APIs 

  1. Approvals (in catchments)
    1. Get list of pending approvals for patients in catchment:  https://{mci-service}/api/{version}/catchments//patients?phone_no=01678904560for HouseHold code: https{location code}/approvals
    2. Get details of a pending approval: https://{mci-service}/api/{version}//patients?household_code=5by name or location within an area. for Name within geo coded area:  httpscatchments/603602/approvals/{id}
    3. Get pending approvals since: https://{mci-service}/api/{version}/catchments/100409/patients?given_name=Kabir&present_address=3026149994&sur_name=Dasfor PhoneNo within geo coded area:  httpsapprovals?after=(after)
    4. for HouseHold within area: httpsAccept pending approval:  PUT https://{mci-service}/api/{version}/patients?phone_no=9678909&present_address=100419catchments/603602/approvals/11140871455
    5. Reject pending approval:  DELETE https://{mci-service}/api/{version}/patients?household_code=5&present_address=100419
    Get All Patient by Catchment: GET https
    1. /catchments/603602/approvals/11140871455
  2. Get audit logs for patient:  https://{mci-service}/api/{version}/catchmentsaudit/100409patients/patients
    Generate HIDs:-All HIDs:- POST  5975391576157847553
  3. Update feed for SHR: https://{mci-service}/api/{version}/healthIds/generate
  4. A range of HIDs:- POST https://{mci-service}/api/{version}/healthIds/generateRange?start=9800100010&end=9800100215

Internal APIs 

  1. Approvals (in catchments)Get list of pending approvals for patients in catchment:  httpsfeed/patients?since=(ISO_FORMAT_TIME)   ISO_FORMAT_TIME : 2015-01-15T06:16:57Z
  2. Update active and merged_with (patient): https://{mci-service}/api/{version}/catchmentspatients/active/{location codehid}/approvals
    Get details of a pending approval: https
  3.  Duplicates in a catchment:- GET https://{mci-service}/api/{version}/catchmentspatients/603602duplicates/approvalscatchments/{idcatchmentId}
    Get pending approvals since: httpsE.g.- https://{mci-service}/api/{version}/patients/duplicates/catchments/100409/approvals?after=(after)Accept pending approval:  PUT https3026
  4. Merge/Retain two duplicate patients:- PUT https://{mci-service}/api/{version}/

    catchments

    patients/

    603602/approvals/11140871455Reject pending approval:  DELETE 

    duplicates/

Internal System APIs

  1. Heath ID 
    1. Generations
      1. All HIDsPOST  https://{mci-service}/api/{version}/
      catchments/603602/approvals/11140871455
    Get audit logs for patient:  
      1. healthIds/generate
      2. A range of HIDs for MCI: POST https://{mci-service}/api/{version}/
    audit/patients/5975391576157847553Update feed for SHR:
      1. healthIds/generateBlock?start={start}&totalHIDs={number_of_hids}
      2. range of HIDs for a given organization: POST https://{mci-service}/api/{version}/
    feed
      1. healthIds/
    patients
      1. generateBlockForOrg?
    since=(ISO_FORMAT_TIME)   ISO_FORMAT_TIME : 2015-01-15T06:16:57Z
    Update active and merged_with (patient): 
      1. org={org_code_from_hrm}&start={start}&totalHIDs={number_of_hids}
    1. Get next block of healthIds: GET https://{mci-service}/api/{version}/

    patients/active/{hid}
    1. healthIds/nextblock

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