Location Registry

The purpose of location registry is to uniquely identify geographical locations in a country - often in terms of administrative setup. This allows to identify patients location and care services location uniquely.

API

1. Get Locations
   

   Request :

   GET  https://{lr_service}/locations/list/{level}?updatedSince={ISO8601 formatted date}&limit={limit}&offset={offset}

   Headers :

   X-Auth-Token : {auth token assigned while user registration in HRM}

   client_id : {client id of requester in Identity Service Provider}

   The level field can contain one of the following :

   1. division

   2. district

   3. upazila

   4. paurasava

   5. union

   6. ward

   Sample Response Expand source

   [
     {
       "code": "1020",
       "id": "1020",
       "name": "Example Location",
       "name_BN": "",
       "type": "district",
       "active": 1,
       "updatedAt": "2016-10-02 13:19:57",
       "hierarchy": [
         {
           "code": "10",
           "name": "Example Parent Location",
           "name_BN": "",
           "type": "division"
         },
         {
           "code": "20",
           "name": "Example Location",
           "name_BN": "",
           "type": "district"
         }
       ]
     }
   ]

2. Get Single Location Information
   

   Request :

   GET http://hrmtest.dghs.gov.bd/api/1.0/locations/{geoCode}.json

   Headers :

   X-Auth-Token : {auth token assigned while user registration in HRM}

   client_id : {client id of requester in Identity Service Provider}

   Sample Response Expand source

   {
       "code": "1020",
       "id": "1020",
       "name": "Example Location",
       "name_BN": "",
       "type": "district",
       "active": 1,
       "updatedAt": "2016-10-02 13:19:57",
       "hierarchy": [
         {
           "code": "10",
           "name": "Example Parent Location",
           "name_BN": "",
           "type": "division"
         },
         {
           "code": "20",
           "name": "Example Location",
           "name_BN": "",
           "type": "district"
         }
       ]
     }

BHIE

For Bangladesh, the geographical codes for locations are unique for a specific hierarchy.

The code sequence

Bangladesh Geo Code, BBS

• format - http://www.bbs.gov.bd/PageWebMenuContent.aspx?MenuKey=150
• Geo code list - an excel version of it is attached below

Attachments

BBS_Geocode_list_upz.xlsx