Wiki source code of SDMX 2.1 Standards. Section. 5. Registry Specification – Logical Interfaces

Version 4.1 by Helena on 2025/05/21 15:51

version	line-number	content
1.1	1	{{box title="Contents"}}
	2	{{toc/}}
	3	{{/box}}
	4
	5	Revision History
	6
3.4	7	(% style="width:833.294px" %)
	8	\|(% style="width:122px" %)Revision\|(% style="width:126px" %)Date\|(% style="width:581px" %)Contents
	9	\|(% style="width:122px" %) \|(% style="width:126px" %)April 2011\|(% style="width:581px" %)Initial release
	10	\|(% style="width:122px" %)1.0\|(% style="width:126px" %)July 2011\|(% style="width:581px" %)Rectification of problems of the specifications dated April 2011
	11	\|(% style="width:122px" %)2.0\|(% style="width:126px" %)July 2020\|(% style="width:581px" %)Addition of VTL (Validation and Transformation Language) package, maintainable artefacts, nameable artefacts to 5.2.3, 6.2.2, 6.2.3, 6.2.4, 7.1.1
1.1	12
	13	Corrigendum
	14
	15	The following problems with the specification dated April 2011 have been rectified as described below.
	16
	17	1. Problem
	18
	19	Figure 17 - Logical Class Diagram of Registration of Data and Metadata – shows the Provision Agreement as it was identified in version 2.0, and not as it is identified in version 2.1.
	20
	21	Rectification
	22
	23	Provision Agreement is a Maintainable Artefact at version 2.1 and so the relationship is shown directly to the Provision Agreement class and not indirectly to the Provision Agreement via a ProvisionAgreementRef class.
	24
	25	~1. Problem
	26
	27	Figure 17 - Logical Class Diagram of Registration of Data and Metadata – shows the Registration class without the indexAttributes attribute.
	28
	29	Rectification
	30
	31	The attribute indexAttribute attribute is added to the Registration class and a description is of its purpose is given in the table at line 916.
	32
	33	2. Problem
	34
	35	Lines 437 and 648 of the April 2011 document mention that the fixed id for an AgencyScheme is AGENCY_SCHEME whereas it should be AGENCIES. Rectification
	36
	37	The reference to AGENCY_SCHEME is changed to AGENCIES.
	38
	39	Adoption of the Validation and Transformation Language in 2020
	40
	41	The SDMX specifications dated July 2011 envisaged the adoption of a language aimed at defining algorithms for the derivation of the data and presented a basic framework requiring however further elaboration for its actual use.
	42
	43	Following the adoption of the Validation and Transformation Language (VTL) version 2.0 and its application to SDMX 2.1, this section of the SDMX specifications has been integrated by introducing the VTL package, maintainable artefacts, nameable artefacts to the sections 5.2.3, 6.2.2, 6.2.3, 6.2.4 and 7.1.1.
	44
	45	= 1 Introduction =
	46
	47	The business vision for SDMX envisages the promotion of a “data sharing” model to facilitate low-cost, high-quality statistical data and metadata exchange. Data sharing reduces the reporting burden of organisations by allowing them to publish data once, and let their counterparties “pull” data and related metadata as required. The scenario is based on:
	48
	49	* the availability of an abstract information model capable of supporting timeseries and cross-sectional data, structural metadata, and reference metadata (SDMX-IM)
	50	* standardised XML schemas derived from the model (SDMX-ML)
	51	* the use of web-services technology (XML, XSD, WSDL, WADL)
	52
	53	Such an architecture needs to be well organised, and the SDMX Registry/Repository (SDMX-RR) is tasked with providing structure, organisation, and maintenance and query interfaces for most of the SDMX components required to support the datasharing vision.
	54
	55	However, it is important to emphasis that the SDMX-RR provides support for the submission and retrieval of all SDMX structural metadata and provisioning metadata. Therefore, the Registry not only supports the data sharing scenario, but this metadata is also vital in order to provide support for data and metadata reporting/collection, and dissemination scenarios.
	56
	57	Standard formats for the exchange of aggregated statistical data and metadata as prescribed in SDMX v2.1 are envisaged to bring benefits to the statistical community because data reporting and dissemination processes can be made more efficient.
	58
	59	As organisations migrate to SDMX enabled systems, many XML (and conventional) artefacts will be produced (e.g. Data Structure, Metadata Structure, Code List and Concept definitions (often collectively called structural metadata), XML schemas generated from data and metadata structure definitions, XSLT style-sheets for transformation and display of data and metadata, terminology references, etc.). The SDMX model supports interoperability, and it is important to be able to discover and share these artefacts between parties in a controlled and organized way.
	60
	61	This is the role of the registry.
	62
	63	With the fundamental SDMX standards in place, a set of architectural standards are needed to address some of the processes involved in statistical data and metadata exchange, with an emphasis on maintenance, retrieval and sharing of the structural metadata. In addition, the architectural standards support the registration and discovery of data and referential metadata.
	64
	65	These architectural standards address the ‘how’ rather than the ‘what’, and are aimed at enabling existing SDMX standards to achieve their mission. The architectural standards address registry services which initially comprise:
	66
	67	* structural metadata repository
	68	* data and metadata registration
	69	* query
	70
	71	The registry services outlined in this specification are designed to help the SDMX community manage the proliferation of SDMX assets and to support data sharing for reporting and dissemination.
	72
	73	= 2 Scope and Normative Status =
	74
	75	The scope of this document is to specify the logical interfaces for the SDMX registry in terms of the functions required and the data that may be present in the function call, and the behaviour expected of the registry.
	76
	77	In this document, functions and behaviours of the Registry Interfaces are described in four ways:
	78
	79	* in text
	80	* with tables
	81	* with UML diagrams excerpted from the SDMX Information Model (SDMX-IM)
	82	* with UML diagrams that are not a part of the SDMX-IM but are included here for clarity and to aid implementations (these diagram are clearly marked as “Logical Class Diagram ...”)
	83
	84	Whilst the introductory section contains some information on the role of the registry, it is assumed that the reader is familiar with the uses of a registry in providing shared metadata across a community of counterparties.
	85
	86	Note that sections 5 and 6 contain normative rules regarding the Registry Interface and the identification of registry objects. Further, the minimum standard for access to the registry is via a REST interface (HTTP or HTTPS), as described in the appropriate sections. The notification mechanism must support e-mail and HTTP/HTTPS protocols as described. Normative registry interfaces are specified in the SDMX-ML specification (Part 03 of the SDMX Standard). All other sections of this document are informative.
	87
	88	Note that although the term “authorised user” is used in this document, the SDMX standards do not define an access control mechanism. Such a mechanism, if required, must be chosen and implemented by the registry software provider.
	89
	90	= 3 Scope of the SDMX Registry/Repository =
	91
	92	== 3.1 Objective ==
	93
	94	The objective of the SDMX registry/repository is, in broad terms, to allow organisations to publish statistical data and reference metadata in known formats such that interested third parties can discover these data and interpret them accurately and correctly. The mechanism for doing this is twofold:
	95
	96	1. To maintain and publish structural metadata that describes the structure and valid content of data and reference metadata sources such as databases, metadata repositories, data sets, metadata sets. This structural metadata enables software applications to understand and to interpret the data and reference metadata in these sources.
	97	1. To enable applications, organisations, and individuals to share and to discover data and reference metadata. This facilitates data and reference metadata dissemination by implementing the data sharing vision of SDMX.
	98
	99	== 3.2 Structural Metadata ==
	100
	101	Setting up structural metadata and the exchange context (referred to as “data provisioning”) involves the following steps for maintenance agencies:
	102
	103	* agreeing and creating a specification of the structure of the data (called a Data Structure Definition or DSD in this document but also known as “key family”) which defines the dimensions, measures and attributes of a dataset and their valid value set
	104	* if required, defining a subset or view of a DSD which allows some restriction of content called a “dataflow definition”
	105	* agreeing and creating a specification of the structure of reference metadata (Metadata Structure Definition) which defines the attributes and presentational arrangement of a Metadataset and their valid values and content
	106	* if required, defining a subset or view of a MSD which allows some restriction of content called a “metadataflow definition”
	107	* defining which subject matter domains (specified as a Category Scheme) are related to the Dataflow and Metadataflow Definitions to enable browsing
	108	* defining one or more lists of Data Providers (which includes metadata providers)
	109	* defining which Data Providers have agreed to publish a given Dataflow and/or Metadataflow Definition - this is called a Provision Agreement
	110
	111	[[image:1747824122996-812.jpeg]]
	112
	113	Figure 1: Schematic of the Basic Structural Artifacts in the SDMX-IM
	114
	115	== 3.3 Registration ==
	116
	117	Publishing the data and reference metadata involves the following steps for a Data Provider:
	118
	119	* making the reference metadata and data available in SDMX-ML conformant data files or databases (which respond to an SDMX-ML query with SDMX-ML data). The data and reference metadata files or databases must be webaccessible, and must conform to an agreed Dataflow or Metadataflow Definition (Data Structure Definition or Metadata Structure Definition subset)
	120	* registering the existence of published reference metadata and data files or databases with one or more SDMX registries
	121
	122	[[image:1747824123003-199.jpeg]]
	123
	124	Figure 2: Schematic of Registered Data and Metadata Sources in the SDMX-IM
	125
	126	== 3.4 Notification ==
	127
	128	Notifying interested parties of newly published or re-published data, reference metadata or changes in structural metadata involves:
	129
	130	* registry support of a subscription-based notification service which sends an email or notifies an HTTP address announcing all published data that meets the criteria contained in the subscription request
	131
	132	== 3.5 Discovery ==
	133
	134	Discovering published data and reference metadata involves interaction with the registry to fulfil the following logical steps that would be carried out by a user interacting with a service that itself interacts with the registry and an SDMX-enabled data or reference metadata resource:
	135
	136	* optionally browsing a subject matter domain category scheme to find Dataflow Definitions (and hence Data Structure Definitions) and Metadataflows which structure the type of data and/or reference metadata being sought
	137	* build a query, in terms of the selected Data Structure Definition or Metadata Structure Definition, which specifies what data are required and submitting this to a service that can query an SDMX registry which will return a list of (URLs of) data and reference metadata files and databases which satisfy the query
	138	* processing the query result set and retrieving data and/or reference metadata from the supplied URLs
	139
	140	[[image:1747824123006-476.jpeg]]
	141
	142	Figure 3: Schematic of Data and Metadata Discovery and Query in the SDMX-IM
	143
	144	= 4 SDMX Registry/Repository Architecture =
	145
	146	== 4.1 Architectural Schematic ==
	147
	148	The architecture of the SDMX registry/repository is derived from the objectives stated above. It is a layered architecture that is founded by a structural metadata repository which supports a provisioning metadata repository which supports the registry services. These are all supported by the SDMX-ML schemas. Applications can be built on top of these services which support the reporting, storage, retrieval, and dissemination aspects of the statistical lifecycle as well as the maintenance of the structural metadata required to drive these applications.
	149
	150	[[image:1747824123008-995.jpeg]]
	151
	152	Figure 4: Schematic of the Registry Content and Services
	153
	154	== 4.2 Structural Metadata Repository ==
	155
	156	The basic layer is that of a structural metadata service which supports the lifecycle of SDMX structural metadata artefacts such as Maintenance Agencies, Data Structure Definitions, Metadata Structure Definitions, Provision Agreements, Processes etc. This layer is supported by the Structure Submission and Query Service.
	157
	158	Note that the SDMX-ML Submit Structure Request message supports all of the SDMX structural artefacts. The only structural artefacts that are not supported by the SDMX-ML Submit Structure Request are::
	159
	160	* Registration of data and metadata sources
	161	* Subscription and Notification
	162
	163	Separate registry-based messages are defined to support these artefacts.
	164
	165	== 4.3 Provisioning Metadata Repository ==
	166
	167	The function of this repository is to support the definition of the structural metadata that describes the various types of data-store which model SDMX-conformant databases or files, and to link to these data sources. These links can be specified for a data provider, for a specific data or metadata flow. In the SDMX model this is called the Provision Agreement.
	168
	169	This layer is supported by the Data and Metadata Registration Service.
	170
	171	= 5 Registry Interfaces and Services =
	172
	173	== 5.1 Registry Interfaces ==
	174
	175	The Registry Interfaces are:
	176
	177	* Notify Registry Event
	178	* Submit Subscription Request
	179	* Submit Subscription Response
	180	* Submit Registration Request
	181	* Submit Registration Response
	182	* Query Registration Request
	183	* Query Registration Response
	184	* Query Subscription Request
	185	* Query Subscription Response
	186	* Submit Structure Request
	187	* Submit Structure Response
	188
	189	The registry interfaces are invoked in one of two ways:
	190
	191	1. The interface is the name of the root node of the SDMX-ML document
	192	1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the SDMX-ML document.
	193
	194	In addition to these interfaces the registry must support a mechanism for querying for structural metadata. This is detailed in 5.2.2.
	195
1.2	196	All these interactions with the Registry – with the exception of Notify Registry Event – are designed in pairs. The first document – the one which invokes the SDMX-RR interface, is a “Request” document. The message returned by the interface is a “Response” document.
1.1	197
	198	It should be noted that all interactions are assumed to be synchronous, with the exception of Notify Registry Event. This document is sent by the SDMX-RR to all subscribers whenever an even occurs to which any users have subscribed. Thus, it does not conform to the request-response pattern, because it is inherently asynchronous.
	199
	200	== 5.2 Registry Services ==
	201
	202	=== 5.2.1 Introduction ===
	203
	204	The services described in this section do not imply that each is implemented as a discrete web service.
	205
	206	=== 5.2.2 Structure Submission and Query Service ===
	207
	208	This service must implement the following SDMX-ML Interfaces:
	209
	210	* SubmitStructureRequest
	211	* SubmitStructureResponse
	212
	213	These interfaces allow structural definitions to be created, modified, and removed in a controlled fashion. It also allows the structural metadata artefacts to be queried and retrieved either in part or as a whole. In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact (see next section on the SDMX Information Model).
	214
	215	=== 5.2.3 Structure Query Service ===
	216
	217	The registry must support a mechanism for querying for structural metadata. This mechanism can be one or both of the SDMX-ML Query message and the SDMX REST interface for structural metadata (this is defined in Part 7 of the SDMX standards). The registry response to both of these query mechanisms is the SDMX Structure message which has as its root node
	218
	219	* Structure
	220
	221	The SDMX structural artefacts that may be queried are:
	222
	223	* dataflows and metadataflows
	224	* data structure definitions and metadata structure definitions
	225	* codelists
	226	* concept schemes
	227	* reporting taxonomies
	228	* provision agreements
	229	* structure sets
	230	* processes
	231	* hierarchical code lists
	232	* constraints
	233	* category schemes
	234	* categorisations and categorised objects (examples are categorised dataflows and metadatflows, data structure definitions, metadata structure definitions, provision agreements registered data sources and metadata sources)
	235	* organisation schemes (agency scheme, data provider scheme, data consumer scheme, organisation unit scheme)
	236
	237	Due to the VTL implementation the other structural artefact that may be queried are:
	238
	239	* transformation schemes
	240	* custom type schemes
	241	* name personalisation schemes
	242	* vtl mapping schemes
	243	* ruleset schemes
	244	* user defined operator schemes
	245
	246	The SDMX query messages that are a part of the SDMX-ML Query message are:
	247
	248	* StructuresQuery
	249	* DataflowQuery
	250	* MetadataflowQuery
	251	* DataStructureQuery
	252	* MetadataStructureQuery
	253	* CategorySchemeQuery
	254	* ConceptScheneQuery
	255	* CodelistQuery
	256	* HierarchicalCodelistQuery
	257	* OrganisationSchemeQuery
	258	* ReportingTaxonomyQuery
	259	* StructureSetQuery
	260	* ProcessQuery
	261	* CategorisationQuery
	262	* ProvisionAgreementQuery
	263	* ConstraintQuery
	264
	265	Due to the VTL implementation the other query messages that became a part of the SDMX-ML Query message are:
	266
	267	* TransformationSchemeQuery
	268	* CustomTypeSchemeQuery
	269	* VtlMappingSchemeQuery
	270	* NamePersonalisationSchemeQuery
	271	* RulesetSchemeQuery
	272	* UserDefinedOperatorSchemeQuery
	273
	274	=== 5.2.4 Data and Reference Metadata Registration Service ===
	275
	276	This service must implement the following SDMX-ML Interfaces:
	277
	278	* SubmitRegistrationRequest
	279	* SubmitRegistrationResponse
	280	* QueryRegistrationRequest
	281	* QueryRegistrationResponse
	282
	283	The Data and Metadata Registration Service allows SDMX conformant XML files and web-accessible databases containing published data and reference metadata to be registered in the SDMX Registry. The registration process MAY validate the content of the data-sets or metadata-sets, and MAY extract a concise representation of the contents in terms of concept values (e.g. values of the data attribute, dimension, metadata attribute), or entire keys, and storing this as a record in the registry to enable discovery of the original data-set or metadata-set. These are called Constraints in the SDMX-IM.
	284
	285	The Data and Metadata Registration Service MAY validate the following, subject to the access control mechanism implemented in the Registry:
	286
	287	* that the data provider is allowed to register the data-set or metadata-set
	288	* that the content of the data set or metadata set meets the validation constraints. This is dependent upon such constraints being defined in the structural repository and which reference the relevant Dataflow, Metadataflow, Data Provider, Data Structure Definition, Metadata Structure Definition, Provision Agreement
	289	* that a queryable data source exists - this would necessitate the registration service querying the service to determine its existence
	290	* that a simple data source exists (i.e. a file accessible at a URL)
	291	* that the correct Data Structure Definition or Metadata Structure Definition is used by the registered data that the components (Dimensions, Attributes, Measures, Identifier Components etc.) are consistent with the Data Structure Definition or Metadata Structure Definition
3.3	292	* that the valid representations of the concepts to which these components correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition
1.1	293
3.6	294	The Registration has an action attribute which takes one of the following values:
1.1	295
3.6	296	\|(% style="width:219px" %)Action Attribute Value\|(% style="width:1652px" %)Behaviour
	297	\|(% style="width:219px" %)Append\|(% style="width:1652px" %)Add this registration to the registry
	298	\|(% style="width:219px" %)Replace\|(% style="width:1652px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
	299	\|(% style="width:219px" %)Delete\|(% style="width:1652px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
	300
1.1	301	The Registration has three Boolean attributes which may be present to determine how an SDMX compliant Dataset or Metadata Set indexing application must index the Datasets or Metadata Set upon registration. The indexing application behaviour is as follows:
3.6	302
	303	\|(% style="width:228px" %)Boolean Attribute\|(% style="width:1644px" %)Behaviour if Value is “true”
	304	\|(% style="width:228px" %)indexTimeSeries\|(% style="width:1644px" %)A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadata Set registration)
	305	\|(% style="width:228px" %)indexDataSet\|(% style="width:1644px" %)A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset (for a Dataset registration) or the range of actual (present) values for each Metadata Attribute which takes an enumerated value.
1.1	306	Note that for data this requires much less storage than full key indexing, but this method cannot guarantee that a specific combination of Dimension values (the Key) is actually present in the Dataset
3.6	307	\|(% style="width:228px" %)indexReportingPeriod\|(% style="width:1644px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set
1.1	308
	309	=== 5.2.5 Data and Reference Metadata Discovery ===
	310
	311	The Data and Metadata Discovery Service implements the following Registry Interfaces:
	312
1.3	313	* QueryRegistrationRequest
	314	* QueryRegistrationResponse
1.1	315
	316	=== 5.2.6 Subscription and Notification ===
	317
	318	The Subscription and Notification Service implements the following Registry Interfaces:
	319
	320	* SubmitSubscriptionRequest
	321	* SubmitSubscriptionResponse
	322	* NotifyRegistryEvent
	323
	324	The data sharing paradigm relies upon the consumers of data and metadata being able to pull information from data providers’ dissemination systems. For this to work efficiently, a data consumer needs to know when to pull data, i.e. when something has changed in the registry (e.g. a dataset has been updated and re-registered). Additionally, SDMX systems may also want to know if a new Data Structure Definition, Code List or Metadata Structure Definition has been added. The Subscription and Notification Service comprises two parts: subscription management, and notification.
	325
	326	Subscription management involves a user submitting a subscription request which contains:
	327
	328	* a query or constraint expression in terms of a filter which defines the events for which the user is interested (e.g. new data for a specific dataflow, or for a domain category, or changes to a Data Structure Definition).
	329	* a list of URIs or end-points to which an XML notification message can be sent. Supported end-point types will be email (mailto~:) and HTTP POST (a normal http:~/~/ address)
	330	* request for a list of submitted subscriptions
	331	* deletion of a subscription
	332
	333	Notification requires that the structural metadata repository and the provisioning metadata repository monitor any event which is of interest to a user (the object of a subscription request query), and to issue an SDMX-ML notification document to the end-points specified in the relevant subscriptions.
	334
	335	=== 5.2.7 Registry Behaviour ===
	336
	337	The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages.
	338
3.3	339	\|(% style="width:227px" %)Interface\|(% style="width:1644px" %)Behaviour
	340	\|(% style="width:227px" %)All\|(% style="width:1644px" %)(((
1.1	341	1) If the action is set to “replace” then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted, unless the final attribute is set to “true” in which case the only changes that are allowed are to the following constructs:
	342
	343	* Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list.
	344	* Description - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
	345	* Annotation - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
	346	* validTo
	347	* validFrom
	348	* structureURL
	349	* serviceURL
	350	* uri
	351	* isExternalReference
	352
1.4	353	2) Cross referenced structures MUST exist in either the submitted document (in Structures or Structure Location) or in the registry to which the request is submitted.
	354	3) If the action is set to “delete” then the Registry MUST verify that the object can deleted. In order to qualify for deletion the object must:
1.1	355
1.4	356	а) Not have the final attribute set to “true”
	357	b) Not be referenced from any other object in the Registry.
1.1	358
1.4	359	4) The version rules in the SDMX Schema documentation MUST be obeyed.
	360	5) The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed.
1.1	361	)))
3.3	362	\|(% style="width:227px" %)SubmitStructureRequest\|(% style="width:1644px" %)Structures are submitted at the level of the Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact.
	363	\|(% style="width:227px" %)SubmitProvisioningRequest\|(% style="width:1644px" %)No additional behaviour.
	364	\|(% style="width:227px" %)Submit Registration Request\|(% style="width:1644px" %)(((
1.1	365	If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean attributes set in the Registration.
	366	For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query.
	367	)))
	368
	369	= 6 Identification of SDMX Objects =
	370
	371	== 6.1 Identification, Versioning, and Maintenance ==
	372
	373	All major classes of the SDMX Information model inherit from one of:
	374
	375	* IdentifiableArtefact - this gives an object the ability to be uniquely identified (see following section on identification), to have a user-defined URI, and to have multi-lingual annotations.
	376	* NamableArtefact - this has all of the features of IdentifiableArtefact plus the ability to have a multi-lingual name and description,
	377	* VersionableArtefact – this has all of the above features plus a version number and a validity period.
	378	* MaintainableArtefact – this has all of the above features, and indication as to whether the object is “final” and cannot be changed or deleted, registry and structure URIs, plus an association to the maintenance agency of the object.
	379
	380	=== 6.1.1 Identification, Naming, Versioning, and Maintenance Model ===
	381
1.6	382	[[image:1747824504225-229.png]]
	383
1.1	384	Figure 5: Class diagram of fundamental artefacts in the SDMX-IM
	385
	386	The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
	387
	388	* Annotable
	389	* Identifiable
	390	* Nameable
	391	* Versionable
	392	* Maintainable
	393
1.6	394	(% style="width:935.294px" %)
	395	\|Object Type\|(% style="width:244px" %)Data Attributes\|(% style="width:99px" %)Status\|Data type\|(% style="width:389px" %)Notes
	396	\|Annotable\|(% style="width:244px" %)AnnotationTitle\|(% style="width:99px" %)C\|string\|(% style="width:389px" %)
	397	\| \|(% style="width:244px" %)AnnotationType\|(% style="width:99px" %)C\|string\|(% style="width:389px" %)
	398	\| \|(% style="width:244px" %)AnnotationURN\|(% style="width:99px" %)C\|string\|(% style="width:389px" %)
	399	\| \|(% style="width:244px" %)(((
	400	AnnotationText in the form of International String
	401	)))\|(% style="width:99px" %)C\| \|(% style="width:389px" %)This can have languagespecific variants.
	402	\|Identifiable\|(% style="width:244px" %)all content as for Annotable plus\|(% style="width:99px" %) \| \|(% style="width:389px" %)
	403	\| \|(% style="width:244px" %)id\|(% style="width:99px" %)M\|string\|(% style="width:389px" %)
	404	\| \|(% style="width:244px" %)uri\|(% style="width:99px" %)C\|string\|(% style="width:389px" %)
	405	\| \|(% style="width:244px" %)urn\|(% style="width:99px" %)C\|string\|(% style="width:389px" %)Although the urn is computable and therefore may not be submitted or stored physically, the Registry must return the urn for each object, and must be able to service a query on an object referenced solely by its urn.
	406	\|Nameable\|(% style="width:244px" %)all content as for Identifiable plus\|(% style="width:99px" %) \| \|(% style="width:389px" %)
	407	\| \|(% style="width:244px" %)Name in the form of International String\|(% style="width:99px" %)M\|string\|(% style="width:389px" %)This can have languagespecific variants.
	408	\| \|(% style="width:244px" %)(((
	409	Description in the form of International String
	410	)))\|(% style="width:99px" %)C\|string\|(% style="width:389px" %)This can have languagespecific variants.
	411	\|Versionable\|(% style="width:244px" %)All content as for Identifiable plus\|(% style="width:99px" %) \| \|(% style="width:389px" %)
	412	\| \|(% style="width:244px" %)version\|(% style="width:99px" %)C\|string\|(% style="width:389px" %)This is the version number. If not present the default is 1.0
	413	\| \|(% style="width:244px" %)validFrom\|(% style="width:99px" %)C\|Date/time\|(% style="width:389px" %)
	414	\| \|(% style="width:244px" %)validTo\|(% style="width:99px" %)C\|Date/time\|(% style="width:389px" %)
	415	\|Maintainable\|(% style="width:244px" %)All content as for Versionable plus\|(% style="width:99px" %) \| \|(% style="width:389px" %)
	416	\| \|(% style="width:244px" %)final\|(% style="width:99px" %) \|boolean\|(% style="width:389px" %)Value of “true” indicates that this is a final specification and it cannot be changed except as a new version. Note that providing a “final’ object is not referenced from another object then it may be deleted.
	417	\| \|(% style="width:244px" %)isExternalReference\|(% style="width:99px" %)C\|boolean\|(% style="width:389px" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURI, each of which must return a valid SDMX-ML file.
	418	\| \|(% style="width:244px" %)serviceURL\|(% style="width:99px" %)C\|string\|(% style="width:389px" %)The url of the service that can be queried for this resource
	419	\| \|(% style="width:244px" %)structureURL\|(% style="width:99px" %)C\|string\|(% style="width:389px" %)The url of the resource.
	420	\| \|(% style="width:244px" %)(Maintenance) agencyId\|(% style="width:99px" %)M\|string\|(% style="width:389px" %)The object must be linked to a maintenance agency.
1.1	421
	422	Table 1: Common Attributes of Object Types
	423
	424	== 6.2 Unique identification of SDMX objects ==
	425
	426	=== 6.2.1 Agencies ===
	427
	428	The Maintenance Agency in SDMX is maintained in an Agency Scheme which itself is a sub class of Organisation Scheme – this is shown in the class diagram below.
	429
	430	Figure 6: Agency Scheme Model
	431
	432	The Agency in SDMX is extremely important. The Agency Id system used in SDMX is an n-level structure. The top level of this structure is maintained by SDMX. Any Agency in this top level can declare sub agencies and any sub agency can also declare sub agencies. The Agency Scheme has a fixed id and version and is never declared explicitly in the SDMX object identification mechanism.
	433
	434	In order to achieve this SDMX adopts the following rules:
	435
	436	1. Agencies are maintained in an Agency Scheme (which is a sub class of Organisation Scheme)
	437	1. The agency of the Agency Scheme must also be declared in a (different) Agency Scheme.
	438	1. The “top-level” agency is SDMX and maintains the “top-level” Agency Scheme.
	439	1. Agencies registered in the top-level scheme can themselves maintain a single Agency Scheme. Agencies in these second-tier schemes can themselves maintain a single Agency Scheme and so on.
	440	1. The AgencyScheme cannot be versioned and so take a default version number of 1.0 and cannot be made “final”.
	441	1. There can be only one AgencyScheme maintained by any one Agency. It has a fixed Id of AGENCIES.
	442	1. The /hierarchy of Organisation is not inherited by Maintenance Agency – thus each Agency Scheme is a flat list of Maintenance Agencies.
	443	1. The format of the agency identifier is agencyID.agencyID etc. The toplevel agency in this identification mechanism is the agency registered in the SDMX agency scheme. In other words, SDMX is not a part of the hierarchical ID structure for agencies. However SDMX is, itself, a maintenance agency and is contained in the top-level Agency Scheme.
	444
	445	This supports a hierarchical structure of agencyID.
	446
	447	An example is shown below.
	448
	449	[[image:1747824123012-527.jpeg]]
	450
3.6	451	*
	452	** Figure 7: Example of Hierarchic Structure of Agencies
1.1	453
	454	The following organizations maintain an Agency Scheme.
	455
	456	* SDMX – contains Agencies AA, BB
	457	* AA – contains Agencies CC, DD
	458	* BB – contains Agencies CC, DD
	459	* DD – Contains Agency EE
	460
	461	Each agency is identified by its full hierarchy excluding SDMX.
	462
	463	e.g. the id of EE as an agencyID is AA.DD.EE
	464
	465	An example of this is shown in the XML snippet below.
	466
2.1	467	[[image:1747824123013-196.jpeg\|\|height="309" width="446"]]
1.1	468
2.1	469	Figure 8: Example Showing Use of Agency Identifiers
1.1	470
	471	Each of these maintenance agencies has an identical Code list with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure.
	472
	473	=== 6.2.2 Universal Resource Name (URN) ===
	474
	475	==== 6.2.2.1 Introduction ====
	476
	477	To provide interoperability between SDMX Registry/Repositories in a distributed network environment, it is important to have a scheme for uniquely identifying (and thus accessing) all first-class (Identifiable) SDMX-IM objects. Most of these unique identifiers are composite (containing maintenance agency, or parent object identifiers), and there is a need to be able to construct a unique reference as a single string. This is achieved by having a globally unique identifier called a universal resource name (URN) which is generated from the actual identification components in the SDMX-RR APIs. In other words, the URN for any Identifiable Artefact is constructed from its component identifiers (agency, Id, version etc.).
	478
	479	==== 6.2.2.2 URN Structure ====
	480
	481	===== //Case Rules for URN// =====
	482
	483	For the URN, all parts of the string are case sensitive. The Id of any object must be UPPER CASE. Therefore, CRED_ext_Debt is invalid and it should be CRED_EXT_DEBT.
	484
	485	The generic structure of the URN is as follows:
	486
3.3	487	>SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
1.1	488
	489	~* this can repeat and may not be present (see explanation below)
	490
	491	Note that in the SDMX Information Model there are no concrete Versionable Artefacts that are not a Maintainable Artefact. For this reason the only version information that is allowed is for the maintainable object.
	492
	493	The Maintenance agency identifier is separated from the maintainable artefact identifier by a colon ‘:’. All other identifiers in the SDMX URN syntax are separated by a period(.).
	494
	495	==== 6.2.2.3 Explanation of the generic structure ====
	496
	497	In the explanation below the actual object that is the target of the URN is called the //actual object//.
	498
3.2	499	SDMXPrefix: urn:sdmx:org.
1.1	500
	501	SDMX-IM package name: sdmx.infomodel.package=
	502
	503	[[image:1747824123016-678.png]]
	504
	505	maintainable-object-id is the identifier of the maintainable object. This will always be present as all identifiable objects are either a maintainable object or contained in a maintainable object.
	506
	507	(maintainable-object-version) is the version of the maintainable object and is enclosed in round brackets (). It will always be present.
	508
2.2	509	container-object-id is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a Code is in a maintained object (Code List) and has no intermediary container object, whereas a Metadata Attribute has an intermediary container object (Report Structure) and may have an intermediary container object which is its parent Metadata Attribute. For this reason the container object id may repeat, with each repetition identifying the object at the next-lower level in its hierarchy. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to Attribute Descriptor, Dimension Descriptor, and Measure Descriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a URN, the id of the Attribute Descriptor, Dimension Descriptor, and Measure Descriptor is not included when the actual object is a Data Attribute or a Dimension/Measure Dimension/ Time Dimension, or a Measure.
1.1	510
	511	Note that although a Code can have a parent Code and a Concept can have a parent Concept these are maintained in a flat structure and therefore do not have a container-object-id.
	512
	513	For example the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId.
	514
	515	object-id is the identifier of the actual object unless the actual object is a maintainable object. If present it is always the last id and is not followed by any other character.
	516
2.2	517	===== __//Generic Examples of the URN Structure//__ =====
1.1	518
2.2	519	__Actual object is a maintainable__
1.1	520
2.5	521	> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version)
1.1	522
2.2	523	__Actual object is contained in a maintained object with no intermediate containing object__
1.1	524
2.5	525	> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).object-id
1.1	526
2.2	527	__Actual object is contained in a maintained object with an intermediate containing object__
1.1	528
2.5	529	> SDMXPrefix.SDMX-IM package name.classname=agency
1.1	530
	531	id:maintained-object-id(version).contained-object-id.object-id
	532
2.2	533	__Actual object is contained in a maintained object with no intermediate containing object but the object type itself is hierarchical__
1.1	534
	535	In this case the object id may not be unique in itself but only within the context of the hierarchy. In the general syntax of the URN all intermediary objects in the structure (with the exception, of course, of the maintained object) are shown as a contained object. An example here would be a Category in a Category Scheme. The Category is hierarchical and all intermediate Categories are shown as a contained object. The example below shows the generic structure for Category Scheme/Category/Category
	536
2.5	537	> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id.object-id
1.1	538
2.3	539	__Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical__
1.1	540
	541	In this case the generic syntax is the same as for the example above as the parent object is regarded as a containing object, even if it is of the same type. An example here is a Metadata Attribute where the contained objects are Report Structure (first contained object id) and Metadata Attribute (subsequent contained object Ids). The example below shows the generic structure for MSD/Report Structure/Metadata Attribute/Metadata Attribute
	542
2.5	543	> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id. contained-object-id contained-object-id.object-id
1.1	544
2.4	545	===== __//Concrete Examples of the URN Structure//__ =====
1.1	546
	547	The Data Structure Definition CRED_EXT_DEBT version 1.0 maintained by the top level Agency TFFS would have the URN:
	548
2.5	549	> urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(1.0)
1.1	550
	551	The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 version 1.0 would be:
	552
2.5	553	> urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0).AR
1.1	554
	555	The URN for a category (id of 1) which has parent category (id of 2) maintained by SDMX in the category scheme SUBJECT_MATTER_DOMAINS version 1.0 would be:
	556
2.5	557	> urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJE CT_MATTER_DOMAINS(1.0).1.2
1.1	558
	559	The URN for a Metadata Attribute maintained by SDMX in the MSD CONTACT_METADATA version 1.0 in the Report Structure CONTACT_REPORT where the hierarchy of the Metadata Attribute is
	560
	561	CONTACT_DETAILS/CONTACT_NAME would be:
	562
2.5	563	> urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribut e=SDMX:CONTACT_METADATA(1.0).CONTACT_REPORT.CONTACT_DETAILS.CO NTACT_NAME
1.1	564
	565	The TFFS defines ABC as a sub Agency of TFFS then the URN of a Dataflow maintained by ABC and identified as EXTERNAL_DEBT version 1.0 would be:
	566
2.5	567	> urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EX
1.1	568
	569	TERNAL_DEBT(1.0)
	570
	571	The SDMX-RR MUST support this globally unique identification scheme. The SDMXRR MUST be able to create the URN from the individual identification attributes submitted and to transform the URN to these identification attributes. The identification attributes are:
	572
	573	* Identifiable and Nameable Artefacts: id (in some cases this id may be hierarchic)
	574	* Maintainable Artefacts: id, version, agencyId,
	575
	576	The SDMX-RR MUST be able to resolve the unique identifier of an SDMX artefact and to produce an SDMX-ML rendering of that artefact if it is located in the Registry.
	577
	578	=== 6.2.3 Table of SDMX-IM Packages and Classes ===
	579
	580	The table below lists all of the packages in the SDMX-IM together with the concrete classes that are in these packages and whose objects have a URN.
	581
2.6	582	\|(% style="width:127px" %)Package\|(% style="width:1745px" %)(((
	583	URN Classname (model classname where this is different)
1.1	584	)))
2.6	585	\|(% style="width:127px" %)base\|(% style="width:45px" %)Agency
	586	\|(% style="width:127px" %) \|(% style="width:45px" %)OrganisationUnitScheme
	587	\|(% style="width:127px" %) \|(% style="width:45px" %)AgencyScheme
	588	\|(% style="width:127px" %) \|(% style="width:45px" %)DataProviderScheme
	589	\|(% style="width:127px" %) \|(% style="width:45px" %)DataConsumerScheme
	590	\|(% style="width:127px" %) \|(% style="width:45px" %)OrganisationUnit
	591	\|(% style="width:127px" %) \|(% style="width:45px" %)DataProvider
	592	\|(% style="width:127px" %) \|(% style="width:45px" %)DataConsumer
	593	\|(% style="width:127px" %)datastructure\|(% style="width:45px" %)DataStructure (DataStructureDefinition)
	594	\|(% style="width:127px" %) \|(% style="width:45px" %)AttributeDescriptor
	595	\|(% style="width:127px" %) \|(% style="width:45px" %)DataAttribute
	596	\|(% style="width:127px" %) \|(% style="width:45px" %)GroupDimensionDescriptor
	597	\|(% style="width:127px" %) \|(% style="width:45px" %)DimensionDescriptor
	598	\|(% style="width:127px" %) \|(% style="width:45px" %)Dimension
	599	\|(% style="width:127px" %) \|(% style="width:45px" %)MeasureDimension
	600	\|(% style="width:127px" %) \|(% style="width:45px" %)TimeDimension
	601	\|(% style="width:127px" %) \|(% style="width:45px" %)MeasureDescriptor
	602	\|(% style="width:127px" %) \|(% style="width:45px" %)PrimaryMeasure
	603	\|(% style="width:127px" %) \|(% style="width:45px" %)Dataflow (DataflowDefinition)
	604	\|(% style="width:127px" %)metadatastructure\|(% style="width:45px" %)MetadataTarget
	605	\|(% style="width:127px" %) \|(% style="width:45px" %)DimensionDescriptorValueTarget
	606	\|(% style="width:127px" %) \|(% style="width:45px" %)IdentifiableObjectTarget
	607	\|(% style="width:127px" %) \|(% style="width:45px" %)ReportPeriodTarget
	608	\|(% style="width:127px" %) \|(% style="width:45px" %)DataSetTarget
	609	\|(% style="width:127px" %) \|(% style="width:45px" %)ReportStructure
	610	\|(% style="width:127px" %) \|(% style="width:45px" %)MetadataAttribute
	611	\|(% style="width:127px" %) \|(% style="width:45px" %)(((
1.1	612	MetadataStructure
	613
	614	(MetadataStructureDefinition)
	615	)))
2.6	616	\|(% style="width:127px" %) \|(% style="width:45px" %)Metadataflow (MetadataflowDefinition)
	617	\|(% style="width:127px" %)process\|(% style="width:45px" %)Process
	618	\|(% style="width:127px" %) \|(% style="width:45px" %)ProcessStep
	619	\|(% style="width:127px" %) \|(% style="width:45px" %)Transition
	620	\|(% style="width:127px" %)registry\|(% style="width:45px" %)ProvisionAgreement
	621	\|(% style="width:127px" %) \|(% style="width:45px" %)AttachmentConstraint
	622	\|(% style="width:127px" %) \|(% style="width:45px" %)ContentConstraint
	623	\|(% style="width:127px" %) \|(% style="width:45px" %)Subscription
	624	\|(% style="width:127px" %)mapping\|(% style="width:45px" %)StructureMap
	625	\|(% style="width:127px" %) \|(% style="width:45px" %)StructureSet
	626	\|(% style="width:127px" %) \|(% style="width:45px" %)ComponentMap
	627	\|(% style="width:127px" %) \|(% style="width:1745px" %)ConceptSchemeMap
	628	\|(% style="width:127px" %) \|(% style="width:1745px" %)OrganisationSchemeMap
	629	\|(% style="width:127px" %) \|(% style="width:1745px" %)CodelistMap
	630	\|(% style="width:127px" %) \|(% style="width:1745px" %)CategorySchemeMap
	631	\|(% style="width:127px" %) \|(% style="width:1745px" %)ReportingTaxonomyMap
	632	\|(% style="width:127px" %) \|(% style="width:1745px" %)ConceptMap
	633	\|(% style="width:127px" %) \|(% style="width:1745px" %)OrganisationMap
	634	\|(% style="width:127px" %) \|(% style="width:1745px" %)CodeMap
	635	\|(% style="width:127px" %) \|(% style="width:1745px" %)HybridCodelistMap
	636	\|(% style="width:127px" %) \|(% style="width:1745px" %)CategoryMap
	637	\|(% style="width:127px" %) \|(% style="width:1745px" %)HybridCodeMap
	638	\|(% style="width:127px" %) \|(% style="width:1745px" %)ReportingCategoryMap
	639	\|(% style="width:127px" %)codelist\|(% style="width:1745px" %)Codelist
	640	\|(% style="width:127px" %) \|(% style="width:1745px" %)HierarchicalCodelist
	641	\|(% style="width:127px" %) \|(% style="width:1745px" %)Hierarchy
	642	\|(% style="width:127px" %) \|(% style="width:1745px" %)Hierarchy
	643	\|(% style="width:127px" %) \|(% style="width:1745px" %)Code
	644	\|(% style="width:127px" %) \|(% style="width:1745px" %)HierarchicalCode
	645	\|(% style="width:127px" %) \|(% style="width:1745px" %)Level
	646	\|(% style="width:127px" %)categoryscheme\|(% style="width:1745px" %)CategoryScheme
	647	\|(% style="width:127px" %) \|(% style="width:1745px" %)Category
	648	\|(% style="width:127px" %) \|(% style="width:1745px" %)Categorisation
	649	\|(% style="width:127px" %) \|(% style="width:1745px" %)ReportingTaxonomy
	650	\|(% style="width:127px" %) \|(% style="width:1745px" %)ReportingCategory
	651	\|(% style="width:127px" %)conceptscheme\|(% style="width:1745px" %)ConceptScheme
	652	\|(% style="width:127px" %) \|(% style="width:1745px" %)Concept
	653	\|(% style="width:127px" %)transformation\|(% style="width:1745px" %)TransformationScheme
	654	\|(% style="width:127px" %) \|(% style="width:1745px" %)Transformation
	655	\|(% style="width:127px" %) \|(% style="width:1745px" %)CustomTypeScheme
	656	\|(% style="width:127px" %) \|(% style="width:1745px" %)CustomType
	657	\|(% style="width:127px" %) \|(% style="width:1745px" %)NamePersonalisationScheme
	658	\|(% style="width:127px" %) \|(% style="width:1745px" %)NamePersonalisation
	659	\|(% style="width:127px" %) \|(% style="width:1745px" %)VtlCodelistMapping
	660	\|(% style="width:127px" %) \|(% style="width:1745px" %)VtlConceptMapping
	661	\|(% style="width:127px" %) \|(% style="width:1745px" %)VtlDataflowMapping
	662	\|(% style="width:127px" %) \|(% style="width:1745px" %)VtlConceptSchemeMapping
	663	\|(% style="width:127px" %) \|(% style="width:1745px" %)RulesetScheme
	664	\|(% style="width:127px" %) \|(% style="width:1745px" %)Ruleset
	665	\|(% style="width:127px" %) \|(% style="width:1745px" %)UserDefinedOperatorScheme
	666	\|(% style="width:127px" %) \|(% style="width:1745px" %)UserDefinedOperator
1.1	667
	668	Table 2: SDMX-IM Packages and Contained Classes
	669
	670	=== 6.2.4 URN Identification components of SDMX objects ===
	671
	672	The table below describes the identification components for all SDMX object types that have identification. Note the actual attributes are all Id, but have been prefixed by their class name or multiple class names to show navigation, e.g. conceptSchemeAgencyId is really the Id attribute of the Agency class that is associated to the ConceptScheme.
	673
	674	~* indicates that the object is maintainable.
	675
	676	Note that for brevity the URN examples omit the prefix. All URNs have the prefix
	677
2.7	678	> urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
1.1	679
2.10	680	(% style="width:1091.29px" %)
	681	\|(% style="width:250px" %)SDMX Class\|(% style="width:444px" %)Key attribute(s)\|(% style="width:396px" %)Example of URN
	682	\|(% style="width:250px" %)Agency\|(% style="width:444px" %)The URN for an Agency is shown later in this table. The identification of an Agency in the URN structure for the maintainable object is by means of the agencyId. The AgencyScheme is not identified as SDMX has a mechanism for identifying an Agency uniquely by its Id. Note that this Id may be hierarchical.\|(% style="width:396px" %)(((
1.1	683	IMF
2.9	684	Sub agency in the IMF AGENCIES
1.1	685	IMF.SubAgency1
	686	)))
2.10	687	\|(% style="width:250px" %)*ConceptScheme\|(% style="width:444px" %)conceptSchemeAgencyId:conceptSchemeId(ve rsion)\|(% style="width:396px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0)
	688	\|(% style="width:250px" %)Concept\|(% style="width:444px" %)conceptSchemeAgencyId:
	689	conceptSchemeId(version).conceptId\|(% style="width:396px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0).FREQ
	690	\|(% style="width:250px" %)*Codelist\|(% style="width:444px" %)codeListAgencyId:codeListId(version)\|(% style="width:396px" %)SDMX:CL_FREQ(1.0)
	691	\|(% style="width:250px" %)Code\|(% style="width:444px" %)codeListAgencyId:codelistId(version).codeId\|(% style="width:396px" %)SDMX:CL_FREQ(1.0).Q
	692	\|(% style="width:250px" %)(((
2.8	693	*Hierarchical Codelist
2.10	694	)))\|(% style="width:444px" %)hierachicalCodelistAgencyId: hierarchicalCodelistId(version)\|(% style="width:396px" %)(((
2.8	695	UNESCO:CL_EXP_SOURCE(1.0(% style="background-color:transparent" %))
1.1	696	)))
2.10	697	\|(% style="width:250px" %)Hierarchy\|(% style="width:444px" %)(((
1.1	698	hierachicalcodeListAgencyId:
	699	hierarchicalcodelistId(version).Hierarchy
2.10	700	)))\|(% style="width:396px" %)UNESCO:CL_EXP_SOURCE(1.0).
2.9	701	H-C-GOV
2.10	702	\|(% style="width:250px" %)Level\|(% style="width:444px" %)(((
1.1	703	hierachicalcodeListAgencyId:
	704	hierarchicalcodelistId(version).Hierarchy.Level
2.10	705	)))\|(% style="width:396px" %)(((
1.1	706	ESTAT:HCL_REGION(1.0).H_1.COUNTRY
	707	)))
2.10	708	\|(% style="width:250px" %)HierarchicalCode\|(% style="width:444px" %)hierachicalCodeListAgencyId: hierarchicalcodelistId(version).hierarchy.hierarc hicalCode\|(% style="width:396px" %)UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV.GOV_CODE1
	709	\|(% style="width:250px" %)*DataStructure\|(% style="width:444px" %)dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)\|(% style="width:396px" %)TFFS:EXT_DEBT(1.0)
	710	\|(% style="width:250px" %)(((
1.1	711	Dimension
	712	Descriptor
	713	Measure
	714	Descriptor
	715	Attribute
	716	Descriptor
2.10	717	)))\|(% style="width:444px" %)(((
1.1	718	dataStructureDefinitionAgencyId: dataStructureDefinitionId(version).
	719	componentListId
	720	where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)
2.10	721	)))\|(% style="width:396px" %)(((
1.1	722	TFFS:EXT_DEBT(1.0).DimensionDescriptor
	723
	724	TFFS:EXT_DEBT(1.0).MeasureDescriptor
	725
	726	TFFS:EXT_DEBT(1.0).AttributeDescriptor
	727	)))
2.10	728	\|(% style="width:250px" %)(((
1.1	729	GroupDimension
	730	Descriptor
2.10	731	)))\|(% style="width:444px" %)(((
1.1	732	dataStructureDefinitionAgencyId: dataStructureDefinitionId(version).
	733	groupDimensionDescriptorId
2.10	734	)))\|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).SIBLING
	735	\|(% style="width:250px" %)Dimension\|(% style="width:444px" %)(((
1.1	736	dataStructureDefinitionAgencyId: dataStructureDefinition (version).
	737	dimensionId
2.10	738	)))\|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).FREQ
	739	\|(% style="width:250px" %)TimeDimension\|(% style="width:444px" %)(((
1.1	740	dataStructureDefinitionAgencyId: dataStructureDefinition (version).
	741	timeDimensionId
2.10	742	)))\|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).TIME_PERIOD
	743	\|(% style="width:250px" %)Measure Dimension\|(% style="width:444px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version).
	744	measureDimensionId\|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).STOCK_FLOW
	745	\|(% style="width:250px" %)DataAttrribute\|(% style="width:444px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version). dataAttributeId\|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).OBS_STATUS
	746	\|(% style="width:250px" %)PrimaryMeasure\|(% style="width:444px" %)(((
1.1	747	dataStructureDefinitionAgencyId: dataStructureDefinition (version).
	748	primaryMeasureId
2.10	749	)))\|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).OBS_VALUE
	750	\|(% style="width:250px" %)(((
2.9	751	*Category Scheme
2.10	752	)))\|(% style="width:444px" %)categorySchemeAgencyId:
	753	categorySchemeId(version)\|(% style="width:396px" %)IMF:SDDS(1.0)
	754	\|(% style="width:250px" %)Category\|(% style="width:444px" %)categorySchemeAgencyId:
2.9	755	categorySchemeId(version).
2.10	756	categoryId.categoryId categoryId.categoryId etc.\|(% style="width:396px" %)(((
1.1	757	IMF:SDDS(1.0):
	758	level_1_category.level_2_category …
	759	)))
2.10	760	\|(% style="width:250px" %)(((
2.9	761	*Reporting Taxonomy
2.10	762	)))\|(% style="width:444px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version)\|(% style="width:396px" %) IMF:REP_1(1.0)
	763	\|(% style="width:250px" %)ReportingCategory\|(% style="width:444px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version) reportingcategoryId.reportingcategoryId\|(% style="width:396px" %)(((
1.1	764	IMF:REP_1(1.0):
	765	level_1_repcategory.level_2_repcategory …
	766	)))
2.10	767	\|(% style="width:250px" %)*Categorisation\|(% style="width:444px" %)categorisationAgencyId: categorisationId(version)\|(% style="width:396px" %)IMF:cat001(1.0)
	768	\|(% style="width:250px" %)(((
2.9	769	*Organisation Unit Scheme
2.10	770	)))\|(% style="width:444px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version)\|(% style="width:396px" %)ECB:ORGANISATIONS(1.0)
	771	\|(% style="width:250px" %)Organisation Unit\|(% style="width:444px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version). organisationUnitId\|(% style="width:396px" %)ECB:ORGANISATIONS(1.0).1F
	772	\|(% style="width:250px" %)*AgencyScheme\|(% style="width:444px" %)agencySchemeAgencyId: agencySchemeId(version)\|(% style="width:396px" %)ECB:AGENCIES(1.0)
1.1	773
2.10	774	\|(% style="width:262px" %)Agency\|(% style="width:369px" %)agencySchemeAgencyId: agencySchemeId(version). agencyId\|(% style="width:1262px" %)ECB:AGENCY(1.0).AA
	775	\|(% style="width:262px" %)(((
	776	*DataProvider Scheme
	777	)))\|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version)\|(% style="width:1262px" %)SDMX:DATA_PROVIDERS(1.0)
	778	\|(% style="width:262px" %)DataProvider\|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version) dataProviderId\|(% style="width:1262px" %)SDMX:DATA_PROVIDERS(1.0).PROVIDER_1
	779	\|(% style="width:262px" %)(((
	780	*DataConsumer Scheme
	781	)))\|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version)\|(% style="width:1262px" %)SDMX:DATA_CONSUMERS(1.0)
	782	\|(% style="width:262px" %)Data Consumer\|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version) dataConsumerId\|(% style="width:1262px" %)SDMX:DATA_CONSUMERS(1.0).CONSUMER_1
	783	\|(% style="width:262px" %)(((
	784	*Metadata Structure
	785	)))\|(% style="width:369px" %)MSDAgencyId:MSDId(version)\|(% style="width:1262px" %)IMF:SDDS_MSD(1.0)
	786	\|(% style="width:262px" %)MetadataTarget\|(% style="width:369px" %)(((
1.1	787	MSDAgencyId:
	788	MSDId(version).metadataTargetId
2.10	789	)))\|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY
	790	\|(% style="width:262px" %)(((
1.1	791	Dimension
	792	DescriptorValues
	793	Target
2.10	794	)))\|(% style="width:369px" %)(((
1.1	795	MSDAgencyId: MSDId(version).
	796	metadataTargetId.keyDescriptorValueTargetId
2.10	797	)))\|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.KEY
	798	\|(% style="width:262px" %)Identifiable Object Target\|(% style="width:369px" %)(((
	799	MSDAgencyId: MSDId(version).metadataTargetId.identifiableObjectTargetId
	800	)))\|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.STR-OBJECT
	801	\|(% style="width:262px" %)DataSetTarget\|(% style="width:369px" %)(((
1.1	802	MSDAgencyId:
2.10	803	MSDId(version).metadataTargetId.dataSetTargetId
	804	)))\|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.D1101
	805	\|(% style="width:262px" %)PeportPeriod Target\|(% style="width:369px" %)(((
	806	MSDAgencyId: MSDId(version).metadataTargetId.reportPeriodTargetId
	807	)))\|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.REP_PER
1.1	808
2.10	809	\|(% style="width:251px" %)(((
1.1	810	ReportStructure
2.10	811	)))\|(% style="width:442px" %)(((
	812	MSDAgencyId: MSDId(version).reportStructureId
	813	)))\|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT
	814	\|(% style="width:251px" %)(((
3.6	815	Metadata Attribute
2.10	816	)))\|(% style="width:442px" %)(((
	817	MSDAgencyId: MSDId(version).reportStructureId.metadataattri buteID
	818	)))\|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION
	819	\|(% style="width:251px" %)*Dataflow\|(% style="width:442px" %)dataflowAgencyId: dataflowId(version)\|(% style="width:1178px" %)TFFS:CRED_EXT_DEBT(1.0)
	820	\|(% style="width:251px" %)*Provision Agreement\|(% style="width:442px" %)(((
1.1	821	provisionAgreementAgencyId:provisionAgreem entId(version)
2.10	822	)))\|(% style="width:1178px" %)(((
1.1	823	TFFS:CRED_EXT_DEBT_AB(1.0)
	824	)))
2.10	825	\|(% style="width:251px" %)(((
3.6	826	*Content Constraint
2.10	827	)))\|(% style="width:442px" %)constraintAgencyId:ContentConstraintId(versio n)\|(% style="width:1178px" %)TFFS:CREDITOR_DATA_CONTENT(1.0)
	828	\|(% style="width:251px" %)(((
3.6	829	*Attachment Constraint
2.10	830	)))\|(% style="width:442px" %)(((
1.1	831	constraintAgencyId:
	832
	833	attachmentConstraintId(version)
2.10	834	)))\|(% style="width:1178px" %)TFFS:CREDITOR_DATA_ATTACHMENT_CONSTRAINT_ONE(1.0)
	835	\|(% style="width:251px" %)*Metadataflow\|(% style="width:442px" %)metadataflowAgencyId: metadataflowId(version)\|(% style="width:1178px" %)IMF:SDDS_FLOW(1.0)
	836	\|(% style="width:251px" %)*StructureSet\|(% style="width:442px" %)structureSetAgencyId: structureSetId(version)\|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0)
	837	\|(% style="width:251px" %)StructureMap\|(% style="width:442px" %)structureSetAgencyId: structureSetId(version). structureMapId\|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2
	838	\|(% style="width:251px" %)Component Map\|(% style="width:442px" %)(((
1.1	839	structureSetAgencyId: structureSetId(version).
	840
	841	structureMapId. componentMapId
2.10	842	)))\|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2. REFAREA_REPCOUNTRY
	843	\|(% style="width:251px" %)CodelistMap\|(% style="width:442px" %)structureSetAgencyId: structureSetId(version). codelistMapId\|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY
	844	\|(% style="width:251px" %)CodeMap\|(% style="width:442px" %)structureSetAgencyId: structureSetId(version).\|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY. DE_GER
1.1	845
	846	\| \|(((
	847	codeListMapId.
	848
	849	codeMapId
	850	)))\|
	851	\|(((
3.6	852	CategorySchemeMap
1.1	853	)))\|structureSetAgencyId: structureSetId(version). categorySchemeMapId\|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT
	854	\|CategoryMap\|structureSetAgencyId: structureSetId(version). categorySchemeMapId. categoryMapId\|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT.TOURISM_M AP
	855	\|Organisation SchemeMap\|structureSetAgencyId: structureSetId(version). organisationSchemeMapId\|SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP
	856	\|Organisation Map\|structureSetAgencyId: structureSetId(version). organisationSchemeMapId. organisationMapId\|SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP.IMF_1C0
	857	\|(((
	858	Concept
	859
	860	SchemeMap
	861	)))\|structureSetAgencyId: structureSetId(version). conceptSchemeMapId\|SDMX:BOP_STRUCTURES(1.0).SDMX_OECD
	862	\|ConceptMap\|(((
	863	structureSetAgencyId: structureSetId(version). conceptSchemeMapId.
	864
	865	conceptMapId
	866
	867	)))\|SDMX:BOP_STRUCTURES(1.0).SDMX_OECD.COVERAGE_AVAI LABILITY
	868	\|(((
3.6	869	ReportingTaxonomyMap
1.1	870	)))\|structureSetAgencyId: structureSetId(version). reportingTaxonomyMapId\|SDMX:BOP_STRUCTURES(1.0).TAXMAP
	871	\|(((
3.7	872	ReportingCategoryMap
1.1	873	)))\|(((
	874	structureSetAgencyId: structureSetId(version).
	875	reportngCategoryId
	876	)))\|SDMX:BOP_STRUCTURES(1.0).TAXMAP.TOPCAT
	877
	878	\|(((
3.6	879	HybridCodelistMap
	880	)))\|structureSetAgencyId: structureSetId(version).
	881	hybridCodelistMapId.\|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP
1.1	882	\|HybridCodeMap\|structureSetAgencyId: structureSetId(version). hybridCodelistMapId. hybridCodeMapId\|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP.CO DEMAP1
	883	\|*Process\|processAgencyId: processId{version]\|BIS:PROCESS1(1.0)
	884	\|ProcessStep\|(((
	885	processAgencyId: processId(version).
	886	processStepId
	887	)))\|BIS:PROCESS1(1.0).STEP1
	888	\|Transition\|(((
	889	processAgencyId: processId(version).
	890	processStepId transitionId
	891	)))\|BIS:PROCESS1(1.0).STEP1.TRANSITION1
	892	\|Subscription\|The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure, The name of the URN is registryURN There is no pre-determined format.\|This cannot be generated by a common mechanism as subscriptions, although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a maintenance agency, and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the Subscription, and for the application creating the subscription to store the registryURN that is returned from the registry in the subscription response message.
	893	\|(((
3.6	894	*Transformation Scheme
1.1	895	)))\|transformationSchemeAgencyId transformationSchemeId(version)\|ECB: TRANSFORMATION_SCHEME(1.0)
	896	\|Transformation\|(((
	897	transformationSchemeAgencyId transformationSchemeId(version)
	898	transformationId
	899	)))\|ECB:TRANSFORMATION_SCHEME(1.0).TRANS_1
	900	\|CustomType Scheme\|customTypeSchemeAgencyId customTypeSchemeId(version)\|ECB:CUSTOM_TYPE_SCHEME(1.0)
	901
	902	\|CustomType\|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId\|ECB: CUSTOM_TYPE_SCHEME(1.0).CUSTOM_TYPE_1
	903	\|(((
	904	Name
	905	Personalisation
	906	Scheme
	907	)))\|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)\|ECB:PSN_SCHEME(1.0)
	908	\|(((
	909	Name
	910	Personalisation
3.6	911	)))\|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)
	912	namePersonalisationId\|ECB:PSN_SCHEME(1.0).PSN1234
1.1	913	\|VtlMapping Scheme\|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)\|ECB:CLIST_MP(2.0)
	914	\|VtlCodelist Mapping\|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId\|ECB:CLIST_MP(2.0).ABZ
	915	\|VtlConcept Mapping\|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId\|ECB:CLIST_MP(1.0).XYA
	916	\|VtlDataflow Mapping\|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId\|ECB:CLIST_MP(1.0).MOQ
	917	\|(((
	918	VtlConcept
	919
	920	SchemeMapping
	921	)))\|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptSchemeId\|ECB:CLIST_MP(1.0).Z11
	922	\|RulesetScheme\|rulesetSchemeAgencyId rulesetSchemeId(version)\|ECB:RULESET_23(1.0)
	923	\|Ruleset\|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId\|ECB:RULESET_23(1.0).SET111
	924	\|(((
3.7	925	UserDefinedOperatorScheme
1.1	926	)))\|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)\|ECB:OS_CALC(1.2)
	927	\|UserDefined Operator\|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId\|ECB:OS_CALC(1.2).OS267
	928
3.7	929	Table 3: Table of identification components for SDMX Identifiable Artefacts
1.1	930
	931	= 7 Implementation Notes =
	932
	933	== 7.1 Structural Definition Metadata ==
	934
	935	=== 7.1.1 Introduction ===
	936
	937	The SDMX Registry must have the ability to support agencies in their role of defining and disseminating structural metadata artefacts. These artefacts include data structure definitions, code lists, concepts etc. and are fully defined in the SDMX-IM. An authenticated agency may submit valid structural metadata definitions which must be stored in the registry. Note that the term “structural metadata” refers as a general term to all structural components (Data structure Definitions, Metadata Structure Definitions, Code lists, Concept Schemes, etc.)
	938
	939	At a minimum, structural metadata definitions may be submitted to and queried from the registry via an HTTP/HTTPS POST in the form of one of the SDMX-ML registry messages for structural metadata and the SDMX Query message for structure queries. The use of SOAP is also recommended, as described in the SDMX Web Services Guidelines. The message may contain all structural metadata items for the whole registry, structural metadata items for one maintenance agency, or individual structural metadata items.
	940
	941	Structural metadata items
	942
	943	* may only be modified by the maintenance agency which created them
	944	* may only be deleted by the agency which created them
	945	* may not be deleted if they are referenced from other constructs in the Registry
	946
	947	The level of granularity for the maintenance of SDMX Structural Metadata objects in the registry is the Maintainable Artefact. In other words, any function such as add, modify, delete is at the level of the Maintainable Artefact. For instance, if a Code is added to a Code List, or the Name of a Code is changed, the Registry must replace the existing Code List with the submitted Code List of the same Maintenance Agency, Code List, Id and Version.
	948
	949	The following table lists the Maintainable Artefacts.
	950
2.10	951	(% style="width:640.294px" %)
	952	\|(% colspan="2" rowspan="1" style="width:186px" %)Maintainable Artefacts\|(% style="width:206px" %)Content
	953	\|(% style="width:171px" %)Abstract Class\|(% style="width:232px" %)Concrete Class\|(% style="width:206px" %)
	954	\|(% style="width:171px" %)Item Scheme\|(% style="width:232px" %)Codelist\|(% style="width:206px" %)Code
	955	\|(% style="width:171px" %) \|(% style="width:232px" %)Concept Scheme\|(% style="width:206px" %)Concept
	956	\|(% style="width:171px" %) \|(% style="width:232px" %)Category Scheme\|(% style="width:206px" %)Category
	957	\|(% style="width:171px" %) \|(% style="width:232px" %)Organisation Unit Scheme\|(% style="width:206px" %)Organisation Unit
	958	\|(% style="width:171px" %) \|(% style="width:232px" %)Agency Scheme\|(% style="width:206px" %)Agency
	959	\|(% style="width:171px" %) \|(% style="width:232px" %)Data Provider Scheme\|(% style="width:206px" %)Data Provider
	960	\|(% style="width:171px" %) \|(% style="width:232px" %)Data Consumer Scheme\|(% style="width:206px" %)Data Consumer
	961	\|(% style="width:171px" %) \|(% style="width:232px" %)Reporting Taxonomy\|(% style="width:206px" %)Reporting Category
	962	\|(% style="width:171px" %) \|(% style="width:232px" %)Transformation Scheme\|(% style="width:206px" %)Transformation
	963	\|(% style="width:171px" %) \|(% style="width:232px" %)Custom Type Scheme\|(% style="width:206px" %)Custom Type
	964	\|(% style="width:171px" %) \|(% style="width:232px" %)Name Personalisation Scheme\|(% style="width:206px" %)Name Personalisation
	965	\|(% style="width:171px" %) \|(% style="width:232px" %)Vtl Mapping Scheme\|(% style="width:206px" %)Vtl Codelist Mapping
	966	\|(% style="width:171px" %) \|(% style="width:232px" %) \|(% style="width:206px" %)Vtl Dataflow Mapping
	967	\|(% style="width:171px" %) \|(% style="width:232px" %) \|(% style="width:206px" %)Vtl Concept Scheme Mapping
	968	\|(% style="width:171px" %) \|(% style="width:232px" %)Ruleset Scheme\|(% style="width:206px" %)Ruleset
	969	\|(% style="width:171px" %) \|(% style="width:232px" %)User Defined Operator Scheme\|(% style="width:206px" %)User Defined Operator
	970	\|(% style="width:171px" %) \|(% style="width:232px" %) \|(% style="width:206px" %)User Defined Operator
	971	\|(% style="width:171px" %)Structure\|(% style="width:232px" %)Data Structure Definition\|(% style="width:206px" %)(((
1.1	972	Dimension Descriptor
	973	Group Dimension
	974	Descriptor
	975	Dimension
	976	Measure Dimension
	977	Time Dimension
	978	Attribute Descriptor
	979	Data Attribute
	980	Measure Descriptor
	981	Primary Measure
	982	)))
2.10	983	\|(% style="width:171px" %) \|(% style="width:232px" %)Metadata Structure Definition\|(% style="width:206px" %)(((
	984	Metadata Target, Dimension Descriptor
1.1	985	Values Target Identifiable
	986	Object Target
	987	Report Period Target
	988	Data SetTarget
	989	Report Structure
	990	Metadata Attribute
	991	)))
2.11	992	\|(% style="width:171px" %)Structure Usage\|(% style="width:232px" %)Dataflow Definition\|(% style="width:206px" %)
	993	\|(% style="width:171px" %) \|(% style="width:232px" %)Metadataflow Definition\|(% style="width:206px" %)
	994	\|(% style="width:171px" %)None\|(% style="width:232px" %)Process\|(% style="width:206px" %)Process Step
	995	\|(% style="width:171px" %)None\|(% style="width:232px" %)Structure Set\|(% style="width:206px" %)(((
1.1	996	Component Map
	997	Concept Scheme Map
	998	Codelist Map
	999	Category Scheme Map
	1000	Reporting Taxonomy Map
	1001	Organisation Scheme Map
	1002	Concept Map
	1003	Code Map
	1004	Category Map
	1005	Organisation Map
	1006	Reporting Category Map
	1007	Hybrid Codelist Map
	1008	Hybrid Code Map
	1009	)))
2.11	1010	\|(% style="width:171px" %)None\|(% style="width:232px" %)Provision Agreement\|(% style="width:206px" %)
	1011	\|(% style="width:171px" %)None\|(% style="width:232px" %)Hierarchical Codelist\|(% style="width:206px" %)(((
1.1	1012	Hierarchy
	1013	Hierarchical Code
	1014	)))
	1015
2.11	1016	able 4: Table of Maintainable Artefacts for Structural Definition Metadata
1.1	1017
	1018	=== 7.1.2 Item Scheme, Structure ===
	1019
	1020	The artefacts included in the structural definitions are:
	1021
	1022	* All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme - Agency Scheme, Data Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme)
2.11	1023	* All types of Structure (Data Structure Definition, Metadata Structure Definition)
1.1	1024	* All types of Structure Usage (Dataflow Definition, Metadataflow Definition)
	1025
	1026	=== 7.1.3 Structure Usage ===
	1027
	1028	==== 7.1.3.1 Structure Usage: Basic Concepts ====
	1029
	1030	The Structure Usage defines, in its concrete classes of Dataflow Definition and
	1031
	1032	Metadataflow Definition, which flows of data and metadata use which specific Structure, and importantly for the support of data and metadata discovery, the Structure Usage can be linked to one or more Category in one or more Category Scheme using the Categorisation mechanism. This gives the ability for an application to discover data and metadata by “drilling down” the Category Schemes.
	1033
	1034	==== 7.1.3.2 Structure Usage Schematic ====
	1035
	1036	[[image:1747824123018-658.jpeg]]
	1037
	1038	Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions
	1039
	1040	==== 7.1.3.3 Structure Usage Model ====
	1041
2.12	1042	[[image:1747829078194-749.png]]
	1043
1.1	1044	Figure 10: SDMX-IM of links from Structure Usage to Category
	1045
	1046	In addition to the maintenance of the Dataflow Definition and the Metadataflow Definition the following links must be maintained in the registry:
	1047
	1048	* Dataflow Definition to Data Structure Definition
	1049	* Metadataflow Definition to Metadata Structure Definition
	1050
	1051	The following links may be created by means of a Categorisation
	1052
	1053	* Categorisation to Dataflow Definition and Category
	1054	* Categorisation to Metadataflow Definition and Category
	1055
	1056	== 7.2 Data and Metadata Provisioning ==
	1057
	1058	=== 7.2.1 Provisioning Agreement: Basic concepts ===
	1059
	1060	Data provisioning defines a framework in which the provision of different types of statistical data and metadata by various data providers can be specified and controlled. This framework is the basis on which the existence of data can be made known to the SDMX-enabled community and hence the basis on which data can subsequently be discovered. Such a framework can be used to regulate the data content to facilitate the building of intelligent applications. It can also be used to facilitate the processing implied by service level agreements, or other provisioning agreements in those scenarios that are based on legal directives. Additionally, quality and timeliness metadata can be supported by this framework which makes it practical to implement information supply chain monitoring.
	1061
	1062	Note that in the SDMX-IM the class “Data Provider” encompasses both data and metadata and the term “data provisioning” here includes both the provisioning of data and metadata.
	1063
	1064	Although the Provision Agreement directly supports the data-sharing “pull” model, it is also useful in “push” exchanges (bilateral and gateway scenarios), or in a dissemination environment. It should be noted, too, that in any exchange scenario, the registry functions as a repository of structural metadata.
	1065
	1066	=== 7.2.2 Provisioning Agreement Model – pull use case ===
	1067
	1068	An organisation which publishes statistical data or reference metadata and wishes to make it available to an SDMX enabled community is called a Data Provider. In terms of the SDMX Information Model, the Data Provider is maintained in a Data Provider Scheme.
	1069
2.13	1070	[[image:1747829109466-595.png]]
1.1	1071
	1072	Figure 11: SDMX-IM of the Data Provider
	1073
	1074	Note that the Data Provider does not inherit the hierarchy association. The diagram below shows a logical schematic of the data model classes required to maintain provision agreements
	1075
	1076	[[image:1747824123019-181.jpeg]]
	1077
	1078	Figure 12: Schematic of the Provision Agreement
	1079
	1080	The diagram below is a logical representation of the data required in order to maintain Provision Agreements.
	1081
2.13	1082	[[image:1747829139951-378.png]]
1.1	1083
2.13	1084	(% class="wikigeneratedid" id="HFigure13:LogicalclassdiagramoftheinformationcontainedintheProvisionAgreement" %)
	1085	Figure 13: Logical class diagram of the information contained in the Provision Agreement
1.1	1086
	1087	A Provision Agreement is structural metadata. Each Provision Agreement must reference a Data Provider and a Dataflow or Metadataflow Definition. The Data Provider and the Dataflow/Metadataflow Definition must exist already in order to set up a Provision Agreement.
	1088
	1089	== 7.3 Data and Metadata Constraints ==
	1090
	1091	=== 7.3.1 Data and Metadata Constraints: Basic Concepts ===
	1092
	1093	Constraints are, effectively, lists of the valid or actual content of data and metadata. Constraints can be used to specify a sub set of the theoretical content of data set or metadata set which can be derived from the specification of the DSD or MSD. A Constraint can comprise a list of keys or a list of content (usually code values) of a specific component such as a dimension or attribute.
	1094
	1095	Constraints comprise the specification of subsets of key or target values or attribute values that are contained in a Datasource, or is to be provided for a Dataflow or Metadataflow Definition, or directly attached to a Data Structure Definition or Metadata Structure Definition. This is important metadata because, for example, the full range of possibilities which is implied by the Data Structure Definition (e.g. the complete set of valid keys is the Cartesian product of all the values in the code lists for each of the Dimensions) is often more than is actually present in any specific Datasource, or more than is intended to be supplied according to a specific Dataflow Definition.
	1096
	1097	Often a Data Provider will not be able to provide data for all key combinations, either because the combination itself is not meaningful, or simply because the provider does not have the data for that combination. In this case the Data Provider could constrain the Datasource (at the level of the Provision Agreement or the Data Provider) by supplying metadata that defines the key combinations or cube regions that are available. This is done by means of a Constraint. The Content Constraint is also used to define a code list sub set which is used to populate a Partial Code List.
	1098
	1099	Furthermore, it is often useful to define subsets or views of the Data Structure Definition which restrict values in some code lists, especially where many such subsets restrict the same Data Structure Definition. Such a view is called a Dataflow Definition, and there can be one or more defined for any Data Structure Definition.
	1100
	1101	Whenever data is published or made available by a Data Provider, it must conform to a Dataflow Definition (and hence to a Data Structure Definition). The Dataflow Definition is thus a means of enabling content based processing.
	1102
	1103	In addition, Constraints can be extremely useful in a data visualisation system, such as dissemination of statistics on a website. In such a system a Cube Region can be used to specify the Dimension codes that actually exist in a datasource (these can be used to build relevant selection tables), and the Key Set can be used to specify the keys that exist in a datasource (these can be used to guide the user to select only those Dimension code values that will return data based on the Dimension values already selected).
	1104
	1105	=== 7.3.2 Data and Metadata Constraints: Schematic ===
	1106
	1107	[[image:1747824123021-978.jpeg]]
	1108
	1109	Figure 14: Schematic of the Constraint and the Artefacts that can be Constrained
	1110
	1111	=== 7.3.3 Data and Metadata Constraints: Model ===
	1112
2.13	1113	[[image:1747829204737-370.png]]
1.1	1114
2.13	1115	Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts
1.1	1116
2.13	1117	The class diagram above shows that DataProvider, DataflowDefinition, MetadataflowDefinition, ProvisionAgreement, DataStructureDefinition, MetadataStructureDefinition, SimpleDatasource and QueryDatasource are all concrete sub-classes of ConstrainableArtefact and can therefore have Constraints specified. Note that the actual Constraint as submitted is associated to the reference classes which inherit from ConstrainableRef: these are used to refer to the classes to which the Constraint applies.
1.1	1118
	1119	The content of the Constraint can be found in the SDMX Information Model document.
	1120
	1121	== 7.4 Data and Metadata Registration ==
	1122
	1123	=== 7.4.1 Basic Concepts ===
	1124
	1125	A Data Provider has published a new dataset conforming to an existing Dataflow Definition (and hence Data Structure Definition). This is implemented as either a web-accessible SDMX-ML file, or in a database which has a web-services interface capable of responding to an SDMX-ML Query or RESTful query with an SDMX-ML data stream.
	1126
	1127	The Data Provider wishes to make this new data available to one or more data collectors in a “pull” scenario, or to make the data available to data consumers. To do this, the Data Provider registers the new dataset with one or more SDMX conformant registries that have been configured with structural and provisioning metadata. In other words, the registry “knows” the Data Provider and “knows” what data flows the data provider has agreed to make available.
	1128
	1129	The same mechanism can be used to report or make available a metadata set.
	1130
	1131	SDMX-RR supports dataset and metadata set registration via the Registration Request, which can be created by the Data Provider (giving the Data Provider maximum control). The registry responds to the registration request with a registration response which indicates if the registration was successful. In the event of an error, the error messages are returned as a registry exception within the response.
	1132
	1133	=== 7.4.2 The Registration Request ===
	1134
	1135	==== 7.4.2.1 Registration Request Schematic ====
	1136
	1137	[[image:1747824123025-411.jpeg]]
	1138
3.3	1139	Figure 16: Schematic of the Objects Concerned with Registration
1.1	1140
	1141	==== 7.4.2.2 Registration Request Model ====
	1142
	1143	The following UML diagram shows the composition of the registration request. Each request is made up of one or more Registrations, one per dataset or metadata set to be registered. The Registration can optionally have information which has been extracted from the Registration:
	1144
	1145	* validFrom
	1146	* validTo
	1147	* lastUpdated
	1148
	1149	The last updated date is useful during the discovery process to make sure the client knows which data is freshest.
	1150
	1151	The Registration has an action attribute which takes one of the following values:
	1152
2.14	1153	(% style="width:970.294px" %)
	1154	\|(% style="width:212px" %)Action Attribute Value\|(% style="width:756px" %)Behaviour
	1155	\|(% style="width:212px" %)Append\|(% style="width:756px" %)Add this Registration to the registry
	1156	\|(% style="width:212px" %)Replace\|(% style="width:756px" %)Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
	1157	\|(% style="width:212px" %)Delete\|(% style="width:756px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1.1	1158
2.15	1159	[[image:1747829290890-122.png]]
	1160
1.1	1161	Figure 17: Logical Class Diagram of Registration of Data and Metadata
	1162
	1163	The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query
	1164
	1165	(RESTDatasource) and respond appropriately. Each of these different Datasources inherit the dataURL from Datasource, and the QueryDatasource has an additional URL to locate a WSDL or WADL document to describe how to access it. All other supported protocols are assumed to use the Simple Datasource URL.
	1166
	1167	A Simple Datasource is used to reference a physical SDMX-ML file that is available at a URL.
	1168
	1169	The Registration Request has an action attribute which defines whether this is a new (append) or updated (replace) Registration, or that the Registration is to be deleted (delete). The id is only provided for the replace and delete actions, as the Registry will allocate the unique id of the (new) Registration.
	1170
	1171	The Registration includes attributes that state how a Simple Datasource is to be indexed when registered. The Registry registration process must act as follows.
	1172
	1173	Information in the data or metadata set is extracted and placed in one or more Content Constraints (see the Constraints model in the SDMX Information Model – Section 2 of the SDMX Standards). The information to be extracted is indicated by the Boolean values set on the Provision Agreement as shown in the table below.
	1174
2.16	1175	\|(% style="width:185px" %)Indexing Required\|(% style="width:1686px" %)Registration Process Activity
	1176	\|(% style="width:185px" %)indexTimeSeries\|(% style="width:1686px" %)Extract all the series keys and create a KeySet(s) Constraint.
	1177	\|(% style="width:185px" %)indexDataSet\|(% style="width:1686px" %)(((
	1178	Extract all the codes and other content of the Key value of the Series Key in a Data Set and create one or more Cube Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value.
1.1	1179	)))
2.16	1180	\|(% style="width:185px" %)indexReportingPeriod\|(% style="width:1686px" %)(((
1.1	1181	This applies only to a registered dataset.
	1182	Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
	1183	)))
2.16	1184	\|(% style="width:185px" %)indexAttributes\|(% style="width:1686px" %)(((
1.1	1185	Data Set
	1186	Extract the content of the Attribute Values in a Data Set and create one or more Cube Regions containing Member Selections of Data Attribute Components of the Constraints model in the SDMXIM, and the associated Selection Value
	1187	Metadata Set
	1188	Indicate the presence of a Reported Attribute by creating one or more Cube Regions containing Member Selections of Metadata Attribute Components of the Constraints model in the SDMX-IM. Note that the content is not stored in the Selection Value.
	1189	)))
	1190
	1191	Constraints that specify the contents of a Query Datasource are submitted to the Registry in a Submit Structure Request.
	1192
	1193	The Registration must reference the Provision Agreement to which it relates.
	1194
	1195	=== 7.4.3 Registration Response ===
	1196
2.16	1197	After a registration request has been submitted to the registry, a response is returned to the submitter indicating success or failure. Given that a registration request can hold many Registrations, then there must be a registration status for each Registration. The Submit Registration class has a status field which is either set to “Success”, “Warning” or “Failure”.
1.1	1198
	1199	If the registration has succeeded, a Registration will be returned - this holds the Registry-allocated Id of the newly registered Datasource plus a Datasource holding the URL to access the dataset, metadataset, or query service.
	1200
	1201	The Registration Response returns set of registration status (one for each registration submitted) in terms of a Status Message (this is common to all Registry Responses) that indicates success or failure. In the event of registration failure, a set of Message Text are returned, giving the error messages that occurred during registration. It is entirely possible when registering a batch of datasets, that the response will contain some successful and some failed statuses. The logical model for the Registration Response is shown below:
	1202
2.16	1203	[[image:1747829477882-750.png]]
1.1	1204
	1205	Figure 18: Logical class diagram showing the registration response
	1206
	1207	== 7.5 Subscription and Notification Service ==
	1208
	1209	The contents of the SDMX Registry/Repository will change regularly: new code lists and key families will be published, new datasets and metadata-sets will be registered. To obviate the need for users to repeatedly query the registry to see when new information is available, a mechanism is provided to allow users to be notified when these events happen.
	1210
	1211	A user can submit a subscription in the registry that defines which events are of interest, and either an email and/or an HTTP address to which a notification of qualifying events will be delivered. The subscription will be identified in the registry by a URN which is returned to the user when the subscription is created. If the user wants to delete the subscription at a later point, the subscription URN is used as identification. Subscriptions have a validity period expressed as a date range (startDate, endDate) and the registry may delete any expired subscriptions, and will notify the subscriber on expiry.
	1212
2.17	1213	When a registry/repository artefact is modified, any subscriptions which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the subscription. This is called a “notification”.
1.1	1214
3.2	1215	=== 7.5.1Subscription Logical Class Diagram ===
1.1	1216
2.17	1217	[[image:1747829554603-150.png]]
1.1	1218
	1219	Figure 19: Logical Class Diagram of the Subscription
	1220
	1221	=== 7.5.2 Subscription Information ===
	1222
	1223	Regardless of the type of registry/repository events being observed, a subscription always contains:
	1224
2.17	1225	1. A set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent.
	1226	1. A user-defined identifier which is returned in the response to the subscription request. This helps with asynchronous processing and is NOT stored in the Registry.
	1227	1. A validity period which defines both when the subscription becomes active and expires. The subscriber may be sent a notification on expiration of the subscription.
	1228	1. A selector which specifies which type of events are of interest. The set of event types is:
1.1	1229
4.1	1230	\|(% style="width:319px" %)Event Type\|(% style="width:1553px" %)Comment
	1231	\|(% style="width:319px" %)STRUCTURAL_REPOSITORY_EVENTS\|(% style="width:1553px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
	1232	\|(% style="width:319px" %)DATA_REGISTRATION_EVENTS\|(% style="width:1553px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
	1233	\|(% style="width:319px" %)METADATA_REGISTRATION_EVENTS\|(% style="width:1553px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
	1234	\|(% style="width:319px" %)ALL_EVENTS\|(% style="width:1553px" %)All events of the specified EventType
1.1	1235
	1236	=== 7.5.3 Wildcard Facility ===
	1237
	1238	Subscription notification supports wildcarded identifier components URNs, which are identiiers which have some or all of their component parts replaced by the wildcard character `%`. Identifier components comprise:
	1239
2.17	1240	* agencyID
	1241	* id
	1242	* version
1.1	1243
	1244	Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
	1245
2.18	1246	//AgencyID = %
1.1	1247	Id = %
2.18	1248	Version = %//
1.1	1249
	1250	This subscribes to all Codelists of all versions for all agencies.
	1251
2.18	1252	//AgencyID = AGENCY1
1.1	1253	Id = CODELIST1
2.18	1254	Version = %//
1.1	1255
	1256	This subscribes to all versions of Codelist CODELIST1 maintained by the agency
	1257
2.18	1258	//AGENCY1
1.1	1259	AgencyID = AGENCY1
	1260	Id = %
2.18	1261	Version = %//
1.1	1262
	1263	This subscribes to all versions of all Codelist objects maintained by the agency
	1264
2.18	1265	//AGENCY1
1.1	1266	AgencyID = %
	1267	Id = CODELIST1
2.18	1268	Version = %//
1.1	1269
	1270	This subscribes to all versions of Codelist CODELIST1 maintained by the agency
	1271
2.18	1272	//AGENCY1//
1.1	1273
	1274	Note that if the subscription is to the latest version then this can be achieved by the * character
	1275
2.18	1276	//i.e. Version = *//
1.1	1277
	1278	Note that a subscription using the URN mechanism cannot use wildcard characters.
	1279
	1280	=== 7.5.4 Structural Repository Events ===
	1281
	1282	Whenever a maintainable artefact (data structure definition, concept scheme, codelist, metadata structure definition, category scheme, etc.) is added to, deleted from, or modified in the structural metadata repository, a structural metadata event is triggered. Subscriptions may be set up to monitor all such events, or focus on specific artefacts such as a Data Structure Definition.
	1283
	1284	=== 7.5.5 Registration Events ===
	1285
	1286	Whenever a dataset or metadata-set is registered a registration event is created. A subscription may be observing all data or metadata registrations, or it may focus on specific registrations as shown in the table below:
	1287
3.1	1288	\|(% style="width:405px" %)Selector\|(% style="width:1467px" %)Comment
	1289	\|(% style="width:405px" %)DataProvider\|(% style="width:1467px" %)Any datasets or metadata sets registered by the specified data provider will activate the notification.
	1290	\|(% style="width:405px" %)ProvisionAgreement\|(% style="width:1467px" %)Any datasets or metadata sets registered for the provision agreement will activate the notification.
	1291	\|(% style="width:405px" %)Dataflow (&Metadataflow)\|(% style="width:1467px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
	1292	\|(% style="width:405px" %)DataStructureDefinition & MetadataStructureDefinition\|(% style="width:1467px" %)Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will
	1293	\|(% style="width:405px" %)Selector\|(% style="width:1467px" %)Comment
	1294	\|(% style="width:405px" %) \|(% style="width:1467px" %)activate the notification.
	1295	\|(% style="width:405px" %)Category\|(% style="width:1467px" %)Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1.1	1296
	1297	The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
	1298
	1299	== 7.6 Notification ==
	1300
	1301	=== 7.6.1 Logical Class Diagram ===
	1302
3.1	1303	[[image:1747829675568-610.png]]
1.1	1304
3.1	1305	(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %)
	1306	Figure 20: Logical Class Diagram of the Notification
1.1	1307
	1308	A notification is an XML document that is sent to a user via email or http POST whenever a subscription is activated. It is an asynchronous one-way message.
	1309
	1310	Regardless of the registry component that caused the event to be triggered, the following common information is in the message:
	1311
	1312	* Date and time that the event occurred
	1313	* The URN of the artefact that caused the event
	1314	* The URN of the Subscription that produced the notification
	1315	* Event Action: Add, Replace, or Delete.
	1316
	1317	Additionally, supplementary information may be contained in the notification as detailed below.
	1318
	1319	=== 7.6.2 Structural Event Component ===
	1320
	1321	The notification will contain the MaintainableArtefact that triggered the event in a form similar to the SDMX-ML structural message (using elements from that namespace).
	1322
	1323	=== 7.6.3 Registration Event Component ===
	1324
	1325	The notification will contain the Registration.