Kenya Patient Summary FHIR Implementation Guide
0.1.0 - ci-build KE

Kenya Patient Summary FHIR Implementation Guide, published by Digital Health Agency of Kenya. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IntelliSOFT-Consulting/Kenya-Patient-Summary-FHIR-IG/ and changes regularly. See the Directory of published versions

Logical Model: KPS.A Client Registration

Official URL: https://fhir.dha.go.ke/kps/StructureDefinition/ClientRegistrationModel Version: 0.1.0
Draft as of 2026-05-11 Computable Name: ClientRegistrationModel

Copyright/Legal: Copyright © 2024+ Digital Health Agency of Kenya. This content is licensed under Creative Commons Zero v1.0 Universal (CC0 1.0). No rights reserved.

Logical model for registering a client under the Kenya Patient Summary (KPS.A) standard.

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClientRegistrationModel 0..* Base KPS.A Client Registration
... identifier 1..1 Identifier Government-issued identifier used to distinguish individuals, e.g., National ID (adults) or Birth Certificate number (under 18)
... name 1..1 BackboneElement Client's name
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... given 1..1 string Client's first name
.... family 1..1 string Client's family name or last name
... dateOfBirth 1..1 date Client's date of birth, if known
... address 0..1 BackboneElement Client's residential address
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... country 0..1 string Name of country of affiliation
.... county 0..1 string County where the client resides
.... subcounty 0..1 string Subcounty of residence
.... ward 0..1 string Ward where the client lives
.... village 0..1 string Village or estate of residence
.... postalAddress 0..1 string Mailing address including P.O. Box, street or building details
... telecom 0..1 BackboneElement Client's contact information
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... phone 0..1 string Phone number (mobile or landline)
.... email 0..1 string Email address
... contactPerson 0..1 BackboneElement Contact person or legal guardian
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role 1..1 code Role: legal guardian, next of kin, or other
Binding: KPSPatientContactRelationship (required)
.... relationship 0..1 string Relationship to the client (e.g., father, spouse, daughter)
.... name 0..1 BackboneElement Name of contact person
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... given 1..1 string First name of contact person
..... family 1..1 string Surname of contact person
.... phone 0..1 string Phone number of contact person
.... email 0..1 string Email of contact person
... insurance 0..1 BackboneElement Insurance information
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... insuranceNumber 0..1 string Health insurance ID assigned to the client

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ClientRegistrationModel.​sex Base required KPS - Administrative Gender 📦0.1.0 This IG
ClientRegistrationModel.​contactPerson.role Base required KPSPatientContactRelationship 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClientRegistrationModel 0..* Base KPS.A Client Registration
... identifier 1..1 Identifier Government-issued identifier used to distinguish individuals, e.g., National ID (adults) or Birth Certificate number (under 18)
... name 1..1 BackboneElement Client's name
.... given 1..1 string Client's first name
.... family 1..1 string Client's family name or last name
... dateOfBirth 1..1 date Client's date of birth, if known
... address 0..1 BackboneElement Client's residential address
.... country 0..1 string Name of country of affiliation
.... county 0..1 string County where the client resides
.... subcounty 0..1 string Subcounty of residence
.... ward 0..1 string Ward where the client lives
.... village 0..1 string Village or estate of residence
.... postalAddress 0..1 string Mailing address including P.O. Box, street or building details
... telecom 0..1 BackboneElement Client's contact information
.... phone 0..1 string Phone number (mobile or landline)
.... email 0..1 string Email address
... contactPerson 0..1 BackboneElement Contact person or legal guardian
.... role 1..1 code Role: legal guardian, next of kin, or other
Binding: KPSPatientContactRelationship (required)
.... relationship 0..1 string Relationship to the client (e.g., father, spouse, daughter)
.... name 0..1 BackboneElement Name of contact person
..... given 1..1 string First name of contact person
..... family 1..1 string Surname of contact person
.... phone 0..1 string Phone number of contact person
.... email 0..1 string Email of contact person
... insurance 0..1 BackboneElement Insurance information
.... insuranceNumber 0..1 string Health insurance ID assigned to the client

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ClientRegistrationModel.​sex Base required KPS - Administrative Gender 📦0.1.0 This IG
ClientRegistrationModel.​contactPerson.role Base required KPSPatientContactRelationship 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClientRegistrationModel 0..* Base KPS.A Client Registration
... identifier 1..1 Identifier Government-issued identifier used to distinguish individuals, e.g., National ID (adults) or Birth Certificate number (under 18)
... name 1..1 BackboneElement Client's name
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... given 1..1 string Client's first name
.... family 1..1 string Client's family name or last name
... dateOfBirth 1..1 date Client's date of birth, if known
... address 0..1 BackboneElement Client's residential address
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... country 0..1 string Name of country of affiliation
.... county 0..1 string County where the client resides
.... subcounty 0..1 string Subcounty of residence
.... ward 0..1 string Ward where the client lives
.... village 0..1 string Village or estate of residence
.... postalAddress 0..1 string Mailing address including P.O. Box, street or building details
... telecom 0..1 BackboneElement Client's contact information
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... phone 0..1 string Phone number (mobile or landline)
.... email 0..1 string Email address
... contactPerson 0..1 BackboneElement Contact person or legal guardian
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role 1..1 code Role: legal guardian, next of kin, or other
Binding: KPSPatientContactRelationship (required)
.... relationship 0..1 string Relationship to the client (e.g., father, spouse, daughter)
.... name 0..1 BackboneElement Name of contact person
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... given 1..1 string First name of contact person
..... family 1..1 string Surname of contact person
.... phone 0..1 string Phone number of contact person
.... email 0..1 string Email of contact person
... insurance 0..1 BackboneElement Insurance information
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... insuranceNumber 0..1 string Health insurance ID assigned to the client

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ClientRegistrationModel.​sex Base required KPS - Administrative Gender 📦0.1.0 This IG
ClientRegistrationModel.​contactPerson.role Base required KPSPatientContactRelationship 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(9 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClientRegistrationModel 0..* Base KPS.A Client Registration
... identifier 1..1 Identifier Government-issued identifier used to distinguish individuals, e.g., National ID (adults) or Birth Certificate number (under 18)
... name 1..1 BackboneElement Client's name
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... given 1..1 string Client's first name
.... family 1..1 string Client's family name or last name
... dateOfBirth 1..1 date Client's date of birth, if known
... address 0..1 BackboneElement Client's residential address
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... country 0..1 string Name of country of affiliation
.... county 0..1 string County where the client resides
.... subcounty 0..1 string Subcounty of residence
.... ward 0..1 string Ward where the client lives
.... village 0..1 string Village or estate of residence
.... postalAddress 0..1 string Mailing address including P.O. Box, street or building details
... telecom 0..1 BackboneElement Client's contact information
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... phone 0..1 string Phone number (mobile or landline)
.... email 0..1 string Email address
... contactPerson 0..1 BackboneElement Contact person or legal guardian
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role 1..1 code Role: legal guardian, next of kin, or other
Binding: KPSPatientContactRelationship (required)
.... relationship 0..1 string Relationship to the client (e.g., father, spouse, daughter)
.... name 0..1 BackboneElement Name of contact person
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... given 1..1 string First name of contact person
..... family 1..1 string Surname of contact person
.... phone 0..1 string Phone number of contact person
.... email 0..1 string Email of contact person
... insurance 0..1 BackboneElement Insurance information
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... insuranceNumber 0..1 string Health insurance ID assigned to the client

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ClientRegistrationModel.​sex Base required KPS - Administrative Gender 📦0.1.0 This IG
ClientRegistrationModel.​contactPerson.role Base required KPSPatientContactRelationship 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClientRegistrationModel 0..* Base KPS.A Client Registration
... identifier 1..1 Identifier Government-issued identifier used to distinguish individuals, e.g., National ID (adults) or Birth Certificate number (under 18)
... name 1..1 BackboneElement Client's name
.... given 1..1 string Client's first name
.... family 1..1 string Client's family name or last name
... dateOfBirth 1..1 date Client's date of birth, if known
... address 0..1 BackboneElement Client's residential address
.... country 0..1 string Name of country of affiliation
.... county 0..1 string County where the client resides
.... subcounty 0..1 string Subcounty of residence
.... ward 0..1 string Ward where the client lives
.... village 0..1 string Village or estate of residence
.... postalAddress 0..1 string Mailing address including P.O. Box, street or building details
... telecom 0..1 BackboneElement Client's contact information
.... phone 0..1 string Phone number (mobile or landline)
.... email 0..1 string Email address
... contactPerson 0..1 BackboneElement Contact person or legal guardian
.... role 1..1 code Role: legal guardian, next of kin, or other
Binding: KPSPatientContactRelationship (required)
.... relationship 0..1 string Relationship to the client (e.g., father, spouse, daughter)
.... name 0..1 BackboneElement Name of contact person
..... given 1..1 string First name of contact person
..... family 1..1 string Surname of contact person
.... phone 0..1 string Phone number of contact person
.... email 0..1 string Email of contact person
... insurance 0..1 BackboneElement Insurance information
.... insuranceNumber 0..1 string Health insurance ID assigned to the client

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ClientRegistrationModel.​sex Base required KPS - Administrative Gender 📦0.1.0 This IG
ClientRegistrationModel.​contactPerson.role Base required KPSPatientContactRelationship 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ClientRegistrationModel 0..* Base KPS.A Client Registration
... identifier 1..1 Identifier Government-issued identifier used to distinguish individuals, e.g., National ID (adults) or Birth Certificate number (under 18)
... name 1..1 BackboneElement Client's name
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... given 1..1 string Client's first name
.... family 1..1 string Client's family name or last name
... dateOfBirth 1..1 date Client's date of birth, if known
... address 0..1 BackboneElement Client's residential address
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... country 0..1 string Name of country of affiliation
.... county 0..1 string County where the client resides
.... subcounty 0..1 string Subcounty of residence
.... ward 0..1 string Ward where the client lives
.... village 0..1 string Village or estate of residence
.... postalAddress 0..1 string Mailing address including P.O. Box, street or building details
... telecom 0..1 BackboneElement Client's contact information
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... phone 0..1 string Phone number (mobile or landline)
.... email 0..1 string Email address
... contactPerson 0..1 BackboneElement Contact person or legal guardian
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role 1..1 code Role: legal guardian, next of kin, or other
Binding: KPSPatientContactRelationship (required)
.... relationship 0..1 string Relationship to the client (e.g., father, spouse, daughter)
.... name 0..1 BackboneElement Name of contact person
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... given 1..1 string First name of contact person
..... family 1..1 string Surname of contact person
.... phone 0..1 string Phone number of contact person
.... email 0..1 string Email of contact person
... insurance 0..1 BackboneElement Insurance information
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... insuranceNumber 0..1 string Health insurance ID assigned to the client

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ClientRegistrationModel.​sex Base required KPS - Administrative Gender 📦0.1.0 This IG
ClientRegistrationModel.​contactPerson.role Base required KPSPatientContactRelationship 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(9 nested mandatory elements)

 

Other representations of profile: CSV, Excel