NPHCDA Immunization FHIR IG
1.0.0 - ci-build
NPHCDA Immunization FHIR IG
1.0.0 - ci-build
NPHCDA Immunization FHIR IG, published by https://nphcda.gov.ng. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Nigeria-FHIR-Community/ImmunizationIG/ and changes regularly. See the Directory of published versions
| Active as of 2025-08-04 |
Definitions for the IMMZGGenerateReport logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. IMMZGGenerateReport | |
| Definition | IMMZ.H - Data elements for the IMMZ.G Report Generation Data Dictionary. |
| Short | NG-Imm-H GenerateReport |
| Logical Model | Instances 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 |
| Short | Report Identification |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. IMMZGGenerateReport.reportStatus | |
| Definition | The status of the report (for example, initial, complete, etc.) |
| Short | Report Status |
| Control | 1..1 |
| Type | CodeableConcept |
| Definitional Codes | [not stated] NGVerificationStatusVS |
| 6. IMMZGGenerateReport.reportType | |
| Definition | The type of report which has been generated (i.e., list of individuals, summary, etc.) |
| Short | Report Type |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. IMMZGGenerateReport.reportIndicatorCode | |
| Definition | The indicator or measure definition being reported on (e.g., dropout rate, defaulters, etc.) |
| Short | Report Indicator Code |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. IMMZGGenerateReport.numberOfDosesPerVial | |
| Definition | The number of doses contained within a vial |
| Short | Number of doses per vial |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. IMMZGGenerateReport.minimumStock | |
| Definition | 25% of the vaccine requirement in a facility during the reporting month |
| Short | Minimum Stock |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. IMMZGGenerateReport.maximumStock | |
| Definition | 125% of the vaccine requirement in a facility during the reporting month |
| Short | Maximum Stock |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. IMMZGGenerateReport.openingBalance | |
| Definition | The initial quantity of vials in stock at the beginning of a specific reporting period |
| Short | Opening balance |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. IMMZGGenerateReport.quantityReceived | |
| Definition | The quantity of vaccines/diluents received during the reporting month. |
| Short | Quantity received |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. IMMZGGenerateReport.dosesOpened | |
| Definition | The quantity of vaccines/diluents opened in doses during the reporting month. |
| Short | Doses opened |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. IMMZGGenerateReport.dosesReturned | |
| Definition | The quantity of vaccines/diluents returned in doses to the LGA during the reporting month. |
| Short | Doses returned to LGA/Facility |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. IMMZGGenerateReport.stockDiscarded | |
| Definition | The quantity of vaccine/diluent discarded in doses |
| Short | Stock discarded |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. IMMZGGenerateReport.stockDiscardedType | |
| Definition | The reason vaccine was discarded |
| Short | Stock discarded type |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. IMMZGGenerateReport.aefiCaseRate | |
| Definition | An indicator for the assessment of a particular vaccine's Adverse Event Following Immunization (AEFI) case rate. |
| Short | AEFI Case Rate |
| Control | 1..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. IMMZGGenerateReport.openVialWastage | |
| Definition | A measure of the percentage of doses of a vaccine that were opened but discarded due to under-utilization |
| Short | Open Vial Wastage |
| Control | 1..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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. |
| Short | Closed Vial Wastage |
| Control | 1..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. IMMZGGenerateReport.reportSubjectArea | |
| Definition | Location (facility or place) for which the data in the report is being represented. |
| Short | Report Subject Area |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. IMMZGGenerateReport.reportGenerationDate | |
| Definition | The date and time on which the report was generated. |
| Short | Report Generation Date |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. IMMZGGenerateReport.reportingPeriodStart | |
| Definition | The start date of the reporting period for which data in the report has been included. |
| Short | Reporting Period Start |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 40. IMMZGGenerateReport.reportingPeriodEnd | |
| Definition | The end date of the reporting period for which data in the report has been included. |
| Short | Reporting Period End |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 42. IMMZGGenerateReport.improvementIndicator | |
| Definition | Indicates to the receiver how to interpret the data (i.e., what constitutes an improvement or deterioration) |
| Short | Improvement Indicator |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 44. IMMZGGenerateReport.reportGenerator | |
| Definition | Indicates the organization, or location which is generating or producing the report |
| Short | Report Generator / Author |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 46. IMMZGGenerateReport.measureIdentifier | |
| Definition | Represents the name of the report/indicator. It codifies the meaning of the group / measure. |
| Short | Measure Identifier / Meaning |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 48. IMMZGGenerateReport.measuredScore | |
| Definition | The calculated score of the measure / indicator which is being reported on. |
| Short | Measured Score |
| Control | 1..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 50. IMMZGGenerateReport.measureNumerator | |
| Definition | The count of individual objects (persons, doses, etc.) which was used as the numerator to calculate the measure score. |
| Short | Measure Numerator |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 52. IMMZGGenerateReport.measureDenominator | |
| Definition | The count of individual objects (persons, doses, etc.) which was used as the denominator to calculate the measure score. |
| Short | Measure Denominator |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 54. IMMZGGenerateReport.disaggregationGroup | |
| Definition | Indicates the overall strata or disaggregation which is being represented in the report. |
| Short | Disaggregation Group |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 56. IMMZGGenerateReport.bySex | |
| Definition | Represents a disaggregation grouped by the indicator population's sex values. |
| Short | By-Sex |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 58. IMMZGGenerateReport.byRegion | |
| Definition | Represents a disaggregation grouped by the indicator population's administrative regions. |
| Short | By-Region |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 60. IMMZGGenerateReport.byAgeGroup | |
| Definition | Represents a disaggregation grouped by the indicator population's age groups. |
| Short | By-Age Group |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 62. IMMZGGenerateReport.byDoseNumber | |
| Definition | Represents a disaggregation grouped by the indicator population's dose numbers for a specific vaccine. |
| Short | By-Dose Number |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 64. IMMZGGenerateReport.byVaccineType | |
| Definition | Represents a disaggregation grouped by the indicator population's vaccine types. |
| Short | By-Vaccine Type |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 66. IMMZGGenerateReport.byVaccineManufacturer | |
| Definition | Represents a disaggregation grouped by the indicator population's vaccine manufacturers for a specific vaccine. |
| Short | By-Vaccine Manufacturer |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 68. IMMZGGenerateReport.byReactionManifestation | |
| Definition | Represents a disaggregation grouped by the indicator population's reaction manifestations for a specific vaccine. |
| Short | By-Reaction Manifestation |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 70. IMMZGGenerateReport.byOccupation | |
| Definition | Represents a disaggregation grouped by the indicator population's occupations. |
| Short | By-Occupation |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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. |
| Short | Disaggregation Measure Identifier / Meaning |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 74. IMMZGGenerateReport.disaggregationNumerator | |
| Definition | The count of individual objects (persons, doses, etc.) which were used as the numerator for the disaggregation score. |
| Short | Disaggregation Numerator |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 76. IMMZGGenerateReport.disaggregationDenominator | |
| Definition | The count of individual objects (persons, doses, etc.) which were used as the denominator for the disaggregation score. |
| Short | Disaggregation Denominator |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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. |
| Short | Disaggregated Score |
| Control | 1..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. IMMZGGenerateReport | |
| Definition | IMMZ.H - Data elements for the IMMZ.G Report Generation Data Dictionary. |
| Short | NG-Imm-H GenerateReport |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances 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 |
| Short | Report Identification |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. IMMZGGenerateReport.reportStatus | |
| Definition | The status of the report (for example, initial, complete, etc.) |
| Short | Report Status |
| Control | 1..1 |
| Type | CodeableConcept |
| Summary | true |
| Definitional Codes | [not stated] NGVerificationStatusVS |
| 6. IMMZGGenerateReport.reportType | |
| Definition | The type of report which has been generated (i.e., list of individuals, summary, etc.) |
| Short | Report Type |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 8. IMMZGGenerateReport.reportIndicatorCode | |
| Definition | The indicator or measure definition being reported on (e.g., dropout rate, defaulters, etc.) |
| Short | Report Indicator Code |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 10. IMMZGGenerateReport.numberOfDosesPerVial | |
| Definition | The number of doses contained within a vial |
| Short | Number of doses per vial |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 12. IMMZGGenerateReport.minimumStock | |
| Definition | 25% of the vaccine requirement in a facility during the reporting month |
| Short | Minimum Stock |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 14. IMMZGGenerateReport.maximumStock | |
| Definition | 125% of the vaccine requirement in a facility during the reporting month |
| Short | Maximum Stock |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 16. IMMZGGenerateReport.openingBalance | |
| Definition | The initial quantity of vials in stock at the beginning of a specific reporting period |
| Short | Opening balance |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 18. IMMZGGenerateReport.quantityReceived | |
| Definition | The quantity of vaccines/diluents received during the reporting month. |
| Short | Quantity received |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 20. IMMZGGenerateReport.dosesOpened | |
| Definition | The quantity of vaccines/diluents opened in doses during the reporting month. |
| Short | Doses opened |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 22. IMMZGGenerateReport.dosesReturned | |
| Definition | The quantity of vaccines/diluents returned in doses to the LGA during the reporting month. |
| Short | Doses returned to LGA/Facility |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 24. IMMZGGenerateReport.stockDiscarded | |
| Definition | The quantity of vaccine/diluent discarded in doses |
| Short | Stock discarded |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 26. IMMZGGenerateReport.stockDiscardedType | |
| Definition | The reason vaccine was discarded |
| Short | Stock discarded type |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 28. IMMZGGenerateReport.aefiCaseRate | |
| Definition | An indicator for the assessment of a particular vaccine's Adverse Event Following Immunization (AEFI) case rate. |
| Short | AEFI Case Rate |
| Control | 1..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 30. IMMZGGenerateReport.openVialWastage | |
| Definition | A measure of the percentage of doses of a vaccine that were opened but discarded due to under-utilization |
| Short | Open Vial Wastage |
| Control | 1..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Short | Closed Vial Wastage |
| Control | 1..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 34. IMMZGGenerateReport.reportSubjectArea | |
| Definition | Location (facility or place) for which the data in the report is being represented. |
| Short | Report Subject Area |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 36. IMMZGGenerateReport.reportGenerationDate | |
| Definition | The date and time on which the report was generated. |
| Short | Report Generation Date |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 38. IMMZGGenerateReport.reportingPeriodStart | |
| Definition | The start date of the reporting period for which data in the report has been included. |
| Short | Reporting Period Start |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 40. IMMZGGenerateReport.reportingPeriodEnd | |
| Definition | The end date of the reporting period for which data in the report has been included. |
| Short | Reporting Period End |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 42. IMMZGGenerateReport.improvementIndicator | |
| Definition | Indicates to the receiver how to interpret the data (i.e., what constitutes an improvement or deterioration) |
| Short | Improvement Indicator |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 44. IMMZGGenerateReport.reportGenerator | |
| Definition | Indicates the organization, or location which is generating or producing the report |
| Short | Report Generator / Author |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 46. IMMZGGenerateReport.measureIdentifier | |
| Definition | Represents the name of the report/indicator. It codifies the meaning of the group / measure. |
| Short | Measure Identifier / Meaning |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 48. IMMZGGenerateReport.measuredScore | |
| Definition | The calculated score of the measure / indicator which is being reported on. |
| Short | Measured Score |
| Control | 1..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 50. IMMZGGenerateReport.measureNumerator | |
| Definition | The count of individual objects (persons, doses, etc.) which was used as the numerator to calculate the measure score. |
| Short | Measure Numerator |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 52. IMMZGGenerateReport.measureDenominator | |
| Definition | The count of individual objects (persons, doses, etc.) which was used as the denominator to calculate the measure score. |
| Short | Measure Denominator |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 54. IMMZGGenerateReport.disaggregationGroup | |
| Definition | Indicates the overall strata or disaggregation which is being represented in the report. |
| Short | Disaggregation Group |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 56. IMMZGGenerateReport.bySex | |
| Definition | Represents a disaggregation grouped by the indicator population's sex values. |
| Short | By-Sex |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 58. IMMZGGenerateReport.byRegion | |
| Definition | Represents a disaggregation grouped by the indicator population's administrative regions. |
| Short | By-Region |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 60. IMMZGGenerateReport.byAgeGroup | |
| Definition | Represents a disaggregation grouped by the indicator population's age groups. |
| Short | By-Age Group |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 62. IMMZGGenerateReport.byDoseNumber | |
| Definition | Represents a disaggregation grouped by the indicator population's dose numbers for a specific vaccine. |
| Short | By-Dose Number |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 64. IMMZGGenerateReport.byVaccineType | |
| Definition | Represents a disaggregation grouped by the indicator population's vaccine types. |
| Short | By-Vaccine Type |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 66. IMMZGGenerateReport.byVaccineManufacturer | |
| Definition | Represents a disaggregation grouped by the indicator population's vaccine manufacturers for a specific vaccine. |
| Short | By-Vaccine Manufacturer |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 68. IMMZGGenerateReport.byReactionManifestation | |
| Definition | Represents a disaggregation grouped by the indicator population's reaction manifestations for a specific vaccine. |
| Short | By-Reaction Manifestation |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 70. IMMZGGenerateReport.byOccupation | |
| Definition | Represents a disaggregation grouped by the indicator population's occupations. |
| Short | By-Occupation |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Short | Disaggregation Measure Identifier / Meaning |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 74. IMMZGGenerateReport.disaggregationNumerator | |
| Definition | The count of individual objects (persons, doses, etc.) which were used as the numerator for the disaggregation score. |
| Short | Disaggregation Numerator |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 76. IMMZGGenerateReport.disaggregationDenominator | |
| Definition | The count of individual objects (persons, doses, etc.) which were used as the denominator for the disaggregation score. |
| Short | Disaggregation Denominator |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Short | Disaggregated Score |
| Control | 1..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
Guidance on how to interpret the contents of this table can be foundhere
| 0. IMMZGGenerateReport | |
| Definition | IMMZ.H - Data elements for the IMMZ.G Report Generation Data Dictionary. |
| Short | NG-Imm-H GenerateReport |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances 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 |
| Short | Report Identification |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. IMMZGGenerateReport.reportStatus | |
| Definition | The status of the report (for example, initial, complete, etc.) |
| Short | Report Status |
| Control | 1..1 |
| Type | CodeableConcept |
| Summary | true |
| Definitional Codes | [not stated] NGVerificationStatusVS |
| 6. IMMZGGenerateReport.reportType | |
| Definition | The type of report which has been generated (i.e., list of individuals, summary, etc.) |
| Short | Report Type |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 8. IMMZGGenerateReport.reportIndicatorCode | |
| Definition | The indicator or measure definition being reported on (e.g., dropout rate, defaulters, etc.) |
| Short | Report Indicator Code |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 10. IMMZGGenerateReport.numberOfDosesPerVial | |
| Definition | The number of doses contained within a vial |
| Short | Number of doses per vial |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 12. IMMZGGenerateReport.minimumStock | |
| Definition | 25% of the vaccine requirement in a facility during the reporting month |
| Short | Minimum Stock |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 14. IMMZGGenerateReport.maximumStock | |
| Definition | 125% of the vaccine requirement in a facility during the reporting month |
| Short | Maximum Stock |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 16. IMMZGGenerateReport.openingBalance | |
| Definition | The initial quantity of vials in stock at the beginning of a specific reporting period |
| Short | Opening balance |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 18. IMMZGGenerateReport.quantityReceived | |
| Definition | The quantity of vaccines/diluents received during the reporting month. |
| Short | Quantity received |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 20. IMMZGGenerateReport.dosesOpened | |
| Definition | The quantity of vaccines/diluents opened in doses during the reporting month. |
| Short | Doses opened |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 22. IMMZGGenerateReport.dosesReturned | |
| Definition | The quantity of vaccines/diluents returned in doses to the LGA during the reporting month. |
| Short | Doses returned to LGA/Facility |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 24. IMMZGGenerateReport.stockDiscarded | |
| Definition | The quantity of vaccine/diluent discarded in doses |
| Short | Stock discarded |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 26. IMMZGGenerateReport.stockDiscardedType | |
| Definition | The reason vaccine was discarded |
| Short | Stock discarded type |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 28. IMMZGGenerateReport.aefiCaseRate | |
| Definition | An indicator for the assessment of a particular vaccine's Adverse Event Following Immunization (AEFI) case rate. |
| Short | AEFI Case Rate |
| Control | 1..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 30. IMMZGGenerateReport.openVialWastage | |
| Definition | A measure of the percentage of doses of a vaccine that were opened but discarded due to under-utilization |
| Short | Open Vial Wastage |
| Control | 1..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Short | Closed Vial Wastage |
| Control | 1..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 34. IMMZGGenerateReport.reportSubjectArea | |
| Definition | Location (facility or place) for which the data in the report is being represented. |
| Short | Report Subject Area |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 36. IMMZGGenerateReport.reportGenerationDate | |
| Definition | The date and time on which the report was generated. |
| Short | Report Generation Date |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 38. IMMZGGenerateReport.reportingPeriodStart | |
| Definition | The start date of the reporting period for which data in the report has been included. |
| Short | Reporting Period Start |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 40. IMMZGGenerateReport.reportingPeriodEnd | |
| Definition | The end date of the reporting period for which data in the report has been included. |
| Short | Reporting Period End |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 42. IMMZGGenerateReport.improvementIndicator | |
| Definition | Indicates to the receiver how to interpret the data (i.e., what constitutes an improvement or deterioration) |
| Short | Improvement Indicator |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 44. IMMZGGenerateReport.reportGenerator | |
| Definition | Indicates the organization, or location which is generating or producing the report |
| Short | Report Generator / Author |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 46. IMMZGGenerateReport.measureIdentifier | |
| Definition | Represents the name of the report/indicator. It codifies the meaning of the group / measure. |
| Short | Measure Identifier / Meaning |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 48. IMMZGGenerateReport.measuredScore | |
| Definition | The calculated score of the measure / indicator which is being reported on. |
| Short | Measured Score |
| Control | 1..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 50. IMMZGGenerateReport.measureNumerator | |
| Definition | The count of individual objects (persons, doses, etc.) which was used as the numerator to calculate the measure score. |
| Short | Measure Numerator |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 52. IMMZGGenerateReport.measureDenominator | |
| Definition | The count of individual objects (persons, doses, etc.) which was used as the denominator to calculate the measure score. |
| Short | Measure Denominator |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 54. IMMZGGenerateReport.disaggregationGroup | |
| Definition | Indicates the overall strata or disaggregation which is being represented in the report. |
| Short | Disaggregation Group |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 56. IMMZGGenerateReport.bySex | |
| Definition | Represents a disaggregation grouped by the indicator population's sex values. |
| Short | By-Sex |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 58. IMMZGGenerateReport.byRegion | |
| Definition | Represents a disaggregation grouped by the indicator population's administrative regions. |
| Short | By-Region |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 60. IMMZGGenerateReport.byAgeGroup | |
| Definition | Represents a disaggregation grouped by the indicator population's age groups. |
| Short | By-Age Group |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 62. IMMZGGenerateReport.byDoseNumber | |
| Definition | Represents a disaggregation grouped by the indicator population's dose numbers for a specific vaccine. |
| Short | By-Dose Number |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 64. IMMZGGenerateReport.byVaccineType | |
| Definition | Represents a disaggregation grouped by the indicator population's vaccine types. |
| Short | By-Vaccine Type |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 66. IMMZGGenerateReport.byVaccineManufacturer | |
| Definition | Represents a disaggregation grouped by the indicator population's vaccine manufacturers for a specific vaccine. |
| Short | By-Vaccine Manufacturer |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 68. IMMZGGenerateReport.byReactionManifestation | |
| Definition | Represents a disaggregation grouped by the indicator population's reaction manifestations for a specific vaccine. |
| Short | By-Reaction Manifestation |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 70. IMMZGGenerateReport.byOccupation | |
| Definition | Represents a disaggregation grouped by the indicator population's occupations. |
| Short | By-Occupation |
| Control | 1..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Short | Disaggregation Measure Identifier / Meaning |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 74. IMMZGGenerateReport.disaggregationNumerator | |
| Definition | The count of individual objects (persons, doses, etc.) which were used as the numerator for the disaggregation score. |
| Short | Disaggregation Numerator |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 76. IMMZGGenerateReport.disaggregationDenominator | |
| Definition | The count of individual objects (persons, doses, etc.) which were used as the denominator for the disaggregation score. |
| Short | Disaggregation Denominator |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 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. |
| Short | Disaggregated Score |
| Control | 1..1 |
| Type | decimal |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |