FHIR IG analytics| Package | fhir.kenyaPSIG |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-ImmunizationRecord.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/IntelliSOFT-Consulting/Kenya-Patient-Summary-FHIR-IG/StructureDefinition-ImmunizationRecord.html |
| URL | https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ImmunizationRecord |
| Version | 0.1.0 |
| Status | draft |
| Date | 2026-06-19T10:10:16+00:00 |
| Name | ImmunizationRecord |
| Title | KPS.E Immunization |
| Realm | us |
| Authority | hl7 |
| Description | Logical model for capturing immunization information under the Kenya Patient Summary (KPS.E) domain. |
| Copyright | Copyright © 2024+ Digital Health Agency of Kenya. This content is licensed under Creative Commons Zero v1.0 Universal (CC0 1.0). No rights reserved. |
| Type | https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ImmunizationRecord |
| Kind | logical |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition ImmunizationRecord
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ImmunizationRecord | 0..* | Base | KPS.E Immunization | |
  targetDisease | 1..1 | string | Disease or agent that the vaccination provides protection against | |
| status | 1..1 | code | Current status of immunization against the disease | |
| vaccineProphylaxis | 0..1 | string | Generic description of the vaccine/prophylaxis or its component(s) | |
| vaccineBrand | 0..1 | string | Brand name of the vaccine medicinal product | |
| vaccineIdentifier | 0..1 | string | Identifier for the vaccine medicinal product (e.g. MPID, EMA PMS ID, or national ID) | |
| marketingAuthorisationHolder | 0..1 | string | Organization or individual authorized to market the vaccine | |
| doseNumber | 0..1 | integer | Order in the vaccination course | |
| lotNumber | 0..1 | string | Specific identifier of the vaccine batch | |
| vaccinationDate | 0..1 | date | Date when the vaccination was administered | |
| ageAtVaccination | 0..1 | string | Age at which the vaccination was administered | |
| administeringCentre | 0..1 | string | Name or code of the administering centre or health authority | |
| healthProfessional | 0..1 | string | Name or code of the health professional who administered the vaccine | |
 nextVaccinationDate | 0..1 | date | Date of the planned next vaccination (e.g. next dose) | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "ImmunizationRecord",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ImmunizationRecord",
"version": "0.1.0",
"name": "ImmunizationRecord",
"title": "KPS.E Immunization",
"status": "draft",
"date": "2026-06-19T10:10:16+00:00",
"publisher": "Digital Health Agency of Kenya",
"contact": [
{
"name": "Digital Health Agency of Kenya",
"telecom": [
{
"system": "url",
"value": "https://www.dha.go.ke"
},
{
"system": "email",
"value": "interoperability@dha.go.ke"
}
]
},
{
"name": "Digital Health Agency of Kenya – Interoperability Team",
"telecom": [
{
"system": "email",
"value": "interoperability@dha.go.ke",
"use": "work"
},
{
"system": "url",
"value": "https://www.dha.go.ke",
"use": "work"
}
]
}
],
"description": "Logical model for capturing immunization information under the Kenya Patient Summary (KPS.E) domain.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "KE",
"display": "Kenya"
}
]
}
],
"copyright": "Copyright © 2024+ Digital Health Agency of Kenya. This content is licensed under Creative Commons Zero v1.0 Universal (CC0 1.0). No rights reserved.\n",
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "https://nshr-uat.sha.go.ke/fhir/StructureDefinition/ImmunizationRecord",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "ImmunizationRecord",
"path": "ImmunizationRecord",
"short": "KPS.E Immunization",
"definition": "Logical model for capturing immunization information under the Kenya Patient Summary (KPS.E) domain.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "ImmunizationRecord.targetDisease",
"path": "ImmunizationRecord.targetDisease",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.1"
}
],
"short": "Disease or agent that the vaccination provides protection against",
"definition": "Disease or agent that the vaccination provides protection against",
"min": 1,
"max": "1",
"base": {
"path": "ImmunizationRecord.targetDisease",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.status",
"path": "ImmunizationRecord.status",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.1.1"
}
],
"short": "Current status of immunization against the disease",
"definition": "Current status of immunization against the disease",
"min": 1,
"max": "1",
"base": {
"path": "ImmunizationRecord.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "ImmunizationRecord.vaccineProphylaxis",
"path": "ImmunizationRecord.vaccineProphylaxis",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.2"
}
],
"short": "Generic description of the vaccine/prophylaxis or its component(s)",
"definition": "Generic description of the vaccine/prophylaxis or its component(s)",
"min": 0,
"max": "1",
"base": {
"path": "ImmunizationRecord.vaccineProphylaxis",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.vaccineBrand",
"path": "ImmunizationRecord.vaccineBrand",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.3"
}
],
"short": "Brand name of the vaccine medicinal product",
"definition": "Brand name of the vaccine medicinal product",
"min": 0,
"max": "1",
"base": {
"path": "ImmunizationRecord.vaccineBrand",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.vaccineIdentifier",
"path": "ImmunizationRecord.vaccineIdentifier",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.4"
}
],
"short": "Identifier for the vaccine medicinal product (e.g. MPID, EMA PMS ID, or national ID)",
"definition": "Identifier for the vaccine medicinal product (e.g. MPID, EMA PMS ID, or national ID)",
"min": 0,
"max": "1",
"base": {
"path": "ImmunizationRecord.vaccineIdentifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.marketingAuthorisationHolder",
"path": "ImmunizationRecord.marketingAuthorisationHolder",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.5"
}
],
"short": "Organization or individual authorized to market the vaccine",
"definition": "Organization or individual authorized to market the vaccine",
"min": 0,
"max": "1",
"base": {
"path": "ImmunizationRecord.marketingAuthorisationHolder",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.doseNumber",
"path": "ImmunizationRecord.doseNumber",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.6"
}
],
"short": "Order in the vaccination course",
"definition": "Order in the vaccination course",
"min": 0,
"max": "1",
"base": {
"path": "ImmunizationRecord.doseNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "ImmunizationRecord.lotNumber",
"path": "ImmunizationRecord.lotNumber",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.7"
}
],
"short": "Specific identifier of the vaccine batch",
"definition": "Specific identifier of the vaccine batch",
"min": 0,
"max": "1",
"base": {
"path": "ImmunizationRecord.lotNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.vaccinationDate",
"path": "ImmunizationRecord.vaccinationDate",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.8"
}
],
"short": "Date when the vaccination was administered",
"definition": "Date when the vaccination was administered",
"min": 0,
"max": "1",
"base": {
"path": "ImmunizationRecord.vaccinationDate",
"min": 0,
"max": "1"
},
"type": [
{
"code": "date"
}
]
},
{
"id": "ImmunizationRecord.ageAtVaccination",
"path": "ImmunizationRecord.ageAtVaccination",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.8.1"
}
],
"short": "Age at which the vaccination was administered",
"definition": "Age at which the vaccination was administered",
"min": 0,
"max": "1",
"base": {
"path": "ImmunizationRecord.ageAtVaccination",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.administeringCentre",
"path": "ImmunizationRecord.administeringCentre",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.9"
}
],
"short": "Name or code of the administering centre or health authority",
"definition": "Name or code of the administering centre or health authority",
"min": 0,
"max": "1",
"base": {
"path": "ImmunizationRecord.administeringCentre",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.healthProfessional",
"path": "ImmunizationRecord.healthProfessional",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.10"
}
],
"short": "Name or code of the health professional who administered the vaccine",
"definition": "Name or code of the health professional who administered the vaccine",
"min": 0,
"max": "1",
"base": {
"path": "ImmunizationRecord.healthProfessional",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.nextVaccinationDate",
"path": "ImmunizationRecord.nextVaccinationDate",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.12"
}
],
"short": "Date of the planned next vaccination (e.g. next dose)",
"definition": "Date of the planned next vaccination (e.g. next dose)",
"min": 0,
"max": "1",
"base": {
"path": "ImmunizationRecord.nextVaccinationDate",
"min": 0,
"max": "1"
},
"type": [
{
"code": "date"
}
]
}
]
},
"differential": {
"element": [
{
"id": "ImmunizationRecord",
"path": "ImmunizationRecord",
"short": "KPS.E Immunization",
"definition": "Logical model for capturing immunization information under the Kenya Patient Summary (KPS.E) domain."
},
{
"id": "ImmunizationRecord.targetDisease",
"path": "ImmunizationRecord.targetDisease",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.1"
}
],
"short": "Disease or agent that the vaccination provides protection against",
"definition": "Disease or agent that the vaccination provides protection against",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.status",
"path": "ImmunizationRecord.status",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.1.1"
}
],
"short": "Current status of immunization against the disease",
"definition": "Current status of immunization against the disease",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "ImmunizationRecord.vaccineProphylaxis",
"path": "ImmunizationRecord.vaccineProphylaxis",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.2"
}
],
"short": "Generic description of the vaccine/prophylaxis or its component(s)",
"definition": "Generic description of the vaccine/prophylaxis or its component(s)",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.vaccineBrand",
"path": "ImmunizationRecord.vaccineBrand",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.3"
}
],
"short": "Brand name of the vaccine medicinal product",
"definition": "Brand name of the vaccine medicinal product",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.vaccineIdentifier",
"path": "ImmunizationRecord.vaccineIdentifier",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.4"
}
],
"short": "Identifier for the vaccine medicinal product (e.g. MPID, EMA PMS ID, or national ID)",
"definition": "Identifier for the vaccine medicinal product (e.g. MPID, EMA PMS ID, or national ID)",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.marketingAuthorisationHolder",
"path": "ImmunizationRecord.marketingAuthorisationHolder",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.5"
}
],
"short": "Organization or individual authorized to market the vaccine",
"definition": "Organization or individual authorized to market the vaccine",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.doseNumber",
"path": "ImmunizationRecord.doseNumber",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.6"
}
],
"short": "Order in the vaccination course",
"definition": "Order in the vaccination course",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"id": "ImmunizationRecord.lotNumber",
"path": "ImmunizationRecord.lotNumber",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.7"
}
],
"short": "Specific identifier of the vaccine batch",
"definition": "Specific identifier of the vaccine batch",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.vaccinationDate",
"path": "ImmunizationRecord.vaccinationDate",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.8"
}
],
"short": "Date when the vaccination was administered",
"definition": "Date when the vaccination was administered",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"id": "ImmunizationRecord.ageAtVaccination",
"path": "ImmunizationRecord.ageAtVaccination",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.8.1"
}
],
"short": "Age at which the vaccination was administered",
"definition": "Age at which the vaccination was administered",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.administeringCentre",
"path": "ImmunizationRecord.administeringCentre",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.9"
}
],
"short": "Name or code of the administering centre or health authority",
"definition": "Name or code of the administering centre or health authority",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.healthProfessional",
"path": "ImmunizationRecord.healthProfessional",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.10"
}
],
"short": "Name or code of the health professional who administered the vaccine",
"definition": "Name or code of the health professional who administered the vaccine",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ImmunizationRecord.nextVaccinationDate",
"path": "ImmunizationRecord.nextVaccinationDate",
"code": [
{
"system": "https://nshr-uat.sha.go.ke/fhir/CodeSystem/kps-data-elements",
"code": "KPS.E.DE.12"
}
],
"short": "Date of the planned next vaccination (e.g. next dose)",
"definition": "Date of the planned next vaccination (e.g. next dose)",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
}
]
}
}