Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: added dedup APIs
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
    /5945343868835725313Create Patient: POST 
      1. ?bin_brn=76543210123456789
      2. for search with 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-mci-qa.twhosted.com/api/v1/patients/11140871455Search Patient: GET
      1. {mci-service}/api/{version}//patients?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)&
      1. given_name=
    (name)&sur_name=(surname)&
      1. Kabir&present_address=
    (geolocation code)
    1. by other primary identifiers - National ID, Birth Regd No
      1. for Nid: 3026149994&sur_name=Das
      2. for PhoneNo within geo coded area:  https://{mci-service}/api/{version}//patients?nid=9000000610077for BRN: httpsphone_no=9678909&present_address=100419
      3. for HouseHold within area: https://{mci-service}/api/{version}//patients?bin_brn=76543210123456789
      4. for search with UID
      by secondary identifiers -  phone number, household code
      1. for PhoneNo:  httpshousehold_code=5&present_address=100419
  5. Get All Patient by Catchment: GET https://{mci-service}/api/{version}/catchments/100409/patients?phone_no=01678904560for HouseHold code:
  6. Generate HIDs:-
    1. 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
    2. 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
  7. 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 

  1. Approvals (in catchments)
    1. Get list of pending approvals for patients in catchment:  https://{mci-service}/api/{version}/patients?household_code=5&present_address=100419
    Get All Patient by Catchment: GET https
    1. catchments/{location code}/approvals
    2. Get details of a pending approval: https://{mci-service}/api/{version}/catchments/603602/
    100409
    1. approvals/
    patients
    Generate HIDs:-
    1. All HIDs:- POST  https:{id}
    2. Get pending approvals since: https://{mci-service}/api/{version}/healthIds/generateA range of HIDs:- POST httpscatchments/100409/approvals?after=(after)
    3. Accept pending approval:  PUT https://{mci-service}/api/{version}/catchments/healthIds/generateRange?start=9800100010&end=9800100215

Internal APIs 

  1. Approvals (in catchments)
    1. Get list of pending approvals for patients in catchment:  https603602/approvals/11140871455
    2. Reject pending approval:  DELETE https://{mci-service}/api/{version}/catchments/{location code}603602/approvals/11140871455
  2. 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
  3. 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
  4. Update active and merged_with (patient): https://{mci-service}/api/{version}/catchmentspatients/603602/approvals/11140871455Reject pending approval:  DELETE active/{hid}
  5.  Duplicates in a catchment:- GET https://{mci-service}/api/{version}/catchmentspatients/603602/approvals/11140871455
  6. Get audit logs for patient:  https://{mci-service}/api/{version}/audit/patients/5975391576157847553
  7. 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
  8. Merge/Retain two duplicate patients:- PUT https://{mci-service}/api/{version}/patients/

    active/{hid}

    duplicates/

      

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