-
Notifications
You must be signed in to change notification settings - Fork 7
Using the Facility Registry API in ResourceMap
The Facility Registry API is an open standard for sharing and updating health facility data. http://facilityregistry.org/.
Some people refer to it as "The FRED API".
It provides an agreed-upon format for facility objects (Resource Map sites) and core properties, as well as support for specific query approaches useful when using Resource Map as a Facility Registry in the context of a Health Information Exchange.
To follow or contribute to the discussion related features in the API: see facility registry github issues.
The API is an ongoing collaborative effort begun under the Open Facility Registry Service Project: Facility Registry Expansion Development (FRED). Thus the FRED API nickname.
This project is supported by PEPFAR and USAID
Facility Registry API Term -> Resource MAP Term
-
Facility -> Site
-
Coordinates -> lat/lng
-
Identifiers -> Fields of identifier type
The Facility Registry API assumes only one 'dataset' of facilities, while ResourceMap supports many collections, so the Facility Registry API is accessed already "filtering" by a specific collection.
/collections/:collection_id/fred_api/v1/facilities.json
Example:
http://resourcemap.instedd.org/collections/350/fred_api/v1/facilities.json
http://resourcemap.instedd.org is given as an example base URL. It could be replaced with a specific installation address (e.g. http://facilityregistry.moh.gov.rw)
350 is given as an example collection ID. You must replace this with the ID of the collection you want to see through the FRED API
From there on you can use all the endpoints as documented:
The Facility Registry API is fully documented and maintained here: http://facilityregistry.org/
-
/facilities.json GET for complex queries,
-
/facilities/:id.json GET to get specific facilities,
-
/facilities.json POST (to create),
-
/facilities/:id.json PUT (to update),
-
/facilities/:id.json DELETE (to delete).
The Facility Registry API does not support locale specifications in the current version, so not specifying locale is interpreted as an implicit default locale for the ResourceMap installation (locale=en for http://resourcemap.instedd.org)