reference

iati-activities/iati-activity/result/reference

This is the reference page for the XML element reference.

Definition

A reference element to allow for the coded identification of a results framework.

Rules

This element may occur any number of times.

Attributes

@code

A code from the codelist identified in vocabulary that identifies a results framework.

This attribute is required.

This value must be of type xsd:string.

@vocabulary

A code for the results framework vocabulary. The code must be a valid value in the ResultVocabulary codelist.

This attribute is required.

This value must be of type xsd:string.

This value must be on the ResultVocabulary 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 of reference in the context of a result element.

This example declares use of @vocabulary 1, with a @code of 3429:
<reference vocabulary="1" code="3429" />

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

<reference vocabulary="99" code="B1" vocabulary-uri="http://example.com/indicators.html" />
The reference element can be repeated in any result. If the reference element is reported at result level it must not be reported at indicator level:
   <reference vocabulary="1" code="3429" />
   <reference vocabulary="7" code="861" />
   <reference vocabulary="99" code="B1" vocabulary-uri="http://example.com/indicators.html" />

Changelog

2.03

The optional reference element was added.

Developer tools

Find the source of this documentation on github: