Proposed tags
Note: many of these tags are planned for inclusion in HXL 1.0 beta. See the proposed tag changes for details (open for public commenting).
This page documents proposed new HXL tags (not included in the tag dictionary). Please feel free to leave comments below, as well as suggestions for additional tags.
You are welcome to start using these with your own HXL data, but please note that none of these tags is (currently) an official part of the HXL standard, the HXL Working Group has not endorsed their use, and they are subject to change or non-adoption. When these tags are adopted, we will remove the “x_” prefix from the beginning of each one (e.g. “#x_record_id” will become “#record_id”).
| Proposed tag | Description | Source | Date | Notes |
|---|---|---|---|---|
| #x_record_id | Unique identifier for a HXL data record (metadata). | Simon Johnson, British Red Cross (Ebola response) | September 2014 | The BRC is currently using #x_uniqueid |
| #x_notes | Notes or comments on a HXL data record (metadata), e.g. “All values estimated.” | Simon Johnson, British Red Cross (Ebola response) | September 2014 | The BRC is currently using #x_notes in the Ebola response. |
| #x_site_lnk | A link to a web site describing the subject of a HXL data row (e.g. a clinic or project). | Standby Task Force (Ebola response) | September 2014 | Not yet in use (2014-10-06). |
| #x_placename | Human-readable name and address. To be distinguished from the existing #loc tag, which can be the subject of a data record (e.g. the name of a health clinic). | Standby Task Force (Ebola response) | September 2014 | Not yet in use (2014-10-06). |
| #x_border | Description of a geopolitical border (e.g. relating to movement restrictions). | Simon Johnson, British Red Cross (Ebola response) | September 2014 | The BRC is currently using #x_border_country to describe movement restrictions. Will also likely need to add #border_id |
| #x_restriction | Description of a restriction (movement, etc.) affecting an aid response e.g. “Area Blockade” | Simon Johnson, British Red Cross (Ebola response) | September 2014 | The BRC is currently using #x_restrictiontype specifically to describe restrictions on movement. |
| #x_geoscale | Description of the geopolitical scale of the information being described, e.g. “Domestic” or “International.” | Simon Johnson, British Red Cross (Ebola response) | September 2014 | The BRC is currently using #x_restrictionscale specifically for the scale of restrictions on movement. |
| #x_cause | Description of the cause of an event or other entity being described in a HXL record, e.g. “Quarantine.” | Simon Johnson, British Red Cross (Ebola response) | September 2014 | The BRC is currently using #x_restrictionnature specifically to describe the cause of a restriction on movement. |
| #x_capacity | The capacity of a facility or other resource, e.g. “25 beds.” | Standby Task Force (Ebola response) | October 2014 | Proposed by Per Aarvik for health-facilities data. |
| #x_staff_num | The number of staff working in a facility or other activity, e.g. “9”. | Standby Task Force (Ebola response) | October 2014 | Proposed by Per Aarvik for health-facilities data. |
| #x_responsecat | The category of a humanitarian response (e.g. current problem, lessons learned). | Standby Task Force (Ebola response) | October 2014 | From Helen Campbell, for the column “Response category (UNMEER MCAs)” in the Daily Needs Update. Initially only for Guinea. |
| #x_affgroup | A description of a group affected in a crisis. This is a more-generic complement to #sex, etc. | Standby Task Force (Ebola response) | October 2014 | From Helen Campbell, for the column “Group affected” in the Daily Needs Update. |
| #x_sourcetype | A description of the type of source for data (e.g. local government, donor, media), to complement #source. | Standby Task Force (Ebola response) | October 2014 | From Helen Campbell, for the column “Type of source” in the Daily Needs Update. |
| #x_severity | A description of the severity of an event or need (may be a numeric ranking). | Standby Task Force (Ebola response) | October 2014 | From Helen Campbell, for the column “Severity” in the Daily Needs Update. |
| #x_reliability | A description of the reliability/trustworthiness of a row of data (may be a numeric ranking). | Standby Task Force (Ebola response) | October 2014 | From Helen Campbell, for the column “Reliability” in the Daily Needs Update. |
| #x_tag | The tag being defined by a HXL schema rule. | libhxl (schema support) | November 2014 | See https://github.com/HXLStandard/libhxl-python/wiki/HXL-schemas. |
| #x_minoccur_num | The minimum number of times a tagged value must appear in a row of a HXL dataset. | libhxl (schema support) | November 2014 | See https://github.com/HXLStandard/libhxl-python/wiki/HXL-schemas. |
| #x_maxoccur_num | The maximum number of times a tagged value may appear in a row of a HXL dataset. | libhxl (schema support) | November 2014 | See https://github.com/HXLStandard/libhxl-python/wiki/HXL-schemas. |
| #x_datatype | The type of data for a tag in a HXL dataset. Allowed values are “text”, “number”, “url”, “email”, “phone”, and “date”. | libhxl (schema support) | November 2014 | See https://github.com/HXLStandard/libhxl-python/wiki/HXL-schemas. |
| #x_minvalue_num | The minimum numeric value allowed for a tag in a HXL dataset. | libhxl (schema support) | November 2014 | See https://github.com/HXLStandard/libhxl-python/wiki/HXL-schemas. |
| #x_maxvalue_num | The maximum numeric value allowed for a tag in a HXL dataset. | libhxl (schema support) | November 2014 | See https://github.com/HXLStandard/libhxl-python/wiki/HXL-schemas. |
| #x_pattern | A regular expression pattern matching a value in a HXL dataset. | libhxl (schema support) | November 2014 | See https://github.com/HXLStandard/libhxl-python/wiki/HXL-schemas. |
| #x_enumeration | A list of allowed values for a tag in a HXL dataset. | libhxl (schema support) | November 2014 | See https://github.com/HXLStandard/libhxl-python/wiki/HXL-schemas. |
| #x_caseinsensitive | A flag for whether a HXL schema should ignore upper/lower case when matching patterns or enumerated values in a HXL dataset. | libhxl (schema support) | November 2014 | See https://github.com/HXLStandard/libhxl-python/wiki/HXL-schemas. |
| #x_uniqueid | Unique identifier for an incident report. | Ushahidi | December 2014 | From Sara Terp; see Connecting Ushahidi data to the HDX repository. C.f. the proposed #x_record_id tag. |
| #x_reporttitle | Title for an incident report. | Ushahidi | December 2014 | From Sara Terp; see Connecting Ushahidi data to the HDX repository |
| #x_description | Longer description of an incident report. | Ushahidi | December 2014 | From Sara Terp; see Connecting Ushahidi data to the HDX repository. Compare to the proposed #x_notes tag (perhaps they are different concepts). |
| #x_category | Category of an incident report. | Ushahidi | December 2014 | From Sara Terp; see Connecting Ushahidi data to the HDX repository |
| #x_approved | Approval status of an incident report. | Ushahidi | December 2014 | From Sara Terp; see Connecting Ushahidi data to the HDX repository. Would it be possible to use the standard HXL #status tag instead, or is this metadata for the data record while #status is about the thing being described? See also the proposed #x_verified tag. |
| #x_verified | Verification status of an incident report. | Ushahidi | December 2014 | From Sara Terp; see Connecting Ushahidi data to the HDX repository. See the notes for the #x_approved tag. |
