Package index • khisr

Authorization Credentials

Set and securely store the DHIS2 authorization credentials

Download metadata information from DHIS2

get_metadata(): Get Metadata from a DHIS2 Instance
get_categories() get_category_combos() get_category_option_combos() get_category_option_group_sets() get_category_option_groups() get_category_options() get_data_element_group_sets() get_data_element_groups() get_data_elements() get_data_sets() get_user_groups() get_indicator_group_sets() get_indicator_groups() get_indicators() get_option_group_sets() get_option_groups() get_option_sets() get_options() get_organisation_unit_groupsets() get_organisation_unit_groups() get_organisation_units() get_organisation_unit_levels() get_dimensions() get_period_types() get_programs() get_program_stages() get_tracked_entity_types() get_tracked_entity_attributes() get_relationship_types() get_user_profile(): DHIS2 Metadata Helper Functions
metadata_filter() `%.eq%` `%.ieq%` `%.~eq%` `%.ne%` `%.Like%` `%.~Like%` `%.^Like%` `%.~^Like%` `%.Like$%` `%.~Like$%` `%.like%` `%.~like%` `%.^like%` `%.~^like%` `%.like$%` `%.~like$%` `%.gt%` `%.ge%` `%.lt%` `%.le%` `%.token%` `%.~token%` `%.in%` `%.~in%`: Metadata Filter

To access analytical, aggregated data in DHIS2, the raw data values behind it, and data-quality checks

get_analytics(): Retrieves Disaggregated Analytics Data from DHIS2
analytics_dimension() `%.d%` `%.f%`: Analytics Data Dimensions
get_data_value_sets() experimental: Get Raw Data Values from a DHIS2 Instance
get_event_analytics() experimental: Retrieves Aggregated Event Analytics Data from DHIS2
get_enrollment_analytics() experimental: Retrieves Aggregated Enrollment Analytics Data from DHIS2
get_event_analytics_aggregate() experimental: Get Aggregated (Pivot-Style) Event Analytics from DHIS2
get_enrollment_analytics_aggregate() experimental: Get Aggregated (Pivot-Style) Enrollment Analytics from DHIS2
get_analytics_outliers() experimental: Get Statistical Outliers from DHIS2 Analytics
get_validation_results() experimental: Get Validation Rule Results from DHIS2
get_complete_data_set_registrations() experimental: Get Raw Data Set Completeness Registrations from a DHIS2 Instance

Retrieve tracked entities, events, enrollments, and relationships from DHIS2’s Tracker API

get_tracked_entities() experimental: Get Tracked Entities from a DHIS2 Instance
get_events() experimental: Get Events from a DHIS2 Instance
get_enrollments() experimental: Get Enrollments from a DHIS2 Instance
get_relationships() experimental: Get Relationships from a DHIS2 Instance
tracked_entity_filter() `%.teq%` `%.tne%` `%.tgt%` `%.tge%` `%.tlt%` `%.tle%` `%.tlike%` `%.tsw%` `%.tew%` `%.tin%`: Tracked Entity Attribute Filter

Instance information, mapping, SQL views, the key/value data store, audit history, and file resources

get_system_info() experimental: Get DHIS2 Instance System Information
get_geo_features() experimental: Get Organisation Unit Geographic Features
get_sql_views() experimental: Get SQL Views Metadata from a DHIS2 Instance
get_sql_view_data() experimental: Get Data from a DHIS2 SQL View
get_data_store_namespaces() experimental: Get DHIS2 Data Store Namespaces
get_data_store_keys() experimental: Get the Keys in a DHIS2 Data Store Namespace
get_data_store_value() experimental: Get a Value from a DHIS2 Data Store
get_data_value_audits() experimental: Get Data Value Change History from a DHIS2 Instance
get_file_resources() experimental: Get File Resources Metadata from a DHIS2 Instance

Experimental functions that formats the data in logical manner

get_analytics_by_level() experimental: Retrieves Analytics Table Data
get_data_elements_with_category_options() experimental: Get Data Elements with Category Options
get_data_sets_by_level() experimental: Retrieves Data Set Reporting Rate Metrics
get_organisations_by_level() experimental: Get Organisations by Level