reference

iati-activities/iati-activity/result/indicator/reference

This is the reference page for the XML element reference. See also the relevant overview page: Result

Definition

A standardised means of identifying the indicator from a code in a recognised vocabulary. Multiple vocabularies may be specified, but each vocabulary may be specified only once for each indicator.

Rules

This element may occur any number of times.

Attributes

@vocabulary

A code for a recognised vocabulary of indicators. The value for this field should appear in the IndicatorVocabulary codelist.

This attribute is required.

This value must be of type xsd:string.

This value should be on the IndicatorVocabulary codelist.

@code

A code for an indicator defined in the specified vocabulary specified.

This attribute is required.

This value must be of type xsd:string.

@indicator-uri

If the vocabulary is 99 (reporting organisation), the URI where this internal vocabulary is defined.

This value must be of type xsd:anyURI.

Example Usage

Example of reference in the context of an indicator 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 @indicator-uri attribute should also be used, for example:

<reference vocabulary="99" code="B1" indicator-uri="http://example.com/indicators.html" />
The reference element can be repeated in any indicator:
  <result type="1" aggregation-status="1">
   <title>
    <narrative>Result title</narrative>    
   </title>
   <description>
    <narrative>Result description text</narrative>   
   </description>
   <indicator measure="1" ascending="1">
     <title>
      <narrative>Indicator title</narrative>   		 
     </title>
     <description>
      <narrative>Indicator description text</narrative>
     </description>
     <reference vocabulary="1" code="3429" />
     <reference vocabulary="7" code="861" />
     <reference vocabulary="99" code="B1" indicator-uri="http://example.com/indicators.html" />     
     <baseline year="2012" value="10">
      <comment>
       <narrative>Baseline comment text</narrative>
      </comment>
     </baseline>
     <period>
      <period-start iso-date="2013-01-01" />
      <period-end iso-date="2013-03-31" />
      <target value="10">
       <location ref="AF-KAN" />
       <location ref="KH-PNH" />
       <dimension name="sex" value="female" />
       <dimension name="age" value="adult" />
       <comment>
        <narrative>Target comment text</narrative>			
       </comment> 
      </target>
      <actual value="11">
       <location ref="AF-KAN" />
       <location ref="KH-PNH" />
       <dimension name="sex" value="female" />
       <dimension name="age" value="adult" />
       <comment>
         <narrative>Actual comment text</narrative>
       </comment> 
      </actual>
     </period>
   </indicator>
  </result>

Changelog

2.02

The optional reference element was added.

Developer tools

Find the source of this documentation on github:

Last updated on 2016-09-08