Skip to content

Latest commit

 

History

History
387 lines (219 loc) · 13.8 KB

ATTRIBUTES.md

File metadata and controls

387 lines (219 loc) · 13.8 KB

Humanitarian eXchangle Language (HXL) Attributes

+abducted +activity +adolescents +adults +approved +bounds +canceled +children +cluster +code +converted +coord +dest +displaced +elderly +elevation +email +end +f +funder +hh +i +id +idps +impl +incamp +ind +infants +infected +injured +killed +label +lat +lon +m +name +noncamp +num +occurred +origin +phone +prog +programme +project +provided +refugees +reported +source +start +text +type +url +used

(1) Sex- and-age disaggregation (SADD) attributes

+adolescents

Adolescents, loosely defined (precise age range varies); may overlap +children and +adult. You can optionally create custom attributes in addition to this to add precise age ranges, e.g. "+adolescents +age12_17". Since version 1.0

Tags: #affected #inneed #population #reached #targeted

+adults

Adults, loosely defined (precise age range varies); may overlap +adolescents and +elderly. You can optionally create custom attributes in addition to this to add precise age ranges, e.g. "+adults +age18_64". Since version 1.0

Tags: #affected #inneed #population #reached #targeted

+children

The associated hashtag applies to non-adults, loosely defined (precise age range varies; may overlap +infants and +adolescents). You can optionally create custom attributes in addition to this to add precise age ranges, e.g. "+children +age3_11". Since version 1.0

Tags: #affected #inneed #population #reached #targeted

+elderly

Elderly people, loosely defined (precise age range varies). May overlap +adults. You can optionally create custom attributes in addition to this to add precise age ranges, e.g. "+elderly +age65plus". Since version 1.0

Tags: #affected #inneed #population #reached #targeted

+f

Female people. See also +m and +i. Since version 1.0

Tags: #affected #inneed #population #reached #targeted

+hh

Households (vs +ind for individual people). The exact definition of "household" may vary among aid organisations. Since version 1.1

Tags: #affected #inneed #population #reached #targeted

+i

Intersex or non-gender-binary people. Use this attribute for any groups who do not identify as male (+m) or female (+f). Since version 1.0

Tags: #affected #inneed #population #reached #targeted

+ind

Individual people (vs +hh for households). Since version 1.1

Tags: #affected #inneed #population #reached #targeted

+infants

Infant children, loosely defined (precise age range varies; may overlap +children). You can optionally create custom attributes in addition to this to add precise age ranges, e.g. "+infants +age0_2". Since version 1.0

Tags: #affected #inneed #population #reached #targeted

+m

Male people. See also +f and +i. Since version 1.0

Tags: #affected #inneed #population #reached #targeted

(2) Organisation and activity attributes

+activity

The implementers classify this activity as an "activity" proper (may imply different hierarchical levels in different contexts). Since version 1.1

Tags: #activity

+cluster

Identifies a sector as a formal IASC humanitarian cluster. Since version 1.1

Tags: #sector

+funder

Funding org/agency (e.g. donor). Since version 1.0

Tags: #org

+impl

Implementing partner. Since version 1.0

Tags: #org

+prog

Programming org/agency. Since version 1.0

Tags: #org

+programme

The implementers classify this activity as a "programme" (may imply different hierarchical levels in different contexts). Since version 1.1

Tags: #activity

+project

The implementers classify this activity as a "project" (may imply different hierarchical levels in different contexts). Since version 1.1

Tags: #activity

+provided

Refers to a #service, #item, etc. that has been provided to people in need. Since version 1.1

Tags: #item #service

+used

Refers to a #service, #item, etc. that affected people have actually consumed or otherwise taken advantage of. Since version 1.1

Tags: #item #service

(3) Classification attributes

+code

A unique, machine-readable code. Since version 1.0

Tags: #activity #adm1 #adm2 #adm3 #adm4 #adm5 #beneficiary #cause #channel #country #crisis #currency #event #group #impact #indicator #item #loc #modality #need #org #output #region #sector #service #severity #status #subsector

+type

Types or categories. Use with #org, #loc, #indicator, etc to provide classification information. Since version 1.0

Tags: #access #activity #beneficiary #capacity #cause #contact #crisis #description #event #frequency #group #impact #indicator #item #loc #need #operations #org #output #sector #service #severity #subsector

(4) Geographical attributes

+bounds

Boundary data (e.g. inline GeoJSON). Since version 1.0

Tags: #geo

+coord

Geodetic coordinates (lat+lon together). Since version 1.0

Tags: #geo

+dest

Place of destination (intended or actual). Since version 1.1

Tags: #adm1 #adm2 #adm3 #adm4 #adm5 #country #loc #region

+elevation

Elevation above sea level (usually metres). Since version 1.0

Tags: #geo

+lat

Latitude (decimal degrees preferred). Since version 1.0

Tags: #geo

+lon

Longitude (decimal degrees preferred). Since version 1.0

Tags: #geo

+origin

The data describes places of origin (intended or actual), e.g. the country of origin for displaced people. Since version 1.1

Tags: #adm1 #adm2 #adm3 #adm4 #adm5 #country #loc #region

(5) Date attributes

+approved

Date or time when something was approved. Since version 1.0

Tags: #date

+canceled

Date or time when something (e.g. an #activity) was canceled. Since version 1.0

Tags: #date

+converted

Date or time used for converting a monetary value to another currency. Since version 1.1

Tags: #date

+end

Date or time when something finished or will finish. Since version 1.0

Tags: #date

+occurred

Date or time when something took place. Since version 1.0

Tags: #date

+reported

Date or time when the information was reported. Since version 1.0

Tags: #date

+start

Date or time when something started or will start. Since version 1.0

Tags: #date

(6) Impact attributes

+abducted

Hashtag refers to people who have been abducted. Since version 1.1

Tags: #affected #inneed #reached #targeted

+displaced

Displaced people or households. Refers to all types of displacement: use +idps or +refugees to be more specific. Since version 1.0

Tags: #affected #inneed #population #reached #targeted

+idps

Internally-displaced people or households. More specific than +displaced. Since version 1.0

Tags: #affected #inneed #population #reached #targeted

+incamp

Located in camps. Since version 1.0

Tags: #affected #inneed #population #reached #targeted

+infected

People infected with a disease. Since version 1.0

Tags: #affected #inneed #reached #targeted

+injured

People injured. Since version 1.0

Tags: #affected #inneed #reached #targeted

+killed

People killed. Since version 1.0

Tags: #affected

+noncamp

Not located in camps. Since version 1.0

Tags: #affected #inneed #population #reached #targeted

+refugees

Refugee people or households. More specific than +displaced. Since version 1.0

Tags: #affected #inneed #population #reached #targeted

(7) General attributes

+email

Email address. Since version 1.0

Tags: #contact

+id

Use with #meta to provide internal identifiers for data records. Since version 1.1

Tags: #meta

+label

Text labels (for a table or chart). Since version 1.0

+name

Human-readable name, title, or label. Since version 1.0

Tags: #activity #adm1 #adm2 #adm3 #adm4 #adm5 #beneficiary #cause #channel #contact #country #crisis #event #group #impact #indicator #item #loc #modality #need #org #output #region #sector #service #severity #status #subsector

+num

The data consists of quantitative, numeric information. Since version 1.0

Tags: #capacity #indicator #output

+phone

The data consists of #contact phone numbers. Since version 1.0

Tags: #contact

+source

Information source for the data in the row or record. Since version 1.0

Tags: #meta

+text

The data consists of qualitative, narrative textual information. Since version 1.0

Tags: #indicator

+url

The data consists of web links related to the main hashtag (e.g. for an #org, #service, #activity, #loc, etc). Since version 1.0

Tags: #activity #contact #meta #org #service