Facility Registry

Owned by Angshuman Sarkar
Last updated: Mar 27, 2017 by Nehashri Puttu Lokesh
6 min read

Context

The purpose of Facility Registry is maintain a national health facility registry. Its main job is to maintain all locations where health services are provided.

API

The api is based on Facility Registry Expansion Development (FRED) api project.

Reference Specification: Facility Registry 1.0 - http://facilityregistry.org/

  1. Get Facilities

    Request :

    GET {fr_server}/facilities/list?limit={limit}&offset={offset}&updatedSince={ISO8601 formatted date}

    Headers :

    X-Auth-Token : {auth token assigned while user registration in HRM}
    client_id : {client id of requester in Identity Service Provider}

    Sample Response :

    Sample Response 
    [
    {
        "name": "Example Hospital",
        "url": "",
        "id": "10002",
        "active": 1,
        "createdAt": "",
        "updatedAt": "2016-03-28 23:23:27",
        "coordinates": [
            "90.399004",
            "23.780868"
        ],
        "identifiers": {
            "agency": "Example Agency",
            "context": "Context",
            "id": 2
        },
        "properties": {
            "ownership": "Fully Government-owned",
            "org_type": "Example Org",
            "org_level": "National",
            "care_level": "",
            "deleted_at": null,
            "services": [],
            "locations": {
                "division_code": "30",
                "district_code": "26",
                "upazila_code": "07",
                "paurasava_code": "",
                "union_code": "",
                "ward_code": ""
            },
            "contacts": {
                "name": "",
                "email": "some_email@somemail.com",
                "phone": "99956",
                "mobile": "",
                "fax": "9886"
            },
            "catchment": [
                "302607"
            ],
            "photo": ""
        }
    }
]

    catchment - the area this facility will cover as its catchment zone. the value should be an array of valid geocodes - the granularity level can vary based on the facility. for example, for a facility residing in a ward within a district, it can simply denote the district's geo code (0101). in the same way, if a facility is in a upazilla, it can denote the upazilla's geo code (010105). 

  2. Get Single Facility Information

    Request :

    GET {fr_server}/facilities/{facility_code}.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 :

    Sample Response 
      {
	        "name": "Example Hospital",
        "url": "",
        "id": "10002",
        "active": 1,
        "createdAt": "",
        "updatedAt": "2016-03-28 23:23:27",
        "coordinates": [
            "90.399004",
            "23.780868"
        ],
        "identifiers": {
            "agency": "Example Agency",
            "context": "Context",
            "id": 2
        },
        "properties": {
            "ownership": "Fully Government-owned",
            "org_type": "Example Org",
            "org_level": "National",
            "care_level": "",
            "deleted_at": null,
            "services": [],
            "locations": {
                "division_code": "30",
                "district_code": "26",
                "upazila_code": "07",
                "paurasava_code": "",
                "union_code": "",
                "ward_code": ""
            },
            "contacts": {
                "name": "",
                "email": "some_email@somemail.com",
                "phone": "99956",
                "mobile": "",
                "fax": "9886"
            },
            "catchment": [
                "302607"
            ],
            "photo": ""
        }
    }

    catchment - the area this facility will cover as its catchment zone. the value should be an array of valid geocodes - the granularity level can vary based on the facility. for example, for a facility residing in a ward within a district, it can simply denote the district's geo code (0101). in the same way, if a facility is in a upazilla, it can denote the upazilla's geo code (010105).