Changes for page Guidelines on Using SDMX Annotations

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -527,53 +527,271 @@
527	527
528	528	The categories below are used widely, for example by the European Statistical System (ESS), and the United Nations Statistics Division for its central framework classifications ISIC4{{footnote}}International Standard Industrial Classification of All Economic Activities{{/footnote}} and CPC{{footnote}}Central Product Classification{{/footnote}}.
529	529
	530	+|(% style="width:170px" %)Annotation Type|(% style="width:451px" %)Use Case|(% style="width:203px" %)Where to attach|(% style="width:254px" %)(((
	531	++Text
	532	+Blue is optional
	533	+)))|(% style="width:556.217px" %)(((
	534	+Title
	535	+Blue is optional
	536	+)))|(% style="width:460px" %)(((
	537	+SDMX 2.1:URL
530	530
531		-|**Annotation Type**|(% style="width:524px" %)**Use Case**|(% style="width:198px" %)**Where to attach**|(% style="width:237px" %)(((
532		-**+Text
533		-(% style="background-color:transparent" %)Blue is optional(%%)**
534		-)))|(% style="width:465px" %)(((
535		-**Title
536		-(% style="background-color:transparent" %)Blue is optional(%%)**
537		-)))|(((
538		-**SDMX 2.1:URL
539	539	SDMX >=3.0:+URL
540		-(% style="background-color:transparent" %)Blue is optional(%%)**
	540	+
	541	+Blue is optional
541	541	)))
542		-|FULL_NAME|(% style="width:524px" %)Alternative name to be displayed for items in Item Schemes (e.g. Codelists, Concept Schemes, Category Schemes) whenever the item is displayed without its parent. For example, if a code list that has a hierarchy is displayed as a flat list, then this annotation may be used to provide sufficient context for the code. Concatenation of code + heading in NACE Rev.2.1
543		-en: A0123 Growing of citrus fruits|(% style="width:198px" %)Item in an Item Scheme|(% style="width:237px" %)(((
544		-<language>:<content>,<language>:<content>,…
	543	+|(% style="width:170px" %)ORIGINAL_CODE|(% style="width:451px" %)Code as displayed in other representations, such as official or original documentation (i.e. possibly containing dots, spaces, etc.). Reference to external standard: skos:notation|(% style="width:203px" %)Item in an Item Scheme|(% style="width:254px" %) |(% style="width:556.217px" %)(((
	544	+<original code>
	545	+
	546	+//Examples~://
	547	+
	548	+* 0105.13 [Harmonized System]
	549	+* 11.2.0.9 [COICOP classification]
	550	+)))|(% style="width:460px" %)
	551	+|(% style="width:170px" %)HIER_CONTEXT|(% style="width:451px" %)(((
	552	+In SDMX 2.1, a reference between a usage context and a hierarchy (that may be contained in a Hierarchical Codelist (HCL)).
	553	+In SDMX 3.0, use the HierarchyAssociation artefact
	554	+)))|(% style="width:203px" %)DSD or Dataflow|(% style="width:254px" %) |(% style="width:556.217px" %)(((
	555	+<component Id>:<HCL Id>.<hierarchy Id>
	556	+
545	545	//Example~://
546		-(% style="background-color:transparent" %)en:Labour force (Employment)
547		-)))|(% style="width:465px" %)<content>|
548		-|REPLACE_NAME|(% style="width:524px" %)Replace each code name in a component by the value of another component in an observation or series|(% style="width:198px" %)A Dataflow or DSD|(% style="width:237px" %) |(% style="width:465px" %)(((
549		-<component Id to replace name>:<component Id to use name>
	558	+
	559	+REF_AREA:OECD.EDU:HCL_REF_AREA(1.0).REF_AREA provides the link to the  reference area hierarchy for OECD education data
	560	+)))|(% style="width:460px" %)
	561	+|(% style="width:170px" %)HIER_LEVEL|(% style="width:451px" %)(((
	562	+Explicit specification of the hierarchical level of a code item
	563	+Reference to external standard: xkos:ClassificationLevel - property: xkos:xdepth url: [[http:~~/~~/data.europa.eu/ux2/nace2.1/sections>>url:http://data.europa.eu/ux2/nace2.1/sections]]
	564	+
	565	+text en:sections
	566	+)))|(% style="width:203px" %)Code item|(% style="width:254px" %) |(% style="width:556.217px" %)(((
	567	+<hierarchical level>
	568	+
550	550	//Example~://
551		-(% style="background-color:transparent" %)CUST_BREAKDOWN:CUST_BREAKDOWN_LB
552		-)))|
553		-|REPLACE_CONTENT|(% style="width:524px" %)Replace the content in a component by the value of another component in an observation or series|(% style="width:198px" %)A Dataflow or DSD|(% style="width:237px" %) |(% style="width:465px" %)(((
554		-<component Id to replace content>:<component Id to use content>
	570	+
	571	+1
	572	+)))|(% style="width:460px" %)
	573	+|(% style="width:170px" %)SHORT_LABEL|(% style="width:451px" %)A short label, typically for dissemination purposes where long labels are sometimes not appropriate for presentation in tables where space is an important parameter (generally less than 40 or 50 characters)|(% style="width:203px" %)Artefact, or Concept, or Item in an Item Scheme|(% style="width:254px" %)(((
	574	+<language>:<content>, <language>:<content>,…
	575	+)))|(% style="width:556.217px" %)(((
555	555	//Example~://
556		-(% style="background-color:transparent" %)REF_AREA:M49_CODE
557		-)))|
558		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) |
559		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) |
560		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) |
561		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) |
562		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) |
563		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) |
564		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) |
565		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) |
566		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) |
567		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) |
568		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) |
569		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) |
570		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) |
571		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) |
572		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) |
573		-| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) |
574	574
	578	+[Official French label “Transformation et conservation de la viande de boucherie” is shortened to] fr:Transf. & conserv. viande de boucherie
575	575
	580	+In Codelist=IMF:CL_AREA(1.13)
	581	+Code 4J837 European Union Intellectual Property Office has a Short_Label
576	576
	583	+EN:EUIPO
	584	+)))|(% style="width:460px" %)
	585	+|(% style="width:170px" %)EXPLAN_LABEL|(% style="width:451px" %)An explanatory text that specifies “other” and similar categories. An example is the Combined Nomenclature classification where the many codes labelled “other” are complemented by a verbose text describing in detail the content of the code item|(% style="width:203px" %)Item in an Item Scheme, mapping to Representation Maps|(% style="width:254px" %)(((
	586	+<language>:<content>, <language>:<content>,…
	587	+)))|(% style="width:556.217px" %)(((
	588	+//Example~://
	589	+
	590	+[EU Combined Nomenclature official label for code 3824 99 57 reads “Other”, which is not very informative for the user; instead the EXPLAN_LABEL reads] en:Cartridges and refills, filled, for electronic cigarettes, and preparations for use in the cartridges and refills, not containing nicotine or its salts, ethers, esters or other derivatives thereof
	591	+)))|(% style="width:460px" %)
	592	+|(% style="width:170px" %)EXPLAN_CONSOL|(% style="width:451px" %)Explanatory notes. An explanatory text to be used when objects included in and excluded from a classification position are consolidated, i.e. are presented together. Reference to external standard: skos:scopeNote|(% style="width:203px" %)Item in an Item Scheme, mapping to Representation Maps|(% style="width:254px" %)(((
	593	+<language>:<content>,
	594	+
	595	+<language>:<content>,…
	596	+)))|(% style="width:556.217px" %)(((
	597	+Example (from the US NAICS classification):
	598	+
	599	+en:Industries in the Food Manufacturing subsector transform livestock and agricultural products into products for intermediate or final consumption. […] The food products manufactured in these establishments are typically sold to wholesalers or retailers for distribution to consumers, but establishments primarily engaged in retailing bakery and candy products made on the premises not for immediate consumption are included. Establishments primarily engaged in manufacturing beverages are classified in Subsector 312, Beverage and Tobacco Product Manufacturing.
	600	+)))|(% style="width:460px" %)
	601	+|(% style="width:170px" %)EXPLAN_INCLUDES|(% style="width:451px" %)Explanatory notes. Description of those things known specifically to be included in the concept. Synonyms Typical labels for such explanatory notes: "This class includes", "This category includes", "This position includes", "Includes", etc. Reference to external standard: xkos:inclusionNote or xkos:coreContentNote (if EXPLAN_INCLUDES_ALSO available)|(% style="width:203px" %)Item in an Item Scheme, mapping to Representation Maps|(% style="width:254px" %)(((
	602	+<language>:<content>,
	603	+
	604	+<language>:<content>,…
	605	+)))|(% style="width:556.217px" %)(((
	606	+Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):
	607	+
	608	+en: This class includes:
	609	+
	610	+* manufacture of heavy weapons (artillery, mobile guns, rocket launchers, torpedo tubes, heavy machine guns)
	611	+* manufacture of small arms (revolvers, shotguns, light machine guns)
	612	+* manufacture of air or gas guns and pistols
	613	+* manufacture of war ammunition
	614	+)))|(% style="width:460px" %)
	615	+|(% style="width:170px" %)EXPLAN_CASELAW|(% style="width:451px" %)Explanatory notes. Indication that a decision on the classification has been made by the ad hoc Committee (concept generally described as “ruling”, “classification opinion”, classification decision; caselaw). : Reference to external standardxkos:caseLaw. The difference between caselaws and traditional explanatory notes is that caselaws are adopted during the time period between two official versions of a specific classification and have thus a slightly different status (e.g. from a legal viewpoint)|(% style="width:203px" %)Item in an Item Scheme|(% style="width:254px" %)(((
	616	+<language>:<content>,
	617	+
	618	+<language>:<content>,…
	619	+
	620	+Example (from NACE Rev. 2 caselaw to code 01.62):
	621	+
	622	+en:Automated egg hatching for poultry - Operation of livestock management systems]
	623	+)))|(% style="width:556.217px" %) |(% style="width:460px" %)
	624	+|(% style="width:170px" %)EXPLAN_INCLUDES_ALSO|(% style="width:451px" %)Explanatory notes. Description of those things which can be considered as borderline cases and are generally based on consensus rather than strict methodological principles (e.g. classifying wooden shoes as handicraft rather than shoes). Typical labels for such explanatory notes: "This class includes also", "This category includes also", "This position includes also ", "Includes also", etc. Reference to external standard: xkos:additionalContentNote|(% style="width:203px" %)Item in an Item Scheme|(% style="width:254px" %)(((
	625	+<language>:<content>,
	626	+
	627	+<language>:<content>,…
	628	+)))|(% style="width:556.217px" %)(((
	629	+Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):
	630	+
	631	+en:This class also includes:
	632	+
	633	+* manufacture of hunting, sporting or protective firearms and ammunition
	634	+* manufacture of explosive devices such as bombs, mines and torpedoes
	635	+)))|(% style="width:460px" %)
	636	+|(% style="width:170px" %)EXPLAN_EXCLUDES|(% style="width:451px" %)Explanatory notes. Description of those things which are explicitly excluded from a category. Typical labels for such explanatory notes: "This class excludes", "This category excludes", "This position excludes", "Excludes", etc. Reference to external standards: xkos:exclusionNote|(% style="width:203px" %)(((
	637	+Item in an Item Scheme
	638	+
	639	+
	640	+)))|(% style="width:254px" %)(((
	641	+<language>:<content>,
	642	+
	643	+<language>:<content>,…
	644	+)))|(% style="width:556.217px" %)(((
	645	+Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):
	646	+
	647	+en:This class excludes:
	648	+
	649	+* manufacture of percussion caps, detonators or signalling flares, see 2029
	650	+* manufacture of cutlasses, swords, bayonets etc., see 2593
	651	+)))|(% style="width:460px" %)
	652	+|(% style="width:170px" %)MAP_REFER|(% style="width:451px" %)A reference to a classification mapping or transformation, e.g. an SDMX Structure Map. Reference to external standard: skos:mappingRelation (skos:broadMatch, skos:narrowMatch, skos:closeMatch, skos:exactMatch or skos:relatedMatch)|(% style="width:203px" %)Codelist, Concept Scheme, or another Item Scheme|(% style="width:254px" %) |(% style="width:556.217px" %)Id of an ItemSchemeMap returned by the Annotation URL|(% style="width:460px" %)(((
	653	+See section URL value defaults and specific locale values.
	654	+
	655	+
	656	+)))
	657	+|(% style="width:170px" %)COMP_RULE|(% style="width:451px" %)Code item composition rule. For example, for code A the composition rule may be “A1+A2” where A1 and A2 are other codes in the same Codelist|(% style="width:203px" %)An Item in an Item Scheme|(% style="width:254px" %) |(% style="width:556.217px" %)(((
	658	+<content>
	659	+
	660	+//Example~://
	661	+
	662	+A1+A2
	663	+)))|(% style="width:460px" %)
	664	+|(% style="width:170px" %)FOLLOWS|(% style="width:451px" %)(((
	665	+A reference used to express the succession in time of Item Schemes.
	666	+For example, NACE Rev. 2 is the successor of NACE Rev. 1.1
	667	+Reference to external standard: skos:ConceptScheme - property: xkos:follows
	668	+)))|(% style="width:203px" %)Codelist or Item Scheme|(% style="width:254px" %) |(% style="width:556.217px" %) |(% style="width:460px" %)(((
	669	+See section URL value defaults and specific locale values.
	670	+
	671	+//Example~://
	672	+
	673	+(CL_REGIONAL 3.1.1 follows CL_REGIONAL 3.1):
	674	+
	675	+[[https:~~/~~/registry.sdmx.org/ws/public/sdmxapi/rest/codelist/ESTAT/CL_REGIONAL/3.1>>url:https://registry.sdmx.org/ws/public/sdmxapi/rest/codelist/ESTAT/CL_REGIONAL/3.1]]
	676	+)))
	677	+|(% style="width:170px" %)HAS_VARIANT|(% style="width:451px" %)(((
	678	+A reference used to express the relation between an Item Scheme and its variant(s).
	679	+Reference to external standard: skos:ConceptScheme - property: xkos:variant
	680	+For //Example~:// CL_AREA has a variant CL_GEO
	681	+)))|(% style="width:203px" %)Codelist or Item Scheme|(% style="width:254px" %) |(% style="width:556.217px" %) |(% style="width:460px" %)(((
	682	+See section URL value defaults and specific locale values.
	683	+
	684	+
	685	+)))
	686	+|(% style="width:170px" %)SUPERSEED|(% style="width:451px" %)(((
	687	+A reference to a previous version, if the current version obsoleted the previous one.
	688	+May be used in conjunction with DEPRECATED.
	689	+Reference to external standard: skos:ConceptScheme - property: xkos:supersedes
	690	+)))|(% style="width:203px" %)Codelist or Item Scheme, or an artefact|(% style="width:254px" %) |(% style="width:556.217px" %) |(% style="width:460px" %)(((
	691	+See section URL value defaults and specific locale values.
	692	+
	693	+
	694	+)))
	695	+|(% style="width:170px" %)FAMILY_LABEL|(% style="width:451px" %)(((
	696	+Label of the Classification Family (e.g. NACE, ISIC)
	697	+
	698	+Reference to external standard:
	699	+skos:ConceptScheme - property: xkos:belongsTo
	700	+label of the classification
	701	+)))|(% style="width:203px" %)Codelist or Item Scheme|(% style="width:254px" %)(((
	702	+<language>:<content>,
	703	+
	704	+<language>:<content>,…
	705	+
	706	+//Example~://
	707	+
	708	+en:NACE
	709	+)))|(% style="width:556.217px" %) |(% style="width:460px" %)(((
	710	+See section URL value defaults and specific locale values.
	711	+
	712	+
	713	+)))
	714	+|(% style="width:170px" %)COVERAGE_LABEL|(% style="width:451px" %)(((
	715	+Label(s) of the item scheme’s coverage (e.g. National Accounts, Products, Activities, Occupations)
	716	+
	717	+Reference to external standard: skos:ConceptScheme - property: xkos:covers
	718	+
	719	+//Examples~://
	720	+
	721	+URL <http:~/~/eurovoc.europa.eu/56> (National accounts)
	722	+
	723	+URL <http:~/~/publications.europa.eu/resource/authority/data-theme/REGI> (Regions and Cities)
	724	+)))|(% style="width:203px" %)Codelist or Item Scheme|(% style="width:254px" %)(((
	725	+<language>:<content>,
	726	+
	727	+<language>:<content>,…
	728	+
	729	+//Example~://
	730	+
	731	+En:national accounts
	732	+)))|(% style="width:556.217px" %) |(% style="width:460px" %)(((
	733	+See section URL value defaults and specific locale values.
	734	+
	735	+
	736	+)))
	737	+|(% style="width:170px" %)GEO_FEATURE_SET|(% style="width:451px" %)(((
	738	+In Codelists, transmits GeoFeature values.
	739	+
	740	+Example for NUTS ID BE23
	741	+url:[[http:~~/~~/data.europa.eu/nuts/geometry/2xr1qiv9>>url:http://data.europa.eu/nuts/geometry/2xr1qiv9]]
	742	+)))|(% style="width:203px" %)Code in a Codelist. The Codelist must have an annotation attached with AnnotationType=GEO_TYPE_GEOGRAPHIC|(% style="width:254px" %) |(% style="width:556.217px" %)A set of points defining a feature following the 1363 ISO/IEC 13249-3:2016 standard to conform Well-known Text (WKT) for the 1364 representation of geometries. See SDMX STANDARDS: SECTION 6 for further information on the format.|(% style="width:460px" %)
	743	+|(% style="width:170px" %)GEO_TYPE_GEOGRAPHIC|(% style="width:451px" %)Indicates that a codelist contains GeoFeature values via the GEO_FEATURE_SET annotation.|(% style="width:203px" %)Codelist|(% style="width:254px" %) |(% style="width:556.217px" %) |(% style="width:460px" %)
	744	+|(% style="width:170px" %)LEGAL_BASIS|(% style="width:451px" %)(((
	745	+Indicates that the Legislation on which the codelist/nomenclature is based.
	746	+
	747	+Example for NACE Rev.2.1
	748	+
	749	+url: [[http:~~/~~/data.europa.eu/eli/reg_del/2023/137/oj>>url:http://data.europa.eu/eli/reg_del/2023/137/oj]]
	750	+)))|(% style="width:203px" %)Codelist|(% style="width:254px" %) |(% style="width:556.217px" %) |(% style="width:460px" %)http:~/~/data.europa.eu/eli/reg_del/2023/137/oj
	751	+
	752	+
	753	+
	754	+|Annotation Type|Use Case|Where to attach|(((
	755	++Text
	756	+(% style="background-color:transparent" %)Blue is optional
	757	+)))|(((
	758	+Title
	759	+(% style="background-color:transparent" %)Blue is optional
	760	+)))|(((
	761	+SDMX 2.1:URL
	762	+SDMX >=3.0:+URL
	763	+(% style="background-color:transparent" %)Blue is optional
	764	+)))
	765	+| | | | | |
	766	+| | | | | |
	767	+| | | | | |
	768	+| | | | | |
	769	+| | | | | |
	770	+| | | | | |
	771	+| | | | | |
	772	+| | | | | |
	773	+| | | | | |
	774	+| | | | | |
	775	+| | | | | |
	776	+| | | | | |
	777	+| | | | | |
	778	+| | | | | |
	779	+| | | | | |
	780	+| | | | | |
	781	+| | | | | |
	782	+| | | | | |
	783	+| | | | | |
	784	+
	785	+
	786	+
	787	+
	788	+|Annotation Type|Use Case|Where to attach|(% style="width:288px" %)(((
	789	++TextBlue is optional
	790	+)))|(% style="width:1427px" %)(((
	791	+TitleBlue is optional
	792	+)))|(((
	793	+SDMX 2.1:URLSDMX >=3.0:+URLBlue is optional
	794	+)))
577	577	|FULL_NAME|(% style="width:350px" %)Alternative name to be displayed for items in Item Schemes (e.g. Codelists, Concept Schemes, Category Schemes) whenever the item is displayed without its parent. For example, if a code list that has a hierarchy is displayed as a flat list, then this annotation may be used to provide sufficient context for the code. Concatenation of code + heading in NACE Rev.2.1
578	578	en: A0123 Growing of citrus fruits|Item in an Item Scheme|(% style="width:288px" %)(((
579	579	<language>:<content>,