HIE Registries

Health Worker Registry

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

Endpoints for accessing health worker registry

Get practitioner's record

GET

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

/professionals

Retrieves a practitioner's record from the health worker registry

Related documentation: Professional Search, Understanding Registries

Get practitioner's record › query Parameters

identification_number

string · required

Practitioner identification number. Example value is dummy data.

Example: 123456

identification_type

string · enum · required

Practitioner ID type (registration number preferred)

Enum values:

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

regulator

string · enum

Regulation body (shared.RegulationBody)

Enum values:

KMPDC

COC

NCK

PPB

Example: KMPDC

Get practitioner's record › Responses

Practitioner record retrieved successfully

object

GET/professionals

curl --request GET \
  --url 'https://ilm-dev.dha.go.ke/uat-middleware/api/v1/professionals?identification_number=%3Cstring%3E&identification_type=%3Cstring%3E'

shell

Example Responses

{
  "message": {
    "contacts": {
      "email": "email",
      "phone": "phone",
      "postal_address": "postal_address"
    },
    "identifiers": {
      "client_registry_id": "client_registry_id",
      "identification_number": "identification_number",
      "identification_type": "identification_type",
      "student_id": "student_id"
    },
    "licenses": [
      {
        "external_reference_id": "external_reference_id",
        "id": "id",
        "license_end": "license_end",
        "license_start": "license_start",
        "license_type": "license_type"
      }
    ],
    "membership": {
      "external_reference_id": "external_reference_id",
      "first_name": "first_name",
      "full_name": "full_name",
      "gender": "gender",
      "id": "id",
      "is_active": 0,
      "last_name": "last_name",
      "licensing_body": "licensing_body",
      "middle_name": "middle_name",
      "registration_id": "registration_id",
      "specialty": "specialty"
    },
    "professional_details": {
      "discipline_name": "discipline_name",
      "educational_qualifications": "educational_qualifications",
      "practice_type": "practice_type",
      "professional_cadre": "professional_cadre",
      "specialty": "specialty",
      "subspecialty": "subspecialty"
    }
  }
}

json

application/json

Client Registry Facility Registry

Get practitioner's record

GET

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

/professionals

Retrieves a practitioner's record from the health worker registry

Related documentation: Professional Search, Understanding Registries

Get practitioner's record › query Parameters

identification_number

string · required

Practitioner identification number. Example value is dummy data.

Example: 123456

identification_type

string · enum · required

Practitioner ID type (registration number preferred)

Enum values:

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

regulator

string · enum

Regulation body (shared.RegulationBody)

Enum values:

KMPDC

COC

NCK

PPB

Example: KMPDC

Get practitioner's record › Responses

Practitioner record retrieved successfully

object

{ "message": { "contacts": { "email": "email", "phone": "phone", "postal_address": "postal_address" }, "identifiers": { "client_registry_id": "client_registry_id", "identification_number": "identification_number", "identification_type": "identification_type", "student_id": "student_id" }, "licenses": [ { "external_reference_id": "external_reference_id", "id": "id", "license_end": "license_end", "license_start": "license_start", "license_type": "license_type" } ], "membership": { "external_reference_id": "external_reference_id", "first_name": "first_name", "full_name": "full_name", "gender": "gender", "id": "id", "is_active": 0, "last_name": "last_name", "licensing_body": "licensing_body", "middle_name": "middle_name", "registration_id": "registration_id", "specialty": "specialty" }, "professional_details": { "discipline_name": "discipline_name", "educational_qualifications": "educational_qualifications", "practice_type": "practice_type", "professional_cadre": "professional_cadre", "specialty": "specialty", "subspecialty": "subspecialty" } } }