Kenya Patient Summary FHIR Implementation Guide
0.1.0 - ci-build
Kenya Patient Summary FHIR Implementation Guide
0.1.0 - ci-build
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
| Draft as of 2026-06-19 |
Definitions for the ImmunizationRecord logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. ImmunizationRecord | |
| Definition | Logical model for capturing immunization information under the Kenya Patient Summary (KPS.E) domain. |
| Short | KPS.E Immunization |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. ImmunizationRecord.targetDisease | |
| Definition | Disease or agent that the vaccination provides protection against |
| Short | Disease or agent that the vaccination provides protection against |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.1 (Target Disease) |
| 4. ImmunizationRecord.status | |
| Definition | Current status of immunization against the disease |
| Short | Current status of immunization against the disease |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.1.1 (Status) |
| 6. ImmunizationRecord.vaccineProphylaxis | |
| Definition | Generic description of the vaccine/prophylaxis or its component(s) |
| Short | Generic description of the vaccine/prophylaxis or its component(s) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.2 (Vaccine Prophylaxis) |
| 8. ImmunizationRecord.vaccineBrand | |
| Definition | Brand name of the vaccine medicinal product |
| Short | Brand name of the vaccine medicinal product |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.3 (Vaccine Brand) |
| 10. ImmunizationRecord.vaccineIdentifier | |
| Definition | Identifier for the vaccine medicinal product (e.g. MPID, EMA PMS ID, or national ID) |
| Short | Identifier for the vaccine medicinal product (e.g. MPID, EMA PMS ID, or national ID) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.4 (Vaccine Identifier) |
| 12. ImmunizationRecord.marketingAuthorisationHolder | |
| Definition | Organization or individual authorized to market the vaccine |
| Short | Organization or individual authorized to market the vaccine |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.5 (Marketing Authorisation Holder) |
| 14. ImmunizationRecord.doseNumber | |
| Definition | Order in the vaccination course |
| Short | Order in the vaccination course |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.6 (Dose Number) |
| 16. ImmunizationRecord.lotNumber | |
| Definition | Specific identifier of the vaccine batch |
| Short | Specific identifier of the vaccine batch |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.7 (Lot Number) |
| 18. ImmunizationRecord.vaccinationDate | |
| Definition | Date when the vaccination was administered |
| Short | Date when the vaccination was administered |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.8 (Vaccination Date) |
| 20. ImmunizationRecord.ageAtVaccination | |
| Definition | Age at which the vaccination was administered |
| Short | Age at which the vaccination was administered |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.8.1 (Age at Vaccination) |
| 22. ImmunizationRecord.administeringCentre | |
| Definition | Name or code of the administering centre or health authority |
| Short | Name or code of the administering centre or health authority |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.9 (Administering Centre) |
| 24. ImmunizationRecord.healthProfessional | |
| Definition | Name or code of the health professional who administered the vaccine |
| Short | Name or code of the health professional who administered the vaccine |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.10 (Health Professional) |
| 26. ImmunizationRecord.nextVaccinationDate | |
| Definition | Date of the planned next vaccination (e.g. next dose) |
| Short | Date of the planned next vaccination (e.g. next dose) |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.12 (Next Vaccination Date) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ImmunizationRecord | |
| Definition | Logical model for capturing immunization information under the Kenya Patient Summary (KPS.E) domain. |
| Short | KPS.E Immunization |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. ImmunizationRecord.targetDisease | |
| Definition | Disease or agent that the vaccination provides protection against |
| Short | Disease or agent that the vaccination provides protection against |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.1 (Target Disease) |
| 4. ImmunizationRecord.status | |
| Definition | Current status of immunization against the disease |
| Short | Current status of immunization against the disease |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.1.1 (Status) |
| 6. ImmunizationRecord.vaccineProphylaxis | |
| Definition | Generic description of the vaccine/prophylaxis or its component(s) |
| Short | Generic description of the vaccine/prophylaxis or its component(s) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.2 (Vaccine Prophylaxis) |
| 8. ImmunizationRecord.vaccineBrand | |
| Definition | Brand name of the vaccine medicinal product |
| Short | Brand name of the vaccine medicinal product |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.3 (Vaccine Brand) |
| 10. ImmunizationRecord.vaccineIdentifier | |
| Definition | Identifier for the vaccine medicinal product (e.g. MPID, EMA PMS ID, or national ID) |
| Short | Identifier for the vaccine medicinal product (e.g. MPID, EMA PMS ID, or national ID) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.4 (Vaccine Identifier) |
| 12. ImmunizationRecord.marketingAuthorisationHolder | |
| Definition | Organization or individual authorized to market the vaccine |
| Short | Organization or individual authorized to market the vaccine |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.5 (Marketing Authorisation Holder) |
| 14. ImmunizationRecord.doseNumber | |
| Definition | Order in the vaccination course |
| Short | Order in the vaccination course |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.6 (Dose Number) |
| 16. ImmunizationRecord.lotNumber | |
| Definition | Specific identifier of the vaccine batch |
| Short | Specific identifier of the vaccine batch |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.7 (Lot Number) |
| 18. ImmunizationRecord.vaccinationDate | |
| Definition | Date when the vaccination was administered |
| Short | Date when the vaccination was administered |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.8 (Vaccination Date) |
| 20. ImmunizationRecord.ageAtVaccination | |
| Definition | Age at which the vaccination was administered |
| Short | Age at which the vaccination was administered |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.8.1 (Age at Vaccination) |
| 22. ImmunizationRecord.administeringCentre | |
| Definition | Name or code of the administering centre or health authority |
| Short | Name or code of the administering centre or health authority |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.9 (Administering Centre) |
| 24. ImmunizationRecord.healthProfessional | |
| Definition | Name or code of the health professional who administered the vaccine |
| Short | Name or code of the health professional who administered the vaccine |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.10 (Health Professional) |
| 26. ImmunizationRecord.nextVaccinationDate | |
| Definition | Date of the planned next vaccination (e.g. next dose) |
| Short | Date of the planned next vaccination (e.g. next dose) |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.12 (Next Vaccination Date) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. ImmunizationRecord | |
| Definition | Logical model for capturing immunization information under the Kenya Patient Summary (KPS.E) domain. |
| Short | KPS.E Immunization |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. ImmunizationRecord.targetDisease | |
| Definition | Disease or agent that the vaccination provides protection against |
| Short | Disease or agent that the vaccination provides protection against |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.1 (Target Disease) |
| 4. ImmunizationRecord.status | |
| Definition | Current status of immunization against the disease |
| Short | Current status of immunization against the disease |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.1.1 (Status) |
| 6. ImmunizationRecord.vaccineProphylaxis | |
| Definition | Generic description of the vaccine/prophylaxis or its component(s) |
| Short | Generic description of the vaccine/prophylaxis or its component(s) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.2 (Vaccine Prophylaxis) |
| 8. ImmunizationRecord.vaccineBrand | |
| Definition | Brand name of the vaccine medicinal product |
| Short | Brand name of the vaccine medicinal product |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.3 (Vaccine Brand) |
| 10. ImmunizationRecord.vaccineIdentifier | |
| Definition | Identifier for the vaccine medicinal product (e.g. MPID, EMA PMS ID, or national ID) |
| Short | Identifier for the vaccine medicinal product (e.g. MPID, EMA PMS ID, or national ID) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.4 (Vaccine Identifier) |
| 12. ImmunizationRecord.marketingAuthorisationHolder | |
| Definition | Organization or individual authorized to market the vaccine |
| Short | Organization or individual authorized to market the vaccine |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.5 (Marketing Authorisation Holder) |
| 14. ImmunizationRecord.doseNumber | |
| Definition | Order in the vaccination course |
| Short | Order in the vaccination course |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.6 (Dose Number) |
| 16. ImmunizationRecord.lotNumber | |
| Definition | Specific identifier of the vaccine batch |
| Short | Specific identifier of the vaccine batch |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.7 (Lot Number) |
| 18. ImmunizationRecord.vaccinationDate | |
| Definition | Date when the vaccination was administered |
| Short | Date when the vaccination was administered |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.8 (Vaccination Date) |
| 20. ImmunizationRecord.ageAtVaccination | |
| Definition | Age at which the vaccination was administered |
| Short | Age at which the vaccination was administered |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.8.1 (Age at Vaccination) |
| 22. ImmunizationRecord.administeringCentre | |
| Definition | Name or code of the administering centre or health authority |
| Short | Name or code of the administering centre or health authority |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.9 (Administering Centre) |
| 24. ImmunizationRecord.healthProfessional | |
| Definition | Name or code of the health professional who administered the vaccine |
| Short | Name or code of the health professional who administered the vaccine |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.10 (Health Professional) |
| 26. ImmunizationRecord.nextVaccinationDate | |
| Definition | Date of the planned next vaccination (e.g. next dose) |
| Short | Date of the planned next vaccination (e.g. next dose) |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | KPS Data Element Identifiers: KPS.E.DE.12 (Next Vaccination Date) |