HIE Registries

Client Registry

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

Endpoints for accessing client registry

Get patient record

GET

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

/patients

Retrieves patient record from the client registry using a patient's identification number and type

Related documentation: Patient Search, Understanding Registries

Get patient record › query Parameters

identification_number

string · required

Patient identification number. Example value is dummy data.

Example: 33333333

identification_type

string · enum · required

Patient identification type

Enum values:

National ID

ClientRegistry ID

Birth Notification

Birth Certificate

Alien ID

Refugee ID

Mandate Number

Example: National ID

Get patient record › Responses

admission_number

string

admission_remand_number

string

agent_id

string

building_house_no

string

citizenship

string

city

string

civil_status

string

country

string

county

string

date_of_birth

string

deceased_datetime

string

object[]

disability_category

string

disability_cause

string

disability_subcategory

string

domestic_worker_type

string

employer_name

string

employer_pin

string

employment_type

string

first_name

string

gender

string

grade_level

string

gross_income

number

gross_income_currency

string

id

string

id_serial

string

identification_number

string

identification_residence

string

identification_type

string

is_agent

integer

kra_pin

string

last_name

string

latitude

string

learning_institution_code

string

learning_institution_name

string

longitude

string

object

middle_name

string

object

object[]

phone

string

place_of_birth

string

postal_address

string

preferred_primary_care_network

string

province_state_country

string

resourceType

string

sub_county

string

title

string

object[]

village_estate

string

ward

string

zip_code

string

GET/patients

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

shell

Example Responses

{
  "admission_number": "admission_number",
  "admission_remand_number": "admission_remand_number",
  "agent_id": "agent_id",
  "building_house_no": "building_house_no",
  "citizenship": "citizenship",
  "city": "city",
  "civil_status": "civil_status",
  "country": "country",
  "county": "county",
  "date_of_birth": "date_of_birth",
  "deceased_datetime": "deceased_datetime",
  "dependants": [
    {
      "date_added": "date_added",
      "relationship": "relationship",
      "result": [
        null
      ],
      "total": 0
    }
  ],
  "disability_category": "disability_category",
  "disability_cause": "disability_cause",
  "disability_subcategory": "disability_subcategory",
  "domestic_worker_type": "domestic_worker_type",
  "employer_name": "employer_name",
  "employer_pin": "employer_pin",
  "employment_type": "employment_type",
  "first_name": "first_name",
  "gender": "gender",
  "grade_level": "grade_level",
  "gross_income": 0,
  "gross_income_currency": "gross_income_currency",
  "id": "id",
  "id_serial": "id_serial",
  "identification_number": "identification_number",
  "identification_residence": "identification_residence",
  "identification_type": "identification_type",
  "is_agent": 0,
  "kra_pin": "kra_pin",
  "last_name": "last_name",
  "latitude": "latitude",
  "learning_institution_code": "learning_institution_code",
  "learning_institution_name": "learning_institution_name",
  "longitude": "longitude",
  "meta": {
    "creationTime": "creationTime",
    "lastUpdated": "lastUpdated",
    "source": "source",
    "versionId": "versionId"
  },
  "middle_name": "middle_name",
  "originSystem": {
    "record_id": "record_id",
    "system": "system"
  },
  "other_identifications": [
    {
      "identification_number": "identification_number",
      "identification_type": "National ID"
    }
  ],
  "phone": "phone",
  "place_of_birth": "place_of_birth",
  "postal_address": "postal_address",
  "preferred_primary_care_network": "preferred_primary_care_network",
  "province_state_country": "province_state_country",
  "resourceType": "resourceType",
  "sub_county": "sub_county",
  "title": "title",
  "unconfirmed_dependants": [
    {
      "agent": "agent",
      "citizenship": "citizenship",
      "county": "county",
      "date_of_birth": "date_of_birth",
      "email": "email",
      "first_name": "first_name",
      "gender": "gender",
      "id": "id",
      "identification_number": "identification_number",
      "identification_type": "identification_type",
      "last_name": "last_name",
      "learning_institution_code": "learning_institution_code",
      "learning_institution_name": "learning_institution_name",
      "middle_name": "middle_name",
      "phone": "phone",
      "related_to": "related_to",
      "relationship": "relationship",
      "sub_county": "sub_county"
    }
  ],
  "village_estate": "village_estate",
  "ward": "ward",
  "zip_code": "zip_code"
}

json

application/json

Health Worker Registry

Get patient record

GET

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

/patients

Retrieves patient record from the client registry using a patient's identification number and type

Related documentation: Patient Search, Understanding Registries

Get patient record › query Parameters

identification_number

string · required

Patient identification number. Example value is dummy data.

Example: 33333333

identification_type

string · enum · required

Patient identification type

Enum values:

National ID

ClientRegistry ID

Birth Notification

Birth Certificate

Alien ID

Refugee ID

Mandate Number

Example: National ID

Get patient record › Responses

admission_number

string

admission_remand_number

string

agent_id

string

building_house_no

string

citizenship

string

city

string

civil_status

string

country

string

county

string

date_of_birth

string

deceased_datetime

string

object[]

disability_category

string

disability_cause

string

disability_subcategory

string

domestic_worker_type

string

employer_name

string

employer_pin

string

employment_type

string

first_name

string

gender

string

grade_level

string

gross_income

number

gross_income_currency

string

id

string

id_serial

string

identification_number

string

identification_residence

string

identification_type

string

is_agent

integer

kra_pin

string

last_name

string

latitude

string

learning_institution_code

string

learning_institution_name

string

longitude

string

object

middle_name

string

object

object[]

phone

string

place_of_birth

string

postal_address

string

preferred_primary_care_network

string

province_state_country

string

resourceType

string

sub_county

string

title

string

object[]

village_estate

string

ward

string

zip_code

string

{ "admission_number": "admission_number", "admission_remand_number": "admission_remand_number", "agent_id": "agent_id", "building_house_no": "building_house_no", "citizenship": "citizenship", "city": "city", "civil_status": "civil_status", "country": "country", "county": "county", "date_of_birth": "date_of_birth", "deceased_datetime": "deceased_datetime", "dependants": [ { "date_added": "date_added", "relationship": "relationship", "result": [ null ], "total": 0 } ], "disability_category": "disability_category", "disability_cause": "disability_cause", "disability_subcategory": "disability_subcategory", "domestic_worker_type": "domestic_worker_type", "employer_name": "employer_name", "employer_pin": "employer_pin", "employment_type": "employment_type", "first_name": "first_name", "gender": "gender", "grade_level": "grade_level", "gross_income": 0, "gross_income_currency": "gross_income_currency", "id": "id", "id_serial": "id_serial", "identification_number": "identification_number", "identification_residence": "identification_residence", "identification_type": "identification_type", "is_agent": 0, "kra_pin": "kra_pin", "last_name": "last_name", "latitude": "latitude", "learning_institution_code": "learning_institution_code", "learning_institution_name": "learning_institution_name", "longitude": "longitude", "meta": { "creationTime": "creationTime", "lastUpdated": "lastUpdated", "source": "source", "versionId": "versionId" }, "middle_name": "middle_name", "originSystem": { "record_id": "record_id", "system": "system" }, "other_identifications": [ { "identification_number": "identification_number", "identification_type": "National ID" } ], "phone": "phone", "place_of_birth": "place_of_birth", "postal_address": "postal_address", "preferred_primary_care_network": "preferred_primary_care_network", "province_state_country": "province_state_country", "resourceType": "resourceType", "sub_county": "sub_county", "title": "title", "unconfirmed_dependants": [ { "agent": "agent", "citizenship": "citizenship", "county": "county", "date_of_birth": "date_of_birth", "email": "email", "first_name": "first_name", "gender": "gender", "id": "id", "identification_number": "identification_number", "identification_type": "identification_type", "last_name": "last_name", "learning_institution_code": "learning_institution_code", "learning_institution_name": "learning_institution_name", "middle_name": "middle_name", "phone": "phone", "related_to": "related_to", "relationship": "relationship", "sub_county": "sub_county" } ], "village_estate": "village_estate", "ward": "ward", "zip_code": "zip_code" }