API Specifications v1.0¶

Specification Notes¶

This document defines an API which uses JSON for exchanging data.
All dates should follow ISO 8601.
All field/properties should follow the camelCasing convention.
Use UTF-8 encoding.

Core Properties¶

Each facility must contain the following core properties.

Name¶

Name of the facility.

name: "Kakamega HC"

System Id¶

The internal system uid is denoted with “id”. The id most be universally unique.

id: '0X9OCW3JMV98EYOVN32SGN4II'

Note: the API does not providing a specific format for IDs. That is left up to the implementation.

URL¶

URL link to the unique ID API resource for the facility

url: "http://facilityregistry.org/api/v1/facilities/0X9OCW3JMV98EYOVN32SGN4II.json"

External Facility Identifiers¶

One of the primary functions of the facility registry is facilitate a mapping of the different IDs used by different agencies to represent a particular facility.

Each external identifier consists of the following components:

agency: agency who created the code. ex) ministry of health, UNICEF, etc.
context: context/external system in which the agency is using the ID. eg) HMIS, DHIS2, HR
id: unique identifier

identifiers : [
      {agency: "MOH", context: "DHIS", id: "123"},
      {agency: "UNICEF", context: "mtrac", id: "53adf"},
      { .... }
]

Geolocation¶

Geolocation represented by longitude and latitude coordinates in that order.

coordinates: [lng, lat]

Active¶

Active = true/false indicates whether the facility is active or not.

active: true

CreatedAt¶

ISO 8601 timestamp, including timezone, of when the facility was created.

createdAt: "2011-11-16T14:26:15Z"

UpdatedAt¶

ISO 8601 timestamp, including timezone, of when the facility was last updated.

updatedAt: "2011-11-16T14:26:15Z"

Extended Properties¶

Extended properties are implementation specific properties in the properties block.

The property types that are supported are:

Text
Integer
Decimal
Boolean (true/false)
Date: ISO 8601 format. eg) 2012-12-16T18:22:20Z
Lists

When representing a single select question: should return the scalar that is the code of the selected value.

When representing a multiple-select question: should return the codes of the selected values. eg) fruits: [“apples”,”oranges”,”bananas”]

Can contain complex objects.

Sample properties

"properties": {
    "numBeds": 55,
    "services": ["XR","OBG","TR"],
    "equipment": [
        {
            "id": 542,
            "name": "Microscope"
        },
        {
            "id": 942,
            "name": "Vaccine Fridge"
        }
    ],
    "manager": "Mrs. Liz"
    "hasMaternity": true,
},

Property field specification expectations

For each property field, the implementer specifies a stable code that should not be changed once defined. The implementation should warn the user if they attempt to modify the code.
The property field code should consist only of letters and number and not any special characters, spaces or punctuation to allow them to represent a good xml element. The API does not specify whether to define properties using camelCasing or lower_case, however, we encourage the implementation to be consistent in their formating.
Each property field should be unique
Specific properties for attachments and images are not supported in this version. It is possible to use a text string to represent a file path but that is implementation specific
Properties should follow the camelCasing naming convention

Note

Future releases will support:

linking to an external data dictionary that defines the property schema for the facility
linking to external entities and references to other facilities

API¶

Versioning¶

Semantic versioning. (X.Y.Z) where X is the major version, Y the minor and Z the patch version. Minor version Y must be incremented if a new backwards compatible functionality is introduced to the API. A major version X must be incremented if any backwards incompatible changes are introduced to the public API.

The major version must be exposed in the URL. Note: the URL pattern may vary by implementation.

/api/v1/facilities.json

All prior versions still supported by the code should be exposed by its own URL.

Authentication¶

Will be supported initially by HTTP Basic Authentication.

In the future, support for HTTP Digest Authentication in addition to OAuth 2.0 will be considered.

HTTP Responses¶

Success: HTTP 200, XML/JSON representation of object (when applicable)
Invalid: HTTP 422, XML/JSON representation of errors
Unauthorized: HTTP 401
Missing: HTTP 404
Forbidden: HTTP 403
Method not Allowed: HTTP 405
Conflict: HTTP 409

Error Messages¶

Returns HTTP Response 401 or 404 along with a human readable error message.

Optional Verbose Error messages

JSON

{
  “message”: “human readable error message”,
  “moreInfo” : “http://api.facilityregistry.org/errors/12345"
}

Adding / Updating Facilities¶

/facilities.json

POST: Creates facility. SUCCESS: HTTP 200 Returns URL to the generated facility.

If a duplicate is detected (up to the implementation) a 409 is returned

Note

Need to define JSON input status

GET: See below

PUT: Error, not supported

DELETE: Error, not supported

/facilities/<id>.json

POST:: Error, not supported

GET: See below

DELETE: Delete facility. SUCCESS: Returns: HTTP 200 and the ID of deleted facility

When the facility registry receives a request to obsolete a facility, the facility registry SHALL validate that the facility exists. If the requested target of deletion does not exist, the facility registry SHALL respond with an HTTP 404 error.

If the facility resource exists, the facility registry SHALL delete the facility resource such that the record is no longer discoverable to consumers. The process by which the facility registry marks the facility as deleted is not specified in this document, and is left to implementers to determine the most appropriate method.

Once the record is deleted, the facility registry SHALL return an HTTP 200 response with the URL of the deleted facility.

PUT: Update facility if exists, if not error. Success: HTTP 200, JSON collection

Query Facility Data¶

Individual Facility Lookup¶

GET /facilities/<id>.json

Returns facility in JSON

List Facilities¶

GET /facilities.json

Returns the list of facilities in json.

allProperties

allProperties is a boolean field (default true) that defines that all the core properties plus the user defined properties in the properties block should be returned.

/facilities.json?allProperties=true

This would return all the properties (core + specified)

Defining Partial Response with fields

/facilities.json?fields=name,id,properties:numBeds

This would return just the specified properties of name, id and numBeds (in the properties sub-object) in a partial response. This is very helpful in optimizing performance in bandwidth constrained settings. All properties in the facility registry are accessible by this method including the core properties and those in the property sub-object.

Filter by Active status¶

Filter facilities that are active or not. Supported parameters = true, false

/facilities.json?active=true/false

Filter by Updated Since¶

Returns facilities updated since a particular data expressed in the ISO 8601 format.

/facilities.json?updatedSince=2011-11-16T00:00:00Z

Sample JSON Output¶

{
    "facilities": {
        "facility": {
            "name": "Kakamega HC",
            "url": "http: //facilityregistry.org/api/v1/facilities/0X9OCW3JMV98EYOVN32SGN4II",
            "id": "0X9OCW3JMV98EYOVN32SGN4II",
            "active": true,
            "createdAt": "2011-11-16T14:26:15Z",
            "updatedAt": "2011-11-16T14:26:15Z",
            "coordinates": [
                -1.6917,
                29.525
            ],
            "identifiers": [
                {
                    "agency": "MOH",
                    "context": "DHIS",
                    "id": "123"
                },
                {
                    "agency": "UNICEF",
                    "context": "mtrac",
                    "id": "53adf"
                }
            ],
            "properties": {
                "numBeds": 55,
                "services": [
                    "XR",
                    "OBG",
                    "TR"
                ],
                "equipment": [
                    {
                        "id": 542,
                        "name": "Microscope"
                    },
                    {
                        "id": 942,
                        "name": "Vaccine Fridge"
                    }
                ],
                "manager": "Mrs. Liz",
                "hasMaternity": true,
                "medicalOfficer": "Dr.Mukombo"
            }
        }
    }
}

Recommended Practices¶

While it is not required, we suggest implementations support gzip, etags and cache headers which can help reduce uncessary data transfer which is helpful in low-bandwidth environments.

Cache headers if implemented could be especially useful, as a common use case seems to be maintaining a mirror of facility information.

API Specifications v1.0¶

Specification Notes¶

Core Properties¶

Name¶

System Id¶

URL¶

External Facility Identifiers¶

Geolocation¶

Active¶

CreatedAt¶

UpdatedAt¶

Extended Properties¶

API¶

Versioning¶

Authentication¶

HTTP Responses¶

Error Messages¶

Adding / Updating Facilities¶

Query Facility Data¶

Individual Facility Lookup¶

List Facilities¶

Filter by Active status¶

Filter by Updated Since¶

Sample JSON Output¶

Recommended Practices¶

Table Of Contents

This Page

Navigation

API Specifications v1.0¶

Specification Notes¶

Core Properties¶

Name¶

System Id¶

URL¶

External Facility Identifiers¶

Geolocation¶

Active¶

CreatedAt¶

UpdatedAt¶

Extended Properties¶

API¶

Versioning¶

Authentication¶

HTTP Responses¶

Error Messages¶

Adding / Updating Facilities¶

Query Facility Data¶

Individual Facility Lookup¶

List Facilities¶

Filter by Active status¶

Filter by Updated Since¶

Sample JSON Output¶

Recommended Practices¶

Table Of Contents

This Page

Quick search

Navigation