Difference between revisions of "URN V10"
Jump to navigation
Jump to search
(→URN Examples) |
(→URN Identifiers) |
||
| (17 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | [[Category:Concepts_Reference_V10]] | ||
=Overview= | =Overview= | ||
| − | A URN is an abbreviation for [https://en.wikipedia.org/wiki/Uniform_Resource_Name '''U'''niform '''R'''esource '''N'''ame]. The URN, as used by the SDMX specification, is a globally unique identifier to any [[Identifiable]] SDMX Structure. | + | A URN is an abbreviation for [https://en.wikipedia.org/wiki/Uniform_Resource_Name '''U'''niform '''R'''esource '''N'''ame]. The URN, as used by the SDMX specification, is a globally unique identifier to any [[Identifiable V10|Identifiable]] SDMX Structure. |
| − | The URN is used as a mechanism to link structures | + | The URN is used as a mechanism to link structures together without having to know the exact location of the structure, this is how the URN differs from a URL, the former provides a long lasting references which is agnostic to location, the latter provides a precise location of where to obtain the resource. |
=Structure of a SDMX URN= | =Structure of a SDMX URN= | ||
A URN is made up of 2 to 3 parts, depending on the type of structure being referenced. | A URN is made up of 2 to 3 parts, depending on the type of structure being referenced. | ||
# Namespace | # Namespace | ||
| − | # Reference to the [[Maintainable]] Structure | + | # Reference to the [[Maintainable V10|Maintainable]] Structure |
| − | # Reference to the [[Identifiable]] Structure (if the URN is referencing a Structure within a | + | # Reference to the [[Identifiable V10|Identifiable]] Structure (if the URN is referencing a Structure within a Maintainable, i.e a Code within a Codelist) |
==URN Namespace== | ==URN Namespace== | ||
| Line 15: | Line 16: | ||
[[File:URN Namespace.png|700px]] | [[File:URN Namespace.png|700px]] | ||
| − | The prefix for all SDMX Structural Metadata is '''urn:sdmx:org.sdmx.infomodel'''. The Package and Class are used to represent the type of structure being referenced. | + | The prefix for all SDMX Structural Metadata is '''<nowiki> urn:sdmx:org.sdmx.infomodel</nowiki>'''<br>. The Package and Class are used to represent the type of structure being referenced. |
| − | |||
==URN Identifiers== | ==URN Identifiers== | ||
| − | The URN Namespace identifies which type of Structure is being | + | The URN Namespace identifies which type of Structure is being referenced, i.e., a Codelist, Data Structure, Concept, etc. |
| − | The subsequent properties in the URN Namespace are used to Identify the structure, starting with the [[Maintainable]] identifiers, which are: | + | The subsequent properties in the URN Namespace are used to Identify the structure, starting with the [[Maintainable V10|Maintainable]] identifiers, which are: |
# Agency Id | # Agency Id | ||
| − | # | + | # Identifiable |
# Version | # Version | ||
[[File:URN Maintainable.png|700px]] | [[File:URN Maintainable.png|700px]] | ||
| − | If the structure is not a [[Maintainable]] structure, but instead lives inside one, i.e a Code which lives inside a Codelist or a Dimension which lives inside a Data Structure, then the remainder of the URN is used to identify the structure inside the Maintainable parent. | + | If the structure is not a [[Maintainable_V10|Maintainable]] structure, but instead lives inside one, i.e a Code which lives inside a Codelist or a Dimension which lives inside a Data Structure, then the remainder of the URN is used to identify the structure inside the Maintainable parent. |
[[File:URN Identifiable.png|700px]] | [[File:URN Identifiable.png|700px]] | ||
| − | For structures which live nested inside others, i.e a Category which is a number of levels deep, the nesting is part of the URN | + | For structures which live nested inside others, i.e., a Category which is a number of levels deep, the nesting is part of the URN identification. |
| + | |||
| + | |||
| + | '''<nowiki> urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:STAT_SUBJECT_MATTER(1.0).DEMO_SOCIAL_STAT.HEALTH</nowiki>'''<br> | ||
| − | |||
Where the '''HEALTH''' Category is a child of the '''DEMO_SOCIAL_STAT''' Category. | Where the '''HEALTH''' Category is a child of the '''DEMO_SOCIAL_STAT''' Category. | ||
| Line 43: | Line 45: | ||
! Structure Type !! Package !! Class !! Parent !! Example | ! Structure Type !! Package !! Class !! Parent !! Example | ||
|- | |- | ||
| − | | Agency Scheme|| base || AgencyScheme || - || urn:sdmx:org.sdmx.infomodel.base.AgencyScheme=SDMX:AGENCIES(1.0) | + | | Agency Scheme|| base || AgencyScheme || - || <nowiki>urn:sdmx:org.sdmx.infomodel.base.AgencyScheme=SDMX:AGENCIES(1.0)</nowiki> |
|- | |- | ||
| − | | Agency || base|| Agency || AgencyScheme || urn:sdmx:org.sdmx.infomodel.base.Agency=SDMX | + | | Agency || base|| Agency || AgencyScheme || <nowiki>urn:sdmx:org.sdmx.infomodel.base.Agency=SDMX</nowiki> |
|- | |- | ||
| − | | Data Provider Scheme || base|| DataProviderScheme || - || urn:sdmx:org.sdmx.infomodel.base.DataProviderScheme=FAO:DATA_PROVIDERS(1.0) | + | | Data Provider Scheme || base|| DataProviderScheme || - || <nowiki>urn:sdmx:org.sdmx.infomodel.base.DataProviderScheme=FAO:DATA_PROVIDERS(1.0</nowiki>) |
|- | |- | ||
| − | | Data Provider || base|| DataProvider || DataProviderScheme || urn:sdmx:org.sdmx.infomodel.base.DataProvider=FAO:DATA_PROVIDERS(1.0).FR2 | + | | Data Provider || base|| DataProvider || DataProviderScheme || <nowiki>urn:sdmx:org.sdmx.infomodel.base.DataProvider=FAO:DATA_PROVIDERS(1.0).FR2</nowiki> |
|- | |- | ||
| − | | Data Consumer Scheme || base|| DataConsumerScheme || - || urn:sdmx:org.sdmx.infomodel.base.DataConsumerScheme=FAO:DATA_CONSUMERS(1.0) | + | | Data Consumer Scheme || base|| DataConsumerScheme || - || <nowiki>urn:sdmx:org.sdmx.infomodel.base.DataConsumerScheme=FAO:DATA_CONSUMERS(1.0)</nowiki> |
|- | |- | ||
| − | | Data Consumer || base|| DataConsumer || DataConsumerScheme || urn:sdmx:org.sdmx.infomodel.base.DataConsumer=FAO: | + | | Data Consumer || base|| DataConsumer || DataConsumerScheme || <nowiki>urn:sdmx:org.sdmx.infomodel.base.DataConsumer=FAO:DATA_CONSUMER(1.0).FR2</nowiki> |
|- | |- | ||
| − | | Organisation Unit Scheme || base || OrganisationUnitScheme || - || urn:sdmx:org.sdmx.infomodel.base.OrganisationUnitScheme=FAO:UNITSCHEME_A(1.0) | + | | Organisation Unit Scheme || base || OrganisationUnitScheme || - || <nowiki>urn:sdmx:org.sdmx.infomodel.base.OrganisationUnitScheme=FAO:UNITSCHEME_A(1.0)</nowiki> |
|- | |- | ||
| − | | Organisation Unit|| base || OrganisationUnit || OrganisationUnitScheme || urn:sdmx:org.sdmx.infomodel.base.OrganisationUnit=FAO:UNITSCHEME_A(1.0).STATS | + | | Organisation Unit|| base || OrganisationUnit || OrganisationUnitScheme || <nowiki>urn:sdmx:org.sdmx.infomodel.base.OrganisationUnit=FAO:UNITSCHEME_A(1.0).STATS</nowiki> |
|- | |- | ||
| − | | Categorisation || categoryscheme|| Categorisation || - || urn:sdmx:org.sdmx.infomodel.categoryscheme.Categorisation=IMF:CAT1(1.0) | + | | Categorisation || categoryscheme|| Categorisation || - || <nowiki>urn:sdmx:org.sdmx.infomodel.categoryscheme.Categorisation=IMF:CAT1(1.0)</nowiki> |
|- | |- | ||
| − | | Category Scheme || categoryscheme|| CategoryScheme || - || urn:sdmx:org.sdmx.infomodel.categoryscheme.CategoryScheme=SDMX:STAT_SUBJECT_MATTER(1.0) | + | | Category Scheme || categoryscheme|| CategoryScheme || - || <nowiki>urn:sdmx:org.sdmx.infomodel.categoryscheme.CategoryScheme=SDMX:STAT_SUBJECT_MATTER(1.0)</nowiki> |
|- | |- | ||
| − | | Category || categoryscheme|| Category || CategoryScheme || urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:STAT_SUBJECT_MATTER(1.0).DEMO_SOCIAL_STAT | + | | Category || categoryscheme|| Category || CategoryScheme || <nowiki>urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:STAT_SUBJECT_MATTER(1.0).DEMO_SOCIAL_STAT</nowiki> |
|- | |- | ||
| − | | Reporting Taxonomy || categoryscheme|| ReportingTaxonomy || - || urn:sdmx:org.sdmx.infomodel.categoryscheme.ReportingTaxonomy=SDMX:RT(1.0) | + | | Reporting Taxonomy || categoryscheme|| ReportingTaxonomy || - || <nowiki>urn:sdmx:org.sdmx.infomodel.categoryscheme.ReportingTaxonomy=SDMX:RT(1.0)</nowiki> |
|- | |- | ||
| − | | Reporting Category|| categoryscheme|| ReportingCategory || ReportingTaxonomy || urn:sdmx:org.sdmx.infomodel.categoryscheme.ReportingCategory=SDMX:RT(1.0).CAT1 | + | | Reporting Category|| categoryscheme|| ReportingCategory || ReportingTaxonomy || <nowiki>urn:sdmx:org.sdmx.infomodel.categoryscheme.ReportingCategory=SDMX:RT(1.0).CAT1</nowiki> |
|- | |- | ||
| − | | Concept Scheme || conceptscheme || ConceptScheme || -|| urn:sdmx:org.sdmx.infomodel.conceptscheme.ConceptScheme=SDMX:CROSS_DOMAIN_CONCEPTS(2.0) | + | | Concept Scheme || conceptscheme || ConceptScheme || -|| <nowiki>urn:sdmx:org.sdmx.infomodel.conceptscheme.ConceptScheme=SDMX:CROSS_DOMAIN_CONCEPTS(2.0)</nowiki> |
|- | |- | ||
| − | | Concept || conceptscheme || Concept || ConceptScheme || urn:sdmx:org.sdmx.infomodel.conceptscheme.Concept=SDMX:CROSS_DOMAIN_CONCEPTS(2.0).FREQ | + | | Concept || conceptscheme || Concept || ConceptScheme || <nowiki>urn:sdmx:org.sdmx.infomodel.conceptscheme.Concept=SDMX:CROSS_DOMAIN_CONCEPTS(2.0).FREQ</nowiki> |
|- | |- | ||
| − | | | + | | Codelist || codelist || Codelist || - || <nowiki>urn:sdmx:org.sdmx.infomodel.codelist.Codelist=SDMX:CL_FREQ(2.0)</nowiki> |
|- | |- | ||
| − | | Code || codelist || Code || Codelist || urn:sdmx:org.sdmx.infomodel.codelist.Code=SDMX:CL_FREQ(2.0).A | + | | Code || codelist || Code || Codelist || <nowiki>urn:sdmx:org.sdmx.infomodel.codelist.Code=SDMX:CL_FREQ(2.0).A</nowiki> |
|- | |- | ||
| − | | Data Structure || datastructure || DataStructure || - || urn:sdmx:org.sdmx.infomodel.datastructure.DataStructure=ESTAT:CPI(1.1) | + | | Data Structure || datastructure || DataStructure || - || <nowiki>urn:sdmx:org.sdmx.infomodel.datastructure.DataStructure=ESTAT:CPI(1.1)</nowiki> |
|- | |- | ||
| − | | Attribute List || datastructure || AttributeDescriptor || DataStructure || urn:sdmx:org.sdmx.infomodel.datastructure.AttributeDescriptor=ESTAT:CPI(1.1).AttributeDescriptor | + | | Attribute List || datastructure || AttributeDescriptor || DataStructure || <nowiki>urn:sdmx:org.sdmx.infomodel.datastructure.AttributeDescriptor=ESTAT:CPI(1.1).AttributeDescriptor</nowiki> |
|- | |- | ||
| − | | Attribute || datastructure || DataAttribute || AttributeDescriptor || urn:sdmx:org.sdmx.infomodel.datastructure.DataAttribute=ESTAT:CPI(1.0).DISS_ORG | + | | Attribute || datastructure || DataAttribute || AttributeDescriptor || <nowiki>urn:sdmx:org.sdmx.infomodel.datastructure.DataAttribute=ESTAT:CPI(1.0).DISS_ORG</nowiki> |
|- | |- | ||
| − | | Dimension List || datastructure || DimensionDescriptor || DataStructure || urn:sdmx:org.sdmx.infomodel.datastructure.DimensionDescriptor=ESTAT:CPI(1.1).DimensionDescriptor | + | | Dimension List || datastructure || DimensionDescriptor || DataStructure || <nowiki>urn:sdmx:org.sdmx.infomodel.datastructure.DimensionDescriptor=ESTAT:CPI(1.1).DimensionDescriptor</nowiki> |
|- | |- | ||
| − | | Dimension || datastructure || Dimension || DimensionDescriptor || urn:sdmx:org.sdmx.infomodel.datastructure.Dimension=ESTAT:CPI(1.0).FREQ | + | | Dimension || datastructure || Dimension || DimensionDescriptor || <nowiki>urn:sdmx:org.sdmx.infomodel.datastructure.Dimension=ESTAT:CPI(1.0).FREQ</nowiki> |
|- | |- | ||
| − | | Group List || datastructure || GroupDimensionDescriptor || DataStructure || urn:sdmx:org.sdmx.infomodel.datastructure.GroupDimensionDescriptor=ESTAT:CPI(1.1).SiblingGroup | + | | Group List || datastructure || GroupDimensionDescriptor || DataStructure || <nowiki>urn:sdmx:org.sdmx.infomodel.datastructure.GroupDimensionDescriptor=ESTAT:CPI(1.1).SiblingGroup</nowiki> |
|- | |- | ||
| − | | Measure List || datastructure || MeasureDescriptor || DataStructure || urn:sdmx:org.sdmx.infomodel.datastructure.MeasureDescriptor=ESTAT:CPI(1.1).MeasureDescriptor | + | | Measure List || datastructure || MeasureDescriptor || DataStructure || <nowiki>urn:sdmx:org.sdmx.infomodel.datastructure.MeasureDescriptor=ESTAT:CPI(1.1).MeasureDescriptor</nowiki> |
|- | |- | ||
| − | | Primary Measure || datastructure || PrimaryMeasure || MeasureDescriptor || urn:sdmx:org.sdmx.infomodel.datastructure.PrimaryMeasure=ESTAT:CPI(1.1).OBS_VALUE | + | | Primary Measure || datastructure || PrimaryMeasure || MeasureDescriptor || <nowiki>urn:sdmx:org.sdmx.infomodel.datastructure.PrimaryMeasure=ESTAT:CPI(1.1).OBS_VALUE</nowiki> |
|- | |- | ||
| − | | Time Dimension|| datastructure || TimeDimension || DataStructure || urn:sdmx:org.sdmx.infomodel.datastructure.TimeDimension=ESTAT:CPI(1.0).TIME_PERIOD | + | | Time Dimension|| datastructure || TimeDimension || DataStructure || <nowiki>urn:sdmx:org.sdmx.infomodel.datastructure.TimeDimension=ESTAT:CPI(1.0).TIME_PERIOD</nowiki> |
|- | |- | ||
| Metadata Structure|| metadatastructure || MetadataStructure || - || | | Metadata Structure|| metadatastructure || MetadataStructure || - || | ||
Latest revision as of 04:16, 5 September 2022
Contents
Overview
A URN is an abbreviation for Uniform Resource Name. The URN, as used by the SDMX specification, is a globally unique identifier to any Identifiable SDMX Structure.
The URN is used as a mechanism to link structures together without having to know the exact location of the structure, this is how the URN differs from a URL, the former provides a long lasting references which is agnostic to location, the latter provides a precise location of where to obtain the resource.
Structure of a SDMX URN
A URN is made up of 2 to 3 parts, depending on the type of structure being referenced.
- Namespace
- Reference to the Maintainable Structure
- Reference to the Identifiable Structure (if the URN is referencing a Structure within a Maintainable, i.e a Code within a Codelist)
URN Namespace
The URN Namespaces are defined by SDMX, and take the following syntax:
The prefix for all SDMX Structural Metadata is urn:sdmx:org.sdmx.infomodel
. The Package and Class are used to represent the type of structure being referenced.
URN Identifiers
The URN Namespace identifies which type of Structure is being referenced, i.e., a Codelist, Data Structure, Concept, etc.
The subsequent properties in the URN Namespace are used to Identify the structure, starting with the Maintainable identifiers, which are:
- Agency Id
- Identifiable
- Version
If the structure is not a Maintainable structure, but instead lives inside one, i.e a Code which lives inside a Codelist or a Dimension which lives inside a Data Structure, then the remainder of the URN is used to identify the structure inside the Maintainable parent.
For structures which live nested inside others, i.e., a Category which is a number of levels deep, the nesting is part of the URN identification.
urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:STAT_SUBJECT_MATTER(1.0).DEMO_SOCIAL_STAT.HEALTH
Where the HEALTH Category is a child of the DEMO_SOCIAL_STAT Category.
URN Examples
| Structure Type | Package | Class | Parent | Example |
|---|---|---|---|---|
| Agency Scheme | base | AgencyScheme | - | urn:sdmx:org.sdmx.infomodel.base.AgencyScheme=SDMX:AGENCIES(1.0) |
| Agency | base | Agency | AgencyScheme | urn:sdmx:org.sdmx.infomodel.base.Agency=SDMX |
| Data Provider Scheme | base | DataProviderScheme | - | urn:sdmx:org.sdmx.infomodel.base.DataProviderScheme=FAO:DATA_PROVIDERS(1.0) |
| Data Provider | base | DataProvider | DataProviderScheme | urn:sdmx:org.sdmx.infomodel.base.DataProvider=FAO:DATA_PROVIDERS(1.0).FR2 |
| Data Consumer Scheme | base | DataConsumerScheme | - | urn:sdmx:org.sdmx.infomodel.base.DataConsumerScheme=FAO:DATA_CONSUMERS(1.0) |
| Data Consumer | base | DataConsumer | DataConsumerScheme | urn:sdmx:org.sdmx.infomodel.base.DataConsumer=FAO:DATA_CONSUMER(1.0).FR2 |
| Organisation Unit Scheme | base | OrganisationUnitScheme | - | urn:sdmx:org.sdmx.infomodel.base.OrganisationUnitScheme=FAO:UNITSCHEME_A(1.0) |
| Organisation Unit | base | OrganisationUnit | OrganisationUnitScheme | urn:sdmx:org.sdmx.infomodel.base.OrganisationUnit=FAO:UNITSCHEME_A(1.0).STATS |
| Categorisation | categoryscheme | Categorisation | - | urn:sdmx:org.sdmx.infomodel.categoryscheme.Categorisation=IMF:CAT1(1.0) |
| Category Scheme | categoryscheme | CategoryScheme | - | urn:sdmx:org.sdmx.infomodel.categoryscheme.CategoryScheme=SDMX:STAT_SUBJECT_MATTER(1.0) |
| Category | categoryscheme | Category | CategoryScheme | urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:STAT_SUBJECT_MATTER(1.0).DEMO_SOCIAL_STAT |
| Reporting Taxonomy | categoryscheme | ReportingTaxonomy | - | urn:sdmx:org.sdmx.infomodel.categoryscheme.ReportingTaxonomy=SDMX:RT(1.0) |
| Reporting Category | categoryscheme | ReportingCategory | ReportingTaxonomy | urn:sdmx:org.sdmx.infomodel.categoryscheme.ReportingCategory=SDMX:RT(1.0).CAT1 |
| Concept Scheme | conceptscheme | ConceptScheme | - | urn:sdmx:org.sdmx.infomodel.conceptscheme.ConceptScheme=SDMX:CROSS_DOMAIN_CONCEPTS(2.0) |
| Concept | conceptscheme | Concept | ConceptScheme | urn:sdmx:org.sdmx.infomodel.conceptscheme.Concept=SDMX:CROSS_DOMAIN_CONCEPTS(2.0).FREQ |
| Codelist | codelist | Codelist | - | urn:sdmx:org.sdmx.infomodel.codelist.Codelist=SDMX:CL_FREQ(2.0) |
| Code | codelist | Code | Codelist | urn:sdmx:org.sdmx.infomodel.codelist.Code=SDMX:CL_FREQ(2.0).A |
| Data Structure | datastructure | DataStructure | - | urn:sdmx:org.sdmx.infomodel.datastructure.DataStructure=ESTAT:CPI(1.1) |
| Attribute List | datastructure | AttributeDescriptor | DataStructure | urn:sdmx:org.sdmx.infomodel.datastructure.AttributeDescriptor=ESTAT:CPI(1.1).AttributeDescriptor |
| Attribute | datastructure | DataAttribute | AttributeDescriptor | urn:sdmx:org.sdmx.infomodel.datastructure.DataAttribute=ESTAT:CPI(1.0).DISS_ORG |
| Dimension List | datastructure | DimensionDescriptor | DataStructure | urn:sdmx:org.sdmx.infomodel.datastructure.DimensionDescriptor=ESTAT:CPI(1.1).DimensionDescriptor |
| Dimension | datastructure | Dimension | DimensionDescriptor | urn:sdmx:org.sdmx.infomodel.datastructure.Dimension=ESTAT:CPI(1.0).FREQ |
| Group List | datastructure | GroupDimensionDescriptor | DataStructure | urn:sdmx:org.sdmx.infomodel.datastructure.GroupDimensionDescriptor=ESTAT:CPI(1.1).SiblingGroup |
| Measure List | datastructure | MeasureDescriptor | DataStructure | urn:sdmx:org.sdmx.infomodel.datastructure.MeasureDescriptor=ESTAT:CPI(1.1).MeasureDescriptor |
| Primary Measure | datastructure | PrimaryMeasure | MeasureDescriptor | urn:sdmx:org.sdmx.infomodel.datastructure.PrimaryMeasure=ESTAT:CPI(1.1).OBS_VALUE |
| Time Dimension | datastructure | TimeDimension | DataStructure | urn:sdmx:org.sdmx.infomodel.datastructure.TimeDimension=ESTAT:CPI(1.0).TIME_PERIOD |
| Metadata Structure | metadatastructure | MetadataStructure | - | |
| Report Structure | metadatastructure | ReportStructure | MetadataStructure | |
| Metadata Attribute | metadatastructure | MetadataAttribute | ReportStructure | |
| Metadata Target | metadatastructure | MetadataTarget | MetadataStructure | |
| Metadata Target (URN) | metadatastructure | IdentifiableObjectTarget | MetadataTarget | |
| Metadata Target (Dimension Values) | metadatastructure | DimensionDescriptorValuesTarget | - | |
| Metadataflow | metadatastructure | Metadataflow | - | |
| Process | process | Process | - | |
| Process Step | process | ProcessStep | Process | |
| Transition | process | Transition | ProcessStep | |
| Provision Agreement | registry | ProvisionAgreement | - | |
| Content Constraint | registry | ContentConstraint | - | |
| Structure Set | mapping | StructureSet | - | |
| Structure Map | mapping | Structure Map | StructureSet | |
| Category Scheme Map | mapping | CategorySchemeMap | StructureSet | |
| Concept Scheme Map | mapping | ConceptSchemeMap | StructureSet | |
| Codelist Map | mapping | CodelistMap | StructureSet | |
| Component Map | mapping | ComponentMap | StructureSet | |
| Organisation Scheme Map | mapping | OrganisationSchemeMap | StructureSet |
