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
| Active as of 2024-11-08 |
Definitions for the IMMZEGenerateReport logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. IMMZEGenerateReport | |
| Definition | Data elements for the IMMZ.E Report Generation Data Dictionary. |
| Short | IMMZ.E Generate Report |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. IMMZEGenerateReport.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 |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE1 |
| 4. IMMZEGenerateReport.reportStatus | |
| Definition | The status of the report (for example, initial, complete, etc.) |
| Short | Report Status |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE2 |
| 6. IMMZEGenerateReport.reportType | |
| Definition | The type of report which has been generated (i.e. is the report a list of individuals, a summary, etc.) |
| Short | Report Type |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE3 |
| 8. IMMZEGenerateReport.reportIndicatorCode | |
| Definition | The indicator or measure definition which is being reported on (for example: Dropout rate, defaulters, etc.) |
| Short | Report Indicator Code |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE11 |
| 10. IMMZEGenerateReport.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 |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE18 |
| 12. IMMZEGenerateReport.reportGenerationDate | |
| Definition | Location (facility or place) for which the data in the report is being represented. |
| Short | Report Generation Date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE19 |
| 14. IMMZEGenerateReport.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 | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE20 |
| 16. IMMZEGenerateReport.reportingPeriodEnd | |
| Definition | The start date of the reporting period for which data in the report has been included. |
| Short | Reporting Period End |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE21 |
| 18. IMMZEGenerateReport.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 |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE22 |
| 20. IMMZEGenerateReport.reportGeneratorOrAuthor | |
| 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 |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE25 |
| 22. IMMZEGenerateReport.measureIdentifierMeaning | |
| Definition | Represents the name of the report/indicator. It codifies the meaning of the group / measure. For example, if the report indicator is Coverage each antigen / vaccine would have a measure (i.e. BCG Coverage or BCG Target) |
| Short | Measure Identifier / Meaning |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE26 |
| 24. IMMZEGenerateReport.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 | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE30 |
| 26. IMMZEGenerateReport.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 | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE31 |
| 28. IMMZEGenerateReport.disaggregationGroup | |
| Definition | Indicates the overall strata or disaggregation which is being represented in the report (for example: by gender, by region, by age group, etc.) |
| Short | Disaggregation Group |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE32 |
| 30. IMMZEGenerateReport.disaggregationMeasureIdentifierMeaning | |
| 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 (for example: if By-Sex is used as the disaggregation group, valid values would be 'Male', 'Female', 'Intersex') |
| Short | Disaggregation Measure Identifier / Meaning |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE41 |
| 32. IMMZEGenerateReport.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 | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE42 |
| 34. IMMZEGenerateReport.disaggregationDenominator | |
| Definition | The count of individual objects (persons, doses, etc.) which were used as the denominator for disaggregation score |
| Short | Disaggregation Denominator |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE43 |
| 36. IMMZEGenerateReport.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 | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE44 |
Guidance on how to interpret the contents of this table can be found here
| 0. IMMZEGenerateReport | |
| Definition | Data elements for the IMMZ.E Report Generation Data Dictionary. |
| Short | IMMZ.E Generate Report |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. IMMZEGenerateReport.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 |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE1 |
| 4. IMMZEGenerateReport.reportStatus | |
| Definition | The status of the report (for example, initial, complete, etc.) |
| Short | Report Status |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE2 |
| 6. IMMZEGenerateReport.reportType | |
| Definition | The type of report which has been generated (i.e. is the report a list of individuals, a summary, etc.) |
| Short | Report Type |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE3 |
| 8. IMMZEGenerateReport.reportIndicatorCode | |
| Definition | The indicator or measure definition which is being reported on (for example: Dropout rate, defaulters, etc.) |
| Short | Report Indicator Code |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE11 |
| 10. IMMZEGenerateReport.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 |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE18 |
| 12. IMMZEGenerateReport.reportGenerationDate | |
| Definition | Location (facility or place) for which the data in the report is being represented. |
| Short | Report Generation Date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE19 |
| 14. IMMZEGenerateReport.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 | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE20 |
| 16. IMMZEGenerateReport.reportingPeriodEnd | |
| Definition | The start date of the reporting period for which data in the report has been included. |
| Short | Reporting Period End |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE21 |
| 18. IMMZEGenerateReport.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 |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE22 |
| 20. IMMZEGenerateReport.reportGeneratorOrAuthor | |
| 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 |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE25 |
| 22. IMMZEGenerateReport.measureIdentifierMeaning | |
| Definition | Represents the name of the report/indicator. It codifies the meaning of the group / measure. For example, if the report indicator is Coverage each antigen / vaccine would have a measure (i.e. BCG Coverage or BCG Target) |
| 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 |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE26 |
| 24. IMMZEGenerateReport.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 | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE30 |
| 26. IMMZEGenerateReport.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 | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE31 |
| 28. IMMZEGenerateReport.disaggregationGroup | |
| Definition | Indicates the overall strata or disaggregation which is being represented in the report (for example: by gender, by region, by age group, etc.) |
| 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 |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE32 |
| 30. IMMZEGenerateReport.disaggregationMeasureIdentifierMeaning | |
| 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 (for example: if By-Sex is used as the disaggregation group, valid values would be 'Male', 'Female', 'Intersex') |
| Short | Disaggregation Measure Identifier / Meaning |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE41 |
| 32. IMMZEGenerateReport.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 | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE42 |
| 34. IMMZEGenerateReport.disaggregationDenominator | |
| Definition | The count of individual objects (persons, doses, etc.) which were used as the denominator for disaggregation score |
| Short | Disaggregation Denominator |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE43 |
| 36. IMMZEGenerateReport.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 | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE44 |
Guidance on how to interpret the contents of this table can be found here
| 0. IMMZEGenerateReport | |
| Definition | Data elements for the IMMZ.E Report Generation Data Dictionary. |
| Short | IMMZ.E Generate Report |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. IMMZEGenerateReport.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 |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE1 |
| 4. IMMZEGenerateReport.reportStatus | |
| Definition | The status of the report (for example, initial, complete, etc.) |
| Short | Report Status |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE2 |
| 6. IMMZEGenerateReport.reportType | |
| Definition | The type of report which has been generated (i.e. is the report a list of individuals, a summary, etc.) |
| Short | Report Type |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE3 |
| 8. IMMZEGenerateReport.reportIndicatorCode | |
| Definition | The indicator or measure definition which is being reported on (for example: Dropout rate, defaulters, etc.) |
| Short | Report Indicator Code |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE11 |
| 10. IMMZEGenerateReport.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 |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE18 |
| 12. IMMZEGenerateReport.reportGenerationDate | |
| Definition | Location (facility or place) for which the data in the report is being represented. |
| Short | Report Generation Date |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE19 |
| 14. IMMZEGenerateReport.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 | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE20 |
| 16. IMMZEGenerateReport.reportingPeriodEnd | |
| Definition | The start date of the reporting period for which data in the report has been included. |
| Short | Reporting Period End |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE21 |
| 18. IMMZEGenerateReport.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 |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE22 |
| 20. IMMZEGenerateReport.reportGeneratorOrAuthor | |
| 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 |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE25 |
| 22. IMMZEGenerateReport.measureIdentifierMeaning | |
| Definition | Represents the name of the report/indicator. It codifies the meaning of the group / measure. For example, if the report indicator is Coverage each antigen / vaccine would have a measure (i.e. BCG Coverage or BCG Target) |
| 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 |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE26 |
| 24. IMMZEGenerateReport.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 | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE30 |
| 26. IMMZEGenerateReport.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 | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE31 |
| 28. IMMZEGenerateReport.disaggregationGroup | |
| Definition | Indicates the overall strata or disaggregation which is being represented in the report (for example: by gender, by region, by age group, etc.) |
| 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 |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE32 |
| 30. IMMZEGenerateReport.disaggregationMeasureIdentifierMeaning | |
| 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 (for example: if By-Sex is used as the disaggregation group, valid values would be 'Male', 'Female', 'Intersex') |
| Short | Disaggregation Measure Identifier / Meaning |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE41 |
| 32. IMMZEGenerateReport.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 | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE42 |
| 34. IMMZEGenerateReport.disaggregationDenominator | |
| Definition | The count of individual objects (persons, doses, etc.) which were used as the denominator for disaggregation score |
| Short | Disaggregation Denominator |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE43 |
| 36. IMMZEGenerateReport.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 | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.E CodeSystem for Data Elements DE44 |