ImmunizationRecord
type: StructureDefinition
node role: treeRoot
id:
  v: ImmunizationRecord
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition ImmunizationRecord Name Flags Card. Type Description & Constraints ImmunizationRecord 0..* Base KPS.E Immunization #xD; targetDisease 1..1 string Disease or agent that the vaccination provides protection against #xD; status 1..1 code Current status of immunization against the disease #xD; vaccineProphylaxis 0..1 string Generic description of the vaccine/prophylaxis or its component(s) #xD; vaccineBrand 0..1 string Brand name of the vaccine medicinal product #xD; vaccineIdentifier 0..1 string Identifier for the vaccine medicinal product (e.g. MPID, EMA PMS ID, or national ID) #xD; marketingAuthorisationHolder 0..1 string Organization or individual authorized to market the vaccine #xD; doseNumber 0..1 integer Order in the vaccination course #xD; lotNumber 0..1 string Specific identifier of the vaccine batch #xD; vaccinationDate 0..1 date Date when the vaccination was administered #xD; ageAtVaccination 0..1 string Age at which the vaccination was administered #xD; administeringCentre 0..1 string Name or code of the administering centre or health authority #xD; healthProfessional 0..1 string Name or code of the health professional who administered the vaccine #xD; nextVaccinationDate 0..1 date Date of the planned next vaccination (e.g. next dose) #xD; Documentation for this format
url:
  v: https://example.org/fhir/StructureDefinition/ImmunizationRecord
  l: ImmunizationRecord
version:
  v: 0.1.0
name:
  v: ImmunizationRecord
title:
  v: KPS.E Immunization
status:
  v: draft
date:
  v: 2025-12-09T10:36:20+00:00
publisher:
  v: IntelliSOFT Consulting
contact:
  name:
    v: IntelliSOFT Consulting
  telecom:
    system:
      v: url
    value:
      v: https://.com/fhir/example-publisher
contact:
  name:
    v: KPS Team Kenya.
  telecom:
    system:
      v: email
    use:
      v: work
description:
  v: Logical model for capturing immunization information under the Kenya Patient Summary (KPS.E) domain.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
      l: 3166
    code:
      v: KE
    display:
      v: Kenya
fhir version:
  v: 4.0.1
kind:
  v: logical
abstract:
  v: false
type:
  v: https://example.org/fhir/StructureDefinition/ImmunizationRecord
  l: ImmunizationRecord
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Base
  l: Base
derivation:
  v: specialization
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 4.0.1
  element:
    id:
      v: ImmunizationRecord
    path:
      v: ImmunizationRecord
    short:
      v: KPS.E Immunization
    definition:
      v: Logical model for capturing immunization information under the Kenya Patient Summary (KPS.E) domain.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    is modifier:
      v: false
  element:
    id:
      v: ImmunizationRecord.targetDisease
    path:
      v: ImmunizationRecord.targetDisease
    code:
      code:
        v: KPS.E.DE.1
    short:
      v: Disease or agent that the vaccination provides protection against
    definition:
      v: Disease or agent that the vaccination provides protection against
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: ImmunizationRecord.targetDisease
      min:
        v: 1
      max:
        v: 1
    type:
      code:
        v: string
        l: string
  element:
    id:
      v: ImmunizationRecord.status
    path:
      v: ImmunizationRecord.status
    code:
      code:
        v: KPS.E.DE.1.1
    short:
      v: Current status of immunization against the disease
    definition:
      v: Current status of immunization against the disease
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: ImmunizationRecord.status
      min:
        v: 1
      max:
        v: 1
    type:
      code:
        v: code
        l: code
  element:
    id:
      v: ImmunizationRecord.vaccineProphylaxis
    path:
      v: ImmunizationRecord.vaccineProphylaxis
    code:
      code:
        v: KPS.E.DE.2
    short:
      v: Generic description of the vaccine/prophylaxis or its component(s)
    definition:
      v: Generic description of the vaccine/prophylaxis or its component(s)
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: ImmunizationRecord.vaccineProphylaxis
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: string
        l: string
  element:
    id:
      v: ImmunizationRecord.vaccineBrand
    path:
      v: ImmunizationRecord.vaccineBrand
    code:
      code:
        v: KPS.E.DE.3
    short:
      v: Brand name of the vaccine medicinal product
    definition:
      v: Brand name of the vaccine medicinal product
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: ImmunizationRecord.vaccineBrand
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: string
        l: string

id:
  v: ImmunizationRecord.vaccineIdentifier
path:
  v: ImmunizationRecord.vaccineIdentifier
code:
  code:
    v: KPS.E.DE.4
short:
  v: Identifier for the vaccine medicinal product (e.g. MPID, EMA PMS ID, or national ID)
definition:
  v: Identifier for the vaccine medicinal product (e.g. MPID, EMA PMS ID, or national ID)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ImmunizationRecord.vaccineIdentifier
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: ImmunizationRecord.marketingAuthorisationHolder
path:
  v: ImmunizationRecord.marketingAuthorisationHolder
code:
  code:
    v: KPS.E.DE.5
short:
  v: Organization or individual authorized to market the vaccine
definition:
  v: Organization or individual authorized to market the vaccine
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ImmunizationRecord.marketingAuthorisationHolder
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: ImmunizationRecord.doseNumber
path:
  v: ImmunizationRecord.doseNumber
code:
  code:
    v: KPS.E.DE.6
short:
  v: Order in the vaccination course
definition:
  v: Order in the vaccination course
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ImmunizationRecord.doseNumber
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: integer
    l: integer

id:
  v: ImmunizationRecord.lotNumber
path:
  v: ImmunizationRecord.lotNumber
code:
  code:
    v: KPS.E.DE.7
short:
  v: Specific identifier of the vaccine batch
definition:
  v: Specific identifier of the vaccine batch
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ImmunizationRecord.lotNumber
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: ImmunizationRecord.vaccinationDate
path:
  v: ImmunizationRecord.vaccinationDate
code:
  code:
    v: KPS.E.DE.8
short:
  v: Date when the vaccination was administered
definition:
  v: Date when the vaccination was administered
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ImmunizationRecord.vaccinationDate
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: date
    l: date

id:
  v: ImmunizationRecord.ageAtVaccination
path:
  v: ImmunizationRecord.ageAtVaccination
code:
  code:
    v: KPS.E.DE.8.1
short:
  v: Age at which the vaccination was administered
definition:
  v: Age at which the vaccination was administered
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ImmunizationRecord.ageAtVaccination
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: ImmunizationRecord.administeringCentre
path:
  v: ImmunizationRecord.administeringCentre
code:
  code:
    v: KPS.E.DE.9
short:
  v: Name or code of the administering centre or health authority
definition:
  v: Name or code of the administering centre or health authority
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ImmunizationRecord.administeringCentre
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: ImmunizationRecord.healthProfessional
path:
  v: ImmunizationRecord.healthProfessional
code:
  code:
    v: KPS.E.DE.10
short:
  v: Name or code of the health professional who administered the vaccine
definition:
  v: Name or code of the health professional who administered the vaccine
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ImmunizationRecord.healthProfessional
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: ImmunizationRecord.nextVaccinationDate
path:
  v: ImmunizationRecord.nextVaccinationDate
code:
  code:
    v: KPS.D.DE.12
short:
  v: Date of the planned next vaccination (e.g. next dose)
definition:
  v: Date of the planned next vaccination (e.g. next dose)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ImmunizationRecord.nextVaccinationDate
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: date
    l: date

element:
  id:
    v: ImmunizationRecord
  path:
    v: ImmunizationRecord
  short:
    v: KPS.E Immunization
  definition:
    v: Logical model for capturing immunization information under the Kenya Patient Summary (KPS.E) domain.
element:
  id:
    v: ImmunizationRecord.targetDisease
  path:
    v: ImmunizationRecord.targetDisease
  code:
    code:
      v: KPS.E.DE.1
  short:
    v: Disease or agent that the vaccination provides protection against
  definition:
    v: Disease or agent that the vaccination provides protection against
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: ImmunizationRecord.status
  path:
    v: ImmunizationRecord.status
  code:
    code:
      v: KPS.E.DE.1.1
  short:
    v: Current status of immunization against the disease
  definition:
    v: Current status of immunization against the disease
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: code
      l: code
element:
  id:
    v: ImmunizationRecord.vaccineProphylaxis
  path:
    v: ImmunizationRecord.vaccineProphylaxis
  code:
    code:
      v: KPS.E.DE.2
  short:
    v: Generic description of the vaccine/prophylaxis or its component(s)
  definition:
    v: Generic description of the vaccine/prophylaxis or its component(s)
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: ImmunizationRecord.vaccineBrand
  path:
    v: ImmunizationRecord.vaccineBrand
  code:
    code:
      v: KPS.E.DE.3
  short:
    v: Brand name of the vaccine medicinal product
  definition:
    v: Brand name of the vaccine medicinal product
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: ImmunizationRecord.vaccineIdentifier
  path:
    v: ImmunizationRecord.vaccineIdentifier
  code:
    code:
      v: KPS.E.DE.4
  short:
    v: Identifier for the vaccine medicinal product (e.g. MPID, EMA PMS ID, or national ID)
  definition:
    v: Identifier for the vaccine medicinal product (e.g. MPID, EMA PMS ID, or national ID)
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: ImmunizationRecord.marketingAuthorisationHolder
  path:
    v: ImmunizationRecord.marketingAuthorisationHolder
  code:
    code:
      v: KPS.E.DE.5
  short:
    v: Organization or individual authorized to market the vaccine
  definition:
    v: Organization or individual authorized to market the vaccine
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: ImmunizationRecord.doseNumber
  path:
    v: ImmunizationRecord.doseNumber
  code:
    code:
      v: KPS.E.DE.6
  short:
    v: Order in the vaccination course
  definition:
    v: Order in the vaccination course
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: integer
      l: integer
element:
  id:
    v: ImmunizationRecord.lotNumber
  path:
    v: ImmunizationRecord.lotNumber
  code:
    code:
      v: KPS.E.DE.7
  short:
    v: Specific identifier of the vaccine batch
  definition:
    v: Specific identifier of the vaccine batch
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: ImmunizationRecord.vaccinationDate
  path:
    v: ImmunizationRecord.vaccinationDate
  code:
    code:
      v: KPS.E.DE.8
  short:
    v: Date when the vaccination was administered
  definition:
    v: Date when the vaccination was administered
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: date
      l: date
element:
  id:
    v: ImmunizationRecord.ageAtVaccination
  path:
    v: ImmunizationRecord.ageAtVaccination
  code:
    code:
      v: KPS.E.DE.8.1
  short:
    v: Age at which the vaccination was administered
  definition:
    v: Age at which the vaccination was administered

v: 0

v: 1

code:
  v: string
  l: string

id:
  v: ImmunizationRecord.administeringCentre
path:
  v: ImmunizationRecord.administeringCentre
code:
  code:
    v: KPS.E.DE.9
short:
  v: Name or code of the administering centre or health authority
definition:
  v: Name or code of the administering centre or health authority
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string

id:
  v: ImmunizationRecord.healthProfessional
path:
  v: ImmunizationRecord.healthProfessional
code:
  code:
    v: KPS.E.DE.10
short:
  v: Name or code of the health professional who administered the vaccine
definition:
  v: Name or code of the health professional who administered the vaccine
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string

id:
  v: ImmunizationRecord.nextVaccinationDate
path:
  v: ImmunizationRecord.nextVaccinationDate
code:
  code:
    v: KPS.D.DE.12
short:
  v: Date of the planned next vaccination (e.g. next dose)
definition:
  v: Date of the planned next vaccination (e.g. next dose)
min:
  v: 0
max:
  v: 1
type:
  code:
    v: date
    l: date