ChanjoKE Immunization Implementation Guide
0.1.0 - ci-build

ChanjoKE Immunization Implementation Guide, published by Intellisoft Consulting Ltd. 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/ChanjoKe-FHIR-IG/ and changes regularly. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Structures: Logical Models

These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.

IMMZ.B Update Client History

Data elements for the IMMZ.B Update Client History Data Dictionary.

IMMZ.C Administer Vaccine

Data elements for the IMMZ.C Administer Vaccine Data Dictionary.

IMMZ.C Register Client

Data elements for the IMMZ.C Register Client Data Dictionary.

IMMZ.D Defaulter Tracing

Data elements for the IMMZ.D Defaulter Tracing Data Dictionary.

IMMZ.E Generate Report

Data elements for the IMMZ.E Report Generation Data Dictionary.

IMMZ.F AEFI

Data elements for the IMMZ.F AEFI Data Dictionary.

IMMZ.G Vaccination Status- Continuity of Care

Data elements for the IMMZ.G Vaccination Status - Continuity of Care Data Dictionary.

IMMZ.H Vaccination Status

Data elements for the IMMZ.H Vaccination Status Data Dictionary.

IMMZ.J Vaccination Core DataSets

Data elements for the IMMZ.J Vaccination Certificate CoreDataSet Data Dictionary.

IMMZ.K Vaccination Status- Proof of Vaccination

Data elements for the IMMZ.K Vaccination Status - Proof of Vaccination Dictionary.

NHDD Register Client

Data elements for the NHDD Register Client Data Dictionary.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

AdverseEventProfile

Profile for Adverse Event

BasicProfile

Profile for the Basic resource.

DefaulterTracingRequest

Service Request for defaulter tracing

DigitalCertificateComposition

Describes the logical structure for a Digital Documentation for a Disease Certificates.

DigitalCertificateCompositionVaccinationStatus

Digital Certificate for Vaccination Status Composition

DigitalCertificateDocument

A Digital Certificate Document is a document bundle containing the Digital Certificate information.

DigitalCertificateDocumentFolder

Digital Certificate Folder of the Paper Certificate

DigitalCertificateDocumentReference

Digital Certificate DocumentReference for QR codes including the QR image and the serialized content.

DigitalCertificateDocumentReferenceQR

Digital Certificate DocumentReference for QR codes including the QR image and the serialized content.

DigitalCertificateOrganization

Abstraction for a Digital Certificate Organization. There should be a Digital Certificate Organization associated to each public health authortiy (PHA)

DigitalCertificatePatient

A Digital Certificate Patient should

KenyanImmunization

Kenyan Registry Profile for Immunization.

KenyanImmunizationRecommendation

A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

KenyanImmunizationRegistryPatient

Kenyan Registry Profile for Patient.

KenyanPractitioner

Profile for a Kenyan Practitioner

SupplyDeliveryProfile

Record of delivery of what is supplied.

SupplyRequestProfile

A record of a request for a medication, substance or device used in the healthcare setting.

TaskProfile

These are requested orders. Will have a summary of all my orders

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

AefiOutcomeExtension

AefiOutcomeExtension

BCG vaccine

BCG vaccine

Body Weight extension

Addition for the patient's body weight in kilograms.

Certificate Issue Date

Date when the vaccination certificate was issued

Certificate Issued

Add-on extension to ascertain whether the individual was given a vaccination certificate

ContraIndication to Vaccine

Evaluation to determine if the patient is ineligible for the vaccine due to contraindications.

Extension for Expected Date of Next Order

AExtension for Expected Date of Next Order

Extension for Action Taken

Action Taken

Extension for Allocated Quantity

AExtension for Allocated Quantity

Extension for Batch Number

AExtension for Batch Number

Extension for Children

AExtension for Children

Extension for Date Of last Order

Extension for Date Of last Order

Extension for Date Received

AExtension for Date Received

Extension for Doses in stock

AExtension for Doses in stock

Extension for Event Details

Brief details on the event

Extension for ExpiryDate

AExtension for ExpiryDate

Extension for Facility Reported

Facility Reported

Extension for Issue Date

AExtension for Issue Date

Extension for Kenya counties

A code representing kenya counties

Extension for Manufacturer Details

AExtension for Manufacturer Details

Extension for Maximum

AExtension for Maximum

Extension for Minimum

AExtension for Minimum

Extension for Order number

AExtension for Order number

Extension for Ordered Amount

AExtension for Ordered Amount

Extension for Origin

AExtension for Origin

Extension for Physical Count

AExtension for Physical Count

Extension for Pregnant women

AExtension for Pregnant women

Extension for Products

Extension for Products

Extension for Quantity Issued

AExtension for Quantity Issued

Extension for Reason For Adjustment

AExtension for Reason For Adjustment

Extension for Reason For New VVM

AExtension for New VVM

Extension for Reason For Previous VVM

AExtension for Previous VVM

Extension for Reason For Stock Origin

AExtension for Stock Origin

Extension for Recommended Stock

AExtension for Recommended Stock

Extension for Remaining Quantity

AExtension for Remaining Quantity

Extension for Specimen Details

Specimen Details

Extension for Specimen collected for investigation

Specimen collected for investigation

Extension for Stock Adjustment Date

AExtension for Stock Adjustment Date

Extension for Stock Adjustment Type

AExtension for Stock Adjustment Type

Extension for Stock Location

AExtension for Stock Location

Extension for Stock Quantity

AExtension for Stock Quantity

Extension for Total Population

Extension for Total Population

Extension for Treatment Details

Treatment Details

Extension for Treatment Given

Treatment Given

Extension for VVM Status

AExtension for VVM Status

Extension for Vaccine

AExtension for Vaccine

Extension for types of AEFI

Extension for types of AEFI

Healthworker extension

Add-on extension to ascertain whether the individual is a healthcare worker.

Inventory Items

Inventory Items

InventoryReportTypes

InventoryReportTypes

KenyaAdministrativeGenderExtension

KenyaAdministrativeGenderExtension

Quantity

Quantity

ReactionSeverityExtension

ReactionSeverityExtension

Vaccine Brand

Vaccine Brand

Validity end date of the certificate.

Validity end Date for the vaccination certificate

Validity start date of the certificate.

Validity Start Date for the vaccination certificate

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

AEFI Action Taken

AEFI Action Taken

AEFI Outcome

AEFI Outcome

Administrative Gender

Administrative Gender

Child can be located

Child can be located

Client's HIV Status

Client's HIV Status

Client's TST Test Result

Client's TST Test Result

Combination Codes for vaccine

This is a mixed value set

Contraindications to vaccine

Contraindications to vaccine

Counties in Kenya

Counties in Kenya

Digital Certificate Formats

ValueSets for Digital Certificate Formats

Disaggregation Group

Disaggregation Group

Due OR Overdue Vaccination(s)

Due OR Overdue Vaccination(s)

Exposed to close contact with TB

Exposed to close contact with TB

Improvement Indicator

Improvement Indicator

Maternal HIV Status

The HIV status of the client's biological mother when the client was born.

Maternal's TST Test Result

Maternal's TST Test Result

Patient Contact List

Paytient Contact List

Patient Identifier type

This is a set of valuesets that have been defined for the KenyanPatient Registry

Place of Vaccination

Place of Vaccination

Reaction Severity

Reaction Severity

Reason Vaccine not administered

Reasons a Vaccine was not administered (Kenyan National Program)

Reason vaccine was not administered

Reason vaccine was not administered

Report Indicator Code

Report Indicator Code

Report Status

Report Status

Report Type

Report Type

Service Requests

Service Requests to be used in Kenyan Context

Stock Adjustment

Stock Adjustment

Type of AEFI

Type of AEFI

Type of last DPT-HepB+Hib dose

Type of last DPT-HepB+Hib dose

Type of last HPV dose

Type of last HPV dose

Type of last Measles-Rubella dose

Type of last Measles-Rubella dose

Type of last PCV10 dose

Type of last PCV10 dose

Type of last Polio dose

Type of last Polio dose

Type of last Rotavirus dose

Type of last Rotavirus dose

Vaccine Library

Vaccine Library

Vaccine administered

Vaccine administered

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

DDCC QR Format Codes

Format of the representation of QR code

IMMZ.B CodeSystem for Data Elements

CodeSystem for IMMZ.B Data Elements

IMMZ.C CodeSystem for Data Elements

CodeSystem for IMMZ.C Data Elements

IMMZ.D CodeSystem for Defaulter Tracing

CodeSystem for IMMZ.D Data Elements

IMMZ.E CodeSystem for Data Elements

CodeSystem for IMMZ.E Data Elements

IMMZ.F CodeSystem for Data Elements

CodeSystem for IMMZ.F Data Elements

IMMZ.G CodeSystem for Data Elements

CodeSystem for IMMZ.G (Vaccination Status - Continuity of Care) Data Elements

IMMZ.H CodeSystem for Vaccine status

CodeSystem for Digital documentation of Immunization certificate (DDIMZC) status Data Elements

IMMZ.Z1 CodeSystem for Data Elements

CodeSystem for IMMZ.Z1 Data Elements

Identifier Types

Defined Identifier Types for KenyanRegistryPatient

Kenya Vaccine Codes
KenyaCounties CodeSystem for Counties in Kenya

CodeSystem for Counties in Kenya

NHDD

Kenya National Health Data Dictionary

Patient's Contact List

Patient's family members, friends or others that can be contacted by healthcare providers onbahalf of the patient

Place of Vaccination

Place of Vaccination

Reason Vaccine not Administered
Service Requests

Service Reequests to be used within the Kenyan Contexts

codeSystem for Adjustment Type

CodeSystem for Adjustment Type

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

DDCC QR Format Codes

Format of the representation of QR code

DefaulterTracingRequestExample

An example of a defaulter tracing request

DigitalCertificateCompositionExample

Example of a Digital Certificate Composition

DigitalCertificateCompositionVaccinationStatusExample

An example of a digital certificate for vaccination status composition

DigitalCertificateDocumentExample

An example of a digital certificate document

DigitalCertificateDocumentFolderExample

An example of a digital certificate document folder

DigitalCertificateDocumentReferenceExample

An example of Digital Certificate Document Reference for QR codes

DigitalCertificateDocumentReferenceQRExample

An example of a digital certificate document reference for QR codes

DigitalCertificateOrganizationExample

An example of a digital certificate organization

DigitalCertificatePatientExample

An example of a digital certificate patient

Example Adverse Event

An example instance of an adverse event profile.

Example Condition

An example instance of a condition.

IMMZ.B CodeSystem for Data Elements

CodeSystem for IMMZ.B Data Elements

IMMZ.C Administer Vaccine Example

An example instance of the IMMZ.C Administer Vaccine Data Dictionary.

IMMZ.C CodeSystem for Data Elements

CodeSystem for IMMZ.C Data Elements

IMMZ.D CodeSystem for Defaulter Tracing

CodeSystem for IMMZ.D Data Elements

IMMZ.D Defaulter Tracing Example

An example instance of the IMMZ.D Defaulter Tracing Profile.

IMMZ.E CodeSystem for Data Elements

CodeSystem for IMMZ.E Data Elements

IMMZ.E Generate Report Example

An example instance of the IMMZ.E Generate Report Profile.

IMMZ.F AEFI Example

An example instance of the IMMZ.F AEFI Data Dictionary.

IMMZ.F CodeSystem for Data Elements

CodeSystem for IMMZ.F Data Elements

IMMZ.G CodeSystem for Data Elements

CodeSystem for IMMZ.G (Vaccination Status - Continuity of Care) Data Elements

IMMZ.H CodeSystem for Vaccine status

CodeSystem for Digital documentation of Immunization certificate (DDIMZC) status Data Elements

IMMZ.Z1 CodeSystem for Data Elements

CodeSystem for IMMZ.Z1 Data Elements

IMMZARegisterClientExample

An example of a IMMZA Register Client

IMMZBUpdateClientHistoryExample

Example instance for IMMZBUpdateClientHistory

Identifier Types

Defined Identifier Types for KenyanRegistryPatient

Kenya Vaccine Codes

CodeSystem for Kenya Vaccine Codes

KenyaCounties CodeSystem for Counties in Kenya

CodeSystem for Counties in Kenya

KenyanImmunizationExample
KenyanImmunizationRecommendationExample

An example of a Kenyan Immunization Recommendation

KenyanPractitionerExample

An example of a Kenyan Practitioner

LocationExample

An example of a Location

MedicationExample

An example of a Medication

NHDD CodeSystem for Data Elements

CodeSystem for NHDD Data Elements

OrganizationExample

An example of an organization

Patient's Contact List

Patient's family members, friends or others that can be contacted by healthcare providers on behalf of the patient

PatientExample
PractitionerExample
Reason Vaccine not Administered

CodeSystem for reasons vaccine not administered in Kenya

Service Requests

Service Requests to be used within the Kenyan Contexts

ServiceRequestExample

An example of a service request

SubstanceExample

Example Substance

SupplyDeliveryProfileExample

An example of a Supply Delivery Profile

TaskProfileExample

An example of a Task

codeSystem for Adjustment Type

CodeSystem for Adjustment Type