Nigeria Immunization FHIR IG
0.1.0 - ci-build Nigeria flag

Nigeria Immunization FHIR IG, published by intellisoftkenya.com. 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/Nigeria-Immunization-FHIR-IG/ and changes regularly. See the Directory of published versions

Logical Model: IMMZGGenerateReport - Detailed Descriptions

Active as of 2025-08-11

Definitions for the IMMZGGenerateReport logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. IMMZGGenerateReport
Definition

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

ShortIMMZ.G Generate Report
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. IMMZGGenerateReport.reportIdentification
Definition

A unique identifier for the instance of the report that has been generated

ShortReport Identification
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE1
4. IMMZGGenerateReport.reportStatus
Definition

The status of the report (for example, initial, complete, etc.)

ShortReport Status
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE2
6. IMMZGGenerateReport.reportType
Definition

The type of report which has been generated (i.e., list of individuals, summary, etc.)

ShortReport Type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE6
8. IMMZGGenerateReport.reportIndicatorCode
Definition

The indicator or measure definition being reported on (e.g., dropout rate, defaulters, etc.)

ShortReport Indicator Code
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE10
10. IMMZGGenerateReport.numberOfDosesPerVial
Definition

The number of doses contained within a vial

ShortNumber of doses per vial
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE14
12. IMMZGGenerateReport.minimumStock
Definition

25% of the vaccine requirement in a facility during the reporting month

ShortMinimum Stock
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE15
14. IMMZGGenerateReport.maximumStock
Definition

125% of the vaccine requirement in a facility during the reporting month

ShortMaximum Stock
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE16
16. IMMZGGenerateReport.openingBalance
Definition

The initial quantity of vials in stock at the beginning of a specific reporting period

ShortOpening balance
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE17
18. IMMZGGenerateReport.quantityReceived
Definition

The quantity of vaccines/diluents received during the reporting month.

ShortQuantity received
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE18
20. IMMZGGenerateReport.dosesOpened
Definition

The quantity of vaccines/diluents opened in doses during the reporting month.

ShortDoses opened
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE19
22. IMMZGGenerateReport.dosesReturned
Definition

The quantity of vaccines/diluents returned in doses to the LGA during the reporting month.

ShortDoses returned to LGA/Facility
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE20
24. IMMZGGenerateReport.stockDiscarded
Definition

The quantity of vaccine/diluent discarded in doses

ShortStock discarded
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE21
26. IMMZGGenerateReport.stockDiscardedType
Definition

The reason vaccine was discarded

ShortStock discarded type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE22
28. IMMZGGenerateReport.aefiCaseRate
Definition

An indicator for the assessment of a particular vaccine's Adverse Event Following Immunization (AEFI) case rate.

ShortAEFI Case Rate
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE27
30. IMMZGGenerateReport.openVialWastage
Definition

A measure of the percentage of doses of a vaccine that were opened but discarded due to under-utilization

ShortOpen Vial Wastage
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE28
32. IMMZGGenerateReport.closedVialWastage
Definition

A measure of the percentage of doses of a vaccine that were spoiled due to reasons such as expiry, freezing, breakage, etc.

ShortClosed Vial Wastage
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE29
34. IMMZGGenerateReport.reportSubjectArea
Definition

Location (facility or place) for which the data in the report is being represented.

ShortReport Subject Area
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE30
36. IMMZGGenerateReport.reportGenerationDate
Definition

The date and time on which the report was generated.

ShortReport Generation Date
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE31
38. IMMZGGenerateReport.reportingPeriodStart
Definition

The start date of the reporting period for which data in the report has been included.

ShortReporting Period Start
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE32
40. IMMZGGenerateReport.reportingPeriodEnd
Definition

The end date of the reporting period for which data in the report has been included.

ShortReporting Period End
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE33
42. IMMZGGenerateReport.improvementIndicator
Definition

Indicates to the receiver how to interpret the data (i.e., what constitutes an improvement or deterioration)

ShortImprovement Indicator
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE34
44. IMMZGGenerateReport.reportGenerator
Definition

Indicates the organization, or location which is generating or producing the report

ShortReport Generator / Author
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE37
46. IMMZGGenerateReport.measureIdentifier
Definition

Represents the name of the report/indicator. It codifies the meaning of the group / measure.

ShortMeasure Identifier / Meaning
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE38
48. IMMZGGenerateReport.measuredScore
Definition

The calculated score of the measure / indicator which is being reported on.

ShortMeasured Score
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE39
50. IMMZGGenerateReport.measureNumerator
Definition

The count of individual objects (persons, doses, etc.) which was used as the numerator to calculate the measure score.

ShortMeasure Numerator
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE40
52. IMMZGGenerateReport.measureDenominator
Definition

The count of individual objects (persons, doses, etc.) which was used as the denominator to calculate the measure score.

ShortMeasure Denominator
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE41
54. IMMZGGenerateReport.disaggregationGroup
Definition

Indicates the overall strata or disaggregation which is being represented in the report.

ShortDisaggregation Group
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE42
56. IMMZGGenerateReport.bySex
Definition

Represents a disaggregation grouped by the indicator population's sex values.

ShortBy-Sex
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE43
58. IMMZGGenerateReport.byRegion
Definition

Represents a disaggregation grouped by the indicator population's administrative regions.

ShortBy-Region
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE44
60. IMMZGGenerateReport.byAgeGroup
Definition

Represents a disaggregation grouped by the indicator population's age groups.

ShortBy-Age Group
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE45
62. IMMZGGenerateReport.byDoseNumber
Definition

Represents a disaggregation grouped by the indicator population's dose numbers for a specific vaccine.

ShortBy-Dose Number
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE46
64. IMMZGGenerateReport.byVaccineType
Definition

Represents a disaggregation grouped by the indicator population's vaccine types.

ShortBy-Vaccine Type
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE47
66. IMMZGGenerateReport.byVaccineManufacturer
Definition

Represents a disaggregation grouped by the indicator population's vaccine manufacturers for a specific vaccine.

ShortBy-Vaccine Manufacturer
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE48
68. IMMZGGenerateReport.byReactionManifestation
Definition

Represents a disaggregation grouped by the indicator population's reaction manifestations for a specific vaccine.

ShortBy-Reaction Manifestation
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE49
70. IMMZGGenerateReport.byOccupation
Definition

Represents a disaggregation grouped by the indicator population's occupations.

ShortBy-Occupation
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE50
72. IMMZGGenerateReport.disaggregationMeasureIdentifier
Definition

The type or value of this stratum represents (male, female, region 1, dose 3, etc.). This value depends on the Disaggregation Group data element.

ShortDisaggregation Measure Identifier / Meaning
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE51
74. IMMZGGenerateReport.disaggregationNumerator
Definition

The count of individual objects (persons, doses, etc.) which were used as the numerator for the disaggregation score.

ShortDisaggregation Numerator
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE52
76. IMMZGGenerateReport.disaggregationDenominator
Definition

The count of individual objects (persons, doses, etc.) which were used as the denominator for the disaggregation score.

ShortDisaggregation Denominator
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE53
78. IMMZGGenerateReport.disaggregatedScore
Definition

The computed score for this disaggregation, which is the numerator divided by the denominator for this collection (i.e. population) of records.

ShortDisaggregated Score
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE54

Guidance on how to interpret the contents of this table can be foundhere

0. IMMZGGenerateReport
Definition

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

ShortIMMZ.G Generate Report
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. IMMZGGenerateReport.reportIdentification
Definition

A unique identifier for the instance of the report that has been generated

ShortReport Identification
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE1
4. IMMZGGenerateReport.reportStatus
Definition

The status of the report (for example, initial, complete, etc.)

ShortReport Status
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE2
6. IMMZGGenerateReport.reportType
Definition

The type of report which has been generated (i.e., list of individuals, summary, etc.)

ShortReport Type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE6
8. IMMZGGenerateReport.reportIndicatorCode
Definition

The indicator or measure definition being reported on (e.g., dropout rate, defaulters, etc.)

ShortReport Indicator Code
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE10
10. IMMZGGenerateReport.numberOfDosesPerVial
Definition

The number of doses contained within a vial

ShortNumber of doses per vial
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE14
12. IMMZGGenerateReport.minimumStock
Definition

25% of the vaccine requirement in a facility during the reporting month

ShortMinimum Stock
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE15
14. IMMZGGenerateReport.maximumStock
Definition

125% of the vaccine requirement in a facility during the reporting month

ShortMaximum Stock
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE16
16. IMMZGGenerateReport.openingBalance
Definition

The initial quantity of vials in stock at the beginning of a specific reporting period

ShortOpening balance
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE17
18. IMMZGGenerateReport.quantityReceived
Definition

The quantity of vaccines/diluents received during the reporting month.

ShortQuantity received
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE18
20. IMMZGGenerateReport.dosesOpened
Definition

The quantity of vaccines/diluents opened in doses during the reporting month.

ShortDoses opened
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE19
22. IMMZGGenerateReport.dosesReturned
Definition

The quantity of vaccines/diluents returned in doses to the LGA during the reporting month.

ShortDoses returned to LGA/Facility
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE20
24. IMMZGGenerateReport.stockDiscarded
Definition

The quantity of vaccine/diluent discarded in doses

ShortStock discarded
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE21
26. IMMZGGenerateReport.stockDiscardedType
Definition

The reason vaccine was discarded

ShortStock discarded type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE22
28. IMMZGGenerateReport.aefiCaseRate
Definition

An indicator for the assessment of a particular vaccine's Adverse Event Following Immunization (AEFI) case rate.

ShortAEFI Case Rate
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE27
30. IMMZGGenerateReport.openVialWastage
Definition

A measure of the percentage of doses of a vaccine that were opened but discarded due to under-utilization

ShortOpen Vial Wastage
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE28
32. IMMZGGenerateReport.closedVialWastage
Definition

A measure of the percentage of doses of a vaccine that were spoiled due to reasons such as expiry, freezing, breakage, etc.

ShortClosed Vial Wastage
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE29
34. IMMZGGenerateReport.reportSubjectArea
Definition

Location (facility or place) for which the data in the report is being represented.

ShortReport Subject Area
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE30
36. IMMZGGenerateReport.reportGenerationDate
Definition

The date and time on which the report was generated.

ShortReport Generation Date
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE31
38. IMMZGGenerateReport.reportingPeriodStart
Definition

The start date of the reporting period for which data in the report has been included.

ShortReporting Period Start
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE32
40. IMMZGGenerateReport.reportingPeriodEnd
Definition

The end date of the reporting period for which data in the report has been included.

ShortReporting Period End
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE33
42. IMMZGGenerateReport.improvementIndicator
Definition

Indicates to the receiver how to interpret the data (i.e., what constitutes an improvement or deterioration)

ShortImprovement Indicator
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE34
44. IMMZGGenerateReport.reportGenerator
Definition

Indicates the organization, or location which is generating or producing the report

ShortReport Generator / Author
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE37
46. IMMZGGenerateReport.measureIdentifier
Definition

Represents the name of the report/indicator. It codifies the meaning of the group / measure.

ShortMeasure Identifier / Meaning
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE38
48. IMMZGGenerateReport.measuredScore
Definition

The calculated score of the measure / indicator which is being reported on.

ShortMeasured Score
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE39
50. IMMZGGenerateReport.measureNumerator
Definition

The count of individual objects (persons, doses, etc.) which was used as the numerator to calculate the measure score.

ShortMeasure Numerator
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE40
52. IMMZGGenerateReport.measureDenominator
Definition

The count of individual objects (persons, doses, etc.) which was used as the denominator to calculate the measure score.

ShortMeasure Denominator
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE41
54. IMMZGGenerateReport.disaggregationGroup
Definition

Indicates the overall strata or disaggregation which is being represented in the report.

ShortDisaggregation Group
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE42
56. IMMZGGenerateReport.bySex
Definition

Represents a disaggregation grouped by the indicator population's sex values.

ShortBy-Sex
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE43
58. IMMZGGenerateReport.byRegion
Definition

Represents a disaggregation grouped by the indicator population's administrative regions.

ShortBy-Region
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE44
60. IMMZGGenerateReport.byAgeGroup
Definition

Represents a disaggregation grouped by the indicator population's age groups.

ShortBy-Age Group
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE45
62. IMMZGGenerateReport.byDoseNumber
Definition

Represents a disaggregation grouped by the indicator population's dose numbers for a specific vaccine.

ShortBy-Dose Number
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE46
64. IMMZGGenerateReport.byVaccineType
Definition

Represents a disaggregation grouped by the indicator population's vaccine types.

ShortBy-Vaccine Type
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE47
66. IMMZGGenerateReport.byVaccineManufacturer
Definition

Represents a disaggregation grouped by the indicator population's vaccine manufacturers for a specific vaccine.

ShortBy-Vaccine Manufacturer
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE48
68. IMMZGGenerateReport.byReactionManifestation
Definition

Represents a disaggregation grouped by the indicator population's reaction manifestations for a specific vaccine.

ShortBy-Reaction Manifestation
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE49
70. IMMZGGenerateReport.byOccupation
Definition

Represents a disaggregation grouped by the indicator population's occupations.

ShortBy-Occupation
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE50
72. IMMZGGenerateReport.disaggregationMeasureIdentifier
Definition

The type or value of this stratum represents (male, female, region 1, dose 3, etc.). This value depends on the Disaggregation Group data element.

ShortDisaggregation Measure Identifier / Meaning
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE51
74. IMMZGGenerateReport.disaggregationNumerator
Definition

The count of individual objects (persons, doses, etc.) which were used as the numerator for the disaggregation score.

ShortDisaggregation Numerator
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE52
76. IMMZGGenerateReport.disaggregationDenominator
Definition

The count of individual objects (persons, doses, etc.) which were used as the denominator for the disaggregation score.

ShortDisaggregation Denominator
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE53
78. IMMZGGenerateReport.disaggregatedScore
Definition

The computed score for this disaggregation, which is the numerator divided by the denominator for this collection (i.e. population) of records.

ShortDisaggregated Score
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE54

Guidance on how to interpret the contents of this table can be foundhere

0. IMMZGGenerateReport
Definition

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

ShortIMMZ.G Generate Report
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. IMMZGGenerateReport.reportIdentification
Definition

A unique identifier for the instance of the report that has been generated

ShortReport Identification
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE1
4. IMMZGGenerateReport.reportStatus
Definition

The status of the report (for example, initial, complete, etc.)

ShortReport Status
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE2
6. IMMZGGenerateReport.reportType
Definition

The type of report which has been generated (i.e., list of individuals, summary, etc.)

ShortReport Type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE6
8. IMMZGGenerateReport.reportIndicatorCode
Definition

The indicator or measure definition being reported on (e.g., dropout rate, defaulters, etc.)

ShortReport Indicator Code
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE10
10. IMMZGGenerateReport.numberOfDosesPerVial
Definition

The number of doses contained within a vial

ShortNumber of doses per vial
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE14
12. IMMZGGenerateReport.minimumStock
Definition

25% of the vaccine requirement in a facility during the reporting month

ShortMinimum Stock
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE15
14. IMMZGGenerateReport.maximumStock
Definition

125% of the vaccine requirement in a facility during the reporting month

ShortMaximum Stock
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE16
16. IMMZGGenerateReport.openingBalance
Definition

The initial quantity of vials in stock at the beginning of a specific reporting period

ShortOpening balance
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE17
18. IMMZGGenerateReport.quantityReceived
Definition

The quantity of vaccines/diluents received during the reporting month.

ShortQuantity received
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE18
20. IMMZGGenerateReport.dosesOpened
Definition

The quantity of vaccines/diluents opened in doses during the reporting month.

ShortDoses opened
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE19
22. IMMZGGenerateReport.dosesReturned
Definition

The quantity of vaccines/diluents returned in doses to the LGA during the reporting month.

ShortDoses returned to LGA/Facility
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE20
24. IMMZGGenerateReport.stockDiscarded
Definition

The quantity of vaccine/diluent discarded in doses

ShortStock discarded
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE21
26. IMMZGGenerateReport.stockDiscardedType
Definition

The reason vaccine was discarded

ShortStock discarded type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE22
28. IMMZGGenerateReport.aefiCaseRate
Definition

An indicator for the assessment of a particular vaccine's Adverse Event Following Immunization (AEFI) case rate.

ShortAEFI Case Rate
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE27
30. IMMZGGenerateReport.openVialWastage
Definition

A measure of the percentage of doses of a vaccine that were opened but discarded due to under-utilization

ShortOpen Vial Wastage
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE28
32. IMMZGGenerateReport.closedVialWastage
Definition

A measure of the percentage of doses of a vaccine that were spoiled due to reasons such as expiry, freezing, breakage, etc.

ShortClosed Vial Wastage
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE29
34. IMMZGGenerateReport.reportSubjectArea
Definition

Location (facility or place) for which the data in the report is being represented.

ShortReport Subject Area
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE30
36. IMMZGGenerateReport.reportGenerationDate
Definition

The date and time on which the report was generated.

ShortReport Generation Date
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE31
38. IMMZGGenerateReport.reportingPeriodStart
Definition

The start date of the reporting period for which data in the report has been included.

ShortReporting Period Start
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE32
40. IMMZGGenerateReport.reportingPeriodEnd
Definition

The end date of the reporting period for which data in the report has been included.

ShortReporting Period End
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE33
42. IMMZGGenerateReport.improvementIndicator
Definition

Indicates to the receiver how to interpret the data (i.e., what constitutes an improvement or deterioration)

ShortImprovement Indicator
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE34
44. IMMZGGenerateReport.reportGenerator
Definition

Indicates the organization, or location which is generating or producing the report

ShortReport Generator / Author
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE37
46. IMMZGGenerateReport.measureIdentifier
Definition

Represents the name of the report/indicator. It codifies the meaning of the group / measure.

ShortMeasure Identifier / Meaning
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE38
48. IMMZGGenerateReport.measuredScore
Definition

The calculated score of the measure / indicator which is being reported on.

ShortMeasured Score
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE39
50. IMMZGGenerateReport.measureNumerator
Definition

The count of individual objects (persons, doses, etc.) which was used as the numerator to calculate the measure score.

ShortMeasure Numerator
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE40
52. IMMZGGenerateReport.measureDenominator
Definition

The count of individual objects (persons, doses, etc.) which was used as the denominator to calculate the measure score.

ShortMeasure Denominator
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE41
54. IMMZGGenerateReport.disaggregationGroup
Definition

Indicates the overall strata or disaggregation which is being represented in the report.

ShortDisaggregation Group
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE42
56. IMMZGGenerateReport.bySex
Definition

Represents a disaggregation grouped by the indicator population's sex values.

ShortBy-Sex
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE43
58. IMMZGGenerateReport.byRegion
Definition

Represents a disaggregation grouped by the indicator population's administrative regions.

ShortBy-Region
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE44
60. IMMZGGenerateReport.byAgeGroup
Definition

Represents a disaggregation grouped by the indicator population's age groups.

ShortBy-Age Group
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE45
62. IMMZGGenerateReport.byDoseNumber
Definition

Represents a disaggregation grouped by the indicator population's dose numbers for a specific vaccine.

ShortBy-Dose Number
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE46
64. IMMZGGenerateReport.byVaccineType
Definition

Represents a disaggregation grouped by the indicator population's vaccine types.

ShortBy-Vaccine Type
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE47
66. IMMZGGenerateReport.byVaccineManufacturer
Definition

Represents a disaggregation grouped by the indicator population's vaccine manufacturers for a specific vaccine.

ShortBy-Vaccine Manufacturer
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE48
68. IMMZGGenerateReport.byReactionManifestation
Definition

Represents a disaggregation grouped by the indicator population's reaction manifestations for a specific vaccine.

ShortBy-Reaction Manifestation
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE49
70. IMMZGGenerateReport.byOccupation
Definition

Represents a disaggregation grouped by the indicator population's occupations.

ShortBy-Occupation
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE50
72. IMMZGGenerateReport.disaggregationMeasureIdentifier
Definition

The type or value of this stratum represents (male, female, region 1, dose 3, etc.). This value depends on the Disaggregation Group data element.

ShortDisaggregation Measure Identifier / Meaning
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE51
74. IMMZGGenerateReport.disaggregationNumerator
Definition

The count of individual objects (persons, doses, etc.) which were used as the numerator for the disaggregation score.

ShortDisaggregation Numerator
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE52
76. IMMZGGenerateReport.disaggregationDenominator
Definition

The count of individual objects (persons, doses, etc.) which were used as the denominator for the disaggregation score.

ShortDisaggregation Denominator
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE53
78. IMMZGGenerateReport.disaggregatedScore
Definition

The computed score for this disaggregation, which is the numerator divided by the denominator for this collection (i.e. population) of records.

ShortDisaggregated Score
Control1..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.G CodeSystem for Generate Report IMMZ.G.DE54