HIE Registries

Facility Registry

Endpointhttps://ilm-dev.dha.go.ke/uat-middleware/api/v1

Endpoints for accessing facility registry

Get facility's record

GET

https://ilm-dev.dha.go.ke/uat-middleware/api/v1

/facilities/search

Retrieves a facility's record from facility registry

Related documentation: Facility Search, Understanding Registries

Get facility's record › query Parameters

identifier

string

Facility identification number

Example: FID-47-108521-3

identifier-type

string · enum

Facility identification type

Enum values:

mfl

license-number

fr-code

registration-number

fid

Example: fr-code

name

string

Facility's name

Example: Nairobi West Hospital

Get facility's record › Responses

object

facilityAdministratorEmail

string

facilityAdministratorIdentifier

string

facilityAdministratorName

string

facilityAdministratorPhone

string

facilityEmail

string

facilityLicenseEndDate

string

facilityLicenseStartDate

string

facilityLicenseStatus

string

facilityOwnership

string

facilityPhoneNumber

string

facilityType

string

fidCode

string

frCode

string

isHub

boolean

kephLevel

string

licenseNumber

string

officialName

string

pcnCode

string

registrationNumber

string

regulatoryBody

string

regulatoryOperationalStatus

circular

shaConstractEndDate

string

shaConstractStartDate

string

shaContractStatus

string

shaContractedServices

string[]

uuid

string

GET/facilities/search

curl --request GET \
  --url https://ilm-dev.dha.go.ke/uat-middleware/api/v1/facilities/search

shell

Example Responses

{
  "SHAOperationStatus": {
    "earliestReinstatementDate": "earliestReinstatementDate",
    "operationalStatus": "operationalStatus",
    "operationalStatusReason": "operationalStatusReason",
    "reinstatementDate": "reinstatementDate",
    "reinstatementRecommendations": "reinstatementRecommendations",
    "suspensionDate": "suspensionDate",
    "suspensionReason": "suspensionReason"
  },
  "address": {
    "constituency": "constituency",
    "country": "country",
    "county": "county",
    "countyCode": "countyCode",
    "latitude": "latitude",
    "longitude": "longitude",
    "physicalLocation": "physicalLocation",
    "postalAddress": "postalAddress",
    "subCounty": "subCounty",
    "subCountyCode": "subCountyCode",
    "town": "town",
    "ward": "ward"
  },
  "bedOccupancy": {
    "dialysisBeds": 0,
    "hduBeds": 0,
    "icuBeds": 0,
    "normalBeds": 0,
    "numberOfCots": 0,
    "totalBeds": 0
  },
  "facilityAdministratorEmail": "facilityAdministratorEmail",
  "facilityAdministratorIdentifier": "facilityAdministratorIdentifier",
  "facilityAdministratorName": "facilityAdministratorName",
  "facilityAdministratorPhone": "facilityAdministratorPhone",
  "facilityEmail": "facilityEmail",
  "facilityLicenseEndDate": "facilityLicenseEndDate",
  "facilityLicenseStartDate": "facilityLicenseStartDate",
  "facilityLicenseStatus": "facilityLicenseStatus",
  "facilityOwnership": "facilityOwnership",
  "facilityPhoneNumber": "facilityPhoneNumber",
  "facilityType": "facilityType",
  "fidCode": "fidCode",
  "frCode": "frCode",
  "isHub": true,
  "kephLevel": "kephLevel",
  "licenseNumber": "licenseNumber",
  "officialName": "officialName",
  "pcnCode": "pcnCode",
  "registrationNumber": "registrationNumber",
  "regulatoryBody": "regulatoryBody",
  "shaConstractEndDate": "shaConstractEndDate",
  "shaConstractStartDate": "shaConstractStartDate",
  "shaContractStatus": "shaContractStatus",
  "shaContractedServices": [
    "string"
  ],
  "uuid": "uuid"
}

json

application/json

Health Worker Registry

Get facility's record

GET

https://ilm-dev.dha.go.ke/uat-middleware/api/v1

/facilities/search

Retrieves a facility's record from facility registry

Related documentation: Facility Search, Understanding Registries

Get facility's record › query Parameters

identifier

string

Facility identification number

Example: FID-47-108521-3

identifier-type

string · enum

Facility identification type

Enum values:

mfl

license-number

fr-code

registration-number

fid

Example: fr-code

name

string

Facility's name

Example: Nairobi West Hospital

Get facility's record › Responses

object

facilityAdministratorEmail

string

facilityAdministratorIdentifier

string

facilityAdministratorName

string

facilityAdministratorPhone

string

facilityEmail

string

facilityLicenseEndDate

string

facilityLicenseStartDate

string

facilityLicenseStatus

string

facilityOwnership

string

facilityPhoneNumber

string

facilityType

string

fidCode

string

frCode

string

isHub

boolean

kephLevel

string

licenseNumber

string

officialName

string

pcnCode

string

registrationNumber

string

regulatoryBody

string

regulatoryOperationalStatus

circular

shaConstractEndDate

string

shaConstractStartDate

string

shaContractStatus

string

shaContractedServices

string[]

uuid

string

{ "SHAOperationStatus": { "earliestReinstatementDate": "earliestReinstatementDate", "operationalStatus": "operationalStatus", "operationalStatusReason": "operationalStatusReason", "reinstatementDate": "reinstatementDate", "reinstatementRecommendations": "reinstatementRecommendations", "suspensionDate": "suspensionDate", "suspensionReason": "suspensionReason" }, "address": { "constituency": "constituency", "country": "country", "county": "county", "countyCode": "countyCode", "latitude": "latitude", "longitude": "longitude", "physicalLocation": "physicalLocation", "postalAddress": "postalAddress", "subCounty": "subCounty", "subCountyCode": "subCountyCode", "town": "town", "ward": "ward" }, "bedOccupancy": { "dialysisBeds": 0, "hduBeds": 0, "icuBeds": 0, "normalBeds": 0, "numberOfCots": 0, "totalBeds": 0 }, "facilityAdministratorEmail": "facilityAdministratorEmail", "facilityAdministratorIdentifier": "facilityAdministratorIdentifier", "facilityAdministratorName": "facilityAdministratorName", "facilityAdministratorPhone": "facilityAdministratorPhone", "facilityEmail": "facilityEmail", "facilityLicenseEndDate": "facilityLicenseEndDate", "facilityLicenseStartDate": "facilityLicenseStartDate", "facilityLicenseStatus": "facilityLicenseStatus", "facilityOwnership": "facilityOwnership", "facilityPhoneNumber": "facilityPhoneNumber", "facilityType": "facilityType", "fidCode": "fidCode", "frCode": "frCode", "isHub": true, "kephLevel": "kephLevel", "licenseNumber": "licenseNumber", "officialName": "officialName", "pcnCode": "pcnCode", "registrationNumber": "registrationNumber", "regulatoryBody": "regulatoryBody", "shaConstractEndDate": "shaConstractEndDate", "shaConstractStartDate": "shaConstractStartDate", "shaContractStatus": "shaContractStatus", "shaContractedServices": [ "string" ], "uuid": "uuid" }