recipient-region

iati-activities/iati-activity/recipient-region

This is the reference page for the XML element recipient-region. See also the relevant overview page: Geography

Definition

A supranational geopolitical region that will benefit from this activity. For sub-national geographical location, use the location element.

Multiple countries and regions can be reported, in which case the percentage attribute MUST be used to specify the share of total commitments across all reported countries and regions. Recipient-region must not be used merely to describe the region of a country reported in recipient-country, but ONLY if the region is a recipient IN ADDITION to the country.

Region can also be reported at transaction rather than activity level. If transaction/recipient-country AND/OR transaction/recipient-region are used THEN ALL transaction elements MUST contain a recipient-country and/or recipient-region element AND iati-activity/recipient-region and iati-activity/recipient-region MUST NOT be used AND each transaction MUST only contain one recipient-country or recipient-region.

Rules

This element may occur any number of times.

Attributes

@code

Either an OECD DAC or UN region code. Codelist is determined by vocabulary attribute.

This attribute is required.

This value must be of type xsd:string.

This value must be on the Region codelist, if the relevant vocabulary is used.

@vocabulary

An IATI code for the vocabulary from which the region code is drawn. If it is not present 1 - ‘OECD DAC’ is assumed.

This value must be of type xsd:string.

This value must be on the RegionVocabulary codelist.

@percentage

The percentage of total commitments or total activity budget allocated to this region. Content must be a positive decimal number between 0 and 100, with no percentage sign. Percentages for all reported countries and regions MUST add up to 100%

This value must be of type xsd:decimal.

The sum of values matched at recipient-region/@percentage and recipient-country/@percentage must be 100.

Example Usage

Example recipient-region of an iati-activity.

The @code attribute declares a valid code (489) from the Region codelist.
The optional @vocabulary attribute declares a valid code (1) from the RegionVocabulary codelist.
<recipient-region code="489" vocabulary="1" />
The recipient-region element can be repeated in any iati-activity.
When multiple recipient-region are declared, then the @percentage values should sum to 100% for the specific iati-activity.
<recipient-region code="489" vocabulary="1" percentage="50" />
<recipient-region code="389" vocabulary="1" percentage="50" />
When both the recipient-region and recipient-country, then the @percentage values should sum to 100% for the specific iati-activity.
<recipient-country code="AF" percentage="50" />
<recipient-region code="489" vocabulary="1" percentage="50" />

Changelog

2.01

Freetext is no longer allowed with this element. It should now be declared with the new child narrative element, but only in particular use-cases.

1.03

Where used, the @percentage attribute is now designated as a decimal value and no longer as a positive Integer

Developer tools

Find the source of this documentation on github:

Subelements