HIE Registries

Schemas

internal_domain_tenants.OperationStatus

earliestReinstatementDate

string

operationalStatus

string

operationalStatusReason

string

reinstatementDate

string

reinstatementRecommendations

string

suspensionDate

string

suspensionReason

string

internal_domain_tenants.Address

constituency

string

country

string

county

string

countyCode

string

latitude

string

longitude

string

physicalLocation

string

postalAddress

string

subCounty

string

subCountyCode

string

town

string

ward

string

internal_domain_tenants.BedOcuppancy

dialysisBeds

integer

hduBeds

integer

icuBeds

integer

normalBeds

integer

numberOfCots

integer

totalBeds

integer

internal_domain_tenants.FacilitySummary

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

shaConstractStartDate

shaContractStatus

string

shaContractedServices

string[]

uuid

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_shared.ErrorResponse

error

string

message

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.ErrorResponse

Standard error response format for all error conditions.

error

string

@Description HTTP status text from the standard HTTP status codes @Example "Bad Request"

message

string

@Description Detailed error message explaining what went wrong @Example "token missing required tenant_id claim"

internal_domain_patients.Member

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

meta

circular

middle_name

string

originSystem

circular

other_identifications

array · internal_domain_patients.Identification (circular)

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

unconfirmed_dependants

array · internal_domain_patients.UnconfirmedDependant (circular)

village_estate

string

ward

string

zip_code

string

internal_domain_patients.Dependant

date_added

string

relationship

string

object[]

total

integer

internal_domain_patients.Meta

creationTime

string

lastUpdated

string

source

string

versionId

string

internal_domain_patients.OriginSystem

record_id

string

system

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_shared.PatientIdentificationType

string · enum

Enum values:

National ID

ClientRegistry ID

Birth Notification

Birth Certificate

Alien ID

Refugee ID

Mandate Number

Temporary ID

internal_domain_patients.Identification

identification_number

string

identification_type

string · enum

Enum values:

National ID

ClientRegistry ID

Birth Notification

Birth Certificate

Alien ID

Refugee ID

Mandate Number

Temporary ID

internal_domain_patients.UnconfirmedDependant

agent

string

citizenship

string

county

string

date_of_birth

string

email

string

first_name

string

gender

string

id

string

identification_number

string

identification_type

string

last_name

string

learning_institution_code

string

learning_institution_name

string

middle_name

string

phone

string

related_to

string

relationship

string

sub_county

string

internal_domain_practitioners.PractitionerContacts

email

string

phone

string

postal_address

string

internal_domain_practitioners.PractitionerIdentifiers

client_registry_id

string

identification_number

string

identification_type

string

student_id

string

internal_domain_practitioners.PractitionerLicense

external_reference_id

string

id

string

license_end

string

license_start

string

license_type

string

internal_domain_practitioners.PractitionerMembership

external_reference_id

string

first_name

string

full_name

string

gender

string

id

string

is_active

integer

last_name

string

licensing_body

string

middle_name

string

registration_id

string

specialty

string

internal_domain_practitioners.ProfessionalDetails

discipline_name

string

educational_qualifications

string

practice_type

string

professional_cadre

string

specialty

string

subspecialty

string

internal_domain_practitioners.PractitionerRegistryMessage

object

object[]

object

internal_domain_practitioners.PractitionerRegistryResponseEnvelope

object

internal_domain_tenants.FacilitySummary

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

shaConstractStartDate

shaContractStatus

string

shaContractedServices

string[]

uuid

string

internal_domain_patients.Member

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

meta

circular

middle_name

string

originSystem

circular

other_identifications

array · internal_domain_patients.Identification (circular)

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

unconfirmed_dependants

array · internal_domain_patients.UnconfirmedDependant (circular)

village_estate

string

ward

string

zip_code

string

internal_domain_patients.UnconfirmedDependant

agent

string

citizenship

string

county

string

date_of_birth

string

email

string

first_name

string

gender

string

id

string

identification_number

string

identification_type

string

last_name

string

learning_institution_code

string

learning_institution_name

string

middle_name

string

phone

string

related_to

string

relationship

string

sub_county

string