reference¶
iati-activities/iati-activity/result/indicator/reference
This is the reference page for the XML element reference.
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.
There must be no more than one element or attribute matched at reference[1] or ../reference[1].
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
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 an indicator of a result element.
@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" />
reference element can be repeated in any indicator. If the reference element is reported at indicator level it must not be reported at result level: <indicator measure="1" ascending="1" aggregation-status="1">
<title>
<narrative>Indicator title</narrative>
</title>
<description>
<narrative>Indicator description text</narrative>
</description>
<document-link format="application/vnd.oasis.opendocument.text" url="http:www.example.org/docs/result_indicator_en.odt">
<title>
<narrative>Results Indicator Report 2013</narrative>
</title>
<description>
<narrative>Report of results indicator</narrative>
</description>
<category code="A01" />
<language code="en" />
<document-date iso-date="2014-02-05" />
</document-link>
<reference vocabulary="1" code="3429" />
<reference vocabulary="7" code="861" />
<reference vocabulary="99" code="B1" indicator-uri="http://example.com/indicators.html" />
<!--result-baseline starts-->
<baseline year="2012" iso-date="2012-01-01" value="10">
<location ref="AF-KAN" />
<location ref="KH-PNH" />
<dimension name="sex" value="female" />
<dimension name="age" value="adult" />
<document-link format="application/vnd.oasis.opendocument.text" url="http:www.example.org/docs/result_baseline_en.odt">
<title>
<narrative>Results Baseline Report 2013</narrative>
</title>
<description>
<narrative>Report of results baseline</narrative>
</description>
<category code="A01" />
<language code="en" />
<document-date iso-date="2014-02-05" />
</document-link>
<comment>
<narrative>Baseline comment text</narrative>
</comment>
</baseline>
<!--result-baseline ends-->
<!--result-period starts-->
<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>
<document-link format="application/vnd.oasis.opendocument.text" url="http:www.example.org/docs/result_period_target_en.odt">
<title>
<narrative>Results Period Target Report 2013</narrative>
</title>
<description>
<narrative>Report of results period target</narrative>
</description>
<category code="A01" />
<language code="en" />
<document-date iso-date="2014-02-05" />
</document-link>
</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>
<document-link format="application/vnd.oasis.opendocument.text" url="http:www.example.org/docs/result_period_actual_en.odt">
<title>
<narrative>Results Period Actual Report 2013</narrative>
</title>
<description>
<narrative>Report of results period actual</narrative>
</description>
<category code="A01" />
<language code="en" />
<document-date iso-date="2014-02-05" />
</document-link>
</actual>
</period>
<!--result-period ends-->
</indicator>