recipient-region

Definition

A supranational geopolitical region that will benefit from this transaction. If a specific country is not known, then this element MUST be used.

If transaction/recipient-country AND/OR transaction/recipient-region are used THEN ALL transaction elements MUST contain a recipient-country or recipient-region element AND (iati-activity/recipient-country AND iati-activity/recipient-region MUST NOT be used)

Rules

This element must occur no more than once (within each parent element).

3.6.2: Recipient countries or regions must only be declared at activity level OR for all transactions.

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.

@vocabulary-uri

The URI where this vocabulary is defined. If the vocabulary is 99 (reporting organisation), the URI where this internal vocabulary is defined. While this is an optional field it is STRONGLY RECOMMENDED that all publishers use it to ensure that the meaning of their codes are fully understood by data users.

This value must be of type xsd:anyURI.

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" />

If a publisher uses a vocabulary of 99 (i.e. ‘Reporting Organisation’), then the @vocabulary-uri attribute should also be used, for example:

<recipient-region code="A1" vocabulary="99" vocabulary-uri="http://example.com/vocab.html" />

Full example:

  <transaction ref="1234" humanitarian="1">
   <transaction-type code="1" />
   <transaction-date iso-date="2012-01-01" />
   <value currency="EUR" value-date="2012-01-01">1000</value>
   <description>
    <narrative>Transaction description text</narrative>
   </description>
   <provider-org provider-activity-id="BB-BBB-123456789-1234AA" type="10" ref="BB-BBB-123456789">
    <narrative>Agency B</narrative>
   </provider-org>
   <receiver-org receiver-activity-id="AA-AAA-123456789-1234" type="23" ref="AA-AAA-123456789">
    <narrative>Agency A</narrative>
   </receiver-org>
   <disbursement-channel code="1" />
   <sector vocabulary="2" code="111" />
   <!--Note: only a recipient-region OR a recipient-country is expected-->
   <recipient-country code="TM" />
   <recipient-region code="616" vocabulary="1" />
   <flow-type code="10" />
   <finance-type code="110" />
   <aid-type code="A01" vocabulary="1" />
   <aid-type code="1" vocabulary="2" />
   <tied-status code="3" />
  </transaction>

Changelog

Developer tools

Find the source of this documentation on github:

• Schema

• Extra Documentation

Subelements

• narrative