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
...
- GET /locations.json?updatedSince={ISO8601 formatted date}&limit={limit}&offset={offset}&
active={true/false}&geoCode={geo code} - the parameter "geoCode" is intended for fetching locations under the specified geocoded location. For example in BHIE, geoCode=100409 should fetch list of all locations for Barisal Division (10), Barguna District (04), Amtali Upazila (09). The list will include all location of all wards/unions of Amtali Upazilla, including those under Paurasavas of Amtali upazila.
...
Get Locations
Panel border true borderStyle dashed 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 :
division
district
upazila
paurasava
union
ward
Expand title Sample Response Sample Response :
Code Block language js [ { "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" } ] } ]Get Single Location Information
Panel border true borderStyle dashed 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}Expand title Sample Response Sample Response :
Code Block language js { "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" } ] }
...