跳转至
For the complete DHIS2 documentation index, see llms.txt.

命名约定

本文件介绍了在创建 DHIS2 元数据作为综合 HIS(跟踪或汇总)的一部分时的总体命名约定和建议。这些约定尽可能适用于 UiO 开发的配置包。

命名 DHIS2 对象的一般指南{ #general-guidance-for-naming-dhis2-objects }

一般原则是设计可有效用于分析的数据元素和指标。通常,与这些项目进行交互的最终用户数量将比系统管理员高得多。因此,使物品更易于识别和查找是所建议设计原则的基本要素。 * 尽可能缩短和简化名称/简称,例如,一般情况下无需包含"......数量 "及类似短语,特别是对于几乎所有内容都是数字的汇总数据元素。 * 提供一个有意义且简洁的名称:在不使人难以理解名称含义的前提下,将关键信息放在名称的前面。 * 考虑哪些用户将看到各种对象的名称/简称,以及他们与哪些应用程序交互。记住:用户可以配置自己的用户账户,以便在应用程序中查看长或短名称。 * 名称(长名称)应酌情包括前缀和后缀,以便于元数据的排序以及分析和管理用户的筛选 * 简短名称限制为 52 个字符;考虑到通过分析应用程序访问这些对象的最终用户,尽可能使这些名称具有意义 * 表单名称:数据元素的表单名称应针对数据录入用户进行优化。这些名称出现在数据采集应用程序中,应为输入数据指导的人员提供足够的含义和清晰度。还应考虑这些名称的长度。对于 Android 实施,实施者应考虑这些名称在移动设备上的呈现方式 * 大多数分析用户主要与*仪表板项、数据元素、指标、作为数据维度配置的类别组合、图例集*进行交互。

Programme specific vs generic/shared metadata

DHIS2 被广泛用作综合 HMIS,将多个卫生领域和计划的数据和元数据整合到一个系统中。因此,必须明确某些元数据指的是什么疾病/计划。例如,"每 10 万人病例发生率 "这样的名称可以指疟疾、结核病、霍乱等。不过,确保某些元数据可以跨疾病/健康领域共享也很重要。

为便于统一元数据,我们建议根据元数据是某一计划特有的还是各计划共享的情况,对数据元素和指标等元数据对象的长名称(但不包括 "短名称 "或 "形式名称")使用以下前缀。 * 针对某一卫生项目/疾病的元数据应加上统一的前缀代码,以表示该卫生项目/疾病或元数据的其他逻辑分组: * 例如,结核病、MAL、艾滋病毒、EPI、RMNCAH、CRVS 等 * 跨卫生领域/计划共享的元数据应有一个更通用的前缀,以表示一般认为可重复使用或共享的元数据 * 例如,UiO HIS 元数据包使用前缀 "GEN"。

Examples of naming

数据元素的**佳命名实践**示例:确保名称中最重要的部分是决定有序列表中数据元素顺序的部分:

  • ANC第一次访问
  • ANC第二次访问
  • ANC第三次访问
  • ANC第4次以上造访

这将使这些项目一起出现在主题区域内;它们也按预期从头到尾顺序排列。

image

  • 如果决定对程序中常见的简短形式(通常用于数据元素或指示符)使用已知的命名法,请跨所有数据元数据(即P,Pl或疟原虫)选择统一的方法。

image

数据元素的**不良命名做法**示例:*首次产前检查的孕妇人数。

  • *数目*一般没有必要。据了解,月度报告中报告的是一个数字,这就增加了名称的长度。
  • 孕妇是多余的。仅孕妇进行非国大访问。
  • 首次访问ANC是关键信息,不应在名称的结尾。
  • 理想情况下,名称的第一部分应允许您将有序数据列表中的相似数据元素分组。

如果我们审查ANC访问1-4,则可以使用:

  • 第一次ANC访问
  • 第二次ANC访问
  • 第三次非国大访问
  • 第四次非国大访问

作为通俗易懂的语言,这是有道理的,但是,当与其他数据元素组合在有序列表(例如DHIS2分析应用程序中出现的内容)中时,它们既不会按顺序排列也不会分组在一起。

图像

Numbers as part of names

  • 小于(或等于):使用0–4,而不是0-4,< = 5,< = 4,≤5
  • 大于(或等于):使用15+,而不是>14,> = 15,≥15
  • 间隔:使用5-14,而不是5-14

数据元素

  • 数据元素*名称*前应加上卫生计划/领域的缩写/代码,如 TB、MAL、HIV、EPI 等。
  • 数据元素通常代表值的原始计数,因此可以假设,如果数据元素没有后缀表示其是哪种值类型,则它是原始数(即ANC首次访问-不存在后缀,因此我们可以假设您正在报告ANC访问次数)。
  • 如果您要直接收集某种类型的比率,比例等作为未计算的数据值(即通过数据收集过程作为原始值),则应在数据末尾的方括号中添加一个短后缀来表明这一点。元素名称。
  • 我们可以在可能的情况下从数据元素中删除纯文本,如果在将其作为缩短名称的输出进行审核时并不太有意义的话(例如,“ RDT阳性的疟疾病例数”可以更改为“疟疾阳性(RDT)”))使分析中的输出更具可读性。

指标

  • 数据元素*名称*前应加上卫生领域/计划的缩写/代码,如 TB、MAL、HIV、EPI 等。
  • 指标是使用数据元素的组合来创建分析输出的计算。
  • 命名通常通过指标本身的名称与数据元素区分开(即ANC第一次访问与ANC第一次访问覆盖率(%))
  • 由于添加了后缀以指示其类型,因此这些名称可能比数据元素名称略长。
  • 指标名称的开头不应以%开头。在列表中,它们将变得杂乱无章。
  • (资产/indicator_perc_prefix.png)

  • 可以在描述中使用诸如比例或百分比之类的长名称,但不应将其包含在指标名称中。我们可以看到,这在名称的开头添加了其他文本。它还将项目按“比例/百分比”而不是识别特征(即疫源,疟疾病例,疟疾物种类型)分组。

image

  • 如果我们将%添加为后缀项,则以更有意义的方式组织项目,则名称会缩短,并且名称开头的多余空格将被删除

image

收藏夹

  • 最喜欢的名称:在最喜欢的名称前加上卫生领域/计划名称和 连字符,例如 TB - 病例通知...,MAL - 发病率...
  • 最喜欢的标题:标题不需要前缀,因为它们不用于搜索。

选项集

通用/可重用选项集应尽可能具有通用名称。例如,如果艾滋病毒检测结果需要一个选项集,且选项为“阳性”和“阴性”,则应将其命名为“阳性/阴性”而不是“ HIV检测结果”,以便可以重复使用。如果有几个对象可能混淆或相似但不相同的可能性,则应明确指出,例如“结核病治疗结果”,“疟疾治疗结果”。

代号

  • 所有代码应以疾病程序/地区的首字母缩写词/代码为前缀,并带有下划线,例如TB ,MAL ,HIV _,EPI _等。
  • 代码应大写。
  • 如果存在针对特定计划/疾病领域的代码,则应使用这些代码。但是,对于该区域,应始终在其首字母缩写/代码前加上大写字母)。
  • 如果创建新代码,则应遵循这些准则:
    • 仅应使用字母数字字符和下划线。
    • 代码应尽可能有意义(如 "HIV_TEST_POS "而不是 "HIV_T01_")。